design-system-documenter

Generate design system documentation from design tokens in Markdown, MDX, or Storybook.

181|30|Updated Nov 16, 2025
One-click install
npx skills add https://github.com/curiositech/some_claude_skills --skill design-system-documenter
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: design-system-documenter
Source: https://github.com/curiositech/some_claude_skills/tree/main/.claude/skills/design-system-documenter
Command: npx skills add https://github.com/curiositech/some_claude_skills --skill design-system-documenter

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill bridges the gap between raw design tokens and developer adoption by creating comprehensive, developer-friendly documentation for design systems.

Core Features & Use Cases

  • Token Reference Tables: Generates tables detailing token names, values, usage, and accessibility.
  • Usage Guidelines: Provides clear instructions on when and how to use tokens, including code examples.
  • Visual Examples: Demonstrates token application through visual swatches and interactive elements (in MDX/Storybook).
  • Accessibility Notes: Highlights contrast ratios and reduced motion considerations.
  • Do/Don't Examples: Prevents misuse by showing common mistakes and correct patterns.
  • Output Formats: Supports Markdown, MDX, and Storybook documentation.
  • Use Case: After generating design tokens with design-system-generator, use this Skill to automatically create a documentation page for your design system, making it easy for developers to understand and implement the tokens.

Quick Start

Use the design-system-documenter skill to create markdown documentation for the tokens in 'tokens.json'.

Frequently Asked Questions about design-system-documenter

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

FAQPage Schema
How do I generate developer-ready documentation from design tokens?

Generate developer-ready documentation by processing raw design tokens into token reference tables, usage guidelines, code examples, and accessibility notes automatically. This creates comprehensive documentation that bridges the gap between raw design tokens and developer adoption.

Can I output design system docs in Storybook or MDX format?

Yes, you can output design system docs in Storybook or MDX format. The documentation generation supports Markdown, MDX, and Storybook output formats, allowing you to create interactive visual swatches and elements alongside standard reference tables.

How do I document accessibility considerations like contrast ratios for a style guide?

Document accessibility considerations for a style guide by automatically generating accessibility notes that highlight contrast ratios and reduced motion considerations. This ensures developers understand visual constraints directly within the token reference tables and usage guidelines.

What is the best way to prevent design token misuse in developer docs?

The best way to prevent design token misuse is by generating do/don't examples within your developer docs. This prevents misuse by showing common mistakes alongside correct implementation patterns and clear usage instructions.

Do I need design tokens before generating design system documentation?

Yes, you need generated design tokens before generating design system documentation. The Skill requires a token file, such as 'tokens.json', and integrates with design-system-generator to process raw tokens into comprehensive documentation pages.

Why does my design system documentation lack usage guidelines and code examples?

Your design system documentation lacks usage guidelines because it hasn't been automatically generated from design tokens. Automating the process creates comprehensive, developer-friendly content including usage instructions, code examples, and visual demonstrations instantly.