大部分流程文档只写正常路径。实际维护时最需要的是异常处理。

我加的三节:

  1. 常见失败:列出见过的失败情况和处理方式
  2. 排查入口:出问题先看哪里(日志路径、监控面板、状态表)
  3. 联系人:这个流程依赖谁的系统

第 2 节最实用。半年后接手的人,最想知道的就是「坏了先看哪」。

写文档的成本主要在回忆异常,但价值也在这里。

主楼