-
Notifications
You must be signed in to change notification settings - Fork 45
Slik skriver vi komponent‐dokumentasjon
- Komponentnavn skal alltid ha kode-formatering, f.eks
Card. (React-komponenter skal alltid ha stor bokstav.) - Attributter (props) skal alltid ha kode-formatering, f.eks
data-color. (Liten forbokstav) - HTML-elementer skal alltid skrives inni krokodilletegn i kode-formatering, f.eks
<a>. - Språk: Komponentnavn og attributter skal skrives på engelsk. Øvrige beskrivelser og retningslinjer skrives på norsk. 25% av komponentdokumentasjonen skal være på nynorsk.
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.
< 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]
Relevant for alle komponenter som kan kontrolleres.
[Eksempel]
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.
Passer til:
- Første punkt
- Andre punkt
Passer ikke til:
- Første punkt
- Andre punkt
...
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.