Symptom Description
Describe the problem as users experience it. Include error messages.
Free Planning Template
Download a free troubleshooting guide template in Word, PDF, or Markdown. Or bring your notes, PDFs, or a recording and let Docsie AI fill in every section for you.
Generated by Docsie AI. See it turn real videos into finished guides →
Use this template to how to resolve [problem].
| Field | Details |
|---|---|
| Category | Planning |
| Owner | [Team or owner] |
| Version | [Version number] |
| Effective Date | [Date] |
| Review Cycle | [Monthly / Quarterly / Annual / Event-based] |
| Status | [Draft / In Review / Approved] |
Describe the problem as users experience it. Include error messages.
| Item | Details | Owner | Status |
|---|---|---|---|
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]
List causes in order of probability.
| Item | Details | Owner | Status |
|---|---|---|---|
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]
Systematic approach to identify root cause. Start with simplest checks.
| Item | Details | Owner | Status |
|---|---|---|---|
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]
Step-by-step fix for each identified cause.
| Item | Details | Owner | Status |
|---|---|---|---|
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]
When and how to escalate.
| Item | Details | Owner | Status |
|---|---|---|---|
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]
Steps to prevent recurrence. Use code blocks for commands and error messages.
| Item | Details | Owner | Status |
|---|---|---|---|
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]
Document review conclusions, approvals, unresolved items, and next review date.
| Role | Name | Date | Notes |
|---|---|---|---|
| Preparer | [Name] | [Date] | [Notes] |
| Reviewer | [Name] | [Date] | [Notes] |
| Approver | [Name] | [Date] | [Notes] |
Template Structure
Use this planning template as a starting point, then customize each section to match your internal workflow, evidence, and signoff needs.
Describe the problem as users experience it. Include error messages.
List causes in order of probability.
Systematic approach to identify root cause. Start with simplest checks.
Step-by-step fix for each identified cause.
When and how to escalate.
Steps to prevent recurrence. Use code blocks for commands and error messages.
Write a Troubleshooting Guide in a clear, diagnostic tone. Structure with:
Describe the problem as users experience it. Include error messages.
List causes in order of probability.
Systematic approach to identify root cause. Start with simplest checks.
Step-by-step fix for each identified cause.
When and how to escalate.
Steps to prevent recurrence.
Use code blocks for commands and error messages.
Users see a "Connection timed out" error when loading the Analytics Dashboard. The error appears after a ~30 second delay. Other pages load normally.
Error: Request to /api/v2/analytics/dashboard failed
Status: 504 Gateway Timeout
Message: "Connection timed out after 30000ms"
curl -s https://api.internal/health | jq '.status'
# Expected: "ok"
# If not "ok": Go to Solution B
kubectl logs deploy/api-server --since=10m | grep "SLOW_QUERY"
# If slow queries found: Go to Solution A
psql -c "SELECT count(*) as total, state FROM pg_stat_activity GROUP BY state;"
# If 'active' count is near max_connections: Go to Solution B
The dashboard query likely needs an index. Run:
CREATE INDEX CONCURRENTLY idx_events_dashboard
ON events (org_id, created_at DESC, event_type);
Verify with: EXPLAIN ANALYZE on the dashboard query — should show Index Scan instead of Seq Scan.
If the server is resource-exhausted:
kubectl rollout restart deploy/api-server
kubectl rollout status deploy/api-server
# Wait for all pods to be Ready
Bring what you already have: meeting notes, an old PDF, a spreadsheet, a walkthrough recording. Docsie AI drafts every section of this troubleshooting guide template in the structure above, then exports to Word, PDF, or Markdown for review and signoff.
Free to try. The template above was itself generated by Docsie — see it work on real videos at /tutorials/.
Template FAQ
Common questions about downloading and generating a troubleshooting guide template.
Q: What is a troubleshooting guide template?
A: A troubleshooting guide template is a structured document for how to resolve [problem].
Q: Is the troubleshooting guide template really free?
A: Yes. The troubleshooting guide template is completely free to download in Word (DOCX), PDF, and Markdown formats. No signup or credit card required to download.
Q: How do I turn a video into a troubleshooting Guide?
A: Upload a process walkthrough, training recording, or screen capture to Docsie. The AI analyzes the video and generates a complete troubleshooting Guide using this template's structure — every required field auto-filled from the footage.
Q: Can I edit the troubleshooting guide template after downloading?
A: Yes. The DOCX format opens in Microsoft Word or Google Docs. The Markdown format imports into Notion, Confluence, Docsie, or any markdown editor. Customize fields, add your branding, and adapt to your internal workflow.