Goal
A tech-writer subagent generates README sections, ADRs, ARCHITECTURE.md, and inline code comments from diffs and conversation context, matching the existing documentation tone.
Motivation
Documentation is consistently the last thing written and the first to drift. No current agent specializes in generating or maintaining documentation. The reviewer flags missing docs but does not generate them. A dedicated tech-writer agent that reads diffs and produces tone-matched documentation would close this gap.
Surface
Sketch (optional)
File: agents/tech-writer.md
Scope:
- README section generation (installation, usage, configuration, contributing)
- Architecture Decision Record (ADR) drafting from design discussions
ARCHITECTURE.md / OVERVIEW.md from codebase structure- Inline comment generation for non-obvious logic
- Style-aware: reads existing docs to match tone, vocabulary, and heading conventions
Out of scope: API reference generation from type signatures (that's a formatter concern).
Acceptance (optional)
Goal
A
tech-writersubagent generates README sections, ADRs, ARCHITECTURE.md, and inline code comments from diffs and conversation context, matching the existing documentation tone.Motivation
Documentation is consistently the last thing written and the first to drift. No current agent specializes in generating or maintaining documentation. The
reviewerflags missing docs but does not generate them. A dedicated tech-writer agent that reads diffs and produces tone-matched documentation would close this gap.Surface
Sketch (optional)
File:
agents/tech-writer.mdScope:
ARCHITECTURE.md/OVERVIEW.mdfrom codebase structureOut of scope: API reference generation from type signatures (that's a formatter concern).
Acceptance (optional)
agents/tech-writer.mdexists with valid frontmatter and tools listscripts/validate.pypassesplugin.json