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

update-docs · sangrokjung — команда для Claude Code: что делает и как установить

Команда update-docs пересобирает docs/CONTRIB.md и docs/RUNBOOK.md из package.json и .env.example и заодно показывает, какие файлы в docs устарели.

MIT ★ 880 обновлён 2026-09-03

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

Что делает 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/

Вопросы об 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 от других авторов.

update-docs davila7 Слэш-команда update-docs проходит по specs/, CLAUDE.md и README.md, отмечает выполненное и обновляет проценты готовности проекта. CX Codex +1 3 861установок update-project-docs hoangsonww Скилл update-project-docs для Claude Code обновляет документацию после изменений кода, конфигурации, API, БД или интерфейсов. Агент запускает его при изменении env-переменных, хуков, событий, WebSocket-сообщений и CLI-команд. CX Codex +1 ★ 1 198звёзд репо gsd-docs-update open-gsd Скилл gsd-docs-update для Claude Code создаёт и обновляет документацию по фактическому состоянию кодовой базы. Запускается для проверки существующих документов или полной генерации. CX Codex +1 576установок dev-docs-update diet103 Команда dev-docs-update сохраняет состояние разработки перед сбросом контекста: обновляет документацию задач, память и заметки для передачи работы. CX Codex +1 ★ 10 055звёзд репо update-docs-on-code-change официальный github Правило update-docs-on-code-change для GitHub Copilot, которое обновляет README.md и другие файлы документации при изменении кода. Срабатывает, когда новые функции, изменения API или зависимостей требуют правок в описаниях. CX Codex +1 ★ 41 430звёзд репо skillshare-update-docs runkids Скилл skillshare-update-docs синхронизирует документацию проекта skillshare с кодом на Go и сверяет флаги CLI с исходниками. Пригодится после добавления новых команд или опций. CX Codex +1 ★ 3 269звёзд репо load_ai_docs disler Команда load_ai_docs для Claude Code скачивает документацию AI-платформ и сохраняет её в Markdown-файлы для контекста агентов. Даёт субагентам актуальную справку без постоянного обращения к интернету. CX Codex +1 ★ 1 573звёзд репо

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

Весь набор →
test-coverage Команда test-coverage прогоняет тесты с отчётом покрытия, находит файлы ниже 80% и дописывает недостающие юнит-, интеграционные и E2E-тесты. CX Codex +1 ★ 880звёзд репо build-fix Команда build-fix по очереди находит и правит ошибки сборки TypeScript. Она запускает npm или pnpm, показывает контекст кода и проверяет исправление повторным билдом. CX Codex +1 ★ 880звёзд репо update-codemaps Команда update-codemaps для Claude Code анализирует структуру проекта и обновляет архитектурные карты в codemaps/. Синхронизирует документацию при изменениях кода. CX Codex +1 ★ 880звёзд репо testing Правило testing задаёт строгий TDD-процесс для Claude Code: планку покрытия от 80%, три уровня проверок и сценарии Playwright. CX Codex +1 ★ 880звёзд репо refactor-clean Команда refactor-clean ищет мёртвый код, предлагает безопасное удаление и проверяет тесты до и после каждого изменения. CX Codex +1 ★ 880звёзд репо date-calculation Правило date-calculation запрещает ассистенту считать даты в уме и заставляет вызывать системные утилиты вроде date или python3. Страхует от ошибок при вычислении дней недели, високосных годов и интервалов. CX Codex +1 ★ 880звёзд репо korean-character-count Скилл korean-character-count считает символы, строки и байты корейского текста по правилам графемных кластеров — для самопрезентаций и форм с лимитами. CX Codex +1 ★ 880звёзд репо loop-forge Команда loop-forge превращает краткое описание рутинного действия в готовую слэш-команду с проверками безопасности и точками остановки. CX Codex +1 ★ 880звёзд репо

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

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