docs-review — скилл для Claude Code: проверка документации
Скилл проверяет изменения в markdown-документации на соответствие стайлгайду Metabase и выдаёт нумерованный список замечаний.
npx skills add metabase/metabase --skill docs-review -a claude-codeЧто делает docs-review
Скилл включается, когда в дифе меняются файлы docs/**/*.md. Он читает изменения целиком, чтобы понять замысел правки, а потом проходит по чек-листу: тон и голос, структура, ссылки, форматирование, примеры кода, построение фраз. Замечания нумеруются по порядку, начиная с Issue 1, чтобы автор мог сослаться на конкретные пункты.
Режимов два. Если доступен инструмент mcp__github__create_pending_pull_request_review, скилл работает с пул-реквестом: открывает pending review, собирает все замечания и публикует их одним отзывом через mcp__github__submit_pending_pull_request_review с типом события COMMENT. Без этого MCP-инструмента замечания просто выводятся в разговор пронумерованным списком.
Внутри скилл опирается на общий файл стайлгайда _shared/metabase-style-guide.md и таблицу быстрых совпадений: «click here» вместо описательной ссылки, «easy» и «simple» как снисходительные оценки, «users» вместо «people». Из инструментов ему разрешены Read, Grep, Bash и Glob. Для режима пул-реквеста нужен подключённый GitHub MCP-сервер — без него останется только локальный вывод в консоль.
Какие задачи решает
- проверить markdown-правки в
docs/перед мержем - найти снисходительные формулировки вроде «easy» и «simple»
- заменить «click here» на описательный текст ссылки
- поймать примеры кода, которые не выполнятся
- оставить один отзыв к пул-реквесту вместо россыпи комментариев
Примеры запросов агенту
- Проверь изменения в документации по стайлгайду Metabase
- Прогони docs-review по дифу в
docs/и пронумеруй замечания - Оставь отзыв к пул-реквесту с замечаниями по документации
Как установить docs-review
1Через Skills CLI (Vercel)
npx skills add metabase/metabase --skill docs-review -a claude-code2Вручную: положить файлы
~/.claude/skills/docs-review/SKILL.mdПапка скилла целиком; для одного проекта — .claude/skills/docs-review/
1Через Skills CLI (Vercel)
npx skills add metabase/metabase --skill docs-review -a codex2Вручную: положить файлы
.agents/skills/docs-review/SKILL.mdДля всех проектов — ~/.agents/skills/
1Через Skills CLI (Vercel)
npx skills add metabase/metabase --skill docs-review -a cursor2Вручную: положить файлы
.cursor/skills/docs-review/SKILL.mdCursor читает и .agents/skills/, и .claude/skills/
1GitHub CLI
gh skill install metabase/metabase docs-review2Вручную: положить файлы
.github/skills/docs-review/SKILL.md1Через Skills CLI (Vercel)
npx skills add metabase/metabase --skill docs-review -a gemini-cli2Командой платформы
gemini skills install https://github.com/metabase/metabase --path .claude/skills/docs-reviewВручную: положить файлы
.devin/skills/docs-review/SKILL.mdСтарый путь .windsurf/skills/ тоже читается
Через Skills CLI (Vercel)
npx skills add metabase/metabase --skill docs-review -a opencodeClaude.ai
Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills
По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов
Вопросы о docs-review
Как установить docs-review в Claude Code?
Выполните npx skills add metabase/metabase --skill docs-review -a claude-code. Скилл окажется в ~/.claude/skills/docs-review/SKILL.md.
Что делает docs-review?
Проверяет изменения в markdown-документации на соответствие стайлгайду Metabase и выдаёт пронумерованный список замечаний с предложениями по правке.
Чем отличаются режимы проверки?
С доступным инструментом mcp__github__create_pending_pull_request_review замечания уходят комментариями в пул-реквест одним отзывом. Без него скилл печатает их в разговор.
