tech-docs-writer — субагент для Claude Code: функции и установка
Субагент tech-docs-writer исследует кодовую базу, пишет и обновляет README, архитектурные гайды и спецификации API с обязательной проверкой примеров кода.
лицензия не указана ★ 1 064 обновлён 2026-01-21
.claude/agents/tech-docs-writer.mdЧто делает tech-docs-writer
Субагент изучает структуру репозитория через параллельные вызовы поиска и чтения файлов. Он готовит документацию четырёх типов: обзорные файлы README, спецификации эндпоинтов API, описания архитектуры с потоками данных и руководства пользователя. В конфигурации прописана модель Sonnet.
Работа строится по шагам. Агент может брать задачи напрямую из файла со списком дел (например, docs/ai-todo.md), фиксировать текущий статус и готовить финальный отчёт с перечнем затронутых путей. При формировании коммитов он ориентируется на стиль сообщений из git log.
Главное правило субагента — проверка на практике. Он обязан протестировать команды запуска и примеры запросов к API перед сдачей работы. Если пример не получается выполнить локально, агент прямо фиксирует это ограничение в тексте, не маскируя пробелы.
Какие задачи решает
- актуализировать устаревший файл README и команды установки
- описать параметры и ответы нового эндпоинта API
- задокументировать архитектуру и потоки данных для нового модуля
- разобрать задачи по документации из файла todo со сверкой примеров
Примеры запросов агенту
- Проверь README и обнови шаги установки под текущую версию проекта.
- Я реализовал маршрут
/users/export, напиши для него документацию API с примерами. - Выполни следующую задачу по документации из файла
docs/ai-todo.md.
Как установить tech-docs-writer
Вручную: положить файлы
.claude/agents/tech-docs-writer.mdДля всех проектов — ~/.claude/agents/. Claude делегирует задачу сам по полю description или по @-упоминанию
Вручную: положить файлы
.codex/agents/tech-docs-writer.tomlCodex описывает субагентов в TOML: name, description, developer_instructions. Текст из Markdown перенесите в developer_instructions вручную. Для всех проектов — ~/.codex/agents/
Вручную: положить файлы
.cursor/agents/tech-docs-writer.mdCursor понимает и .claude/agents/
По шагам, с командами для каждой платформы: Субагенты Claude Code: как создать, вызвать и не утопить контекст
Вопросы о tech-docs-writer
Как установить tech-docs-writer в Claude Code?
Разместите файл субагента по пути .claude/agents/tech-docs-writer.md в проекте. После этого Claude Code сможет подключать его для инженерных текстов.
Что делает субагент tech-docs-writer?
Он анализирует исходный код и создаёт технические тексты: справочники API, архитектурные заметки, обучающие руководства и описания репозиториев.
Какую языковую модель использует агент?
В метаданных агента явно задана модель Sonnet. Она отвечает за глубокий разбор логики и форматирование итоговых markdown-файлов.