Skip to content

Troubleshooting Template

Use this template to write a clear troubleshooting page.

Symptom

Describe what the user sees.

Likely cause

Explain the most probable reason.

Fix

List the shortest reliable fix first.

Verification

Explain how to confirm the problem is resolved.

Notes

  • Keep the symptom, cause, fix, and verification sections in that order.
  • Use concrete steps instead of abstract advice.
  • Match the wording to the problem the reader actually sees.

Markdown-first documentation for teams that update docs often.