Zwergomaniac

systematic-debugging

Four-phase root cause process for any bug, test failure or unexpected behavior. Iron Law: no fixes until Phase 1 investigation is complete. Use before proposing any fix, especially under time pressure or after multiple failed attempts. Phases: root cause investigation → pattern analysis → hypothesis testing → implementation. 3+ failed fixes = question the architecture.

Zwergomaniac 0 Updated 1mo ago
GitHub

Install

npx skillscat add zwergomaniac/mxagile/systematic-debugging

Install via the SkillsCat registry.

SKILL.md

Systematic Debugging

Overview

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:

  1. 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
  2. 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
  3. Check Recent Changes

    • What changed that could cause this?
    • Git diff, recent commits
    • New dependencies, config changes
    • Environmental differences
  4. 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
  5. Trace Data Flow

    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:

  1. Find Working Examples — Locate similar working code in same codebase.
  2. Compare Against References — Read reference implementation COMPLETELY. Don't skim.
  3. Identify Differences — List every difference, however small.
  4. Understand Dependencies — What other components does this need?

Phase 3: Hypothesis and Testing

  1. Form Single Hypothesis — "I think X is the root cause because Y." Write it down.
  2. Test Minimally — Smallest possible change. One variable at a time.
  3. Verify Before Continuing — Did it work? Yes → Phase 4. No → new hypothesis.
  4. When You Don't Know — Say "I don't understand X." Don't pretend.

Phase 4: Implementation

  1. Create Failing Test Case — Simplest possible reproduction. MUST have before fixing.

  2. Implement Single Fix — Address root cause. ONE change at a time.

  3. Verify Fix — Test passes? No other tests broken? Issue actually resolved?

  4. If Fix Doesn't Work — Count fixes. If < 3: return to Phase 1. If ≥ 3: question architecture.

  5. If 3+ Fixes Failed: Question Architecture

    Pattern indicating architectural problem: each fix reveals new problem in a different place.

    STOP and question fundamentals with the user before attempting more fixes.

Red Flags - STOP and Follow Process

  • "Quick fix for now, investigate later"
  • "Just try changing X and see if it works"
  • "It's probably X, let me fix that"
  • Proposing solutions before tracing data flow
  • "One more fix attempt" (when already tried 2+)

ALL of these mean: STOP. Return to Phase 1.

Common Rationalizations

Excuse Reality
"Issue is simple, don't need process" Simple issues have root causes too.
"Emergency, no time for process" Systematic debugging is FASTER than guess-and-check thrashing.
"Multiple fixes at once saves time" Can't isolate what worked. Causes new bugs.
"One more fix attempt" (after 2+ failures) 3+ failures = architectural problem.

Quick Reference

Phase Success Criteria
1. Root Cause Understand WHAT and WHY
2. Pattern Identify differences
3. Hypothesis Confirmed or new hypothesis
4. Implementation Bug resolved, tests pass