docs-review

Review documentation markdown files for Metabase style guide compliance.

Updated Jan 6, 2026
One-click install
npx skills add https://github.com/Kidoz-SDK/metabase --skill docs-review-kidoz-sdk
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-review
Source: https://github.com/Kidoz-SDK/metabase/tree/main/.claude/skills/docs-review
Command: npx skills add https://github.com/Kidoz-SDK/metabase --skill docs-review-kidoz-sdk

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures that all documentation changes adhere to the Metabase writing style guide, improving clarity, consistency, and overall quality of the documentation.

Core Features & Use Cases

  • Style Guide Compliance: Automatically checks documentation content against a predefined style guide.
  • Issue Identification: Flags violations related to tone, structure, clarity, links, formatting, and code examples.
  • Use Case: When reviewing a pull request with updated documentation, this Skill will identify any deviations from the Metabase writing style, providing specific feedback for each issue.

Quick Start

Use the docs-review skill to review the attached documentation file for style guide compliance.

Frequently Asked Questions about docs-review

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

FAQPage Schema
How do I check markdown documentation for style guide compliance?

Documentation style guide compliance is verified by reviewing markdown files to identify and report issues related to tone, voice, structure, clarity, links, formatting, and code examples.

Can I review documentation style during a GitHub pull request?

Yes, you can review documentation style during a GitHub pull request using PR review mode, which flags deviations from the writing style guide and provides specific feedback for each issue directly in GitHub tools.

What documentation issues does a style guide review identify?

A documentation style guide review identifies issues related to tone, voice, structure, clarity, links, formatting, and code examples, providing specific feedback for each deviation found in the markdown files.

How do I run a local documentation review on markdown files?

To run a local documentation review on markdown files, use local review mode to output style guide compliance issues directly in your terminal, identifying deviations in clarity, tone, and formatting without GitHub integration.

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

The best way to ensure writing consistency in documentation is to automatically check markdown content against a predefined style guide, improving clarity and overall quality by flagging structural and tonal deviations.