systematic-debugging

系统化调试

概述

随机修复会浪费时间，还会引入新 Bug。快速打补丁会掩盖根本问题。

核心原则： 尝试修复之前，务必找到根本原因。只修复症状等于失败。

违反流程的字面要求，就是违背调试的本意。

铁律

NO FIXES WITHOUT ROOT CAUSE INVESTIGATION FIRST

如果尚未完成阶段 1，就不能提出修复方案。

适用场景

任何技术问题都适用：

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

尤其适用于以下情况：

• 时间紧迫（紧急情况容易让人想要猜测）
• “只需快速修一下”看起来显而易见
• 已经尝试过多种修复方法
• 之前的修复无效
• 尚未完全理解问题

以下情况也不要跳过：

• 问题看起来很简单（简单 Bug 也有根本原因）
• 赶时间（匆忙行事必然导致返工）
• 经理要求立即修好（系统化处理比反复试错更快）

四个阶段

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

阶段 1：调查根本原因

尝试任何修复之前：

1. 仔细阅读错误消息

   • 不要跳过错误或警告
   • 其中通常包含确切的解决方案
   • 完整阅读堆栈跟踪
   • 记下行号、文件路径和错误代码

2. 稳定复现问题

   • 能否可靠地触发问题？
   • 具体步骤是什么？
   • 是否每次都会发生？
   • 如果无法复现 → 收集更多数据，不要猜测

3. 检查近期变更

   • 哪些变更可能导致了这个问题？
   • Git 差异、近期提交
   • 新增依赖项、配置变更
   • 环境差异

4. 在多组件系统中收集证据

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

   提出修复方案之前，先添加诊断检测代码：

   For EACH component boundary:
     - Log what data enters component
     - Log what data exits component
     - Verify environment/config propagation
     - Check state at each layer
   
   Run once to gather evidence showing WHERE it breaks
   THEN analyze evidence to identify failing component
   THEN investigate that specific component
   

   示例（多层系统）：

   # Layer 1: Workflow
   echo "=== Secrets available in workflow: ==="
   echo "IDENTITY: ${IDENTITY:+SET}${IDENTITY:-UNSET}"
   
   # Layer 2: Build script
   echo "=== Env vars in build script: ==="
   env | grep IDENTITY || echo "IDENTITY not in environment"
   
   # Layer 3: Signing script
   echo "=== Keychain state: ==="
   security list-keychains
   security find-identity -v
   
   # Layer 4: Actual signing
   codesign --sign "$IDENTITY" --verbose=4 "$APP"
   

   这可以揭示： 哪一层出现故障（机密信息 → 工作流 ✓，工作流 → 构建 ✗）

5. 追踪数据流

   当错误出现在调用栈深处时：

   必需的子技能： 使用 superpowers:root-cause-tracing 进行反向追踪

   简要步骤：

   • 错误值从哪里来？
   • 是什么将错误值传入了这里？
   • 继续向上追踪，直到找到源头
   • 在源头修复，而不是修复症状

阶段 2：模式分析

先找到规律，再进行修复：

1. 寻找可用示例

   • 在同一代码库中找到类似的可用代码
   • 与出问题的部分相似的代码中，有什么是正常工作的？

2. 对照参考实现

   • 如果要实现某种模式，请完整阅读参考实现
   • 不要略读——逐行阅读
   • 应用之前，充分理解该模式

3. 识别差异

   • 正常工作的部分与出问题的部分有何不同？
   • 列出所有差异，无论多么细微
   • 不要想当然地认为“那不重要”

4. 了解依赖项

   • 需要哪些其他组件？
   • 需要哪些设置、配置和环境？
   • 它依赖哪些假设？

阶段 3：提出假设并测试

采用科学方法：

1. 提出单一假设

   • 清楚地说明：“我认为 X 是根本原因，因为 Y”
   • 把它写下来
   • 具体，不要含糊

2. 尽量精简地测试

   • 做出尽可能小的变更来测试假设
   • 每次只改变一个变量
   • 不要一次修复多个问题

3. 确认后再继续

   • 是否有效？是 → 进入阶段 4
   • 无效？提出新的假设
   • 不要在此基础上叠加更多修复

4. 不知道时

   • 直接说“我不理解 X”
   • 不要假装知道
   • 寻求帮助
   • 进一步调查

阶段 4：实施

修复根本原因，而非表面症状：

1. 创建失败测试用例

   • 尽可能简单地复现问题
   • 如果可能，使用自动化测试
   • 如果没有测试框架，则使用一次性测试脚本
   • 修复前必须先创建测试
   • 必需的子技能： 使用 superpowers:test-driven-development 编写恰当的失败测试

2. 实施单一修复

   • 解决已确定的根本原因
   • 一次只做一项更改
   • 不要顺手做其他改进
   • 不要捆绑重构

3. 验证修复

   • 现在测试通过了吗？
   • 是否有其他测试失败？
   • 问题是否确实已解决？

4. 如果修复无效

   • 停止
   • 计数：你尝试了多少次修复？
   • 如果少于 3 次：返回阶段 1，根据新信息重新分析
   • 如果 ≥ 3 次：停止并质疑架构（见下方第 5 步）
   • 未进行架构讨论前，不要尝试第 4 次修复

5. 如果 3 次或更多修复均失败：质疑架构

   表明存在架构问题的模式：

   • 每次修复都会在不同位置暴露新的共享状态、耦合或问题
   • 实施修复需要“大规模重构”
   • 每次修复都会在其他地方引发新的症状

   停止并质疑根本问题：

   • 这种模式在根本上是否合理？
   • 我们是否只是“出于惯性而坚持下去”？
   • 是否应该重构架构，而不是继续修复表面症状？

   尝试更多修复前，先与你的人类伙伴讨论

   这不是假设失败，而是架构错误。

危险信号——停止并遵循流程

如果你发现自己在想：

• “先快速修复，之后再调查”
• “改一下 X，看看有没有用”
• “做几项更改，然后运行测试”
• “跳过测试，我手动验证”
• “问题可能是 X，我来修复”
• “我还没完全弄明白，但这样或许能行”
• “模式建议做 X，但我会用另一种方式调整”
• “主要问题如下：[未经调查就列出修复方案]”
• 还没追踪数据流就提出解决方案
• “再试一次修复”（已经尝试过 2 次或更多时）
• 每次修复都会在不同位置暴露新问题

以上任何一种情况都意味着：停止。返回阶段 1。

如果 3 次或更多修复均失败： 质疑架构（见阶段 4.5）

你的人类伙伴指出你做得不对时的信号

留意以下纠正：

• “这不是没发生吗？”——你未经验证就做了假设
• “这样能让我们看到……吗？”——你本应收集证据
• “别猜了”——你还没弄清楚就提出修复方案
• “深入思考”——应质疑根本问题，而不只是表面症状
• “我们卡住了吗？”（沮丧）——你的方法行不通

看到这些信号时： 停止。返回阶段 1。

常见自我开脱

借口	事实
“问题很简单，不需要流程”	简单问题也有根本原因。处理简单错误时，流程很快。
“情况紧急，没时间走流程”	系统化调试比猜测和反复试错更快。
“先试试这个，再调查”	第一次修复会为之后定下模式。从一开始就做好。
“确认修复有效后再写测试”	未经测试的修复难以持久。先写测试才能验证。
“一次修复多个问题能节省时间”	无法确定哪些更改有效，还会引入新错误。
“参考资料太长，我会自行调整模式”	理解不完整必然导致错误。请完整阅读。
“我看出问题了，我来修复”	看到症状 ≠ 理解根本原因。
“再试一次修复”（失败 2 次或更多后）	失败 3 次或更多意味着存在架构问题。应质疑模式，不要再次修复。

快速参考

阶段	关键活动	成功标准
1. 根本原因	阅读错误信息、复现问题、检查更改、收集证据	理解是什么问题及其原因
2. 模式	查找有效示例并进行比较	找出差异
3. 假设	提出理论，进行最小化测试	得到证实或形成新假设
4. 实施	创建测试、修复、验证	错误已解决，测试通过

当排查发现“没有根因”时

如果系统性调查发现问题确实由环境、时序或外部因素导致：

1. 你已完成排查流程
2. 记录你调查了哪些内容
3. 实施适当的处理措施（重试、超时、错误消息）
4. 添加监控/日志，便于日后调查

**但是：**95% 的“没有根因”案例，都是调查不彻底。

与其他技能集成

此技能需要使用：

• root-cause-tracing - 当错误位于调用栈深处时必须使用（见阶段 1，第 5 步）
• test-driven-development - 创建失败测试用例时必须使用（见阶段 4，第 1 步）

互补技能：

• defense-in-depth - 找到根因后，在多个层面添加验证
• condition-based-waiting - 替换阶段 2 中发现的任意超时
• verification-before-completion - 在宣称成功前验证修复是否有效

实际效果

来自调试会话的数据：

• 系统性方法：15-30 分钟即可修复
• 随机修复方法：反复折腾 2-3 小时
• 首次修复成功率：95%，而非 40%
• 引入的新 Bug：几乎为零，而非屡见不鲜