跳到主要内容

Bugfix / Refactor / Test Runbook

前置条件

  • 问题已经可复现,或者至少有明确行为差异。
  • 你知道本次允许改哪些文件。
  • 你能运行最小验证命令。

执行表

阶段要做什么产出
定界写问题、范围、禁区、验收。一段清晰任务说明。
定因让工具先解释根因。根因假设和确认点。
最小修改只做本轮必须的修复或测试补充。小 patch 或局部重构。
回归验证跑命令并记录结果。命令结果和剩余风险。

步骤

  1. 先写问题、范围、不要做什么、验收方式。
  2. 再要求工具解释根因,而不是直接改代码。
  3. 只做最小修复、小步重构或补测试。
  4. 跑验证并记录结果。
  5. 把根因、命令结果和剩余风险一起收口到 PR 或变更说明。

最适合搭配:

默认停点

  • 根因没说清,先停,不要继续写 patch。
  • 修改开始跨边界,先停,回到 Spec-First Runbook
  • 验证命令不稳定,先停,先修验证再修功能。

验证

至少留下三样东西:

  • 根因说明。
  • 真正执行过的命令结果。
  • 剩余风险说明。

交付检查

  • 这轮是不是仍然只做了最小改动。
  • 测试或回归步骤是不是覆盖了本轮修复。
  • reviewer 是否能理解本轮为什么到此为止。
  • 如果明天回头看,这份记录是否仍可复盘。

下一步

来源