How do I trigger a documentation audit?

You can trigger the skill by asking Claude to 'run docs consistency check' or 'validate documentation' within your project terminal.

Can it identify missing props in documentation?

Yes, it extracts definitions from Rootage YAML files and compares them against the Props tables in your MDX files to flag undocumented variants or sizes.

What documentation layers does this skill specifically check?

It validates three specific layers: Design Guidelines (MDX), Rootage Component Specs (YAML), and React Implementation Docs (MDX).

Does it support automated fixes for inconsistencies?

While its primary role is auditing and reporting, it provides detailed recommendations that Claude can use to apply fixes directly to your MDX or YAML files.

Documentation Consistency Checker

Name: Documentation Consistency Checker
Author: Microck

byMicrock

•

Design Tools

Validates architectural consistency between design guidelines, technical specs, and React implementation documentation.

The Documentation Consistency Checker is a specialized tool for design system maintainers that ensures synchronization across three critical layers: Design Guidelines, Rootage Component Specs, and React Implementation Docs. It automatically identifies naming mismatches, description drifts, and missing property definitions between YAML specs and MDX documentation. By auditing component IDs and props tables, it helps prevent documentation debt and ensures developers always have access to a single, accurate source of truth for the SEED Design System.

Key Features

01Cross-layer synchronization validation for MDX and YAML

02Comprehensive consistency report generation with actionable fixes

03Automated property and variant verification against specs

0481 GitHub stars

05Component naming and description alignment checks

06Detection of orphaned or missing documentation files

Use Cases

01Identifying outdated documentation after design system architecture changes

02Validating that React documentation accurately reflects Rootage technical specs

03Performing pre-release audits to ensure all component layers are complete

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add microck/ordinary-claude-skills docs-consistency-checker

For use in Claude.ai and ChatGPT

Download Skill