User persona
Describe one type of user - their goals, their work and their problems.
Document one component - when to use it, its variants and its rules.
Component | The name of the component, as it is in the design file and in the code |
Owner | @mention the owner |
Status | 🟡 Beta | 🟢 Stable | ⚪ Deprecated |
One or two sentences: what the component is, and what it helps users do.
Design file and code: links, or delete this line
✅ Use when
🚫 Do not use when
Variant | Use for |
|---|---|
The name of the variant, for example primary or small | When to use this variant |
How to write the text in the component: the tone, the length, and the words to use or to avoid.
An example of good text, and an example of text to avoid.