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

docs-sync — команда для Claude Code: проверка актуальности документации

Команда docs-sync сравнивает свежие изменения кода с документацией и выявляет несоответствия. Помогает найти устаревшие примеры, неправильные сигнатуры API и несовпадения в типах параметров.

лицензия не указана ★ 6 091 обновлён 2026-01-06

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

Что делает docs-sync

docs-sync анализирует коммиты за последний месяц, ищет затронутые файлы и находит связанную документацию в /docs/, README рядом с кодом и комментариях TSDoc. Затем проверяет, совпадают ли примеры в документации с текущей реализацией, актуальны ли описания функций и типы свойств.

Команда работает с Git — получает список изменённых файлов через git log и сравнивает их с документацией. Выводит контрольный список того, что нужно обновить. Главное отличие от поиска просто всей документации: команда флагирует только реальные ошибки, не предлагает писать доки ради самих доков.

Какие задачи решает

  • найти устаревшие примеры кода в документации после рефакторинга
  • выявить несоответствие между API и его описанием
  • проверить, что типы параметров в доках совпадают с кодом
  • составить список документации, которую нужно обновить вслед за изменениями

Примеры запросов агенту

  • Проверь документацию на синхронизацию с кодом
  • Что нужно обновить в доках после моих правок?
  • Сравни docs с последними изменениями в коде

Как установить docs-sync

Вручную: положить файлы

.claude/commands/docs-sync.md

Вызов — /docs-sync. Для всех проектов — ~/.claude/commands/

Вопросы о docs-sync

Как установить docs-sync в Claude Code?

Скопируй файл docs-sync.md в папку .claude/commands/ вашего проекта.

Что делает docs-sync?

Находит код, изменённый за последний месяц, ищет относящуюся к нему документацию и проверяет, не устарела ли она. Выводит список того, что нужно обновить.

Какие файлы команда проверяет?

Анализирует TypeScript-файлы (*.ts, *.tsx), затем ищет документацию в папке /docs/, README рядом с изменённым кодом и TSDoc-комментарии в самих файлах.

Похожие слэш-команды

Все слэш-команды по теме «Код-ревью и рефакторинг» →
docs-sync-audit официальный github Скилл docs-sync-audit сверяет документацию с кодом и конфигурацией в режиме чтения. Пригодится после изменений в API, CLI, настройках или пользовательском сценарии. CX Codex +1 68установок sync FlorianBruniaux Команда sync проверяет согласованность данных между репозиторием руководства и промо-лендингом. Запускает аудит версий, числа файлов и вопросов. CX Codex +1 ★ 6 529звёзд репо docs-updater giuseppe-trisciuoglio Скилл docs-updater для Claude Code анализирует изменения Git и обновляет документацию проекта. Запускается при подготовке релиза, синхронизации README или перед pull request. CX Codex +1 3 700установок docs-curator First Fluke Субагент docs-curator, который следит за дрейфом документации и обновляет MD-файлы, когда код меняется. Ловит неработающие ссылки, предлагает патчи и держит docs/**/*.md в актуальном состоянии. CX Codex ★ 1 472звёзд репо update-project-docs hoangsonww Скилл update-project-docs для Claude Code обновляет документацию после изменений кода, конфигурации, API, БД или интерфейсов. Агент запускает его при изменении env-переменных, хуков, событий, WebSocket-сообщений и CLI-команд. CX Codex +1 ★ 1 198звёзд репо docs-guard amElnagdy Скилл docs-guard проверяет документацию, README и докстринги на соответствие коду проекта. Находит выдуманные сигнатуры и удаляет пустые формулировки. CX Codex +1 4 200установок

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

Весь набор →
pr-summary Команда pr-summary собирает изменения текущей ветки и оформляет черновик описания pull request с файлами, потенциальными breaking changes и планом тестирования. CX Codex +1 ★ 6 091звёзд репо onboard Команда onboard для систематической подготовки агента к работе над проектом. Исследует кодовую базу, задаёт уточняющие вопросы и записывает контекст, чтобы агент был готов к следующей сессии. CX Codex +1 ★ 6 091звёзд репо pr-review Команда pr-review запускает проверку пуллреквеста через GitHub CLI по чек-листу проекта и публикует структурированный разбор. CX Codex +1 ★ 6 091звёзд репо code-quality Команда code-quality проверяет TypeScript-код в указанной папке: запускает npm-проверки и собирает замечания по качеству. Подходит для ревью перед изменениями. CX Codex +1 ★ 6 091звёзд репо github-workflow Субагент github-workflow для Claude Code ведёт ветки, готовит коммиты по Conventional Commits и отправляет пулл-реквесты в GitHub. Он стандартизирует Git-операции в командной разработке. CX Codex ★ 6 091звёзд репо ticket Команда ticket для полного цикла работы с тикетом: от прочтения задачи в JIRA или Linear до создания PR с привязкой к тикету. Автоматизирует разбор требований, поиск кода и обновление статуса. CX Codex +1 ★ 6 091звёзд репо code-reviewer Субагент code-reviewer для Claude Code, который проверяет написанный или изменённый код на соответствие стандартам проекта, TypeScript strict mode и паттернам безопасности. CX Codex ★ 6 091звёзд репо systematic-debugging Скилл systematic-debugging задаёт четырёхэтапный протокол отладки с упором на первопричину бага. Скилл пригодится при расследовании падений тестов или внезапных сбоев рантайма без поверхностных правок. CX Codex +1 ★ 6 091звёзд репо

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

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