Troubleshooting Guide Template

Template

= Troubleshooting: [Device/System Name]
:description: Troubleshooting guide for [device/system]
:category: hardware / software / network / peripheral
:revdate: YYYY-MM-DD

== Quick Reference

[cols="1,2"]
|===
| Field | Value

| Device/System
| [Name, model, version]

| Environment
| [OS, connection type, related systems]

| Common Symptoms
| [Brief list of what goes wrong]

| Success Criteria
| [How you know it's fixed]
|===

== Symptom → Solution Matrix

[cols="2,3,2"]
|===
| Symptom | Likely Cause | Solution

| [Symptom 1]
| [Cause]
| <<solution-1>>

| [Symptom 2]
| [Cause]
| <<solution-2>>

| [Symptom 3]
| [Cause]
| <<solution-3>>
|===

== Solutions

[#solution-1]
=== Solution 1: [Name]

**When to use:** [Symptom description]

**Steps:**

1. Step 1
+
```bash
command
```
+
Expected: [output]

2. Step 2

3. Verify fix:
+
```bash
verification command
```

[#solution-2]
=== Solution 2: [Name]

...

== Diagnostic Commands

=== Check Status

```bash
# Command to check current state
```

=== View Logs

```bash
# Command to view relevant logs
```

=== Test Connectivity

```bash
# Command to test connection/functionality
```

== Prevention

* [ ] Preventive measure 1
* [ ] Preventive measure 2
* [ ] Monitoring/alerting to add

== Related

* Link to vendor documentation
* Link to related troubleshooting guides
* Link to incident reports using this guide

== Changelog

[cols="1,2,2"]
|===
| Date | Change | Reason

| YYYY-MM-DD
| Initial creation
| [Incident that prompted this guide]
|===

Guide Principles

1. Symptom-First Organization

Users search by "what’s broken", not "what command to run". Start with symptoms.

2. Copy-Paste Ready

Every command should be copy-paste ready with: - Expected output documented - Verification step included

3. Progressive Complexity

Order solutions from: 1. Quick fixes (restart, reconnect) 2. Configuration changes 3. Reinstall/reset 4. Hardware replacement

4. Root Cause Capture

Every time you use this guide, add new symptoms/solutions discovered.

Categories

Category Examples

Hardware

Keyboards, mice, monitors, docks

Peripherals

Bluetooth devices, USB, audio

Network

WiFi, Ethernet, VPN

Software

Applications, services, drivers

System

Boot, performance, storage