《如何写作通用教程》将通用写作拆解成五个部分,总结了在写作前 、写作中 和写作后三个阶段需要注意的写作要点和技巧,通读整个系列文档,可以帮助你搭建系统的技术写作知识体系。
第一章:何为结构化写作?
任何事物都有其结构,文档也不例外。结构是指事物各个组成元素之间的排列,文档中的结构便是指文档中各个信息块的排列。而结构化写作是指作者在输出内容的过程中,有意识地理清信息之间的逻辑关系,把无序的信息排列为有序的信息,让文档拥有一个有逻辑且顺畅的信息流。
大部分时候,写作人并不是缺少写作信息,而是不知道如何将大量的信息有效地组织起来,而结构化写作能有效地帮你有逻辑有条理地提炼和组织信息,做到"先框架后细节,先整体再局部"。
第二章:为何结构化写作?
学习结构化写作的目的是掌握一种思维方式,来辅佐我们更好地表达内容。那么我们为什么要结构化写作呢?一言蔽之,有利于双方清晰思考。
- 帮作者理清写作思路:找出信息之间的关联并有逻辑地呈现,可以帮助作者在清晰分类的基础上全面考虑问题,找到写作的方向和重点。
- 为读者降低阅读成本:简明扼要的信息呈现方式可以帮助读者快速锁定目标信息,在最短的时间看清行文结构,获取重点信息和核心观点。
第三章:结构化写作三步走
我们将结构化写作三个步骤,分别是搭建文档框架,填充必要信息,以及巧用结构化呈现。
1. 搭建文档框架
动手写文档之前,最重要的是要有一个内容大纲,即文档的框架。这个框架是文档各个部分相互搭配的方式,它所反映的是作者写作时候的思考路径。好的框架,能突出主题、亮明观点和分明主次;反之,则使得主题不明、观点不清以及主次不分。
那我们要如何搭建框架呢?答案是使用框架思维 。结构化写作地本质是一种框架思维,其所强调强调的框架思维 离不开下图中的四个核心原则,论、证、类、比。这四个原则可以从纵向 和横向两个维度去理解。
-
纵向关系: 包括结论先行 和以上统下两大原则。在纵向关系上层层延伸,可以让内容有深度,形成文档的主干。
-
结论先行
- 定义: 开门见山,把核心观点或中心思想放在文档开头的位置,让读者一目了然。
- 重要性:不同于通过制造悬念吸引读者的小说文体,实用文体写作目的是为了高效传递信息,结论先行可以让读者快速抓住文档核心观点。
-
以上统下
-
定义:上层结论是概括总结,然后通过下层信息进行具体解释和说明:
- 上层对下层的概括总结,并得出结论。
- 下层对上层的论证,并给出论据。
- 上下层之间形成严谨的对应关系,前后呼应。
-
重要性:有理有据,让内容更具有说服力和支撑力。
-
-
-
横向关系:同一层次之间的并列关系或者递推关系,横向全面梳理关系,拓宽内容广度,形成文档的脉络。
-
归类分组
- 定义:把相关联的信息按照一定的标准进行划分归类,归为同一个逻辑范畴。
- 重要性:分类的过程是探寻事物和问题本质的过程,让原本模糊混乱的信息变得有秩序,便于读者获取和记忆。
-
逻辑递进
- 定义:按逻辑顺序递进排列信息。
- 重要性:梳理信息之间的逻辑,可以反映出事物之间的内在联系和规律。
-
2. 填充必要信息
当文档拥有了一个基础框架后,我们就可以基于框架填充信息了。信息的收集在数量上要完整全面,在质量上要深入有层次。信息的来源可以是
- 阅读相关文档
- 使用产品
- 访问专家
- ......
3. 巧用结构化呈现
在使用结构化思维为文档搭建了大的框架并填充信息后,我们便可以采用结构化信息呈现方式来呈现文档的内容,常用的方法包括:
- 无序列表:没有特定顺序的列表,各个列表项之间属于并列关系。
- 有序列表:强调排列顺序的列表,各个列表项之间属于先后关系。
- 表格:一种可视化交流模式,也是一种组织整理内容的手段,主要用来罗列和对比信息。
第四章:小结
本次课程介绍了结构化写作的含义和好处,同时还详细地介绍了结构化写作的三个步骤,即搭建文档框架,填充必要信息,以及巧用结构化呈现。其中理清逻辑关系是结构化写作中最重要的一环,这一环是基于结构化思维的四个核心原则:结论先行、以上统下、归类分组和逻辑递进。此外,我们还了解了三种常用的结构化呈现方式,即有序列表、无序列表和表格,善用这三种结构化呈现方式,能让你的文档变得更整洁有序。
结构化写作是一种强调整体性、以简驭繁的写作方法,它的力量在于有序地传递信息。 想要自如地在生活中运用结构化写作,提升自我表达的效率,小到发一条飞书信息,大到写一篇技术文档,不断实践依旧是不二法门。