核心问题

为什么很多工程文档写了也没人看?

真实场景

团队有一堆文档:接口说明、部署说明、技术方案、会议纪要。可是每次出问题,大家还是去问老同事。

文档存在,但没有成为系统记忆。

常见误区

坏判断是:

文档越长越完整,越有价值。

文档真正的价值不是多,而是在关键时刻能回答关键问题。

工程视角

没人看的工程文档通常有这些问题:

  • 只描述结果,不描述原因。
  • 太长,找不到重点。
  • 过期后没人维护。
  • 没有和代码、PR、事故关联。
  • 写给作者自己,不写给未来读者。

PM 可以怎么做

PM 擅长结构化表达,可以帮助团队把文档写成决策工具:

  • 背景是什么?
  • 选择有哪些?
  • 为什么选这个?
  • 放弃了什么?
  • 未来什么时候需要重新评估?

Atlas Action

下次写工程文档时,先把标题改成一个问题:

为什么我们选择 Kafka 处理点击流?

而不是:

Kafka 接入方案

小结

工程文档不是知识仓库,而是未来决策的导航。

PM 要写的是能被未来使用的文档。