К основному содержанию
субагент CX Codex

docs-writer · justxor — субагент Claude Code: обновление документации после кода

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

MIT ★ 353 обновлён 2026-10-01

Установить в Claude Code · Вручную: положить файлы Все способы и платформы ↓
.claude/agents/docs-writer.md
Открыть на GitHub

Что делает 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 или по @-упоминанию

По шагам, с командами для каждой платформы: Субагенты 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 от других авторов.

docs-writer CloudAI-X Субагент docs-writer читает код перед тем, как писать или обновлять документацию. Подключайте его для README, описаний API и инструкций к изменениям кода. CX Codex ★ 1 424звёзд репо docs-writer alirezarezvani Субагент docs-writer для Claude Code и Cursor готовит API-документацию, руководства пользователя и архитектурные описания по кодовой базе. CX Codex ★ 788звёзд репо tech-docs-writer jarrodwatts Субагент tech-docs-writer исследует кодовую базу, пишет и обновляет README, архитектурные гайды и спецификации API с обязательной проверкой примеров кода. CX Codex ★ 1 064звёзд репо code-documentation-analyzer Jeremy Longshore Автоактивируемый скилл для разбора документации кода: API-справочники, руководства пользователя, архитектурные описания. Включается по фразам вроде «code documentation analyzer» или «code analyzer». CX Codex +1 1установок documentation официальный anthropics Скилл documentation для Claude Code готовит README, справочники API, ранбуки, архитектурные документы и гайды для новичков. Включается, когда код уже есть, а описания нет. CX Codex +1 10 800установок gem-documentation-writer официальный github Субагент gem-documentation-writer для GitHub Copilot пишет техническую документацию, README, API-документацию и диаграммы. Он запускается по задаче на обновление документации или создание PRD. CX Codex +1 ★ 41 430звёзд репо docs sametcelikbicak Субагент docs для Claude Code готовит проектную документацию, описания API и списки изменений по артефактам сборки. Включается при оформлении релизов и обновлении README. CX Codex ★ 71звёзд репо

Из того же набора15

Весь набор →
review Скилл review проверяет изменения на уязвимости и секреты, а затем оформляет находки с уровнем риска и строкой в файле. Запускайте перед мерджем или по запросу на проверку безопасности. CX Codex +1 ★ 353звёзд репо fix-issue Скилл fix-issue для полного цикла исправления GitHub issue по номеру — от анализа и тестов до коммита. CX Codex +1 ★ 353звёзд репо test-runner Субагент test-runner запускает связанные с правками тесты, разбирает ошибки и отделяет баги в коде от устаревших проверок. CX Codex ★ 353звёзд репо debugger Субагент debugger в Claude Code воспроизводит ошибки и падающие тесты, ищет первопричину и проверяет исправление. Разбирает стектрейсы и неожиданные результаты. CX Codex ★ 353звёзд репо pr-description Скилл pr-description собирает заголовок и структурированное описание pull request по коммитам и диффу ветки относительно main. CX Codex +1 ★ 353звёзд репо architect Субагент architect для Claude Code изучает проект и предлагает варианты архитектуры с планом внедрения. Планирует архитектуру новых функций и крупных изменений. CX Codex ★ 353звёзд репо code-reviewer Субагент code-reviewer читает дифф перед коммитом или PR: ищет дыры в безопасности, пропущенные тесты и граничные случаи, отдаёт разбор по приоритетам. CX Codex ★ 353звёзд репо write-tests Скилл write-tests генерирует unit-тесты для указанного файла или функции, повторяя стиль тестов проекта. Запускает проверку и находит скрытые ошибки в коде. CX Codex +1 ★ 353звёзд репо

Спонсоры проекта

Компании, которые помогают держать аналитику открытой