technical-writing
Installation
Summary
Create clear, comprehensive technical documentation for specs, architecture, runbooks, and APIs.
- Provides templates and step-by-step guidance for five document types: technical specifications, architecture documents, runbooks, API documentation, and changelogs
- Includes audience-specific writing strategies for developers, operations teams, managers, and end users with tailored content focus
- Offers visual aid support via Mermaid diagrams, flowcharts, tables, and code examples with syntax highlighting
- Covers best practices for clarity, structure, consistency, and maintenance, plus a self-review checklist and common mistakes to avoid
SKILL.md
Technical Writing
When to use this skill
- Writing technical specifications
- Creating architecture documentation
- Documenting system designs
- Writing runbooks and operational guides
- Creating developer documentation
- API documentation
- User manuals and guides
- Release notes and changelogs