Skip to main content
subagent CX Codex

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

Install into Claude Code · Manually: put the files in place All methods and platforms ↓
.claude/agents/tech-docs-writer.md
Open on GitHub

What 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/export route, please document this API endpoint with samples.
  • Work through the next pending task in docs/ai-todo.md and test the snippets.

How to install tech-docs-writer

Manually: put the files in place

.claude/agents/tech-docs-writer.md

For all projects use ~/.claude/agents/. Claude delegates by the description field or an @-mention

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.

Similar subagents

All subagents for Writing and docs →

From the same set20

The whole set →
rendering-content-visibility The rendering-content-visibility rule applies content-visibility: auto to long lists so off-screen items can wait before rendering. It fits message feeds and other scrollable collections. CX Codex +1 ★ 1,064repo stars rerender-dependencies rerender-dependencies — a Claude rule that keeps useEffect dependency arrays on primitives like user.id rather than whole objects, so an effect stops firing on every field change. CX Codex +1 ★ 1,064repo stars testing The testing rule sets conventions for TypeScript test files and the __tests__ directory. Use it to guide checks for success cases, failures, and edge conditions. CX Codex +1 ★ 1,064repo stars forge The forge rule configures Foundry workflows for Abstract and tells Claude Code to use the ZKsync mode for Solidity projects. CX Codex +1 ★ 1,064repo stars js-batch-dom-css js-batch-dom-css — a Claude rule that keeps the agent from writing styles one property at a time and pushes it toward a class or a single cssText string. CX Codex +1 ★ 1,064repo stars codebase-search codebase-search finds where a feature lives in your repo and hands back absolute paths plus a short explanation of the flow. CX Codex ★ 1,064repo stars media-interpreter media-interpreter — a subagent for working with PDFs, images, diagrams, and other binary formats. Extracts text, tabular data, and descriptions of visual content when standard file reading isn't an option. CX Codex ★ 1,064repo stars open-source-librarian The open-source-librarian subagent investigates open-source libraries and codebases, tracing implementations and linking to exact GitHub lines. Use it for source-level and change-history questions. CX Codex ★ 1,064repo stars

Project sponsors

Companies that keep this analytics open