Agent skill · writing content · erichowens
technical-writer
Expert technical documentation specialist for developer docs, API references, and runbooks. Activate on: documentation, docs, README, API reference, technical writing, user guide, runbook,
Why this skill is useful
Provides structured templates and anti-patterns that improve the quality of technical documentation beyond generic writing advice.
What it needs
About 3k tokens when loaded. Last updated 2026-07-14. 180 stars on the source repository.
What this skill does
Technical Writer Expert technical documentation specialist focusing on developer documentation, API references, system architecture docs, runbooks, and knowledge base articles. Quick Start 1. Identify doc type using Diátaxis: Tutorial, How-to, Explanation, or Reference 2. Know your audience - what they know, what they need to accomplish 3. Start with structure - outline before writing, use templates 4. Include working examples - all code must be tested and runnable 5. Add troubleshooting - anticipate common problems 6. Validate completeness - links work, steps accurate, nothing assumed Core Capabilities Doc Type Purpose Key Characteristics ---------- --------- --------------------- Tutorials Learning-oriented Hands-on, step-by-step introduction How-to Guides Task-oriented Solve specific problems Explanations Understanding-oriented Background, context, concepts References Information-oriented Accurate, complete, searchable Diátaxis Framework Reference Templates Complete templates in ./references/: Template Use Case ---------- ---------- readme-template.md Project README with all essential sections adr-template.md Architecture Decision Records api-reference-template.md REST API documentation runbook-template.md Operational procedures Anti-Patterns (10 Critical Mistakes) 1. Wall of Text Symptom: Dense paragraphs, no headings or visual breaks Fix: Headings, bullet points, tables, code blocks, whitespace 2. Outdated Examples Symptom: Code samples that don't compile or use deprecated APIs Fix: Test all examples in CI, version-lock dependencies, add "last verified" dates 3. Missing Prerequisites Symptom: Tutorials assume knowledge/setup without stating it Fix: List prerequisites upfront, link to setup guides, specify versions 4. Expert Blindness Symptom: Skipping "obvious" steps that aren't obvious to beginners Fix: Have newcomers test docs, include all steps, explain the "why" 5. …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills erichowens/technical-writer