docs-writer · justxor — субагент Claude Code: обновление документации после кода
Субагент docs-writer автоматически актуализирует README, API-документацию, комментарии и ADR когда вы меняете код. Проверяет фактическое поведение и держит примеры в синхронизации с реальностью.
MIT ★ 353 обновлён 2026-10-01
.claude/agents/docs-writer.mdЧто делает docs-writer
docs-writer читает изменения кода через git diff, находит затронутые документы и обновляет их, сохраняя стиль и структуру. Сначала переписывает «как сделать», потом объясняет устройство. Не трогает очевидное — добавляет ясность там, где она нужна: почему выбран тот или иной подход, какие ограничения, как расширить.
Внутри работают инструменты Read, Grep, Glob, Edit, Write, Bash — можно проверить примеры, запустив команды из документации. Модель Sonnet держит баланс между скоростью и качеством.
Какие задачи решает
- Синхронизировать README с изменениями API
- Обновить примеры в документации после рефакторинга
- Актуализировать комментарии и ADR в коде
- Проверить, что примеры в документации работают
Примеры запросов агенту
- Обнови документацию после моих изменений в коде
- Синхронизируй README и API-документацию с текущей версией
- Добавь комментарии и ADR для новой архитектуры базы данных
Как установить docs-writer
Вручную: положить файлы
.claude/agents/docs-writer.mdДля всех проектов — ~/.claude/agents/. Claude делегирует задачу сам по полю description или по @-упоминанию
Вручную: положить файлы
.codex/agents/docs-writer.tomlCodex описывает субагентов в TOML: name, description, developer_instructions. Текст из Markdown перенесите в developer_instructions вручную. Для всех проектов — ~/.codex/agents/
Вручную: положить файлы
.cursor/agents/docs-writer.mdCursor понимает и .claude/agents/
По шагам, с командами для каждой платформы: Субагенты Claude Code: как создать, вызвать и не утопить контекст
Вопросы о docs-writer
Как установить docs-writer в Claude Code?
Создай файл .claude/agents/docs-writer.md в корне проекта с конфигурацией субагента. Для других IDE: .codex/agents/docs-writer.toml (Codex) или .cursor/agents/docs-writer.md (Cursor).
Что делает docs-writer?
Смотрит на изменения кода, находит связанные документы (README, API-документацию, комментарии, ADR) и обновляет их, чтобы они описывали текущее поведение, а не устаревшее.
Нужно ли мне вручную проверять обновления документации?
Субагент запускает примеры и проверяет код, поэтому обновления фактические. Рекомендуется просмотр стиля — если проект держит документацию в особом формате, лучше подсказать это в первый раз.
Исходный текст
docs-writer.md · MIT
--- name: docs-writer description: Технический писатель. Используй для обновления README, документации API, комментариев и ADR после изменений кода. tools: Read, Grep, Glob, Edit, Write, Bash model: sonnet --- Ты технический писатель в команде разработки. Принципы: - Документация описывает **фактическое** поведение — проверяй по коду, запускай команды из примеров. - Кратко, с примерами. Сначала «как сделать», потом «как устроено». - Сохраняй стиль и структуру существующих документов. - Не документируй очевидное; документируй неочевидное и решения («почему»). При вызове: 1. Определи, какие изменения кода влияют на документацию (`git diff`). 2. Обнови затронутые документы. Не создавай новые файлы без необходимости. 3. Верни список изменённых документов и что именно обновлено.
© justxor · MIT · justxor/claude-code-pro-course
Похожие субагенты
Все субагенты по теме «Тексты и документация» →Сначала — docs-writer от других авторов.