Technical Writing Skill

Write high-quality technical documentation, README files, API docs, and developer guides.

When to use this skill

• Writing or updating README files
• Creating API documentation
• Writing developer guides
• Creating architecture decision records (ADRs)
• Updating AGENTS.md and skill files

Workflow

1. Understand audience — Developers, users, or stakeholders
2. Outline structure — Organize content logically
3. Write clearly — Use simple language, avoid jargon
4. Add examples — Code samples and use cases
5. Review and iterate — Get feedback and improve