这是我参与「第五届青训营 」伴学笔记创作活动的第 11 天
这篇学习笔记是我在观看学习字节内部课关于通用素质 - 技术写作原理课程的一些简单学习总结
技术写作原理
文档写作流程拆分
- 写作前
- 了解读者
- 写作中
- 结构化写作
- 写好标题
- 极简写作
- 写作后
- 检查文档
了解读者
目的：了解目标读者实际的需求，定位写作的目标，避免“自嗨式”写作
保证文件可用性：
- 理解文档
- 完成任务
如何了解读者？
- 明确读者身份：小白用户/资深用户/运维人员/开发人员
- 明确读者阅读目的：了解一个概念，完成一个步骤，还是查阅一个参数的解释
- 明确读者所需信息：根据读者的认知能力提供所需信息
知识点： 信息差(狭义解释) 作者和读者之间的认知差异
知识诅咒(The Curse of Knowledge)，指一旦我们自己知道某样东西，我们就会发现很难想象不知道它的时候会是什么样子。我们的知识“诅咒”了我们。对于我们自己来说，同别人分享我们的知识变得很困难，因为我们不易重造我们听众的心境。
常见的信息差来源
- 术语
- 解决方法：使用标准的术语/同一个意思尽量用一个词表达/提供术语解释
- 相似物
- 一个产品提供了两个相似的功能，文档需要帮助读者辨析，方便其作出选择
- 新事物
- 所有新出现的食物都需要充分解释其来源
如何了解读者
- 主动走进读者
- 邀请他人评审
- 读者访谈
- 文档支持群
- 头脑风暴
- 读者从哪来
- 读者在哪里
- 读者到哪去
结构化写作
目的：学习谋篇布局，搭建清晰的文档框架，体现内容之间的联系
什么是结构化写作
- 理清信息之间的逻辑关系
- 把无序信息排列为有序的信息
- 创造逻辑且顺畅的信息流
- 有逻辑有条理地提炼和组织内容
我们为什么需要结构化的写作
- 为作者理清写作思路：
- 帮助作者在清晰分类的基础上全面考虑问题，找到写作的方向和重点
- 为读者降低阅读成本：
- 帮助读者快速锁定目标信息，获取重点信息和核心观点
搭建文档框架
核心原则：结论先行，以上统下，分类归组，逻辑递进
结构化写作三步走
- 搭建文档框架
- 填充必要信息
- 巧用结构化呈现
使用相关技巧将文档进行合理的结构化呈现
- 无序列表：没有特定顺序的列表，各个列表项之间属于并列关系
- 有序列表：强调排列顺序的列表，各个列表项之间属于前后关系
- 表格：一种可视化交流模式，也是一种组织整理内容的手段，主要用来罗列和对比信息
本次分享就先整理这些，下次将后续内容进行整理，再给出相关的总结
