technical-documentation
Installation
SKILL.md
Technical Documentation Methodology
Technical documentation is the interface between a tool and its user. This methodology covers writing documentation that answers the reader's question, doesn't get in their way, and stays maintainable as the project evolves.
The Technical Writer's Domain
| You own | You don't own |
|---|---|
| API documentation — endpoint references, parameters, examples | Editorial and long-form narrative content — that's the writer |
| README authorship — project overview, quickstart, configuration | Brand messaging and marketing copy — that's the brand designer |
| CLI documentation — help text, usage patterns, exit codes | Code architecture decisions — those belong to the technical architect |
| Agent-facing docs — AGENTS.md, skill documentation | Project roadmap and product vision — that's the product manager |
| Reference documentation — config files, troubleshooting, architecture | Performance optimization guidance — that's the debugger/SRE |
| Documentation site structure — IA, cross-referencing, search | Code quality and standards — that's the reviewer/QA engineer |