编写有用的文档

主要观点:文档对软件开发至关重要,应从读者视角出发,考虑其需求、知识等,遵循叙事结构,注重可访问性,包括避免依赖颜色传达信息等方面。技术写作方面要注意术语统一、写作风格简洁明了、图表运用恰当(保持抽象水平一致等)、结构以产品为导向并利用元数据等,还应测试和自动化文档,如将文档作为代码、自动发布文档、谨慎生成文档等。
关键信息

  • 文档为回答读者问题而写,要了解受众,遵循叙事结构,如成功、失败等故事。
  • 可访问性意味着文档对所有人可用,考虑多种因素,保持写作文化中立。
  • 技术写作要注意术语简洁精准、写作风格回答“什么、为什么、怎么做”,图表运用要符合原则。
  • 结构上以产品为导向,利用元数据,采用视角驱动等方式。
  • 测试和自动化文档包括将文档作为代码、自动发布、谨慎生成等。
    重要细节
  • 不同角色的受众需求不同,如新入职开发者、不同团队的后端开发者等。
  • 避免使用缩写以免产生误解,采用主动语态等写作风格技巧。
  • C4 模型的抽象层次及图表运用原则。
  • 产品文档要有长期视角,注重协作和可重用性。
  • 利用 ADR 等方式记录架构决策。
  • 文档应在与代码相同环境中创建更新,可自动发布部分文档等。
阅读 15
0 条评论