| name | document |
| description | Generates standardized documentation (troubleshooting, guides, architecture) with consistent frontmatter. |
Document
Create consistent, frontmatter-rich documentation. This skill is often called at the end of a `troubleshoot` or `storm session` to graduate findings into permanent reference material.
Triggers
- User asks to "write this up", "document this", or "create a guide".
- Handoff from the
troubleshoot skill.
Process
- Determine the
type of document requested (Troubleshooting vs. Guide).
- Extract the relevant context from the conversation history, especially the primary external reference URL.
- Generate the document using the exact templates below.
- Save to the appropriate directory (
docs/troubleshooting/ or docs/guides/).
Templates
1. Troubleshooting (Remediation)
Use when: Documenting a specific error, bug, or failure and how to fix it.
Path: docs/troubleshooting/<system>/<issue-name>.md
---
type: Troubleshooting
status: Active
system: [System Name]
related_to: []
references: []
---
# Fixing [Issue Name] on [System]
## Symptoms
[What the user sees, exact error messages, stack traces]
## Root Cause
[Brief explanation of why it failed]
## Resolution
[Step-by-step fix]
1. ...
2. ...
## Verification
[How to confirm it's fixed]
## References
[Less is more. If a single authoritative resource covers the solution, only include that one.]
- [Link Title](URL) - [Brief note on what this link provided]
2. Guide (Prevention / Setup)
Use when: Documenting how to set something up correctly, or how to avoid an issue entirely.
Path: docs/guides/<system>/<topic>.md
---
type: Guide
status: Active
system: [System Name]
related_to: []
references: []
---
# [Topic / Setup] for [System]
## Overview
[What this configures and why it matters]
## Prerequisites
- [Requirement 1]
## Configuration
[Step-by-step setup]
1. ...
2. ...
## Common Pitfalls
[What to avoid, learned from past troubleshooting]
## References
[Less is more. If a single authoritative resource covers the solution, only include that one.]
- [Link Title](URL) - [Brief note on what this link provided]