Which documentation layers does this skill check?

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

What are the trigger keywords for this skill?

You can trigger this skill using phrases like 'docs consistency', 'documentation audit', 'validate docs', or 'check documentation'.

Does it automatically update the documentation files?

No, it performs a read-only audit and generates a detailed report with recommendations. This allows developers to review changes before manual or AI-assisted updates.

Can this be used for documentation systems other than SEED?

While it is optimized for the SEED Design System file structure and naming conventions, the logic can be adapted for any system that uses a centralized YAML spec for UI components.

How does it handle component properties and variants?

It extracts definitions from the Rootage YAML files and compares them against the Props tables in the MDX files to ensure every technical variant is documented.

Docs Consistency Checker

Name: Docs Consistency Checker
Author: Microck

byMicrock

•

콘텐츠 관리

Ensures structural and content alignment across design guidelines, technical specifications, and framework-specific documentation layers.

The Docs Consistency Checker is a specialized auditing tool designed for the SEED Design System that automates the verification of content across three distinct layers: Design Guidelines, Rootage Component Specs (YAML), and React Implementation docs. It meticulously cross-references component naming, descriptions, props, and metadata to identify mismatches or missing documentation. This skill is essential for maintaining a single source of truth, ensuring that what is defined in the technical spec is accurately reflected in both design and development guides.

주요 기능

01Metadata synchronization checks for component IDs and naming conventions

02Automatic identification of orphaned documentation or missing files

03Deep prop and variant verification against technical schemas

0481 GitHub stars

05Multi-layer cross-validation between MDX docs and YAML specifications

06Actionable summary report generation with critical and warning flags

사용 사례

01Syncing React API documentation with the core Rootage component specifications

02Performing comprehensive documentation audits before major design system releases

03Validating new component documentation for consistency before merging pull requests

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