About documentation-template
documentation-template is a skill for teams documenting design systems. It structures component, pattern, and foundation documentation with consistent sections and guidance.
Key features
- 01Component documentation outlines
- 02Pattern documentation outlines
- 03Foundation documentation outlines
- 04Heading and comparison standards
- 05Documentation maintenance guidance
Use cases
- 01Standardizing component reference pages
- 02Recording reusable design patterns
- 03Documenting design system 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