Skills Design & Creative Document Design System Component

Document Design System Component

v20261121
design-how-component-docs
This skill involves creating comprehensive documentation for individual design system components. It requires analyzing implementation code, stories, and real-world usage examples to define states, behaviors, and constraints. You will identify props, variants, and accessibility requirements, then write minimal and real-world usage examples. The goal is to provide a dependable entry for component consumers, ensuring clarity on when and how to use specific UI elements within the system.
Get Skill
149 downloads
Overview

Document a Design-System Component

When to Use

Use for one existing component whose consumers need a dependable entry. Read its public types, implementation, stories, tests and representative call sites.

Workflow

  1. Identify the canonical import, variants, props, required labels or slots, defaults and supported environments. Compare docs with code and list disagreements as questions for the component owner.
  2. For each important state, name how it is reached, what renders, what events fire and which keys or focus transitions matter. Include only states the implementation supports. Map any meaningful layout or theme dependency.
  3. Write one minimal example and one real-world composition based on actual APIs. Use the project's documentation conventions. Include when to use the component, when to choose another, accessibility obligations and usage pitfalls.
  4. Check the examples against local stories or tests and point to the code that backs the claims. If the request is a draft, return the entry without editing the repo. For a requested update, write only the relevant documentation entry.

Example

“Document our Toast.” Check durations and pause behavior in its code, confirm which notifications use live regions, and show a dismissal example with the actual callback.

Limitations

Covers a single component. Missing examples, tests or behavior stay visible as gaps. Component fixes require a separately scoped implementation change.

Bundled resources

Use the bundled component-entry format for the anatomy, usage and behavior table.

Source

Adapted from design.how by Arlan Marat. See MIT license.

Info
Name design-how-component-docs
Version v20261121
Size 4.57KB
Updated At 2026-11-22
Language