How does it handle component props?

The skill extracts prop definitions directly from technical YAML files and compares them against the props table in your MDX documentation to flag missing or incorrect entries.

What documentation layers does this skill check?

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

Does it support automated reporting?

Yes, it generates structured reports highlighting critical mismatches, warnings for slight description differences, and missing file summaries.

When is the best time to use this skill?

It is most effective during pre-release audits, when reviewing new component pull requests, or during scheduled quarterly documentation maintenance.

Can I use this for a single component instead of the whole project?

Yes, you can request an audit for a specific component ID to receive a detailed consistency report for just that component's files.

Documentation Consistency Checker

Name: Documentation Consistency Checker
Author: Activer007

byActiver007

0•

コンテンツ管理

Validates architectural and content consistency across design system documentation layers and technical specifications.

The Documentation Consistency Checker is a specialized auditing tool designed for the SEED Design System to ensure that design guidelines, Rootage component specifications (YAML), and React implementation documents remain perfectly synchronized. By cross-referencing component IDs, prop definitions, and descriptions, it identifies orphans, missing documentation, and discrepancies in naming or variants. This skill is essential for design system maintainers who need to perform deep audits before releases, validate new component documentation, and maintain a high standard of technical writing across multiple documentation layers.

主な機能

01Tiered reporting with compact, detailed, and summary output modes

02Detection of orphaned files and missing documentation sets

03Three-layer cross-validation between specs and MDX documentation

04Comparison logic for titles, descriptions, and component ID references

050 GitHub stars

06Automated prop and variant extraction from technical YAML definitions

ユースケース

01Validating that newly implemented React props match the official design specifications

02Auditing component documentation completeness before a major design system release

03Identifying outdated or orphaned documentation files during repository cleanup

What are Skills?·How to Install

Install with 🐟 Skill.Fish

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

For use in Claude.ai and ChatGPT

Download Skill