docs-review

Review documentation diffs for Metabase writing style compliance.

48.6k|6.7k|Updated Feb 2, 2015
One-click install
npx skills add https://github.com/metabase/metabase --skill docs-review
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-review
Source: https://github.com/metabase/metabase/tree/main/.claude/skills/docs-review
Command: npx skills add https://github.com/metabase/metabase --skill docs-review

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Review documentation changes for compliance with the Metabase writing style guide. Focus on clarity and consistency.

Core Features & Use Cases

  • Detect style deviations and clarity issues
  • Ensure docs structure is logical and scannable
  • Guide PR and local reviews with actionable feedback
  • Adapt feedback based on review mode (PR vs local)

Quick Start

Process the attached markdown documentation diff and return issues following the prescribed review format.

Frequently Asked Questions about docs-review

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I review documentation changes against a style guide?

Documentation review checks markdown changes for compliance with style guidelines, ensuring clarity and consistency. The Skill analyzes diffs from GitHub PRs or local files, detects style deviations, and returns structured feedback with numbered issues and actionable corrections aligned to the Metabase writing style guide.

Can I use documentation review for GitHub pull requests and local diffs?

Yes. The Skill adapts to both PR and local review modes, processing markdown documentation diffs in either context. It determines the review mode automatically and applies the same style-compliance checks, aggregating issues into a standardized feedback format for each mode.

What does the documentation review check for?

The review detects style deviations, clarity issues, and structural problems in markdown documentation. It ensures docs follow logical organization, remain scannable, and comply with the Metabase style guide, then returns feedback with mandatory sequential numbering and standardized formats.

How are documentation review issues formatted in feedback?

Issues are formatted using a strict sequential numbering system and standardized feedback protocol. Each issue includes actionable guidance, and the Skill enforces a pending-review workflow for posting comments, ensuring consistent, structured communication across all review sessions.

What input formats does documentation review accept?

The Skill processes markdown documentation diffs from GitHub PRs and local file changes. It ingests markdown-formatted documentation and outputs structured issue feedback with prescribed numbering and format compliance, requiring no additional setup or dependencies.

Can I use documentation review without prior setup or dependencies?

Yes. The Skill has no external dependencies and requires no component installation. It operates on markdown diffs directly—either from GitHub PR context or local file comparisons—and returns style-compliance feedback immediately with no prerequisite environment configuration.