Skip to content
UX Atlas
AI workflowCraft conventionIntermediate

Design System to Documentation

Drafting component documentation from code, which handles the mechanical parts and not the judgement.

Definition

Given component source and tokens, a model can draft API tables, state descriptions and usage examples. The parts requiring judgement, particularly when not to use a component, still need a human.

Craft convention. True because the industry converged on it. Breaking it costs familiarity, not correctness.

On this page
  1. Definition
  2. What to generate and what to write
  3. Continue from here

What to generate and what to write

  • Generate: prop tables, type signatures, default values, state enumerations, code examples.
  • Generate as a draft: the one-line description, and accessibility notes derived from the implementation.
  • Write yourself: when to use and when not to use, with the named alternative.
  • Write yourself: the content guidance, which depends on your voice.
  • Write yourself: known limitations and the reasoning behind API decisions.

Continue from here

Each link says what the connection is, so you can tell a principle from an alternative from a thing people mix this up with.

Related concept

Connected closely enough to change how you apply this.

Nearby in the Atlas

Adjacent territory, found through shared tags rather than a stated link.

Specification to Working Code