What specific style issues does it flag?

It identifies corporate jargon, improper UI bolding, vague headings, 'here' links, and condescending language like 'just' or 'simple' to ensure professional, accessible content.

Can I use this skill for local documentation files?

Yes. If GitHub tools are not detected, the skill outputs a structured, numbered list of issues and suggested fixes directly in your terminal or conversation.

Why is the feedback numbered?

The skill enforces a strict sequential numbering system (Issue 1, Issue 2, etc.) so that developers can easily reference and address specific points during the revision process.

How does this skill handle GitHub Pull Requests?

When the GitHub MCP tool is available, the skill creates a pending review and adds numbered comments directly to the specific lines in the diff, submitting them as one cohesive review.

Does it check code examples within documentation?

Yes, the review checklist includes verifying that code examples are functional, commands are in execution order, and screenshots are properly scoped.

Metabase Documentation Style Reviewer

Name: Metabase Documentation Style Reviewer
Author: Microck

byMicrock

•

108

Aprendizaje y Documentación

Reviews markdown documentation for compliance with the Metabase writing style guide and general technical writing best practices.

Acerca de

The Documentation Review skill is a specialized tool designed to automate the auditing of documentation changes against the Metabase writing style guide. It functions in two modes: a GitHub PR mode that utilizes MCP tools to post structured, numbered comments directly onto pull requests, and a local mode for immediate feedback within the conversation. The skill systematically checks for tone consistency, clarity, proper UI element formatting, and link descriptiveness, ensuring that documentation remains conversational, user-centric, and professional without the clutter of corporate jargon.

Características Principales

Specific validation for UI element formatting and link descriptive text
Comprehensive style guide enforcement for tone, voice, and clarity
Sequential, numbered feedback for easy issue tracking and referencing
Automatic detection of GitHub PR or local review environments
108 GitHub stars
Parallelized GitHub comment posting for cohesive PR reviews

Casos de Uso

Checking local markdown files for style compliance before pushing changes
Refining technical documentation to remove corporate jargon and 'easy' qualifiers
Performing automated style audits on GitHub Pull Requests for documentation

Acerca de

Características Principales

Specific validation for UI element formatting and link descriptive text
Comprehensive style guide enforcement for tone, voice, and clarity
Sequential, numbered feedback for easy issue tracking and referencing
Automatic detection of GitHub PR or local review environments
108 GitHub stars
Parallelized GitHub comment posting for cohesive PR reviews

Casos de Uso

Checking local markdown files for style compliance before pushing changes
Refining technical documentation to remove corporate jargon and 'easy' qualifiers
Performing automated style audits on GitHub Pull Requests for documentation