Engineering Execution 14 min
Debugging Briefs
Compress symptoms, logs, and recent changes into a useful investigation path.
Learning Objectives
- Summarize expected and actual behavior.
- Rank hypotheses by evidence.
- Design tests before proposing fixes.
Debugging starts with a clean brief
A debugging prompt should include expected behavior, actual behavior, logs, recent changes, environment, and reproduction steps. Missing context leads to speculative fixes.
Ask the model for ranked hypotheses. Each hypothesis should cite evidence and include a test. Only then should it suggest a fix.
Strong debugging output
- Hypothesis
- Supporting evidence
- How to test it
- Fix if confirmed
- Confidence
Never accept a fix that cannot explain the failure mode. The goal is an investigation path, not a lucky guess.
Examples
Hypothesis table
Hypothesis, supporting evidence, test, and fix-if-confirmed keeps debugging grounded.
Practice Exercise
Create a debugging brief
Paste symptoms, logs, and recent changes. Ask for ranked hypotheses and tests.
- Hypotheses cite logs.
- Each hypothesis has a test.
- Fixes are conditional on confirmation.
Mini Prompt Templates
Debugging Partner
Expected behavior: [EXPECTED] Actual behavior: [ACTUAL] Logs: [LOGS] Recent changes: [CHANGES] Task: Generate ranked hypotheses and tests. Format: Hypothesis, Evidence, Test, Fix if confirmed.
