docs-sync — команда для Claude Code: проверка актуальности документации
Команда docs-sync сравнивает свежие изменения кода с документацией и выявляет несоответствия. Помогает найти устаревшие примеры, неправильные сигнатуры API и несовпадения в типах параметров.
лицензия не указана ★ 6 091 обновлён 2026-01-06
.claude/commands/docs-sync.mdЧто делает docs-sync
docs-sync анализирует коммиты за последний месяц, ищет затронутые файлы и находит связанную документацию в /docs/, README рядом с кодом и комментариях TSDoc. Затем проверяет, совпадают ли примеры в документации с текущей реализацией, актуальны ли описания функций и типы свойств.
Команда работает с Git — получает список изменённых файлов через git log и сравнивает их с документацией. Выводит контрольный список того, что нужно обновить. Главное отличие от поиска просто всей документации: команда флагирует только реальные ошибки, не предлагает писать доки ради самих доков.
Какие задачи решает
- найти устаревшие примеры кода в документации после рефакторинга
- выявить несоответствие между API и его описанием
- проверить, что типы параметров в доках совпадают с кодом
- составить список документации, которую нужно обновить вслед за изменениями
Примеры запросов агенту
- Проверь документацию на синхронизацию с кодом
- Что нужно обновить в доках после моих правок?
- Сравни docs с последними изменениями в коде
Как установить docs-sync
Вручную: положить файлы
.claude/commands/docs-sync.mdВызов — /docs-sync. Для всех проектов — ~/.claude/commands/
Вручную: положить файлы
~/.codex/prompts/docs-sync.mdВызов — /prompts:docs-sync. В Codex этот формат помечен устаревшим, замена — скиллы
Вручную: положить файлы
.github/prompts/docs-sync.prompt.mdВручную: положить файлы
.gemini/commands/docs-sync.tomlGemini хранит команды в TOML: текст запроса — в поле prompt
Вопросы о docs-sync
Как установить docs-sync в Claude Code?
Скопируй файл docs-sync.md в папку .claude/commands/ вашего проекта.
Что делает docs-sync?
Находит код, изменённый за последний месяц, ищет относящуюся к нему документацию и проверяет, не устарела ли она. Выводит список того, что нужно обновить.
Какие файлы команда проверяет?
Анализирует TypeScript-файлы (*.ts, *.tsx), затем ищет документацию в папке /docs/, README рядом с изменённым кодом и TSDoc-комментарии в самих файлах.