Skip to content

Storybook: Component documentation structure

Marianne Røsvik edited this page Feb 1, 2024 · 1 revision

H1 Navn på komponenten (dette blir tittelen)

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 >

H2 Slik bruker du <navn på komponenten>

Her beskriver utvikler hvordan du teknisk tar den i bruk

H2 Eksempler på bruk av <navn på komponenten>

Oppsummering av de ulike eksemplene og variantene, hvis nødvendig.

H3 Eksempel 1

Ett avsnitt om dette eksempelet og når det skal brukes. [Eksempel]

  • eventuelt "Gjør dette"- og "Ikke gjør dette"-eksempler.

H3 Eksempel 2

Ett avsnitt om dette eksempelet og når det skal brukes. [Eksempel]

  • eventuelt "Gjør dette"- og "Ikke gjør dette"-eksempler.

H2 Retningslinjer for <navn på komponenten>

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.

H2 Tekst i komponenten

Nødvendige avsnitt om hva du bør tenke på når det gjelder tekst, språk og formulering for komponenten.

H2 Tilgjengelighet

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.

H2 Kjente mangler med denne komponenten