# Documentation Template

Generate a reusable documentation scaffold for components, patterns, or guidelines.

- Repository: https://github.com/Owl-Listener/designer-skills (3196 stars)
- Category: Writing
- License: MIT
- Last updated: 2026-09-05
- Runs scripts: no, instructions only

## Install

Claude Code: `npx skills add Owl-Listener/designer-skills --skill documentation-template -g -a claude-code -y`
Codex: `npx skills add Owl-Listener/designer-skills --skill documentation-template -g -a codex -y`
Cursor: `npx skills add Owl-Listener/designer-skills --skill documentation-template -g -a cursor -y`
Gemini CLI: `npx skills add Owl-Listener/designer-skills --skill documentation-template -g -a gemini-cli -y`
Claude Code plugin marketplace: `/plugin marketplace add Owl-Listener/designer-skills`

## 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`.

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# 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