Skip to content

Free Planning Template

Free Troubleshooting Guide

How to resolve [problem]

Symptom Description Possible Causes Diagnostic Steps Solutions Escalation Path Prevention

Troubleshooting Guide

Use this template to how to resolve [problem].

Template Metadata

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]

Symptom Description

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]

Notes

[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]

Possible Causes

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]

Notes

[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]

Diagnostic Steps

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]

Notes

[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]

Solutions

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]

Notes

[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]

Escalation Path

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]

Notes

[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]

Prevention

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]

Notes

[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]

Review and Signoff

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

What the Troubleshooting Guide Includes

Use this planning template as a starting point, then customize each section to match your internal workflow, evidence, and signoff needs.

1

Symptom Description

Describe the problem as users experience it. Include error messages.

2

Possible Causes

List causes in order of probability.

3

Diagnostic Steps

Systematic approach to identify root cause. Start with simplest checks.

4

Solutions

Step-by-step fix for each identified cause.

5

Escalation Path

When and how to escalate.

6

Prevention

Steps to prevent recurrence. Use code blocks for commands and error messages.

Recommended Structure

Write a Troubleshooting Guide in a clear, diagnostic tone. Structure with:

Symptom Description

Describe the problem as users experience it. Include error messages.

Possible Causes

List causes in order of probability.

Diagnostic Steps

Systematic approach to identify root cause. Start with simplest checks.

Solutions

Step-by-step fix for each identified cause.

Escalation Path

When and how to escalate.

Prevention

Steps to prevent recurrence.

Use code blocks for commands and error messages.

Example Filled Template

Troubleshooting: "Connection Timed Out" Errors in Dashboard

Symptom Description

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"

Possible Causes

  1. Database query timeout (most likely) — The dashboard query exceeds the 30s timeout
  2. API server resource exhaustion — Too many concurrent requests consuming all workers
  3. Network connectivity — Intermittent connectivity between API server and database
  4. Data volume spike — Sudden increase in data volume causing slower queries

Diagnostic Steps

Step 1: Check API Server Health

curl -s https://api.internal/health | jq '.status'
# Expected: "ok"
# If not "ok": Go to Solution B

Step 2: Check Slow Query Log

kubectl logs deploy/api-server --since=10m | grep "SLOW_QUERY"
# If slow queries found: Go to Solution A

Step 3: Check Database Connections

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

Solutions

Solution A: Optimize Slow Query

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.

Solution B: Restart API Workers

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

Prevention

  • Add a database query timeout of 10s (fail fast instead of hanging)
  • Set up monitoring alert for queries exceeding 5s
  • Schedule weekly ANALYZE on high-traffic tables
Skip Manual Drafting

Generate a Troubleshooting Guide from a Video

Record a walkthrough, training session, or process demonstration. Docsie AI turns it into structured documentation using this template as the starting framework.

Use the template manually, or let Docsie generate the first draft from source footage.

DOCX, PDF, and Markdown downloads
Works with process and training videos

Template FAQ

Troubleshooting Guide FAQ

Common questions about using and generating a troubleshooting Guide.

Using This Template

Q: What is a troubleshooting Guide?

A: A troubleshooting Guide is a structured document for how to resolve [problem].

Q: Can I download this troubleshooting Guide as Word or PDF?

A: Yes. This page includes free downloads in DOCX, PDF, and Markdown formats so you can edit, share, or import the template into your documentation system.

Q: Can Docsie generate this from a video?

A: Yes. Upload a process walkthrough, training recording, or screen capture to Docsie, then use this template structure to generate a first draft automatically.