每份文档必须包含:

  1. 一句话说明这份文档解决什么问题
  2. 适用场景和不适用的场景
  3. 步骤(编号,每步一个动作)
  4. 常见错误(至少三条)
  5. 更新日期和适用版本

第 4 条是关键。文档的价值往往在错误排查,而不是主流程。

第 2 条也重要。写了「不适用」才知道什么时候别翻这份文档。

模板固定之后,产出质量稳定,也便于搜索。

主楼