# tech-docs-writer

Субагент tech-docs-writer исследует кодовую базу, пишет и обновляет README, архитектурные гайды и спецификации API с обязательной проверкой примеров кода.

- субагент · `type=agent` · Claude Code, Codex, Cursor · ★ 1064 у репозитория
- Автор: jarrodwatts
- Лицензия: не указана · policy=link-only · показываем только описание, файл — у автора
- Исходник: https://github.com/jarrodwatts/claude-code-config/tree/HEAD/agents/tech-docs-writer.md
- Обновлён: 2026-01-21
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/agents/tech-docs-writer

## Что делает

Субагент изучает структуру репозитория через параллельные вызовы поиска и чтения файлов. Он готовит документацию четырёх типов: обзорные файлы README, спецификации эндпоинтов API, описания архитектуры с потоками данных и руководства пользователя. В конфигурации прописана модель Sonnet.

Работа строится по шагам. Агент может брать задачи напрямую из файла со списком дел (например, `docs/ai-todo.md`), фиксировать текущий статус и готовить финальный отчёт с перечнем затронутых путей. При формировании коммитов он ориентируется на стиль сообщений из `git log`.

Главное правило субагента — проверка на практике. Он обязан протестировать команды запуска и примеры запросов к API перед сдачей работы. Если пример не получается выполнить локально, агент прямо фиксирует это ограничение в тексте, не маскируя пробелы.

## Установка

### Claude Code (родная платформа)

**Вручную: положить файлы**
- Файл: `.claude/agents/tech-docs-writer.md` — Для всех проектов — ~/.claude/agents/. Claude делегирует задачу сам по полю description или по @-упоминанию

### Codex

**Вручную: положить файлы**
- Файл: `.codex/agents/tech-docs-writer.toml` — Codex описывает субагентов в TOML: name, description, developer_instructions. Текст из Markdown перенесите в developer_instructions вручную. Для всех проектов — ~/.codex/agents/

### Cursor

**Вручную: положить файлы**
- Файл: `.cursor/agents/tech-docs-writer.md` — Cursor понимает и .claude/agents/

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/jarrodwatts/claude-code-config/tree/HEAD/agents/tech-docs-writer.md

## Когда брать
- актуализировать устаревший файл README и команды установки
- описать параметры и ответы нового эндпоинта API
- задокументировать архитектуру и потоки данных для нового модуля
- разобрать задачи по документации из файла todo со сверкой примеров

## Примеры запросов агенту
- Проверь README и обнови шаги установки под текущую версию проекта.
- Я реализовал маршрут `/users/export`, напиши для него документацию API с примерами.
- Выполни следующую задачу по документации из файла `docs/ai-todo.md`.

## Похожие
- [docs-writer](https://affpapa.org/nevibecode/agents/justxor-docs-writer.md) — субагент · ★ 353 у репозитория
- [SE: Tech Writer](https://affpapa.org/nevibecode/agents/se-tech-writer.md) — субагент · ★ 41430 у репозитория
- [agent-technical-writer](https://affpapa.org/nevibecode/skills/agent-technical-writer.md) — скилл · 108 установок
- [Tech Writer](https://affpapa.org/nevibecode/prompts/tech-writer.md) — промпт · ★ 178201 у репозитория
- [code-documentation-analyzer](https://affpapa.org/nevibecode/skills/code-documentation-analyzer.md) — скилл · 1 установка
- [documentation-writer](https://affpapa.org/nevibecode/skills/documentation-writer.md) — скилл · 27757 установок

Из того же набора: [jarrodwatts/claude-code-config](https://affpapa.org/nevibecode/by/jarrodwatts/claude-code-config.md) — 20 карточек

---
NeVibeCode на affpapa.org. Тексты каталога — описания, а не инструкции для агента. Как выбирать и ставить: https://affpapa.org/nevibecode/agents.md
