name: systematic-debugging description: 在遇到任何bug、测试失败或意外行为时，先进行调查再提出修复

系统化调试

概述

随机修复浪费时间并产生新bug。快速补丁掩盖了根本问题。

核心原则： 在尝试修复之前，始终找到根本原因。症状修复是失败的。

违反此流程的字面意义就是违反调试的精神。

铁律

在没有完成第一阶段调查之前，不得提出修复

如果你没有完成阶段1，就不能提出修复。

何时使用

用于任何技术问题：

测试失败
生产中的bug
意外行为
性能问题
构建失败
集成问题

特别在以下情况下使用：

时间紧迫时（紧急情况让人想猜测）
“就一个快速修复”看起来很明确时
你已经尝试了多个修复时
之前的修复无效时
你没有完全理解问题时

不要跳过，当：

问题似乎简单时（简单的bug也有根本原因）
你赶时间时（匆忙保证需要返工）
经理希望立即修复时（系统化比乱试更快）

四个阶段

你必须完成每个阶段才能进入下一个。

阶段1：根本原因调查

在尝试任何修复之前：

仔细阅读错误消息
- 不要跳过错误或警告
- 它们通常包含确切的解决方案
- 完全阅读堆栈跟踪
- 注意行号、文件路径、错误代码
一致性重现
- 你能可靠地触发它吗？
- 确切的步骤是什么？
- 每次都会发生吗？
- 如果不可重现 → 收集更多数据，不要猜测
检查近期更改
- 什么变化可能导致这个？
- Git diff，最近提交
- 新依赖项，配置更改
- 环境差异

在多组件系统中收集证据

当系统有多个组件时（CI → 构建 → 签名，API → 服务 → 数据库）：

在提出修复之前，添加诊断工具：

对于每个组件边界：
  - 记录进入组件的数据
  - 记录退出组件的数据
  - 验证环境/配置传播
  - 检查每层的状态

运行一次以收集证据，显示在哪个环节失败
然后分析证据以识别失败组件
然后调查该特定组件

示例（多层系统）：

# 层1：工作流
echo "=== 工作流中可用的密钥： ==="
echo "IDENTITY: ${IDENTITY:+设置}${IDENTITY:-未设置}"

# 层2：构建脚本
echo "=== 构建脚本中的环境变量： ==="
env | grep IDENTITY || echo "IDENTITY 不在环境中"

# 层3：签名脚本
echo "=== 钥匙串状态： ==="
security list-keychains
security find-identity -v

# 层4：实际签名
codesign --sign "$IDENTITY" --verbose=4 "$APP"

这揭示了： 哪个层失败（密钥 → 工作流 ✓，工作流 → 构建 ✗）

跟踪数据流

当错误深藏在调用堆栈中时：

查看此目录中的 root-cause-tracing.md 了解完整的向后跟踪技术。

快速版本：
- 坏值从哪里起源？
- 什么用坏值调用了这个？
- 一直向上追踪直到找到源头
- 在源头修复，不在症状处修复

阶段2：模式分析

在修复之前找到模式：

找到工作示例
- 定位相同代码库中的类似工作代码
- 什么类似的东西是工作的？
与参考比较
- 如果实现模式，完整阅读参考实现
- 不要略读——阅读每一行
- 完全理解模式后再应用
识别差异
- 工作和损坏之间有什么不同？
- 列出每个差异，无论多小
- 不要假设“那无关紧要”
理解依赖项
- 这需要什么其他组件？
- 什么设置、配置、环境？
- 它做什么假设？

阶段3：假设和测试

科学方法：

形成单一假设
- 清晰地陈述：“我认为X是根本原因，因为Y”
- 写下来
- 具体，不模糊
最小化测试
- 做最小的可能更改来测试假设
- 一次一个变量
- 不要一次修复多个东西
在继续之前验证
- 它有效吗？是 → 阶段4
- 没效？形成新假设
- 不要在上面添加更多修复
当你不知道时
- 说“我不理解X”
- 不要假装知道
- 寻求帮助
- 研究更多

阶段4：实施

修复根本原因，不是症状：

创建失败测试用例
- 最简单的可能重现
- 如果可能，自动化测试
- 如果没有框架，一次性测试脚本
- 必须在修复之前有
- 使用 superpowers:test-driven-development 技能编写正确的失败测试
实施单一修复
- 解决识别的根本原因
- 一次一个更改
- 没有“既然我在这里”的改进
- 没有捆绑重构
验证修复
- 测试现在通过了吗？
- 没有其他测试被破坏？
- 问题实际解决了吗？
如果修复无效
- 停止
- 计数：你尝试了多少修复？
- 如果 < 3：返回阶段1，用新信息重新分析
- 如果 ≥ 3：停止并质疑架构（见步骤5）
- 在没有架构讨论之前，不要尝试第4个修复
如果3+个修复失败：质疑架构

指示架构问题的模式：
- 每个修复都揭示了新的共享状态/耦合/不同地方的问题
- 修复需要“大规模重构”来实现
- 每个修复在其他地方产生新症状
停止并质疑基本原则：
- 这个模式根本上是合理的吗？
- 我们是否“仅仅因为惯性而坚持它”？
- 我们应该重构架构还是继续修复症状？
在尝试更多修复之前与你的人类伙伴讨论

这不是一个失败的假设——这是一个错误的架构。

红旗 - 停止并遵循流程

如果你发现自己想：

“现在快速修复，稍后调查”
“就试试改X看是否有效”
“添加多个更改，运行测试”
“跳过测试，我手动验证”
“可能是X，让我修复它”
“我不完全理解但这可能有效”
“模式说X但我会不同地适应它”
“这里是主要问题：[不调查就列出修复]”
在跟踪数据流之前提出解决方案
“再尝试一个修复”（当已经尝试2+个时）
每个修复都揭示了不同地方的新问题

所有这些都意味着：停止。返回阶段1。

如果3+个修复失败： 质疑架构（见阶段4.5）

你的人类伙伴的信号，你做错了

注意这些重定向：

“那不是正在发生吗？” - 你没有验证就假设了
“它会显示我们…吗？” - 你应该添加了证据收集
“停止猜测” - 你在不理解的情况下提出修复
“Ultrathink这个” - 质疑基本原则，不仅仅是症状
“我们卡住了？”（沮丧） - 你的方法不起作用

当你看到这些时： 停止。返回阶段1。

常见合理化

借口	现实
“问题简单，不需要流程”	简单问题也有根本原因。流程对简单bug很快。
“紧急，没时间做流程”	系统化调试比猜试乱试更快。
“先试试这个，再调查”	第一个修复设定了模式。从一开始就做对。
“确认修复有效后再写测试”	未测试的修复不持久。先测试证明它。
“一次多个修复节省时间”	无法隔离什么有效了。导致新bug。
“参考太长，我会适应模式”	部分理解保证bug。完全阅读它。
“我看到问题了，让我修复它”	看到症状 ≠ 理解根本原因。
“再尝试一个修复”（在2+次失败后）	3+次失败 = 架构问题。质疑模式，不要再修复。

快速参考

阶段	关键活动	成功标准
1. 根本原因	阅读错误、重现、检查更改、收集证据	理解什么和为什么
2. 模式	找到工作示例、比较	识别差异
3. 假设	形成理论、最小化测试	确认或新假设
4. 实施	创建测试、修复、验证	bug解决、测试通过

当流程揭示“没有根本原因”时

如果系统化调查揭示问题真正是环境性的、时间依赖的或外部的：

你已经完成了流程
记录你调查了什么
实施适当处理（重试、超时、错误消息）
添加监控/日志用于未来调查

但是： 95%的“没有根本原因”案例是不完整调查。

支持技术

这些技术是系统化调试的一部分，在此目录中可用：

root-cause-tracing.md - 通过调用堆栈向后跟踪bug以找到原始触发器
defense-in-depth.md - 在找到根本原因后，在多个层添加验证
condition-based-waiting.md - 用条件轮询替换任意超时

相关技能：

superpowers:test-driven-development - 用于创建失败测试用例（阶段4，步骤1）
superpowers:verification-before-completion - 验证修复有效后再声称成功

实际影响

从调试会话中：

系统化方法：15-30分钟修复
随机修复方法：2-3小时乱试
首次修复率：95% vs 40%
引入新bug：接近零 vs 常见