The four-step framework
- Investigate — what was the root cause?
- Explain — the issue plus environment (OS, versions, configs).
- Fix — how to fix it, and how to test the fix.
- Verify — proof the fix works, plus any security implications.
Tips
- Include error messages verbatim.
- Give minimal reproduction steps.
- Remove secrets (API keys, passwords, internal hosts, customer data) from logs and screenshots.