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

audit-repo-docs — команда для Claude Code: аудит документации

Команда audit-repo-docs проверяет документацию репозитория по 30 критериям и выдаёт отчёт с оценкой и списком улучшений. Пригодится, чтобы найти пробелы в README, структуре docs и автоматизации.

CC-BY-SA-4.0 ★ 6 529 обновлён 2026-10-22

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

Что делает audit-repo-docs

Команда просматривает файлы в корне репозитория, папки с документацией, машинно-читаемые материалы, скрипты и примеры. Затем оценивает документацию по 30 критериям в пяти категориях: корневые файлы, структура, машинно-читаемые данные, автоматизация и качество. В основе проверки — паттерны из руководства по Claude Code.

Обычный запуск создаёт Markdown-отчёт: в нём есть баллы, категории и перечни проблем по приоритету. Флаг --generate добавляет предложение создать недостающие файлы по шаблонам, но сначала команда запрашивает подтверждение. Оценка считается из максимума в 58 баллов и переводится в шкалу от 0 до 100; это разные шкалы, поэтому сравнивайте итоговые отчёты по процентной оценке.

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

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

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

  • Проверь документацию этого репозитория и создай Markdown-отчёт: /audit-repo-docs
  • Проведи аудит документации и предложи создать недостающие файлы: /audit-repo-docs --generate

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

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

.claude/commands/audit-repo-docs.md

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

Вопросы об audit-repo-docs

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

Сохраните команду в файл .claude/commands/audit-repo-docs.md.

Что делает audit-repo-docs?

Проверяет документацию репозитория по 30 критериям и формирует отчёт с оценками и рекомендациями. Проверка охватывает корневые файлы, структуру, автоматизацию и качество документации.

Что произойдёт при запуске с --generate?

Команда перечислит недостающие файлы и спросит, создавать ли их. После подтверждения она создаст выбранные файлы по шаблонам.

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

Все слэш-команды по теме «Тексты и документация» →
repo-skillopt objectivlabs Скилл repo-skillopt для Claude Code разбирает устройство репозитория и собирает спецификацию с опорой на файлы, конфиги и тесты. Активируется при просьбах объяснить кодовую базу, описать архитектуру, внести изменения или оценить риски. CX Codex +1 598установок index-repo SuperClaude-Org Команда index-repo анализирует структуру репозитория и создаёт PROJECT_INDEX.md и PROJECT_INDEX.json. Индекс помогает агенту изучать проект без чтения всех файлов при каждом запуске. CX Codex +1 ★ 23 950звёзд репо developer-docs-structure-audit Samuel Berthe Скилл developer-docs-structure-audit для Claude Code, Codex, Cursor и других сред проводит аудит информационной архитектуры документации. Находит страницы не на своём месте и пробелы в структуре по методологии Diátaxis. CX Codex +1 13 700установок repo-standardizer официальный github Скилл repo-standardizer для GitHub Copilot приводит в порядок настройки GitHub-репозитория: шаблоны, метки, CI и документацию. Запускается по просьбе подготовить новый репозиторий или привести в порядок существующий. CX Codex +1 33установок docs-sync-audit официальный github Скилл docs-sync-audit сверяет документацию с кодом и конфигурацией в режиме чтения. Пригодится после изменений в API, CLI, настройках или пользовательском сценарии. CX Codex +1 68установок auto-repo-setup daymade Скилл auto-repo-setup проверяет окружение репозитория, чинит настройку и защищает Git-операции. Пригодится перед работой, онбордингом или изменением хуков. CX Codex +1 534установок

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

Весь набор →
security-audit Команда security-audit для Claude Code и Codex проверяет безопасность проекта и настроек Claude Code. Находит секреты, уязвимости зависимостей и риски в конфигурации, затем выдаёт оценку и план исправлений. CX Codex +1 ★ 6 529звёзд репо update-infos-release Команда update-infos-release для Claude Code синхронизирует данные о новых версиях инструмента по файлам гайда, лендинга и MCP-сервера. Шаг смены версии самого руководства опционален. CX Codex +1 ★ 6 529звёзд репо self-assessment Скилл self-assessment для Claude Code проверяет знания по десяти темам Claude, определяет уровень и пробелы, затем составляет маршрут обучения с учётом зависимостей. CX Codex +1 ★ 6 529звёзд репо source-command-track-mentions Скилл source-command-track-mentions ищет внешние упоминания руководства Claude Code Ultimate Guide или портфолио автора в сети и заносит проверенные ссылки в каталог проекта. CX Codex +1 ★ 6 529звёзд репо source-command-audit-whitepapers Скилл source-command-audit-whitepapers проверяет вайтпейперы и карточки-конспекты на свежесть версии, паритет французской и английской копий и качество метаданных, ставит баллы каждому файлу. CX Codex +1 ★ 6 529звёзд репо audit-whitepapers Команда audit-whitepapers проверяет актуальность версий, синхронизацию переводов FR/EN и метаданные в whitepapers и карточках конспекта. CX Codex +1 ★ 6 529звёзд репо audit-agents-skills Команда audit-agents-skills для Claude Code и Codex проверяет качество агентов, скиллов и команд в проекте, оценивает их по критериям и определяет готовность к продакшену. CX Codex +1 ★ 6 529звёзд репо Claude Code Ultimate Guide MCP-сервер Claude Code Ultimate Guide даёт MCP-клиентам доступ к поиску по интерактивному руководству по Claude Code, системным шаблонам и инженерным паттернам. CX Codex +1 ★ 6 529звёзд репо

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

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