21.教练的真相.结构¶
那上一节课就提到说,写教程是教练的分类知识。那么,今天我们首先从结构上审视一下所谓的教程。那简单来讲,一个好的教程,就是针对一个急需解决的问题,给出一个切实可行的方案。我再重复一遍:针对一个急需解决的问题,给出一个切实可行的方案,这就是好的教程。这里的关键字有两个,一个是“问题”,一个是“方案”,当然也可以被称为“答案”,对吧?问题和方案。
那所谓的问题呢,其实呢,无分以下三种,你按分类看就这么三种。第一种是“what”,什么;第二种是“why”,为何;第三种是“how”,如何。关于“什么”就是“what”这类问题的例子,比如说,大孩子到外地参加夏令营都需要注意什么?或者说,有哪些软件可以帮你快速处理图片?或者说,贝斯定理究竟是什么?那这类的问题呢,答案的焦点通常集中在介绍和讲解概念之上。如果涉及多个概念,通常还可以比较,比如说,这五种快速处理图片的软件,它们之间的优势和劣势,给做出一个比较列表。
那关于“why”,为什么的例子,比如说,孩子刚过三长岁的时候,突然开始出现拒绝对话的情况,怎么回事?或者说,为什么朗读是最好的自然语言学习的手段?又或者说,“阳”了之后到底可不可以洗头洗澡?就这类的问题呢,答案的焦点是因果关系分析,针对一个现象或者结果,给出一个足够合理的分析,主要是因果分析,并且呢,要找到足够精确的原因,然后解释清楚这些原因,给出这些原因的证据。
关于“how”,就是如何的问题的例子是什么呢?比如说,如何使用Excel做定投记录,并实时更新收益率?再比如说,如何尽快学习计算机键盘盲打?再或者说,如何练习胯下运球?那这类的问题呢,答案的焦点是可行的步骤,那就是可行的步骤。
当然了,现实中最常见的,是这三个类别的组合问题啊。比如说上面的例子当中,“为什么朗读是最好的自然语言习得手段?”若是追踪写成文章、写成教程,会自然让人变成啊,三种基本类型的组合。比如说,你在这个文章里可能要解释清楚,最高效的自然语言习得习惯是什么,都有哪些,这就是“what”的问题。然后呢,你还要这个解释清楚,为什么朗读是最高效的,那这就是“为什么”,why的问题。然后呢,你还要往下解释清楚,如何正确的、有效的朗读,那这个就是“how”,如何。
所以到最后啊,教程的标题可能并不是完整体现所有三个类别,对吧?比如说啊,你可以用这样的标题:“我是怎样提高自然语言习得效率的?”又或者说啊,你用这样的标题:“自然语言习得:如何才能更高效?”对吧?那你再一看呢,它就是一个“how”的问题,就是如何的问题。但最终教程里所陈述的内容,基本上是应该以上三个问题的组合。
比如说啊,我再细化一下,那我现在说的每一条,都可能会成为教程里的一个段落,或者是若干个段落组成的一部分。比如说啊,你可以去论述,习得自然语言的手段都有哪些,对吧?然后呢,你再去论述啊,在这些手段之中进行比较分析之后,为什么我选择了朗读,对吧?然后呢,你可能还要再去写啊,除此之外,朗读还有什么其他好处,它竟然还有很多好处,对吧?又或者说啊,你会写这样一部分,就实践之后发现了哪些意料之外的好处,对吧?
然后呢,你可能接着又啊有这样的部分,就是如何选择朗读材料,如何安排朗读时间,如何制定朗读计划,如何监督或自我监督,等等等等。然后呢,你可能还包括这样的段落,比如说啊,嗯,在朗读过程当中可能遇到的困难都有哪些,遇到这些困难的时候,我最初是如何解决的,那后来呢,有没有更好的解决方案,等等等等。
所以你看啊,到最后,它无非就是啊,针对着一个急需解决的问题,从三个方面啊,多角度入手,要么是what,要么是why,要么是how。于是呢,你去看啊,从这个角度去看,天下所有的教程,所有的好教程,从结构上来看,就这点东西的,就这么三个词,就这么三个要素,就这么三个类别。
最后呢,这三个要素各有各的焦点。然后呢,到最后,针对这三种问题的答案,要求都一样的,要求都一样的,都是什么呢?六个字:清晰、准确、必要。六个字:清晰、准确、必要。what就得清晰、准确、必要,无论是定义还是分类,还是比较。why就得严谨,因果关系就得清晰、准确、必要。how就得步骤完整,每个步骤都必须清晰、准确、必要,确保可行。
所以呢,好的教程第一要素,就是从结构上来看,每个要素都要做到清晰、准确、必要。实际上翻来覆去就这么三个要素嘛,然后呢,都要清晰、准确、必要。把措辞哈,就是统一一下,就是教程的核心,就是问题和答案,当然也可以被称之为方案,对吧?就是问题和答案。
那写出来的教程的结构呢,既然骨子里是问题和答案,那么写出来结构自然就是这么相应两个部分嘛。第一部分是问题的陈述,第二部分整个是答案的论述。这里的第一部分呢,就很简单,就是要把问题描述清楚嘛。那你去写这个描述的时候,要求是什么呢?其实很简单嘛,就这么八个字,叫“重点突出,简洁明亮”。“重点突出,简洁明亮”,就是第一部分你需要做到的事情。
第二部分呢,其实是还可以拆分的,对啊,就是第二部分答案是可以被拆分的,对啊。那比如说,你可以拆分成这么三个:第一个呢叫“前提”,第二个呢叫“阐述”,第三个呢叫“总结”。这个“前提”呢指的是什么呢?就是这个细心的作者呀,它会分辨读者当前状况,哪些是这些读者已经知道的,哪些是他们需要进一步学习的,为了完成整个对答案的理解,他们都需要哪些前提条件呢?
通常情况下,零基础就可以开始做的事情是很少的,就算有,也不大可能有太多的实际意义。所以呢,如果有必要的话,就得有一个简单的前提条件告知与罗列,就是你在想看懂这篇文章、看懂这个教程,然后呢,能够成功实践这个教程,你都需要哪些基础知识,这个叫“前提”。
“阐述”部分当然是整个教程的核心了,对吧?最重要,但其实呢,也最为朴素。这个阐述部分是干什么呢?它就是大白话摆事实、讲道理,或者陈述清楚步骤,对吧?那语言的要求呢,那当然要是通俗易懂,但是要逻辑严谨,论证要清晰,举例要做到准确的同时,还要做到说有趣啊,步骤呢要讲解的足够完善、细致、无误,对啊。
好的习惯是,运用语言的时候要形成并遵守一定的规范。而后呢,就是“总结”。那阐述的部分呢,可能是把一句话展开啊,变成一篇文章。而总结的部分呢,是把之前所有内容,尽量少的几句话就解释清楚啊,就是让读者阅读过后,可以迅速回顾、整理啊,在大脑当中回忆这些内容。
于是呢,到最后啊,一个比较完整的教程模板,大概长成这个样子:上来呢,那是第一部分,就是阐述问题。然后呢,给出答案,这里面呢有啊,关于这个答案的“前提”,以及关于这个答案的“阐述”。最后呢,给出一个“总结”,对吧?然后呢,还可以添加一个“附录”,对吧?如果必要的话。
最后这个添加的附录呢,其中有一个叫“进一步之一”,即在之前那些前提矫正基础之下,把当前的知识消化之后,进一步可以学习什么,进一步可以干什么,下一步可以干什么,What's next,还有哪些文章可以进一步阅读、进一步学习。还有一个可能出现的就是什么呢啊,“参考条目”,就好像是非虚构书籍末尾的参考文献那样,把重要的参考资料出处或者是链接罗列出来,以便将来需要的时候可以直接访问,而不是到时候再重新搜索一次,这对读者和作者都是同样方便的事情。
而后呢,也许还应该有一个“更新历史”。其实因为很多的时候啊,这个教程呢,必须与时俱进。那有些步骤呢,是需要优化的了,有些理由呢,是需要补充的了,有些概念呢,可能需要重新定义了,等等等等等等。于是呢,要在更新历史当中罗列重要的更新,关键太过细琐的,比如说错别字修改什么,就没必要罗列了。
那很多的时候呢,嗯,大家要知道的,这个教程是需要维护的,如果是做不到及时更新,它就会失效的,那就意味着说之前的工作浪费了。所以写好教程啊,它从来都不是一次性的工作,它是需要长期持续维护、实时更新,也是教程创作者的分内工作。
最后呢,如果一个教程是写给大众看的,而不仅仅是写给自己或者家属,那么就应该对各自的、来自各个角度的疑问进行回应。于是呢,可能还有一个叫“常见问答集”,FAQ,Frequently asked questions。那这是最锻炼作者啊周全能力的,也是教程作者啊,能够最能够体验到积累效用的地方,是吧?就是到最后,你日积月累,你可以回答所有的问题,无论那个角度有多么刁钻。
在了解以上基本结构之后呢,我们需要限定一下语言的使用。就是首先呢,大家明白,教程呢是知识的传递,传递的对象决定了说,因为传递对象是知识嘛,我们应该使用的,不是毫无规矩的、毫无约束的自然语言,而是毫无歧义的人工语言。这一点非常非常的关键。
这里面的“毫无歧义”是最基础的要求,你知道吗?就是说,英文世界里有维基百科,那中文世界里最懂中文的百度,总是号称自己最懂中文的百度,有个百度百科。你知道他们的关键区别在哪里吗?关键区别在于说,百度百科其实是没有语言规范的,而维基百科不仅有,还很完善。你别看这一点点的差异,最终造成的那就是天壤之别嘛。
举例来说,在陈述时间的时候,在维基百科上是不可以使用相对时间词汇的,因为相对时间词汇将不可避免的造成歧义。比如说,你在维基百科里写的竟然是“最近”或者“去年”怎么怎么样,那这时候,明天人家来看文章,说你今天发文章,我今天看,那我知道“最近”是什么时候,我也能弄清楚,因为你昨天发文章,我今天来看,今天是2023年,所以你说“去年”,我知道那是2022年。可是随着时间流逝,很久之后我才看到你的文字,那我怎么知道你说的“最近”是什么时候?我怎么知道你说的“去年”是哪一年?这一点点的差别,就维基是有这样的语言规范的,不能使用相对时间。你到百度上去看,遍地都是“最近”,遍地都是“最近十年”、“去年”,那就没法看了。
另外一个就是,一定要使用正常、正确的词汇,而不是使用时髦的说法。其实也是基于同样道理的。举个例子,那你就要写“举个例子”,你非要写成“举个栗子”,就朝板栗的“栗”,对吧?“可怕”你非要写成“阔怕”,对啊,“这样子”你非要写成“酱紫”,等等等等。平日你说话这么说着玩,有没问题的,那写教程,这就是坏习惯,白痴行为。这种当下看起来时髦的语言,它是没有生命力的,过段时间就被弃用了,于是你整个教程会因此变成了就是特别别扭的破玩意儿。
这一点呢,就是说,大家有空的时候可以去翻一翻、往上搜一搜“出版社编辑指南”。出版社编辑指南,任何一个出版社都有个简单的编辑指南的,应该认真去看吧,遵守一下语言规范。到最后呢,就是连文字排版都应该养成好习惯。比如说,为了教程在网上有一个好的呈现,中英文混排的时候,汉字与数字之间、汉字与英文字母之间,都应该加一个空格的。左引号和之前的字符之间、右引号和之后的字符之间,应该加个空格的。由于全角字符的视觉特殊效果,破折号和引号之间也应该有空格的,但破折号和书名号之间就不需要有空格了。就是光一个空格,都需要研究很久。
当然,刚开始的时候会觉得麻烦,虽然如此,但是一旦你养成了习惯,也就没有麻烦了,它只不过是好习惯而已,对吧?再次重申一点,所有经常写教程的人都体验过的,就是你自己写出来的教程,更多的时候,其实主要是自己向未来的自己传递信息。就写作的核心意义,这是自己向自己的、未来的自己传递信息,只是我反复说很多遍,都很都不过分的,对吧?在好多课里我也都讲过这个。
那个复杂的知识与技能,总是需要不断访问的。于是呢,很久之后,早就忘了,一件事应该如何做,关键细节是什么。但是呢,还好,我记得我自己写过这件事的教程呢。于是呢,你就可以翻出来看,干净利用,按部就班,就把事情做好之后,那心情舒畅。于是呢,哪怕是只为了对得起未来的自己,也要做到很多细节上的完善。而那些从来不写教程的人,永远都不会知道这种细致带来的好处。好,我们下期课再见。