Documentation Template

by owl-listener9a6930cf84a8No license2.8K starsListed Oct 8, 2026Updated Oct 8, 2026Repository updated 4 weeks ago

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

Instructions onlyWriting & ContentAI & Agents
AI-generated overview

Generates reusable documentation templates for design system components, patterns, and foundations.

What it does
This skill produces documentation scaffolds that standardize how design system artifacts are written up. It defines template types for component docs, pattern docs, and foundation docs, each with its own section outline. It also lists standards such as consistent heading hierarchy, tables of contents, comparison tables, and status indicators, plus maintenance best practices.
When to use it
Use it when you need a consistent structure for documenting a design system or its parts. It fits teams standardizing how components, patterns, and foundations are described. For the content of a single component's specification, the skill points to a separate component-spec skill.
Requirements
No tools, packages, or credentials are needed; it is instructions only and ships no scripts.

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

Source and attribution

Source:owl-listener/designer-skillsindesign-systems/skills/documentation-templateat commit9a6930c

License: No license

Content belongs to its original authors. SourceWeft indexes it from a public repository.

Report or request removal

More from owl-listener/designer-skills

Zeigarnik Effect

owl-listener

Applies the Zeigarnik Effect to design progress indicators, saved drafts, interruption handling and re-engagement prompts.

Design & Creative2.8Kupdated 4 weeks ago

Teslers Law

owl-listener

Applies Tesler's Law to decide whether product or user should absorb irreducible complexity in a design.

Design & Creative2.8Kupdated 4 weeks ago

Von Restorff Effect

owl-listener

Applies the Von Restorff (isolation) effect to make one key element visually distinct in a UI or layout.

Design & Creative2.8Kupdated 4 weeks ago

State Machine

owl-listener

Models UI component behavior as finite state machines with states, events, transitions, guards, and actions.

Design & Creative2.8Kupdated 4 weeks ago

Visual Hierarchy

owl-listener

Guidance for establishing visual hierarchy in interface layouts using size, weight, colour, spacing and position.

Design & Creative2.8Kupdated 4 weeks ago

Serial Position Effect

owl-listener

Applies the Serial Position Effect to order menus, lists, and step sequences so key items land where users recall them best.

Design & Creative2.8Kupdated 4 weeks ago

More in Writing & Content

Doc Coauthoring

anthropics

Featured

Guides users through a three-stage workflow to co-author documentation, proposals, specs and decision docs.

Writing & Content179Kupdated today

Writing Guidelines

vercel-labs

Featured

Reviews documentation and prose against fetched Writing Guidelines and reports style findings.

Writing & Content32Kupdated 5 weeks ago

Job Post Builder

anthropics

Featured

Builds a hiring packet — job post, interview guide with rubrics, and offer letter template — from a role brief.

Writing & Content27Kupdated today

Write Spec

anthropics

Featured

Turns a feature idea or problem statement into a structured PRD with goals, user stories, requirements and metrics.

Writing & Content27Kupdated today

Draft Content

anthropics

Featured

Drafts marketing content such as blog posts, social posts, newsletters, landing pages, press releases and case studies.

Writing & Content27Kupdated today

Brand Voice Enforcement

anthropics

Featured

Applies existing brand voice guidelines to sales and marketing content, then explains the brand choices made.

Writing & Content27Kupdated today