学习笔记:技术写作原理(二)结构化写作|青训营;

117 阅读1分钟

话不多说,书接上回,这次来谈谈结构化写作。

结构化写作

什么是结构化写作?

  1. 理清信息之间的逻辑关系
  2. 把无序信息变成有序信息
  3. 创造逻辑且顺畅的信息流
  4. 有逻辑、条理地提炼、组织内容

最重要的只有一个词:“逻辑” 它可以:

  1. 为作者理清写作思路
  2. 为读者降低阅读成本

如何结构化写作

  1. 搭建文档框架
  2. 填充必要信息
  3. 用结构化思路呈现

搭建文档框架

  1. 结论先行
  2. 以上统下
  3. 归类分组
  4. 逻辑递进

其中关系如图所示:

erDiagram
centerOpinion ||--o{ opinion1 : split
opinion1 ||--|{ evidenceOfGroup1 : contains
centerOpinion }|..|{ opinion2 : spilt

在图中我们可以发现存在两个方向,一个是纵向的结论在前,一个是横向的分组归类和逻辑递进。就像是议论文写作,先给出自己的观点,之后再进行论证,层层递进。比如,将观点或者操作目的放置在前,可以起到类似目录的作用,降低读者的阅读时间和阅读成本,目的是一个小知识点的读者不用阅读整篇文章。 如此行文才是一个好的文档框架。

填充必要信息

在填充必要信息时,需要具体问题具体分析,将信息用大括号塞到途中,每一个想要让读者知道的知识点都要覆盖到,这样才能让文档达到想要的效果。

用结构化呈现

可以用我的笔记作为参考,使用了有序、无序列表和表格,再加上巧用标题和分级,这样一来就可以使文章看着更具有逻辑性。

(未完待续)