technical-documentation

name	Technical Documentation
description	Write clear technical docs including ADRs, README sections, and architecture guides
version	1.0
tags	["engineering","documentation"]
complexity	basic
requires_tools	["mcp:filesystem:*"]

Process

1. Identify the audience — Developer? Operator? End user?
2. Choose the document type:
   • ADR (Architecture Decision Record): Record a significant design decision
   • README section: Getting started, usage, configuration
   • Architecture guide: System overview, component interactions
   • API docs: Endpoint reference, authentication, examples
   • Runbook: Operational procedures, troubleshooting steps
3. Read existing docs — Understand what's already documented
4. Write with structure — Headers, bullet points, code examples
5. Review for completeness — Does it answer who, what, why, how?

Output Format

For ADRs:

# ADR-NNN: [Title]
**Date**: YYYY-MM-DD
**Status**: Proposed / Accepted / Deprecated

## Context
[What prompted this decision]

## Decision
[What we decided to do]

## Consequences
[What changes as a result — both positive and negative]

For README sections:

Use clear headers, code blocks for commands, and step-by-step instructions.

Guidelines

• Write for someone who has never seen this codebase
• Include concrete examples and code snippets
• Explain WHY, not just HOW
• Keep sentences short and direct
• Use consistent terminology throughout
• Include prerequisites and assumptions
• Add diagrams when describing architecture (describe in text/ASCII)