2.4 KiB
2.4 KiB
Debug Report: [Issue Title]
Date: [YYYY-MM-DD] Investigator: [Name/AI] Status: 🟢 Resolved / 🔴 Unresolved / ⚠️ Workaround Applied
Executive Summary
[2-3 sentence summary of the issue, root cause, and resolution]
Issue Description
Reported By: [User/System] Initial Report:
[User's description or error message]
Impact:
- Severity: Critical / High / Medium / Low
- Users Affected: [Number or description]
- Systems Affected: [List of affected components]
Root Cause
TL;DR: [One sentence explanation]
Detailed Explanation: [Explain what caused the issue and why it manifested the way it did]
Location:
- File:
[path/to/file]:[line] - Component: [Component name]
- Introduced in: [Commit hash or version]
Investigation Process
Observations
- [Key observation 1]
- [Key observation 2]
- [Key observation 3]
Hypotheses Considered
- ❌ [Eliminated hypothesis] - Ruled out because [reason]
- ❌ [Eliminated hypothesis] - Ruled out because [reason]
- ✅ [Confirmed hypothesis] - Confirmed by [evidence]
Key Evidence
- [Evidence 1 that led to root cause]
- [Evidence 2 that confirmed the diagnosis]
Resolution
Fix Applied
# File: [filename]
- [removed code]
+ [added code]
Rationale: [Why this fix was chosen over alternatives]
Verification
- ✅ Original issue resolved
- ✅ No regression in related functionality
- ✅ Test suite passes
- ✅ Deployed to production
Prevention Measures
Immediate Actions:
- [Action 1 - e.g., Added validation]
- [Action 2 - e.g., Added test coverage]
Long-term Improvements:
- [Improvement 1 - e.g., Refactor error handling]
- [Improvement 2 - e.g., Add monitoring]
Tests Added:
[Description or snippet of regression test]
Timeline
| Time | Event |
|---|---|
| [HH:MM] | Issue reported |
| [HH:MM] | Investigation started |
| [HH:MM] | Root cause identified |
| [HH:MM] | Fix implemented |
| [HH:MM] | Fix deployed |
| [HH:MM] | Issue resolved |
Total Resolution Time: [Duration]
Lessons Learned
What Went Well:
- [Positive aspect 1]
- [Positive aspect 2]
What Could Be Improved:
- [Improvement area 1]
- [Improvement area 2]
Key Takeaway: [Main lesson for future reference]
Related Issues
- [Related issue #1]
- [Related issue #2]
Report Generated: [YYYY-MM-DD HH:MM]