BMAD-METHOD/bmad/bmm/knowledge/debug/debug-inspection-checklist.md

debug-inspection-checklist

Comprehensive checklist for Fagan inspection methodology.

Phase 1: Planning Checklist

• Bug description clearly documented
• Inspection scope defined (code, tests, config, docs)
• Affected components identified
• Stakeholders notified
• Success criteria established
• Time allocated for inspection

Phase 2: Overview Checklist

• Recent commits reviewed (last 20-50)
• Feature specifications reviewed
• Related documentation gathered
• Environment details captured
• Previous similar issues researched
• Impact scope assessed

Phase 3: Preparation Checklist

Code Analysis

• Static analysis performed
• Code complexity measured
• Anti-patterns identified
• Security vulnerabilities checked
• Performance bottlenecks assessed

Test Analysis

• Test coverage reviewed
• Failed tests analyzed
• Missing test scenarios identified
• Test quality assessed
• Edge cases evaluated

Configuration Analysis

• Environment settings reviewed
• Configuration drift checked
• Dependencies verified
• Version compatibility confirmed
• Resource limits checked

Phase 4: Inspection Meeting Checklist

Defect Categories Reviewed

• Logic defects (algorithms, control flow)
• Interface defects (API, parameters)
• Data defects (types, validation)
• Documentation defects (outdated, incorrect)
• Performance defects (inefficiencies)
• Security defects (vulnerabilities)

Analysis Completed

• Root cause identified
• Evidence documented
• Impact severity assessed
• Defects categorized by priority
• Pattern analysis performed

Phase 5: Rework Planning Checklist

• Fix proposals generated
• Trade-offs analyzed
• Test strategy designed
• Risk assessment completed
• Implementation timeline created
• Regression test plan defined
• Rollback plan prepared

Phase 6: Follow-up Checklist

• Fix effectiveness validated
• All tests passing
• Documentation updated
• Lessons learned captured
• Debug report completed
• Prevention measures identified
• Knowledge shared with team

Quality Gates

Inspection Completeness

• All 6 phases executed
• All checklists completed
• Evidence trail documented
• Peer review conducted

Fix Validation

• Fix addresses root cause
• No side effects introduced
• Performance acceptable
• Security maintained
• Tests comprehensive

Documentation

• Debug report generated
• Code comments updated
• README updated if needed
• Runbook updated if needed
• Team wiki updated

Sign-off

• Developer reviewed
• QA validated
• Team lead approved
• Stakeholders informed