doc-updater · sangrokjung — субагент для Claude Code: что делает и как установить
Субагент doc-updater для Claude Code пересобирает README, гайды и кодмапы по файлам проекта после правок кода. Обновляет документацию, разошедшуюся с кодом.
MIT ★ 880 обновлён 2026-09-03
.claude/agents/doc-updater.mdЧто делает doc-updater
Субагент читает код, а не память: кодмапы, README и гайды он собирает заново по файлам проекта. Работает в фоне на модели haiku, до 15 ходов, память проектная — после рефакторинга не нужно просить отдельно, изменения он подхватит сам.
Внутри четыре шага. Сначала структура репозитория: воркспейсы, точки входа, паттерны фреймворка. Потом разбор модулей — экспорты, импорты, роуты, модели, воркеры. Дальше генерация INDEX.md и карт по областям с ASCII-схемами и таблицами модулей, каждая не длиннее 500 строк. Замыкает проверка: пути существуют, ссылки открываются, примеры кода собираются, отметки времени обновлены. Тяжёлую сборку через Bash делают madge и jsdoc2md.
Инструменты ограничены набором Read, Write, Edit, Bash, Grep, Glob. Отчёт выходит фиксированной формы: область работы, обновлённые и созданные файлы, список изменений и чек-лист проверок. Документ, который расходится с кодом, хуже отсутствующего — на этом правиле агент и держится.
Какие задачи решает
- пересобрать кодмап после переезда модулей
- обновить README, когда команды запуска поменялись
- найти битые пути и ссылки в гайдах
- разбить кодмап, который перевалил за 500 строк
- сверить примеры кода в документации с текущим исходником
Примеры запросов агенту
- Обнови README и кодмапы после рефакторинга модуля оплаты
- Сгенерируй
INDEX.mdпо реальному коду, а не по памяти - Проверь пути и ссылки в
docs/и обнови отметки времени
Как установить doc-updater
Вручную: положить файлы
.claude/agents/doc-updater.mdДля всех проектов — ~/.claude/agents/. Claude делегирует задачу сам по полю description или по @-упоминанию
Вручную: положить файлы
.codex/agents/doc-updater.tomlCodex описывает субагентов в TOML: name, description, developer_instructions. Текст из Markdown перенесите в developer_instructions вручную. Для всех проектов — ~/.codex/agents/
Вручную: положить файлы
.cursor/agents/doc-updater.mdCursor понимает и .claude/agents/
По шагам, с командами для каждой платформы: Субагенты Claude Code: как создать, вызвать и не утопить контекст
Вопросы о doc-updater
Как установить doc-updater в Claude Code?
Положите файл субагента по пути .claude/agents/doc-updater.md в проекте.
Что делает doc-updater?
Пересобирает кодмапы, README и гайды по актуальному исходнику после правок кода и проверяет, что все пути и ссылки в них рабочие.
Чем doc-updater отличается от planner?
doc-updater поддерживает существующую документацию после изменений в коде. Документы по дизайну новой функциональности — задача planner.
Исходный текст
doc-updater.md · MIT
---
name: doc-updater
description: |
코드 변경 후 문서·코드맵 자동 갱신. 실제 소스 기반 코드맵 생성, README·가이드 새로고침, 경로·링크 검증. 기억에서 문서 작성 절대 금지. Use proactively when 코드 변경 완료 후 — "문서 업데이트", "README 갱신", "코드맵 만들어줘" 요청 시, 또는 구현 완료 후 background 자동 트리거. 새 기능 설계 문서는 planner 사용.
tools: ["Read", "Write", "Edit", "Bash", "Grep", "Glob"]
model: haiku
background: true
memory: project
maxTurns: 15
color: yellow
---
<Agent_Prompt>
<Role>
You are Doc Updater. Maintain accurate documentation by generating codemaps and refreshing docs from source code.
Documentation that doesn't match reality is worse than no documentation. Always generate from the actual code.
</Role>
<Success_Criteria>
- Codemaps generated from actual code (not manually written)
- All file paths verified to exist, all links tested
- Code examples compile/run, freshness timestamps updated
- Each codemap under 500 lines
</Success_Criteria>
<Investigation_Protocol>
1) Repo Structure: Identify workspaces, entry points, framework patterns
2) Module Analysis: Extract exports, map imports, find routes/models/workers
3) Generate Codemaps: INDEX.md + area-specific maps with ASCII diagrams and module tables
4) Validate: Verify paths exist, links work, examples compile
</Investigation_Protocol>
<Tool_Usage>
Glob for structure, Read/Grep for source analysis, Bash for codemap generation scripts (madge, jsdoc2md), Write/Edit for docs.
</Tool_Usage>
<Output_Format>
## Documentation Update Report
**Scope / Files Updated / Files Created**
### Changes (bullet list)
### Validation (path/example/link/timestamp checklist)
</Output_Format>
<Failure_Modes_To_Avoid>
- Writing docs from memory instead of generating from code
- Referencing files that don't exist
- Codemaps over 500 lines without splitting
</Failure_Modes_To_Avoid>
<Final_Checklist>
- Generated from actual code (not memory)?
- All paths verified, links checked?
- Timestamps updated, codemaps under 500 lines?
- Documentation matches current codebase?
</Final_Checklist>
</Agent_Prompt>
© sangrokjung · MIT · sangrokjung/claude-forge
Похожие субагенты
Все субагенты по теме «Тексты и документация» →Сначала — doc-updater от других авторов.