name: 系统性调试 description: 一个四阶段的调试框架,确保在尝试修复前进行根因调查。从不跳转到解决方案。 when_to_use: 当遇到任何bug、测试失败或意外行为时,在提出修复前使用 version: 2.1.0 languages: all
系统性调试
概述
随机修复浪费时间并创造新的bug。快速补丁掩盖了潜在问题。
核心原则: 总是在尝试修复前找到根本原因。症状修复是失败的。
违反这个过程的文字就是违反调试的精神。
铁律
没有根因调查就没有修复
如果你没有完成阶段1,就不能提出修复。
何时使用
用于任何技术问题:
- 测试失败
- 生产中的bug
- 意外行为
- 性能问题
- 构建失败
- 集成问题
特别在以下情况下使用:
- 时间压力下(紧急情况容易诱使猜测)
- “只是一个快速修复”看起来很明显
- 你已经尝试了多个修复
- 之前的修复没有奏效
- 你不完全理解问题
不要跳过当:
- 问题看起来简单(简单的bug也有根本原因)
- 你很匆忙(匆忙保证需要返工)
- 经理希望立即修复(系统性的调试比乱试更快)
四个阶段
你必须完成每个阶段才能进入下一个。
阶段1:根因调查
在尝试任何修复之前:
-
仔细阅读错误消息
- 不要跳过错误或警告
- 它们通常包含确切的解决方案
- 完整阅读堆栈跟踪
- 注意行号、文件路径、错误代码
-
一致地复现
- 你能可靠地触发它吗?
- 确切的步骤是什么?
- 每次都发生吗?
- 如果不能复现 → 收集更多数据,不要猜测
-
检查最近的更改
- 什么更改可能导致这个问题?
- Git diff,最近的提交
- 新依赖、配置更改
- 环境差异
-
在多组件系统中收集证据
当系统有多个组件时(CI → 构建 → 签名,API → 服务 → 数据库):
在提出修复前,添加诊断工具:
对于每个组件边界: - 记录数据进入组件 - 记录数据退出组件 - 验证环境/配置传播 - 检查每个层的状态 运行一次以收集证据显示哪里中断 然后分析证据以识别失败组件 然后调查该特定组件示例(多层系统):
# 层1:工作流 echo "=== 工作流中可用的秘密: ===" echo "IDENTITY: ${IDENTITY:+SET}${IDENTITY:-UNSET}" # 层2:构建脚本 echo "=== 构建脚本中的环境变量: ===" env | grep IDENTITY || echo "IDENTITY 不在环境中" # 层3:签名脚本 echo "=== 钥匙串状态: ===" security list-keychains security find-identity -v # 层4:实际签名 codesign --sign "$IDENTITY" --verbose=4 "$APP"这揭示: 哪个层失败(秘密 → 工作流 ✓,工作流 → 构建 ✗)
-
追踪数据流
当错误在调用堆栈深处时:
参见 skills/root-cause-tracing 以了解反向追踪技术
快速版本:
- 坏值从哪里起源?
- 什么用坏值调用了这个?
- 一直向上追踪直到找到源头
- 在源头修复,而不是在症状处
阶段2:模式分析
在修复前找到模式:
-
找到工作示例
- 在相同代码库中找到类似的工作代码
- 什么与损坏的类似但有效?
-
与参考比较
- 如果实现模式,完整阅读参考实现
- 不要略读——阅读每一行
- 在应用前完全理解模式
-
识别差异
- 工作和损坏之间有什么不同?
- 列出每个差异,无论多小
- 不要假设“那不重要”
-
理解依赖关系
- 这需要什么其他组件?
- 需要什么设置、配置、环境?
- 它做出什么假设?
阶段3:假设和测试
科学方法:
-
形成单一假设
- 清晰陈述:“我认为X是根本原因,因为Y”
- 写下来
- 具体,不模糊
-
最小化测试
- 做出最小的可能更改来测试假设
- 一次一个变量
- 不要一次修复多个东西
-
在继续前验证
- 有效吗?是的 → 阶段4
- 没有效?形成新的假设
- 不要在上面添加更多修复
-
当你不知道时
- 说“我不理解X”
- 不要假装知道
- 请求帮助
- 更多研究
阶段4:实现
修复根本原因,而不是症状:
-
创建失败的测试案例
- 最简单的可能复现
- 如果可能,自动化测试
- 如果没有框架,一次性测试脚本
- 在修复前必须有
- 参见 skills/testing/test-driven-development 以编写适当的失败测试
-
实现单一修复
- 解决识别的根本原因
- 一次一个更改
- 没有“趁我在这里”的改进
- 没有捆绑重构
-
验证修复
- 测试现在通过了吗?
- 没有其他测试损坏吗?
- 问题实际上解决了吗?
-
如果修复不奏效
- 停止
- 计数:你已经尝试了多少修复?
- 如果 < 3:返回阶段1,用新信息重新分析
- 如果 ≥ 3:停止并质疑架构(见下面的步骤5)
- 没有架构讨论不要尝试修复 #4
-
如果3+修复失败:质疑架构
指示架构问题的模式:
- 每个修复揭示新的共享状态/耦合/问题在不同地方
- 修复需要“大规模重构”来实现
- 每个修复在其他地方创造新症状
停止并质疑基本问题:
- 这个模式根本上是合理的吗?
- 我们是否“仅凭惯性坚持它”?
- 我们应该重构架构而不是继续修复症状吗?
在尝试更多修复前与你的人类伙伴讨论
这不是失败的假设——这是错误的架构。
红旗 - 停止并遵循过程
如果你发现自己思考:
- “现在快速修复,稍后调查”
- “只是试试改X,看是否有效”
- “添加多个更改,运行测试”
- “跳过测试,我会手动验证”
- “可能是X,让我修复那个”
- “我不完全理解但这可能有效”
- “模式说X但我会以不同方式适应它”
- “这是主要问题:[在不调查的情况下列出修复]”
- 在追踪数据流前提出解决方案
- “再来一次修复尝试”(当已经尝试2+次)
- 每个修复在不同地方揭示新问题
所有这些意味着:停止。返回到阶段1。
如果3+修复失败: 质疑架构(见阶段4.5)
你的人类伙伴的信号表明你做错了
注意这些重定向:
- “那不是发生吗?” - 你假设没有验证
- “它会显示我们…吗?” - 你应该添加了证据收集
- “停止猜测” - 你在没有理解的情况下提出修复
- “深层思考这个” - 质疑基本问题,不仅仅是症状
- “我们卡住了?”(沮丧) - 你的方法无效
当你看到这些时: 停止。返回到阶段1。
常见合理化
| 借口 | 现实 |
|---|---|
| “问题简单,不需要过程” | 简单问题也有根本原因。过程对于简单bug也快。 |
| “紧急情况,没时间进行过程” | 系统性调试比猜试乱试更快。 |
| “先试试这个,然后调查” | 第一次修复设定了模式。从一开始就做对。 |
| “确认修复有效后我会写测试” | 未测试的修复不稳定。测试首先证明它。 |
| “一次多个修复节省时间” | 无法隔离什么有效。导致新bug。 |
| “参考太长,我会适应模式” | 部分理解保证bug。完全阅读它。 |
| “我看到问题,让我修复它” | 看到症状 ≠ 理解根本原因。 |
| “再来一次修复尝试”(在2+次失败后) | 3+失败 = 架构问题。质疑模式,不要再次修复。 |
快速参考
| 阶段 | 关键活动 | 成功标准 |
|---|---|---|
| 1. 根因 | 阅读错误、复现、检查更改、收集证据 | 理解什么和为什么 |
| 2. 模式 | 找到工作示例、比较 | 识别差异 |
| 3. 假设 | 形成理论、最小化测试 | 确认或新假设 |
| 4. 实现 | 创建测试、修复、验证 | bug解决、测试通过 |
当过程揭示“没有根因”时
如果系统性调查揭示问题确实是环境性的、时间依赖的或外部的:
- 你已经完成了过程
- 记录你调查了什么
- 实现适当处理(重试、超时、错误消息)
- 添加监控/日志以供将来调查
但: 95%的“没有根因”案例是不完整的调查。
与其他技能的集成
这个技能与以下配合工作:
- skills/root-cause-tracing - 如何通过调用堆栈追踪
- skills/defense-in-depth - 找到根因后添加验证
- skills/testing/condition-based-waiting - 替换在阶段2识别的超时
- skills/verification-before-completion - 验证修复有效前声称成功
现实世界影响
从调试会话:
- 系统性方法:15-30分钟修复
- 随机修复方法:2-3小时的乱试
- 首次修复率:95% vs 40%
- 引入新bug:接近零 vs 常见