writer
A Domain agent that writes user documentation, migration notes, and change summaries.
Overview
The writer agent writes text, not code. User guides, API documentation, migration notes, and release change summaries are its main work. Once implementation is done, explaining it clearly is this agent's domain.
When to use
- After a feature is implemented, when user documentation or API reference needs to be written
- When a release with breaking changes needs a migration guide
- When changes need to be organized in language that users can understand
- When release note writing is needed in the
$releaseskill
Examples
"Write a migration guide for these API changes"
"Write a user guide for the new authentication feature"
"Create migration notes for upgrading from v2 to v3"Scope of work
| Item | Description |
|---|---|
| User guides | Feature descriptions, usage examples, configuration instructions |
| API documentation | Endpoints, parameters, response examples |
| Migration notes | Breaking change list, upgrade procedures |
| Release notes | Change summary, key feature announcements |
Process
- Understand the feature or change to document.
- Confirm who the audience is (developers, end users, etc.).
- Write clear, practical content with usage examples.
- Use technical terms accurately and keep explanations concrete.
Inputs
- Description of the feature or change to document
- Code or API spec implemented by
executor - Target audience and documentation purpose
Outputs
- User guide or API reference document
- Migration guide or release notes
- Practical explanations with code examples
Limits
- Code implementation is handled by
executor. - External documentation research is deferred to
researcher. - Security or performance judgments use the relevant reviewer agents.
Related agents
- executor — handles the implementation that writer documents.
- researcher — researches external references and official docs to support writer.
- product-manager — determines the scope and direction of documentation work.