update-docs · sangrokjung — команда для Claude Code: что делает и как установить
Команда update-docs пересобирает docs/CONTRIB.md и docs/RUNBOOK.md из package.json и .env.example и заодно показывает, какие файлы в docs устарели.
MIT ★ 880 обновлён 2026-09-03
.claude/commands/update-docs.mdЧто делает update-docs
Команда читает два файла, на которых и так держится проект: package.json и .env.example. Из первого берётся секция scripts — из неё собирается таблица скриптов, описания подтягиваются из комментариев. Из второго — переменные окружения: что каждая делает и в каком формате её задавать.
На выходе два документа. В docs/CONTRIB.md попадает порядок разработки, список скриптов, настройка окружения и процедура тестов. docs/RUNBOOK.md получает выкладку, мониторинг с алертами, частые сбои и способы их чинить, откат. Отдельный шаг ищет в docs файлы, которых не касались 90+ дней, и выносит их списком на ручную проверку. Удалять она ничего не станет. В конце показывает сводку изменений.
Источник правды ровно один — package.json и .env.example. Если переменные у вас лежат в другом файле, в сгенерированных документах их не будет. Права у команды ограничены Read, Write, Glob и Bash.
Какие задачи решает
- собрать таблицу скриптов из
package.json, не переписывая её руками - задокументировать переменные из
.env.exampleс назначением и форматом - написать вводную страницу для нового участника команды
- держать процедуру отката записанной, а не в голове
- выловить в
docsфайлы, которые не трогали 90 дней
Примеры запросов агенту
- Запусти
/update-docsи перепишиdocs/CONTRIB.mdпод текущийpackage.json. - Обнови
docs/RUNBOOK.md: добавь новые переменные из.env.exampleи покажи, что изменилось. - Прогони
/update-docsи выведи список файлов вdocs, которые не меняли 90 дней.
Как установить update-docs
Вручную: положить файлы
.claude/commands/update-docs.mdВызов — /update-docs. Для всех проектов — ~/.claude/commands/
Вручную: положить файлы
~/.codex/prompts/update-docs.mdВызов — /prompts:update-docs. В Codex этот формат помечен устаревшим, замена — скиллы
Вручную: положить файлы
.github/prompts/update-docs.prompt.mdВручную: положить файлы
.gemini/commands/update-docs.tomlGemini хранит команды в TOML: текст запроса — в поле prompt
Вопросы об update-docs
Как установить update-docs в Claude Code?
Скопируйте файл команды в .claude/commands/update-docs.md. После этого она вызывается как /update-docs.
Что делает update-docs?
Собирает docs/CONTRIB.md и docs/RUNBOOK.md из package.json и .env.example, а затем показывает сводку изменений и список устаревших файлов.
Что команда считает устаревшей документацией?
Файлы в docs, которые не изменялись 90+ дней. Она только перечисляет их для ручной проверки, удалять не берётся.
Исходный текст
update-docs.md · MIT
--- description: Sync documentation from source-of-truth (package.json, .env.example) allowed-tools: Read, Write, Glob, Bash --- # Update Documentation Sync documentation from source-of-truth: 1. Read package.json scripts section - Generate scripts reference table - Include descriptions from comments 2. Read .env.example - Extract all environment variables - Document purpose and format 3. Generate docs/CONTRIB.md with: - Development workflow - Available scripts - Environment setup - Testing procedures 4. Generate docs/RUNBOOK.md with: - Deployment procedures - Monitoring and alerts - Common issues and fixes - Rollback procedures 5. Identify obsolete documentation: - Find docs not modified in 90+ days - List for manual review 6. Show diff summary Single source of truth: package.json and .env.example
© sangrokjung · MIT · sangrokjung/claude-forge
Похожие слэш-команды
Все слэш-команды по теме «Настройка агента: память, контекст, субагенты» →Сначала — update-docs от других авторов.