Symptom Description
Describe the problem as users experience it. Include error messages.
Free Planning Template
How to resolve [problem]
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
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.
Template FAQ
Common questions about using and generating a troubleshooting Guide.
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.