The four-step framework

  1. Investigate — what was the root cause?
  2. Explain — the issue plus environment (OS, versions, configs).
  3. Fix — how to fix it, and how to test the fix.
  4. 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.
Advertisement