documentation-template

name	documentation-template
description	Generate a reusable documentation scaffold for components, patterns, or guidelines. Use when standardising how the system is documented. For the content of one component's spec, use `component-spec`.

Documentation 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