AIKraft/Skills/docs-review

docs-review

Проверяет изменения в документации на соответствие гайдлайну стиля Metabase. Полезно при ревью pull requests, файлов или диффов с markdown-документацией.

MEMetabase official Документы ★ 49.6k

Что делает навык

Навык проверяет изменения в документации на соответствие гайдлайну стиля Metabase. Он полезен при ревью pull requests, отдельных файлов или диффов с markdown-документацией для обеспечения единообразия тона, структуры и форматирования.

Когда применять

  • Автоматическое ревью pull requests в GitHub с использованием MCP-инструментов
  • Локальная проверка документации или диффов при отсутствии доступа к GitHub API
  • Оценка текста на соответствие требованиям к тону (формальный/разговорный) и структуре
  • Проверка ссылок, форматирования списков и корректности примеров кода

Как работает

  1. Определить режим работы: если доступен инструмент mcp__github__create_pending_pull_request_review, использовать режим PR review, иначе — локальный режим
  2. Прочитать изменения один раз, чтобы понять контекст и намерения автора
  3. Проверить текст по чеклисту: тон, структура, ссылки, форматирование, примеры кода и построение предложений
  4. Выявить все нарушения, которые существенно влияют на читаемость, и пронумеровать их последовательно от Issue 1
  5. В локальном режиме вывести список проблем в формате нумерованного markdown-списка; в режиме PR — собрать все комментарии
  6. В режиме PR отправить все комментарии параллельно через mcp__github__add_pull_request_review_comment_to_pending_review, затем опубликовать отзыв через mcp__github__submit_pending_pull_request_review с событием COMMENT

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

Проверь этот дифф документации на соответствие стилю Metabase
Выполни ревью pull request в GitHub, используя инструменты MCP
Найди проблемы в этом фрагменте markdown-файла и предложи исправления

Что понадобится

  • Инструмент mcp__github__create_pending_pull_request_review (для режима PR review)
  • Инструмент mcp__github__get_pull_request_diff (для получения информации о диффе)
  • Инструмент mcp__github__add_pull_request_review_comment_to_pending_review (для добавления комментариев)

Описание составлено по SKILL.md навыка, сверено 08.10.2026.

Как подключить

1Скачать навык
# возьмите папку навыка «docs-review» из репозитория: # https://github.com/metabase/metabase
2Положить папку с SKILL.md к навыкам ассистента
# положите папку навыка туда, где ассистент ищет skills: cp -r docs-review/ ~/.claude/skills/docs-review/

Навык — папка с файлом SKILL.md (описание + инструкции) и опциональными скриптами. Ассистент (Claude, Claude Code и совместимые) подхватывает его по описанию и следует шагам.