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. 追踪数据流

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

   请参阅 skills/root-cause-tracing，了解向上追踪的方法。

   简要步骤：

   • 错误值从哪里产生？
   • 是什么调用方传入了这个错误值？
   • 持续向上追踪，直到找到源头
   • 在源头修复，而不是修复症状

阶段 2：模式分析

修复之前先找出模式：

1. 寻找可正常工作的示例

   • 在同一代码库中找到类似且正常工作的代码
   • 类似的部分中，哪些正常工作，哪些出了问题？

2. 对照参考实现

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

3. 找出差异

   • 正常工作的部分和出问题的部分有何不同？
   • 列出所有差异，无论多么细微
   • 不要假定“这不可能有影响”

4. 理解依赖项

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

阶段 3：提出假设并进行测试

采用科学方法：

1. 提出单一假设

   • 清楚陈述：“我认为 X 是根本原因，因为 Y”
   • 写下来
   • 具体明确，不要含糊

2. 以最小改动进行测试

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

3. 验证后再继续

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

4. 遇到不懂的地方

   • 直接说“我不理解 X”
   • 不要假装自己懂
   • 寻求帮助
   • 继续调查

阶段 4：实施

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

1. 创建失败的测试用例

   • 尽可能简单地复现问题
   • 尽可能编写自动化测试
   • 如果没有测试框架，就编写一次性测试脚本
   • 修复前必须先完成
   • 编写合适的失败测试，请参阅 skills/testing/test-driven-development

2. 实施单一修复

   • 解决已确定的根本原因
   • 一次只做一项更改
   • 不要顺手改进其他内容
   • 不要打包进行重构

3. 验证修复

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

4. 如果修复无效

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

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

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

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

   停止并质疑根本问题：

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

   尝试更多修复前，先与人类搭档讨论

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

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

如果你发现自己在想：

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

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

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

人类搭档指出你做错时的信号

留意这些引导你改正方向的话：

• “这种情况真的发生了吗？”——你未经验证就做了假设
• “这样能让我们看到……吗？”——你本该收集证据
• “别猜了”——你在不了解情况时就提出修复方案
• “深入思考一下”——要质疑根本问题，而不只是表面症状
• “我们卡住了吗？”（沮丧）——你的方法不起作用

**出现这些信号时：**停止。返回阶段 1。

常见的自我辩解

借口	事实
“问题很简单，不需要流程”	简单问题也有根本原因。对于简单 Bug，按流程处理很快。
“情况紧急，没时间走流程”	系统化调试比盲目尝试和反复折腾更快。
“先试一下，再调查”	第一次修复会决定后续模式。从一开始就做好。
“确认修复有效后再写测试”	未经测试的修复无法保证有效。先写测试才能验证。
“一次修复多个问题可以节省时间”	无法确定哪项修复起了作用，还会引入新 Bug。
“参考内容太长，我会自行调整模式”	理解不完整必然导致 Bug。请完整阅读。
“我看出问题了，让我来修”	看到症状 ≠ 理解根本原因。
“再试一次修复”（已失败 2 次或更多后）	失败 3 次或更多 = 架构问题。应质疑这种模式，不要再修一次。

快速参考

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

当排查结果是“没有根本原因”时

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

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

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

与其他技能集成

此技能可与以下技能配合使用：

• skills/root-cause-tracing - 如何沿调用栈追溯
• skills/defense-in-depth - 找到根本原因后添加验证
• skills/testing/condition-based-waiting - 替换第 2 阶段中发现的超时
• skills/verification-before-completion - 在宣称成功前验证修复是否有效

实际影响

根据调试会话的结果：

• 系统性方法：15–30 分钟即可修复
• 随机修复方法：耗时 2–3 小时反复折腾
• 首次修复成功率：95% 对比 40%
• 引入的新 Bug：几乎为零，而随机修复则很常见