谷歌技术文档写作课程笔记 9 组织文档

Posted by Shiwei Shang on June 24, 2025

组织文档

组织文档一般要考虑以下几个方面:

  • 说明文档的范围,让读者知道文档是围绕什么来写的,能帮助读者解决哪些问题。
  • 说明文档的受众,自己受众应该具备的知识,好让读者判断这个文档是否适合自己。
  • 在文档的开头介绍所有的重点。人们阅读的时候,往往会仔细阅读最前面的内容,所以要在文档的开头交代所有重要的事情。
  • 分析受众角色和承担的任务,根据受众的知识水平和任务流程组织文档。