把工作文档写得让读者一看就懂、马上能照做

## 写作前，确定谁会读以及需要他们做什么 起草前，先确定： - 谁会使用这份文档； - 他们已经知道什么； - 他们需要了解什么或决定什么； - 他们需要采取什么行动；如果不需要行动，也应明确这一点；以及 - 哪些限制或风险可能影响他们使用这些信息。 面向目标读者中了解最少但仍需正确行动的人来写。如果多个受众的需求不同，应为他们设置不同的阅读路径，或清楚标明分别适用于各类受众的章节。 ## 先给出主要答案，再按读者提问的顺序排列 将目的和最重要的信息放在靠近开头的位置。其余内容按照读者可能提出问题的顺序排列，而不是按照作者发现信息的顺序排列。 适用时，采用以下顺序： 1. 说明文档为什么重要。 2. 给出决定、要求或主要答案。 3. 解释读者必须知道或必须做什么。 4. 补充支持性细节、例外和参考资料。 纳入信息的理由应是它能帮助读者理解或行动。只有少数读者需要的背景材料应移到后面有清晰标签的章节。 ## 用能预示内容的标题把长文分成短节 将较长的内容划分为短小且重点明确的章节。为每个章节设置一个能够预示内容或回答读者可能提出的问题的标题。 除非文档确实需要更深的层级，否则标题层级不超过三个。并列章节应采用平行的表述和相近的详细程度。标题不应承诺本节没有提供的内容。 当读者在阅读细节前需要背景时，用一句简短的引导语开始内容密集的章节。 ## 写明每个行动由谁负责 优先使用直接点明责任主体和行动的句子。 - 当责任归属很重要时，使用主动语态。 - 当行动者未知、不重要或有意作为次要信息时，使用被动语态。 - 让行动者与行动在句中保持接近。 - 将条件放在其限制的指令之前或紧邻该指令的位置。 不要用被动表达掩盖尚未明确的责任人。如果责任由多方共同承担，应列出相关角色并区分各自的行动。 ## 使用熟悉的词语，同一事物始终用同一说法 使用最简单且准确的词。优先选择熟悉的表达，而不是术语、夸大的短语或未作说明的缩写。 当技术术语对准确性必不可少，或读者需要在其他地方识别该术语时，应予以保留。首次使用时给出定义，之后始终使用同一术语。如果更换近义词可能暗示不同含义，就不要交替使用这些近义词。 将过长的名词组合拆成能够显示概念之间关系的短语。 ## 清楚区分哪些是必须做的，哪些只是建议 将行动表达为动词，不要把它们隐藏在抽象名词中。当直接的动词表达和现在时能够准确描述规则、流程或当前状态时，优先使用它们。 谨慎选择表达义务程度的词： - 用 **must** 表示要求； - 用 **may** 表示许可； - 用 **should** 表示建议；以及 - 用 **will** 表示预测或承诺的未来行动。 当读者需要知道某项行动是必需、可选、建议还是预期时，不要依赖含义模糊的情态词。 ## 去掉重复的词语，一句话只讲一个意思 删除重复某个观点、增加形式感却没有增添含义，或只是陈述读者已经能够推断内容的词语。两个词含义几乎相同时，优先使用一个准确的词，而不是成对使用。 让每个句子集中表达一个主要观点。当条件、例外和行动争夺读者注意力时，应拆分句子。将修饰语放在被修饰词旁边，并让每个条件靠近它所控制的结果。 当肯定表达比否定结构更清楚时，使用肯定表达。如果否定形式能更准确地表达规则或防止危险的误解，则保留否定形式。 ## 用列表和表格让文档便于快速阅读 使用视觉结构揭示含义： - 无固定顺序的项目使用项目符号； - 有顺序的步骤或排名项目使用编号； - 重复比较使用表格； - 使用留白分隔观点；以及 - 只对真正重要的区别进行适度强调。 保持字体、间距、标签和对齐方式一致。避免使用会与信息本身争夺注意力的装饰。选择一种在复制、调整大小、打印或窄屏查看时仍然容易理解的版式。 当旧有格式妨碍读者查找或使用信息时，应更改该格式，除非有具约束力的要求禁止更改。 ## 交付前站在读者角度重读，并核对名称和数字 交付前，假设自己不是作者，从头阅读一次文档。确认目标读者能够： 1. 快速识别目的； 2. 找到相关章节； 3. 理解所需的行动或决定； 4. 区分规则、建议和示例；以及 5. 识别条件、例外、责任人和期限。 然后检查姓名、数字、链接、标签、主题行和格式是否准确且一致。删除任何会引出本应由文档回答的问题的句子。