Systematic Debugging
Overview
Random fixes waste time and create new bugs. Quick patches mask underlying issues.
Core principle: ALWAYS find root cause before attempting fixes. Symptom fixes are failure.
Violating the letter of this process is violating the spirit of debugging.
The Iron Law
NO FIXES WITHOUT ROOT CAUSE INVESTIGATION FIRST
If you haven't completed Phase 1, you cannot propose fixes.
When to Use
Use for ANY technical issue:
- Test failures
- Bugs in production
- Unexpected behavior
- Performance problems
- Build failures
- Integration issues
Use this ESPECIALLY when:
- Under time pressure (emergencies make guessing tempting)
- "Just one quick fix" seems obvious
- You've already tried multiple fixes
- Previous fix didn't work
- You don't fully understand the issue
Don't skip when:
- Issue seems simple (simple bugs have root causes too)
- You're in a hurry (rushing guarantees rework)
- Manager wants it fixed NOW (systematic is faster than thrashing)
The Four Phases
You MUST complete each phase before proceeding to the next.
Phase 1: Root Cause Investigation
BEFORE attempting ANY fix:
Read Error Messages Carefully
- Don't skip past errors or warnings
- They often contain the exact solution
- Read stack traces completely
- Note line numbers, file paths, error codes
Reproduce Consistently
- Can you trigger it reliably?
- What are the exact steps?
- Does it happen every time?
- If not reproducible → gather more data, don't guess
Check Recent Changes
- What changed that could cause this?
- Git diff, recent commits
- New dependencies, config changes
- Environmental differences
Gather Evidence in Multi-Component Systems
WHEN system has multiple components (CI → build → signing, API → service → database):
BEFORE proposing fixes, add diagnostic instrumentation:
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
Example (multi-layer system):
# 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"
This reveals: Which layer fails (secrets → workflow ✓, workflow → build ✗)
Trace Data Flow
WHEN error is deep in call stack:
REQUIRED SUB-SKILL: Use trace skill for backward tracing technique
Quick version:
- Where does bad value originate?
- What called this with bad value?
- Keep tracing up until you find the source
- Fix at source, not at symptom
Phase 2: Pattern Analysis
Find the pattern before fixing:
Find Working Examples
- Locate similar working code in same codebase
- What works that's similar to what's broken?
Compare Against References
- If implementing pattern, read reference implementation COMPLETELY
- Don't skim - read every line
- Understand the pattern fully before applying
Identify Differences
- What's different between working and broken?
- List every difference, however small
- Don't assume "that can't matter"
Understand Dependencies
- What other components does this need?
- What settings, config, environment?
- What assumptions does it make?
Phase 3: Hypothesis and Testing
Scientific method:
Form Single Hypothesis
- State clearly: "I think X is the root cause because Y"
- Write it down
- Be specific, not vague
Test Minimally
- Make the SMALLEST possible change to test hypothesis
- One variable at a time
- Don't fix multiple things at once
Verify Before Continuing
- Did it work? Yes → Phase 4
- Didn't work? Form NEW hypothesis
- DON'T add more fixes on top
When You Don't Know
- Say "I don't understand X"
- Don't pretend to know
- Ask for help
- Research more
Phase 4: Implementation
Fix the root cause, not the symptom:
Decide on Testing Strategy
Auto-decide based on complexity:
- Write test for: Complex algorithms, business logic, data transformations where bugs are likely
- Skip test for: UI components, React hooks, simple CRUD, straightforward mappings, anything you're 100% certain is correct
- Test type: Only deterministic unit tests - no integration tests, no complex mocking, no async complexity
If writing test:
- Simplest possible reproduction
- Automated test that fails before fix
- Verify logic, not implementation details
If skipping test:
- Verify fix with typecheck/lint
- Manual verification for UI changes
- Code review confidence that fix is correct
Implement Single Fix
- Address the root cause identified
- ONE change at a time
- No "while I'm here" improvements
- No bundled refactoring
Verify Fix
If test was written:
- Test passes now?
- No other tests broken?
If no test:
- Typecheck passes?
- Lint clean?
- Manual verification confirms fix?
Always check:
- Issue actually resolved?
- No regressions in related functionality?
If Fix Doesn't Work
- STOP
- Count: How many fixes have you tried?
- If < 3: Return to Phase 1, re-analyze with new information
- If ≥ 3: STOP and question the architecture (step 5 below)
- DON'T attempt Fix #4 without architectural discussion
If 3+ Fixes Failed: Question Architecture
Pattern indicating architectural problem:
- Each fix reveals new shared state/coupling/problem in different place
- Fixes require "massive refactoring" to implement
- Each fix creates new symptoms elsewhere
STOP and question fundamentals:
- Is this pattern fundamentally sound?
- Are we "sticking with it through sheer inertia"?
- Should we refactor architecture vs. continue fixing symptoms?
Discuss with your human partner before attempting more fixes
This is NOT a failed hypothesis - this is a wrong architecture.
Red Flags - STOP and Follow Process
If you catch yourself thinking:
- "Quick fix for now, investigate later"
- "Just try changing X and see if it works"
- "Add multiple changes, run tests"
- "It's probably X, let me fix that"
- "I don't fully understand but this might work"
- "Pattern says X but I'll adapt it differently"
- "Here are the main problems: [lists fixes without investigation]"
- Proposing solutions before tracing data flow
- "One more fix attempt" (when already tried 2+)
- Each fix reveals new problem in different place
- Writing tests for UI components when you're certain the fix is correct
ALL of these mean: STOP. Return to Phase 1.
If 3+ fixes failed: Question the architecture (see Phase 4.5)
your human partner's Signals You're Doing It Wrong
Watch for these redirections:
- "Is that not happening?" - You assumed without verifying
- "Will it show us...?" - You should have added evidence gathering
- "Stop guessing" - You're proposing fixes without understanding
- "Ultrathink this" - Question fundamentals, not just symptoms
- "We're stuck?" (frustrated) - Your approach isn't working
When you see these: STOP. Return to Phase 1.
Common Rationalizations
| Excuse |
Reality |
| "Issue is simple, don't need process" |
Simple issues have root causes too. Process is fast for simple bugs. |
| "Emergency, no time for process" |
Systematic debugging is FASTER than guess-and-check thrashing. |
| "Just try this first, then investigate" |
First fix sets the pattern. Do it right from the start. |
| "Multiple fixes at once saves time" |
Can't isolate what worked. Causes new bugs. |
| "Reference too long, I'll adapt the pattern" |
Partial understanding guarantees bugs. Read it completely. |
| "I see the problem, let me fix it" |
Seeing symptoms ≠ understanding root cause. |
| "One more fix attempt" (after 2+ failures) |
3+ failures = architectural problem. Question pattern, don't fix again. |
| "UI fix doesn't need tests" |
Correct! UI components verified via typecheck/manual testing, not unit tests. |
Quick Reference
| Phase |
Key Activities |
Success Criteria |
| 1. Root Cause |
Read errors, reproduce, check changes, gather evidence |
Understand WHAT and WHY |
| 2. Pattern |
Find working examples, compare |
Identify differences |
| 3. Hypothesis |
Form theory, test minimally |
Confirmed or new hypothesis |
| 4. Implementation |
Create test, fix, verify |
Bug resolved, tests pass |
When Process Reveals "No Root Cause"
If systematic investigation reveals issue is truly environmental, timing-dependent, or external:
- You've completed the process
- Document what you investigated
- Implement appropriate handling (retry, timeout, error message)
- Add monitoring/logging for future investigation
But: 95% of "no root cause" cases are incomplete investigation.
Integration with Other Skills
This skill requires using:
- trace - REQUIRED when error is deep in call stack (see Phase 1, Step 5)
Testing skills (when needed):
- tdd (if available) - Use when fixing complex business logic that needs test coverage
- Skip for UI components, simple CRUD, or anything verifiable via typecheck/manual testing
Real-World Impact
From debugging sessions:
- Systematic approach: 15-30 minutes to fix
- Random fixes approach: 2-3 hours of thrashing
- First-time fix rate: 95% vs 40%
- New bugs introduced: Near zero vs common
1---
2name: debug
3description: Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes - four-phase framework (root cause investigation, pattern analysis, hypothesis testing, implementation) that ensures understanding before attempting solutions
4metadata:
5 source: https://skillmd.com/skills/udecode/debug
6---
7
8# Systematic Debugging
9
10## Overview
11
12Random fixes waste time and create new bugs. Quick patches mask underlying issues.
13
14**Core principle:** ALWAYS find root cause before attempting fixes. Symptom fixes are failure.
15
16**Violating the letter of this process is violating the spirit of debugging.**
17
18## The Iron Law
19
20```
21NO FIXES WITHOUT ROOT CAUSE INVESTIGATION FIRST
22```
23
24If you haven't completed Phase 1, you cannot propose fixes.
25
26## When to Use
27
28Use for ANY technical issue:
29
30- Test failures
31- Bugs in production
32- Unexpected behavior
33- Performance problems
34- Build failures
35- Integration issues
36
37**Use this ESPECIALLY when:**
38
39- Under time pressure (emergencies make guessing tempting)
40- "Just one quick fix" seems obvious
41- You've already tried multiple fixes
42- Previous fix didn't work
43- You don't fully understand the issue
44
45**Don't skip when:**
46
47- Issue seems simple (simple bugs have root causes too)
48- You're in a hurry (rushing guarantees rework)
49- Manager wants it fixed NOW (systematic is faster than thrashing)
50
51## The Four Phases
52
53You MUST complete each phase before proceeding to the next.
54
55### Phase 1: Root Cause Investigation
56
57**BEFORE attempting ANY fix:**
58
591. **Read Error Messages Carefully**
60
61 - Don't skip past errors or warnings
62 - They often contain the exact solution
63 - Read stack traces completely
64 - Note line numbers, file paths, error codes
65
662. **Reproduce Consistently**
67
68 - Can you trigger it reliably?
69 - What are the exact steps?
70 - Does it happen every time?
71 - If not reproducible → gather more data, don't guess
72
733. **Check Recent Changes**
74
75 - What changed that could cause this?
76 - Git diff, recent commits
77 - New dependencies, config changes
78 - Environmental differences
79
804. **Gather Evidence in Multi-Component Systems**
81
82 **WHEN system has multiple components (CI → build → signing, API → service → database):**
83
84 **BEFORE proposing fixes, add diagnostic instrumentation:**
85
86 ```
87 For EACH component boundary:
88 - Log what data enters component
89 - Log what data exits component
90 - Verify environment/config propagation
91 - Check state at each layer
92
93 Run once to gather evidence showing WHERE it breaks
94 THEN analyze evidence to identify failing component
95 THEN investigate that specific component
96 ```
97
98 **Example (multi-layer system):**
99
100 ```bash
101 # Layer 1: Workflow
102 echo "=== Secrets available in workflow: ==="
103 echo "IDENTITY: ${IDENTITY:+SET}${IDENTITY:-UNSET}"
104
105 # Layer 2: Build script
106 echo "=== Env vars in build script: ==="
107 env | grep IDENTITY || echo "IDENTITY not in environment"
108
109 # Layer 3: Signing script
110 echo "=== Keychain state: ==="
111 security list-keychains
112 security find-identity -v
113
114 # Layer 4: Actual signing
115 codesign --sign "$IDENTITY" --verbose=4 "$APP"
116 ```
117
118 **This reveals:** Which layer fails (secrets → workflow ✓, workflow → build ✗)
119
1205. **Trace Data Flow**
121
122 **WHEN error is deep in call stack:**
123
124 **REQUIRED SUB-SKILL:** Use trace skill for backward tracing technique
125
126 **Quick version:**
127
128 - Where does bad value originate?
129 - What called this with bad value?
130 - Keep tracing up until you find the source
131 - Fix at source, not at symptom
132
133### Phase 2: Pattern Analysis
134
135**Find the pattern before fixing:**
136
1371. **Find Working Examples**
138
139 - Locate similar working code in same codebase
140 - What works that's similar to what's broken?
141
1422. **Compare Against References**
143
144 - If implementing pattern, read reference implementation COMPLETELY
145 - Don't skim - read every line
146 - Understand the pattern fully before applying
147
1483. **Identify Differences**
149
150 - What's different between working and broken?
151 - List every difference, however small
152 - Don't assume "that can't matter"
153
1544. **Understand Dependencies**
155 - What other components does this need?
156 - What settings, config, environment?
157 - What assumptions does it make?
158
159### Phase 3: Hypothesis and Testing
160
161**Scientific method:**
162
1631. **Form Single Hypothesis**
164
165 - State clearly: "I think X is the root cause because Y"
166 - Write it down
167 - Be specific, not vague
168
1692. **Test Minimally**
170
171 - Make the SMALLEST possible change to test hypothesis
172 - One variable at a time
173 - Don't fix multiple things at once
174
1753. **Verify Before Continuing**
176
177 - Did it work? Yes → Phase 4
178 - Didn't work? Form NEW hypothesis
179 - DON'T add more fixes on top
180
1814. **When You Don't Know**
182 - Say "I don't understand X"
183 - Don't pretend to know
184 - Ask for help
185 - Research more
186
187### Phase 4: Implementation
188
189**Fix the root cause, not the symptom:**
190
1911. **Decide on Testing Strategy**
192
193 **Auto-decide based on complexity:**
194
195 - **Write test for**: Complex algorithms, business logic, data transformations where bugs are likely
196 - **Skip test for**: UI components, React hooks, simple CRUD, straightforward mappings, anything you're 100% certain is correct
197 - **Test type**: Only deterministic unit tests - no integration tests, no complex mocking, no async complexity
198
199 **If writing test:**
200
201 - Simplest possible reproduction
202 - Automated test that fails before fix
203 - Verify logic, not implementation details
204
205 **If skipping test:**
206
207 - Verify fix with typecheck/lint
208 - Manual verification for UI changes
209 - Code review confidence that fix is correct
210
2112. **Implement Single Fix**
212
213 - Address the root cause identified
214 - ONE change at a time
215 - No "while I'm here" improvements
216 - No bundled refactoring
217
2183. **Verify Fix**
219
220 **If test was written:**
221
222 - Test passes now?
223 - No other tests broken?
224
225 **If no test:**
226
227 - Typecheck passes?
228 - Lint clean?
229 - Manual verification confirms fix?
230
231 **Always check:**
232
233 - Issue actually resolved?
234 - No regressions in related functionality?
235
2364. **If Fix Doesn't Work**
237
238 - STOP
239 - Count: How many fixes have you tried?
240 - If < 3: Return to Phase 1, re-analyze with new information
241 - **If ≥ 3: STOP and question the architecture (step 5 below)**
242 - DON'T attempt Fix #4 without architectural discussion
243
2445. **If 3+ Fixes Failed: Question Architecture**
245
246 **Pattern indicating architectural problem:**
247
248 - Each fix reveals new shared state/coupling/problem in different place
249 - Fixes require "massive refactoring" to implement
250 - Each fix creates new symptoms elsewhere
251
252 **STOP and question fundamentals:**
253
254 - Is this pattern fundamentally sound?
255 - Are we "sticking with it through sheer inertia"?
256 - Should we refactor architecture vs. continue fixing symptoms?
257
258 **Discuss with your human partner before attempting more fixes**
259
260 This is NOT a failed hypothesis - this is a wrong architecture.
261
262## Red Flags - STOP and Follow Process
263
264If you catch yourself thinking:
265
266- "Quick fix for now, investigate later"
267- "Just try changing X and see if it works"
268- "Add multiple changes, run tests"
269- "It's probably X, let me fix that"
270- "I don't fully understand but this might work"
271- "Pattern says X but I'll adapt it differently"
272- "Here are the main problems: [lists fixes without investigation]"
273- Proposing solutions before tracing data flow
274- **"One more fix attempt" (when already tried 2+)**
275- **Each fix reveals new problem in different place**
276- **Writing tests for UI components when you're certain the fix is correct**
277
278**ALL of these mean: STOP. Return to Phase 1.**
279
280**If 3+ fixes failed:** Question the architecture (see Phase 4.5)
281
282## your human partner's Signals You're Doing It Wrong
283
284**Watch for these redirections:**
285
286- "Is that not happening?" - You assumed without verifying
287- "Will it show us...?" - You should have added evidence gathering
288- "Stop guessing" - You're proposing fixes without understanding
289- "Ultrathink this" - Question fundamentals, not just symptoms
290- "We're stuck?" (frustrated) - Your approach isn't working
291
292**When you see these:** STOP. Return to Phase 1.
293
294## Common Rationalizations
295
296| Excuse | Reality |
297| -------------------------------------------- | ----------------------------------------------------------------------------- |
298| "Issue is simple, don't need process" | Simple issues have root causes too. Process is fast for simple bugs. |
299| "Emergency, no time for process" | Systematic debugging is FASTER than guess-and-check thrashing. |
300| "Just try this first, then investigate" | First fix sets the pattern. Do it right from the start. |
301| "Multiple fixes at once saves time" | Can't isolate what worked. Causes new bugs. |
302| "Reference too long, I'll adapt the pattern" | Partial understanding guarantees bugs. Read it completely. |
303| "I see the problem, let me fix it" | Seeing symptoms ≠ understanding root cause. |
304| "One more fix attempt" (after 2+ failures) | 3+ failures = architectural problem. Question pattern, don't fix again. |
305| "UI fix doesn't need tests" | Correct! UI components verified via typecheck/manual testing, not unit tests. |
306
307## Quick Reference
308
309| Phase | Key Activities | Success Criteria |
310| --------------------- | ------------------------------------------------------ | --------------------------- |
311| **1. Root Cause** | Read errors, reproduce, check changes, gather evidence | Understand WHAT and WHY |
312| **2. Pattern** | Find working examples, compare | Identify differences |
313| **3. Hypothesis** | Form theory, test minimally | Confirmed or new hypothesis |
314| **4. Implementation** | Create test, fix, verify | Bug resolved, tests pass |
315
316## When Process Reveals "No Root Cause"
317
318If systematic investigation reveals issue is truly environmental, timing-dependent, or external:
319
3201. You've completed the process
3212. Document what you investigated
3223. Implement appropriate handling (retry, timeout, error message)
3234. Add monitoring/logging for future investigation
324
325**But:** 95% of "no root cause" cases are incomplete investigation.
326
327## Integration with Other Skills
328
329**This skill requires using:**
330
331- **trace** - REQUIRED when error is deep in call stack (see Phase 1, Step 5)
332
333**Testing skills (when needed):**
334
335- **tdd** (if available) - Use when fixing complex business logic that needs test coverage
336- Skip for UI components, simple CRUD, or anything verifiable via typecheck/manual testing
337
338## Real-World Impact
339
340From debugging sessions:
341
342- Systematic approach: 15-30 minutes to fix
343- Random fixes approach: 2-3 hours of thrashing
344- First-time fix rate: 95% vs 40%
345- New bugs introduced: Near zero vs common