# tech-docs-writer

tech-docs-writer explores unfamiliar codebases to generate and maintain technical documentation, README files, and API guides with verified code samples.

- subagent · `type=agent` · Claude Code, Codex, Cursor · ★ 1064 repo stars
- Author: jarrodwatts
- License: not stated · policy=link-only · description only; the file stays with the author
- Source: https://github.com/jarrodwatts/claude-code-config/tree/HEAD/agents/tech-docs-writer.md
- Updated: 2026-01-21
- Security check: automated, 2026-11-16 (text) — no signs of malicious code found.
- HTML: https://affpapa.org/en/nevibecode/agents/tech-docs-writer

## What it 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.

## Install

### Claude Code (native platform)

**Manually: put the files in place**
- File: `.claude/agents/tech-docs-writer.md` — For all projects use ~/.claude/agents/. Claude delegates by the description field or an @-mention

### Codex

**Manually: put the files in place**
- File: `.codex/agents/tech-docs-writer.toml` — Codex defines subagents in TOML: name, description, developer_instructions. Move the Markdown text into developer_instructions by hand. For all projects use ~/.codex/agents/

### Cursor

**Manually: put the files in place**
- File: `.cursor/agents/tech-docs-writer.md` — Cursor also reads .claude/agents/

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/jarrodwatts/claude-code-config/tree/HEAD/agents/tech-docs-writer.md

## When to use it
- 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
- 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.

## Similar
- [docs-writer](https://affpapa.org/en/nevibecode/agents/justxor-docs-writer.md) — subagent · ★ 353 repo stars
- [SE: Tech Writer](https://affpapa.org/en/nevibecode/agents/se-tech-writer.md) — subagent · ★ 41430 repo stars
- [agent-technical-writer](https://affpapa.org/en/nevibecode/skills/agent-technical-writer.md) — skill · 108 installs
- [Tech Writer](https://affpapa.org/en/nevibecode/prompts/tech-writer.md) — prompt · ★ 178201 repo stars
- [code-documentation-analyzer](https://affpapa.org/en/nevibecode/skills/code-documentation-analyzer.md) — skill · 1 install
- [documentation-writer](https://affpapa.org/en/nevibecode/skills/documentation-writer.md) — skill · 27757 installs

From the same set: [jarrodwatts/claude-code-config](https://affpapa.org/en/nevibecode/by/jarrodwatts/claude-code-config.md) — 20 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md
