tech-docs-writer — Claude Code subagent: what it does, how to install
tech-docs-writer explores unfamiliar codebases to generate and maintain technical documentation, README files, and API guides with verified code samples.
no license ★ 1,064 updated 2026-01-21
.claude/agents/tech-docs-writer.mdWhat tech-docs-writer does
This agent analyzes project code using concurrent search and file-reading tools. It structures developer documentation across four formats: introductory README files, API endpoint specifications, user guides, and architectural breakdowns detailing components and data flow. The configuration runs on the Sonnet model.
The workflow handles automated backlogs. The agent can ingest items from a markdown checklist such as docs/ai-todo.md, mark active progress, and output a completion report showing modified paths. When preparing commits, it inspects git log to match the project's historical style.
Verification is mandatory before closing any task. The agent executes documented commands and validates API payloads against the real codebase. If a snippet cannot be tested directly in the environment, it flags that limitation in the doc instead of guessing.
What it helps with
- update outdated setup instructions in a README
- document parameters and response payloads for new API endpoints
- explain system architecture and data flow for fresh modules
- complete queued documentation tasks from a markdown checklist
Example prompts for the agent
- Review our README and update the setup steps to reflect current code.
- I just finished the
/users/exportroute, please document this API endpoint with samples. - Work through the next pending task in
docs/ai-todo.mdand test the snippets.
How to install tech-docs-writer
Manually: put the files in place
.claude/agents/tech-docs-writer.mdFor all projects use ~/.claude/agents/. Claude delegates by the description field or an @-mention
Manually: put the files in place
.codex/agents/tech-docs-writer.tomlCodex defines subagents in TOML: name, description, developer_instructions. Move the Markdown text into developer_instructions by hand. For all projects use ~/.codex/agents/
Manually: put the files in place
.cursor/agents/tech-docs-writer.mdCursor also reads .claude/agents/
Step by step, with commands for each platform: Claude Code subagents: how to create one, call it and keep context clean
Questions about tech-docs-writer
How do I install tech-docs-writer in Claude Code?
Add the subagent definition to .claude/agents/tech-docs-writer.md in your repository. Claude Code will recognize the agent and invoke it for technical documentation tasks.
What does tech-docs-writer do?
It inspects code implementation details to author API references, architecture overviews, onboarding guides, and README files.
Which model powers tech-docs-writer?
The frontmatter specifies Sonnet as the underlying model for code investigation and documentation drafting.