docs-review

Review documentation changes against a specified writing style guide.

Updated Jan 1, 2026
One-click install
npx skills add https://github.com/Palomig/PALOMATIKA --skill docs-review-palomig
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-review
Source: https://github.com/Palomig/PALOMATIKA/tree/main/.claude/skills/docs-review
Command: npx skills add https://github.com/Palomig/PALOMATIKA --skill docs-review-palomig

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses the challenge of maintaining high-quality, consistent documentation by automatically reviewing changes against a defined style guide, ensuring clarity, adherence to tone, and proper formatting.

Core Features & Use Cases

  • Style Guide Enforcement: Checks documentation for adherence to tone, voice, structure, and formatting rules.
  • Readability Improvement: Identifies verbose text, vague headings, and unclear instructions.
  • Link and Formatting Checks: Ensures proper link text and consistent list formatting.
  • Use Case: When reviewing a pull request for new documentation, this Skill will flag any deviations from the Metabase writing style guide, providing specific, actionable feedback to the author.

Quick Start

Review the provided documentation changes for compliance with the Metabase writing 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, provide the updated markdown files or pull request diffs alongside your specified writing style guide. The review identifies deviations in tone, voice, structure, clarity, links, and formatting.

What is the best way to enforce a writing style guide in a pull request?

Enforcing a writing style guide in a pull request involves comparing the documentation diffs against defined rules for tone, voice, and formatting. This process flags verbose text, vague headings, unclear instructions, and improper link text for the author to correct.

How do I check markdown formatting and link text during a documentation audit?

Checking markdown formatting and link text during a documentation audit requires comparing files against your style guide rules. This identifies inconsistent list formatting, improper link text, and structural deviations to ensure content quality and consistency.

Does a documentation review require access to the original style guide document?

Yes, a documentation review requires access to the specified style guide document to compare changes against established rules. Without the style guide, the review cannot evaluate tone, voice, clarity, or formatting compliance.

Can I use this documentation review for both local audits and pull request reviews?

Yes, you can use this documentation review for both local audits and pull request reviews. It processes provided file changes and diffs to identify style guide deviations, ensuring content quality across different review workflows.