-
Notifications
You must be signed in to change notification settings - Fork 38
Storybook: Component documentation structure
Ingress: En kort oppsummering av hva komponenten brukes til. Helst bare ett avsnitt, med de viktigste retningslinjene. Toppen av komponentbeskrivelsen må være kort slik at komponenten vises i det første skjermbildet. Legg resten av retningslinjene i avsnitt lenger ned.
Vær oppmerksom på: (brukes hvis det er noe som er spesielt viktig å fremheve om bruken)
- ...
- ...
< Komponenten med tilhørende props >
Her beskriver utvikler hvordan du teknisk tar den i bruk
Oppsummering av de ulike eksemplene og variantene, hvis nødvendig.
Ett avsnitt om dette eksempelet og når det skal brukes.
[Eksempel]
- eventuelt "Gjør dette"- og "Ikke gjør dette"-eksempler.
Ett avsnitt om dette eksempelet og når det skal brukes.
[Eksempel]
- eventuelt "Gjør dette"- og "Ikke gjør dette"-eksempler.
Generelt avsnitt, hva komponenten er egnet til og ikke, eventuelt med "Gjør dette" og "Ikke gjør dette"-eksempler, men pass på at det ikke blir gjentakelser fra variant-eksemplene.
Nødvendige avsnitt om hva du bør tenke på når det gjelder tekst, språk og formulering for komponenten.
Nødvendige avsnitt om hva du bør tenke på når det gjelder tilgjengelighet/universell utforming. Nevn spesielt det som ikke kommer integrert i komponenten. Her kan vi også skrive om feller du må unngå å gå i. Eventuelt "Gjør dette" og "Ikke gjør dette"-eksempler, men pass på at det ikke blir gjentakelser fra tidligere.