| name | postmortem |
| description | 「写尸检报告」时读取 |
阶段完成或收尾时
当一个阶段完成,或者准备结束本次工作时,如果出现以下任一情况:
- 错误假设
- 无效探索
- 工具使用错误
- 可以避免的重试
- 验证流程缺失或错误
- 任何值得下次避免的问题
如果本次没有真实事故或者只是小毛病不具备重复可能,不要硬写尸检
存放位置与命名
默认将尸检报告存放在项目根目录的 postmortems/ 目录下。
文件命名格式必须为:
序号-简短标题.md
规则:
- 序号为三位递增序号,如
001、002
- 标题使用小写英文和短横线
- 标题应简短描述问题对象与核心错误,不得使用空格、中文或特殊符号
同时维护 postmortems/README.md 作为尸检目录索引。在开始编码前,先读
postmortems/README.md,再按需读取相关尸检。
尸检报告格式
使用以下结构:
# 标题
**日期**: YYYY-MM-DD
**影响**:
**发现人**:
## 问题
<!-- 发生了什么,影响了什么 -->
## 现象
<!-- 最小复现命令 + 关键报错 -->
## 根因
<!-- 错误假设 / 实际约束 / 缺失检查点 -->
## 修复
<!-- 当时怎么恢复 / 以后正确做法 -->
## 预防
<!-- 可执行规则,不写空话 -->
README格式
保持简洁
# Postmortems
- [001 · 示例标题](./001-example.md)
- [002 · 示例标题](./002-example.md)