# Review Metabase Documentation Changes

Documentation PRs can drift from the Metabase style guide and create unclear guidance for readers. This skill checks changes for tone, structure, formatting, links, examples, and useful review feedback.

## Install

```bash
npx skillstore add metabase/docs-review
```

## Metadata

- Status: approved
- Slug: metabase-docs-review
- Skillstore revision: r1
- Version status: missing
- Tree hash: 63f8c05ba4791456cb9d63a3ced084e23056f15524cbbe1b5f7aff33a7b3a561
- Author: metabase
- GitHub username: metabase
- License: MIT
- Repository: https://github.com/metabase/metabase/tree/master/.claude/skills/docs-review
- Ref: 1ffa7643651792ccb4bd3b15d924d2c97edff755
- Supported tools: Claude, Codex, Claude Code
- Audit status: complete
- Agent install advisory: allowed
- Manual install advisory: allowed
- Artifact signature: available
- Audit attestation: unavailable
- Human verification: not\_verified
- Risk factors: external\_commands, filesystem
- Quality score: 78
- Quality tier: bronze
- Public page: https://skillstore.pages.dev/skills/metabase-docs-review
- Manifest: https://skillstore.pages.dev/api/skills/metabase-docs-review/manifest

## Capabilities

- Reviews documentation diffs against the Metabase writing style guide.
- Flags tone, clarity, structure, link text, formatting, and example quality issues.
- Numbers every issue so authors can reference and resolve feedback easily.
- Supports local review output when GitHub review tools are unavailable.
- Can post grouped, non-blocking GitHub PR review comments when the required MCP tools are available.

## Use Cases

- Review documentation pull requests: Check a documentation PR for style guide violations before it is merged.
- Improve technical writing drafts: Find unclear headings, formal tone, weak link text, and verbose paragraphs in Markdown changes.
- Standardize contributor feedback: Produce numbered, actionable issues that contributors can resolve one by one.

## Prompt Templates

### Review a docs file

```
Review this documentation file with the docs-review skill and list only issues that would materially improve the reader experience.
```

### Review a documentation diff

```
Use docs-review on the current Markdown diff. Number every issue and include a short suggested fix for each one.
```

### Prepare PR feedback

```
Review this documentation PR with docs-review. If GitHub review tools are available, post numbered comments as one non-blocking pending review.
```

### Audit complex docs changes

```
Use docs-review across all changed documentation files. Group only high-value issues, preserve sequential numbering, and avoid summary-only feedback.
```

## Limitations

- Focuses on documentation Markdown and may not be suitable for product code review.
- Depends on access to the Metabase style guide content for complete guidance.
- Cannot verify screenshots or commands beyond the available project context.
- GitHub comment posting requires the relevant MCP review tools to be available.

## Best Practices

- Provide the relevant diff or files so the review can cite precise locations.
- Ask for material issues only to avoid noisy style feedback.
- Keep the numbered issue format when replying to or resolving feedback.

## Anti Patterns

- Do not use it as a general code security or architecture reviewer.
- Do not ask it to enforce preferences outside the Metabase style guide without clear instructions.
- Do not post PR comments without confirming that GitHub review tools and permissions are available.

## Security Audit

- Audited at: 2026-07-09T04:15:38.679\+00:00
- Summary: Static findings are false positives caused by Markdown backticks, a relative include for a shared style guide, and PR review formatting instructions. No malicious intent, prompt injection, data exfiltration, or unsafe command execution was found in SKILL.md.

## Stats

- Views: 176
- Downloads: 11
- Favorites: 0
- Popularity score: 0