Making a library usable.
WHAT DOCUMENTATION MUST INCLUDE
What the component is for When to use it, and when not Every prop, with types and defaults Live examples of each variant and state Accessibility notes
WHY THE SECOND POINT MATTERS MOST
Without guidance on when not to use something, it is used everywhere.
WHAT TOOLS PROVIDE
An interactive environment showing components in isolation, with controls.
WHAT THAT ENABLES
Developing components without the application Reviewing every state Designers and developers looking at the same thing
WHAT TO DOCUMENT BEYOND COMPONENTS
Tokens Layout patterns Content guidance Accessibility requirements
WHAT TO KEEP CURRENT
All of it.
WHY
Out-of-date documentation is worse than none, because it is trusted.
WHAT TO AUTOMATE
Generating prop documentation from the code.
WHY
Manually maintained lists diverge immediately.
WHAT TO INCLUDE FOR EACH EXAMPLE
The code producing it.
WHAT TO REVIEW
Whether people can find what they need.
