Template de documentation de composant de Design System

Voici un modèle et guide de documentation de composant de Design System.
La documentation n'aura plus de secret pour vous en suivant ce guide qui permet d'avancer pas à pas et de manière efficace en explicitant le nom, le but, les variations, les différents états et les guide d'utilisation (do et don't).

Transcript

1. Design Systems France - Workshop 25/06/2019 Utilisation Définissez les règles d’usage de ce composant en essayant de couvrir tous les cas possibles. N’hésitez pas à rappeler des règles qui vous semblent évidentes ! Don’t Do Variantes Déclinaisons du composant selon son contexte, son usage... États (Comportements) Hover, Focus, Erreur, Success... Nom du composant Donnez un nom clair, générique et modulable à ce composant Objectif du composant À quoi sert-il ? Quelle est sa fonction ? Dans quel but ?