docs-consistency-checker

Validate consistency across SEED Design System documentation layers.

1.0k|75|Updated Mar 11, 2021
One-click install
npx skills add https://github.com/daangn/seed-design --skill docs-consistency-checker
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-consistency-checker
Source: https://github.com/daangn/seed-design/tree/main/.claude/skills/docs-consistency-checker
Command: npx skills add https://github.com/daangn/seed-design --skill docs-consistency-checker

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Validates consistency across SEED Design System documentation layers (design guidelines, Rootage specs, and React docs), helping keep teams aligned and release-ready.

Core Features & Use Cases

  • Cross-layer Validation: Checks title, description, props, and IDs across layers.
  • Orphan & Gap Detection: Identifies missing or orphaned docs for quick remediation.
  • Pre-release Assurance: Ensures components meet documentation standards before releases.

Quick Start

Run the checker across all components to generate a comprehensive consistency report.

Frequently Asked Questions about docs-consistency-checker

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

FAQPage Schema
How do I validate consistency across design system documentation layers?

Consistency validation checks alignment of titles, descriptions, props, and IDs across design guidelines, Rootage specs, and React documentation. Run the checker across all components to generate a comprehensive report identifying mismatches and gaps.

What documentation issues does a consistency audit detect?

The audit identifies orphaned documentation (specs without React docs), missing documentation (components without specs), props misalignment, and metadata conflicts across SEED Design System layers, enabling rapid remediation before release.

When should I run documentation consistency checks?

Run checks during pre-release audits to ensure components meet standards, when reviewing new components for completeness, and as ongoing health checks to maintain alignment across design guidelines, Rootage specs, and React implementation docs.

Can I check documentation consistency for individual components or must I audit all at once?

The checker validates consistency across all components to generate a comprehensive report. This full-scope approach catches cross-component misalignments and systemic documentation gaps that component-level checks might miss.

What React documentation requirements does the consistency checker validate?

The checker validates React docs against design guidelines and Rootage specs, ensuring props documentation is complete and accurate, IDs match across layers, and descriptions align with component intent and usage patterns.

Why does documentation consistency matter for design system releases?

Inconsistent documentation across design guidelines, specs, and implementation causes team misalignment and component misuse. Pre-release consistency validation ensures stakeholders have authoritative, aligned documentation before public availability.