工程师卓越之旅:技术文档怎么写

0.意义和价值

  • 当前信息共享
  • 长期技术知识传承
  • 加深作者的理解和思考
  • 交付包括代码和技术文档

1.准备阶段

  • 明确文档需求、受众和内容范围

2.调研阶段

  • 对比有代表性的同类或相似的技术文档,建立大致框架
  • 收集相关信息,分析验证进行技术决策
  • 在文档中将每个方案的成本、收益、风险罗列清晰,方便回顾时明白决策者的意图

3.构建阶段

  • 标准化模板来建设
  • 金字塔结构:
    • 纵向结论先行、以上统下
    • 横向归类分组、逻辑递进
      工程师卓越之旅:技术文档怎么写_第1张图片

4.文档写作

  • 规范语法、得体措辞、正确语言表达(不用语气词,用主谓来表达做了什么事情)
  • 高度专注,编写过程及时修正,降低后期反复迭代的时间和成本
  • 不缺失、不冗余
  • 用户友好

5.审阅修改

工程师卓越之旅:技术文档怎么写_第2张图片

6.详细技术方案文档

工程师卓越之旅:技术文档怎么写_第3张图片

  • 不同类别的技术文档使用不同的模板
  • 模板需要与时俱进

7.重要思维过程

  • 结构化思维
  • 定义问题、拆解问题、整理问题、重塑问题
  • 维护好团队文档索引页面,方便后续检索

你可能感兴趣的:(工程师卓越之旅,技术文档)