audit-repo-docs — команда для Claude Code: аудит документации
Команда audit-repo-docs проверяет документацию репозитория по 30 критериям и выдаёт отчёт с оценкой и списком улучшений. Пригодится, чтобы найти пробелы в README, структуре docs и автоматизации.
CC-BY-SA-4.0 ★ 6 529 обновлён 2026-10-22
.claude/commands/audit-repo-docs.mdЧто делает 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/
Вручную: положить файлы
~/.codex/prompts/audit-repo-docs.mdВызов — /prompts:audit-repo-docs. В Codex этот формат помечен устаревшим, замена — скиллы
Вручную: положить файлы
.github/prompts/audit-repo-docs.prompt.mdВручную: положить файлы
.gemini/commands/audit-repo-docs.tomlGemini хранит команды в TOML: текст запроса — в поле prompt
Вопросы об audit-repo-docs
Как установить audit-repo-docs в Claude Code?
Сохраните команду в файл .claude/commands/audit-repo-docs.md.
Что делает audit-repo-docs?
Проверяет документацию репозитория по 30 критериям и формирует отчёт с оценками и рекомендациями. Проверка охватывает корневые файлы, структуру, автоматизацию и качество документации.
Что произойдёт при запуске с --generate?
Команда перечислит недостающие файлы и спросит, создавать ли их. После подтверждения она создаст выбранные файлы по шаблонам.