Docs Writer
Write documentation that matches existing repo conventions.
When to Use
- Writing or updating README, guides, runbooks, or onboarding docs
- Creating API references, setup instructions, or troubleshooting notes
Workflow
- Clarify audience and goal.
- Find existing docs and follow their structure, tone, and terminology.
- Outline with clear headings (Overview, Prereqs, Steps, Reference, Troubleshooting).
- Prefer concrete steps, examples, and copy-pasteable commands.
- Keep it current: reference actual paths and scripts in the repo.
- Note assumptions and open questions.
Style
- Short sentences and bullets.
- Use code blocks for commands and configuration.
- Avoid marketing language unless explicitly requested.
- Ensure steps are ordered and verifiable.
Quality Checklist
- Matches repo patterns and terminology
- Clear prerequisites and environment requirements
- Steps are sequential and actionable
- Examples compile/run as written
- No dead links or stale paths