这是我参与「第五届青训营 」笔记创作活动的第17天。
一、主要内容
- 了解读者
- 结构化写作
- 写好标题
- 检查文档
二、详细内容介绍
了解读者
Why
保证文档可用性：读者能理解文档，完成任务。
What
- 明确读者身份：小白用户/资深用户？运维人员/开发人员？
- 明确读者阅读目的：了解一个概念、完成一个步骤，还是查阅一个参数解释？
- 明确读者所需信息：根据读者的认知能力提供所需信息。
How
- 主动走近读者：邀请同事评审、读者访谈、建立文档支持群……
- 头脑风暴：读者从哪里来，读者在哪里，读者到哪里去……
结构化写作
搭建清晰的文档框架，体现内容之间的联系。
What
- 理清信息之间的逻辑关系
- 把无序信息排列为有序信息
- 创造逻辑且顺畅的信息流
- 有逻辑有条理地提炼和组织内容
Why
- 为作者理清写作思路：帮助作者在清晰分类的基础上全面考虑问题，找到写作的方向和重点。
- 为读者降低阅读成本：帮助读者快速锁定目标信息，获取重点信息和核心观点。
How
- 搭建文档框架 论（结论先行）开门见山，把核心观点或中心思想放在文章开头的位置，让读者一目了然。 证（以上统下）上层结论是概况总结，然后通过下层信息进行具体解释和说明。 类（归类分组）把相关联的信息按照一定的标准进行划分归类，归为同一个逻辑范畴。 比（逻辑推进）按逻辑顺序递进排列素材。
- 填充必要信息
- 巧用结构化呈现：无序列表、有序列表、表格
写好标题
巧用SPA原则，在文本有一个框架之后再根据核心起标题。
Why
可提升浏览量，更容易被引用。
帮助读者快速了解文档的主要内容。
How
S:Simple简明扼要
P:Profit利益相关
A:Accurate准确客观
参考标题模板
概念性：名词+名词，（《A原理》）
任务型：名词+动词或动词+名词（《A工具的安装》）
参考型：名词+名词（《机器配置的要求》）
检查文档
先冷却，后自查。
检查内容:
主题是否明确且聚焦，符合目标读者的需求？内容是否过于发散，是否跑题？
结构是否遵照一定逻辑顺序？是否符合结构化写作原则：结论先行、以上统下、归类分组、逻辑递进？
标题是否符合SPA原则？
内容的文字表述是否简单清晰，不拖泥带水？
三、个人总结
写文章不能只是自说自话，还需要对目标读者以及写作技巧进行一定的分析，让文章发挥更好的效果。
