通用素质——技术写作原理 | 学习笔记 241107

70 阅读1分钟

学习时间:22:00-22:35 共计0.5H

最大的收获是避免写作时口语化、写作前注意明确文档的受众和需求,避免自嗨式写作、要减少读者的阅读成本,缩小作者和读者之间的信息差。

  1. 关键:明确阅读受众、明确读者目的、明确读者所需信息

  2. 信息差:作者和读者的认知差异

  3. 术语用词:注意使用统一性

  4. 新事物:需要充分解释其来源

  5. 如何了解读者?

  • 邀请同事评审
  • 读者访谈
  • 文档支持群
  • 换位思考法:把自己想象成读者,想象整个操作流程
  1. 结构化写作:减少读者阅读成本
  • 搭建框架在细节,先整体再局部。
  • 总分结构——分类逻辑递进
  1. 如何写好标题:概括核心 SPA:简明扼要、利益相关、准确客观

  2. 极简写作:减少阅读成本,以最优的方式达成目标路径。

  • why? 节省时间、易于理解、减少成本
  • 极简原则:保持一致、避免啰嗦、提供路标和索引
  • 先将目的,再讲怎么做
  1. 检查文档:先冷却一段时间后自查
  • 检查范围:主题、结构、标题、内容