Does this skill work with any style guide?

This skill is specifically tuned to the Metabase writing style guide, focusing on conversational tone, bold UI elements, and user-centric language.

Why is the feedback numbered?

All issues are numbered sequentially so that users can efficiently track changes and reference specific feedback points, such as 'fixed issues 1 and 4'.

What kind of formatting issues does it catch?

It specifically looks for backticks used on UI elements (which should be bold), incorrect link text like 'click here', and the use of ampersands instead of 'and'.

How does PR review mode work?

If the GitHub MCP tool is available, the skill will create a pending review and post all identified issues as separate comments on the specific lines of the pull request.

Documentation Review (Metabase Style)

Name: Documentation Review (Metabase Style)
Author: Activer007

byActiver007

0•

Learning & Documentation

Reviews documentation changes for compliance with the Metabase writing style guide and general readability standards.

The Documentation Review skill automates the process of auditing markdown files against the Metabase writing style guide, ensuring consistent tone, voice, and formatting across your technical content. It operates in two modes: a local mode for immediate conversational feedback and a PR review mode that integrates directly with GitHub to post structured, numbered comments on pull requests. By identifying issues like corporate jargon, incorrect UI element formatting, and vague headings, this skill helps developers and technical writers maintain high-quality, user-centric documentation.

Key Features

01Automated Metabase style guide compliance auditing

02Sequential issue numbering for streamlined referencing and fixes

03Dual-mode operation for local files and GitHub Pull Requests

04Tone and voice analysis to eliminate corporate or condescending language

050 GitHub stars

06Validation of UI element formatting and code example accuracy

Use Cases

01Auditing documentation PRs on GitHub for style and clarity

02Standardizing technical writing across teams using the Metabase guide

03Performing pre-commit checks on local markdown documentation files

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add activer007/ordinary-claude-skills docs-review

For use in Claude.ai and ChatGPT

Download Skill