What is Local Review Mode?

In local mode, the skill outputs a numbered list of issues directly into your conversation, allowing you to fix documentation files before they are even committed.

How does the skill handle GitHub reviews?

It uses the GitHub MCP toolset to create a pending review, batching all feedback into a single, cohesive set of comments for better PR hygiene.

Can I use this for non-Metabase projects?

Yes. While it defaults to Metabase style standards, its checks for clarity, active voice, and formatting are best practices for most professional technical documentation.

Why are issues numbered sequentially?

Sequential numbering (Issue 1, Issue 2, etc.) is a mandatory requirement that allows developers to easily reference specific feedback items during the revision process.

Does it check code examples in docs?

Yes, it validates that code examples are functional, commands are in the correct execution order, and formatting follows best practices.

Documentation Style Reviewer

Name: Documentation Style Reviewer
Author: Activer007

byActiver007

•

Content Management

Audits documentation markdown files for style guide compliance, tone consistency, and structural clarity.

About

Documentation Style Reviewer is a specialized Claude Code skill designed to enforce professional writing standards—specifically the Metabase style guide—across markdown files. It intelligently adapts to your workflow, detecting whether it is running in a local environment or within a GitHub Pull Request context to provide appropriately formatted feedback. The skill systematically identifies corporate jargon, improper UI element formatting, vague headings, and accessibility issues like 'click here' links, ensuring that all technical documentation remains conversational, clear, and highly readable.

Key Features

Automated style guide compliance checking based on Metabase standards
Comprehensive checks for tone, voice, formatting, and link accessibility
Parallel GitHub comment posting to minimize PR clutter and notification noise
Dual-mode operation for both local terminal output and GitHub PR reviews
Sequential issue numbering for easy reference and feedback tracking
1 GitHub stars

Use Cases

Reviewing documentation changes in a GitHub Pull Request before merging
Performing a final sweep of local markdown files for style inconsistencies
Ensuring technical writers maintain a consistent brand voice across all docs

About

Key Features

Automated style guide compliance checking based on Metabase standards
Comprehensive checks for tone, voice, formatting, and link accessibility
Parallel GitHub comment posting to minimize PR clutter and notification noise
Dual-mode operation for both local terminal output and GitHub PR reviews
Sequential issue numbering for easy reference and feedback tracking
1 GitHub stars

Use Cases

Reviewing documentation changes in a GitHub Pull Request before merging
Performing a final sweep of local markdown files for style inconsistencies
Ensuring technical writers maintain a consistent brand voice across all docs