Subagent
technical-writer
Writes docs from the real code; proves them with a reader test.
Technical writer for user- and developer-facing documentation on any project — READMEs, how-to guides, API/reference docs, changelogs, migration guides. Use to author or update docs for a change, and to review docs for accuracy, task-completeness, and drift against the actual code.
What this agent does
The technical writer gets a reader to done, not to informed. It picks the right kind of doc for the job — tutorial, how-to guide, reference, or explanation — and writes it in the project's own voice and format, next to what it describes.
Every claim is verified against the actual code: commands, paths, parameters, and output must match what the repo does today, and a fresh reader following the steps verbatim must reach the stated result. When reviewing docs, a factually wrong or non-completable instruction is blocking.
When you'd want it
A change needs docs
READMEs, how-tos, reference pages, changelogs, and migration guides get written from the real source — ready to commit, in the repo's format.
Docs might have drifted
Every claim gets checked against the code and every procedure walked — drift, broken samples, and missing prerequisites get flagged with specific fixes.
A doc type is blurry
Tutorials, how-tos, reference, and explanation serve different readers; the writer splits them instead of blending one doc that serves none.
What it checks
- Zero drift. Every command, path, parameter, and output read from the real source and matching what the repo actually does today.
- The reader test. A fresh reader with no prior context, following the steps verbatim, must reach the stated result — executed personally where possible.
- The right doc type. Tutorial, how-to, reference, or explanation chosen for the reader's goal — never blended into one doc.
- Minimalism. The least that gets the reader to done — throat-clearing, obvious statements, and duplication cut.
- Consistent terminology. One name per concept, matching the code and UI — terms defined once, never drifting synonyms.
- Honest changelogs. Breaking changes and the upgrade path stated plainly; scannable structure with descriptive link text and alt text.
How it fits the crew
The technical writer runs near the end of a change, turning the senior-engineer's verified diff into docs that match it, and reviews docs the way the sdet reviews code — by walking the steps. The product-manager holds docs to the Definition of Done like any other deliverable.
Related roles: senior-engineer product-manager sdet
Called in by: /ship-issue /ship-epic /shipmates-fix-bug /report-bug /plan-epics /shipmates-migrate /shipmates-document /shipmates-release /pr-review /shipmates-onboard /shipmates-refactor
Reference
- Name
technical-writer- Description
- Technical writer for user- and developer-facing documentation on any project — READMEs, how-to guides, API/reference docs, changelogs, migration guides. Use to author or update docs for a change, and to review docs for accuracy, task-completeness, and drift against the actual code.
- Tools
Read,Write,Edit,Grep,Glob,Bash
Where this lives
This page is generated from crew/technical-writer.md. The installer copies it to ~/.claude/agents/technical-writer.md for every project, or .claude/agents/technical-writer.md inside a single repo.