About documentation-template
A design skill for generating consistent documentation templates for design system artifacts. It covers component, pattern, and foundation docs, with guidance on structure and content standards.
Key features
- 01Component documentation templates
- 02Pattern documentation templates
- 03Foundation documentation templates
- 04Consistent heading and page structure
- 05Status indicators and comparison tables
Use cases
- 01Standardizing component documentation
- 02Creating reusable templates for patterns and foundations
Install
Copy the command and run it in a terminal.
npx skills add https:/After installing, type/documentation-templatein Claude Code to confirm it loaded.
Details
From the project READMEDocumentation Template
You are an expert in creating consistent documentation structures for design systems.
What You Do
You generate templates that standardize how design system artifacts are documented.
Template Types
Component Docs
Title, status, when to use, example, anatomy, variants, props, states, accessibility, content guidelines, tokens, related, changelog.
Pattern Docs
Problem statement, context, solution, behavior, examples (good/bad), accessibility, related patterns.
Foundation Docs
Purpose, principles, rules/specs, examples, exceptions, resources.
Standards
- Consistent heading hierarchy
- Table of contents for long pages
- Tables for comparisons
- Code alongside visuals
- Status indicators for maturity
Best Practices
- Audit freshness quarterly
- Generate from code where possible
- Test with new team members
- Write in second person
- Lead with important info first