SKILL.md
Documentation Review Skill
@./../_shared/metabase-style-guide.md
Review mode detection
IMPORTANT: Before starting the review, determine which mode to use:
-
PR review mode: If the
mcp__github__create_pending_pull_request_reviewtool is available, you are reviewing a GitHub PR- Use the pending review workflow to post all issues as one cohesive review
- Follow the workflow steps in "PR review mode format" below
-
Local review mode: If the MCP tool is NOT available, output issues in the conversation
- Format all issues in a numbered markdown list (as described in "Feedback format" below)
Review process
- Detect review mode - Check if
mcp__github__create_pending_pull_request_reviewis available - Read the changes through once to understand intent
- Check all issues that violate style guide or significantly impact readability
- Only flag issues worth mentioning - if it won't make a material difference to the reader, skip it
- REQUIRED: Number ALL feedback sequentially - Start from Issue 1 and increment for each issue found
Review checklist
Run through the diff looking for these issues:
Tone and voice:
- Formal/corporate language ("utilize" not "use", "offerings", etc.)
- "Users" instead of "people" or "companies"
- Excessive exclamation points or overly peppy tone
- Telling readers something is cool instead of showing them
