docs-review

Review documentation changes for compliance with the Metabase writing style guide.

1|Updated Feb 6, 2026

Search Tags:#quality assurance #documentation #writing #style guide #content #review

Ready to run

npx skills add https://github.com/bradoctech/metabase --skill docs-review-bradoctech

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: docs-review
Source: https://github.com/bradoctech/metabase/tree/main/.claude/skills/docs-review
Command: npx skills add https://github.com/bradoctech/metabase --skill docs-review-bradoctech

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures that documentation changes adhere to the Metabase writing style guide, improving clarity, consistency, and readability for all users.

Core Features & Use Cases

Style Guide Compliance: Automatically checks for violations of tone, voice, structure, formatting, and link usage.
Review Workflow Integration: Supports both local review (outputting issues to conversation) and PR review (posting comments on GitHub).
Use Case: When reviewing a pull request for new documentation, this skill will flag any instances of informal language, incorrect formatting, or broken links, ensuring the final documentation is polished and professional.

Quick Start

Use the docs-review skill to check the provided documentation changes against the style guide.

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 for style guide compliance?▼

To review documentation changes for style guide compliance, use this skill to check text against writing standards for tone, voice, structure, clarity, links, and formatting. It outputs issues as a numbered markdown list or GitHub PR comments.

Does docs-review work with GitHub pull requests?▼

Yes, docs-review works with GitHub pull requests. It supports a PR review mode that uses GitHub tools to post comments directly on the pull request, flagging informal language, incorrect formatting, and broken links.

What does a documentation style guide check typically cover?▼

A documentation style guide check typically covers compliance with rules for tone, voice, structure, clarity, links, formatting, code examples, and sentence construction to ensure content remains polished and professional.

Can I review documentation locally without connecting to GitHub?▼

Yes, you can review documentation locally without GitHub. The local review mode outputs a numbered markdown list of identified style guide issues directly into your conversation instead of posting GitHub comments.

What is the best way to ensure writing consistency in documentation?▼

The best way to ensure writing consistency in documentation is to automatically check changes against a defined style guide. This skill identifies structural, formatting, and tone violations to improve readability and consistency.