Skip to main content
skill CX Codex

component-docs — Claude Code skill: what it does, how to install

component-docs is a Claude Code skill that writes one UI component’s docs from code, stories, and real call sites. It responds to requests about component usage and states.

MIT 582 installs ★ 616 updated 2026-11-16

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add arla6ka/design.how --skill component-docs -a claude-code
Open on GitHub

What component-docs does

component-docs drafts a documentation entry for one component by reading its implementation, props type, styles, stories, and call sites. It fills nine sections with sourced variants, props, states, tokens, and examples, then records disagreements between sources.

Usage rules require evidence such as two call sites, a measurement with its path, a named principle, or the requester’s wording. Each rule also needs a real code example that violates it. The run stops when component code is missing; a missing variant prop or story leaves the variant list empty. The draft is saved to docs/system/<name>.md, and missing example files are written separately.

What it helps with

  • draft documentation for one UI component from its source files
  • compare props, variants, and states with stories and call sites
  • record conflicts between implementation details and usage examples
  • write evidence-backed Usage rules with breaking code samples

Example prompts for the agent

  • Document the Button component from its code, stories, and two real call sites.
  • List every Toast state, trace each example to its source, and record conflicts.
  • Create a sourced entry for Select and save it to docs/system/Select.md.

How to install component-docs

1Skills CLI (Vercel)

npx skills add arla6ka/design.how --skill component-docs -a claude-code

2Manually: put the files in place

~/.claude/skills/component-docs/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/component-docs/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about component-docs

How do I install component-docs in Claude Code?

Run npx skills add arla6ka/design.how --skill component-docs -a claude-code, then use ~/.claude/skills/component-docs/SKILL.md.

What does component-docs do?

The skill builds a draft for one component from its code, props type, styles, stories, and real call sites. It records source conflicts and writes Usage rules only when their evidence is present.

What does component-docs need to run?

It needs the component code, props type, styles, stories, and at least one real or planned use. Missing component code stops the run, while missing variant data leaves an empty variant list.

Source text

SKILL.md · MIT
---
name: component-docs
description: Use to write one component's documentation entry from its code, stories and real call sites, such as "document the button", "write docs for Select", "what states does Toast have", or usage rules for a new or changed component. Not for foundations or pages that span components, which no skill here writes, nor for changing the component, which is build-design-system.
metadata:
  summary: Documents a component
---

# Component docs

A draft entry for one component, built only from what its sources say. Gaps are marked, not filled. It does not judge the design and it publishes nothing. The heading order and a worked example are in `references/doc-format.md`.

## Steps

1. Paste the nine headings from `references/doc-format.md` into the draft, empty.
2. Find the component. Read its code, props type, styles and stories, and record each as a Sources line.
3. Find two real uses, by call-site search or from the ask. One real use or none changes the stop table below.
4. Trace which source gave each example, variant, prop, state and token. Every disagreement between sources is a line under Conflicts, with the quoted rule that settles it, or "no rule, not chosen".
5. Fill each section from sourced facts, copying token names and example code character for character.
6. Write Usage rules last. Each rule is `rule/<component>-<slug>`, a condition, an action, a reason, its evidence (two call sites, a measurement with its path, a named principle, or the person's words), and a `Don't:` line with real code that breaks it. A rule you cannot break with a snippet is cut.
7. Fill Guessed at, one line per judgement call. Reread the draft against the Done list below.

## Output

The entry, then Sources, Conflicts, Guessed at, and Gates (a question with its default) only where a rule adds one. Run on its own, it saves to `docs/system/<name>.md` with a draft comment on line 1 and writes each missing example file. The reply opens with the path, what the entry covers and its status, then up to three questions with defaults and one prompt the person can paste to take the next step.

## Stops

| Missing after searching | Why it stops |
|---|---|
| The code | Nothing else sources the variants, props or behaviour |
| The variant list (props type or stories) | A guessed list documents a different component |
| Any use, real or planned | Invented uses read like real ones and readers copy them first |

A props type with no variant prop is an empty list. Variants reads "None" and the run goes on. One real use, planned uses and a deprecated predecessor are marked as such, not stopped on. A stopped run returns the stop, the facts sourced so far by section, and the smallest reply that unblocks it ("one screen name, what put the component there, and which variant showed").

## Rules

- Never write a variant, prop, token name, example or use that has no listed source. A planned use says planned.
- Never invent a state or a precedence order to make a section look complete.
- A behaviour that looks like a bug is written as it is, followed by a `Defect:` line to the owner with what goes wrong for the user and the smallest fix.
- A part also used on its own gets a `### Parts` subsection under Description. A compound component (`Tabs` with `Tab`) is one entry.
- Do not edit the code, stories or spec being documented.
- Counts in the reply come from `grep -o` on the saved file, below the draft comment.

## Done

Every variant, prop, token and example has a Sources line. Every Usage rule has evidence and a `Don't:` line. Every conflict is shown. The nine headings are present in order, and a section with nothing sourced reads `Not applicable: <reason>`.

© arla6ka · MIT · arla6ka/design.how

Similar skills

All skills for Writing and docs →

From the same set6

Project sponsors

Companies that keep this analytics open