Utviklingsguider

Hvert produkt har en utviklingsguide som skal sørge for at brukeren får en oversikt over hva som må til for å bruke dette produktet. Guiden skal skrives slik at det er lett å forstå hvilken rekkefølge du skal gjøre oppgavene i.

Utviklingsguider skal beskrive steg for steg hvordan utviklere går frem for å bruke de ulike produktene til Altinn. Det bør være én utviklingsguide per produkt. Undersider kan brukes til å vise eksempler eller presentere teknisk dokumentasjon og kodeeksempler som er relevant for produktet.

Brukeroppgaver for utviklingsguider

• Hvordan kommer vi i gang med utviklingen?
• Hvilke tilganger trenger vi?
• Hvordan tilrettelegger vi våre egne system?
• Hvordan tester vi grensesnittet?
• Hvordan produksjonssetter vi tjenesten?

Regler for innhold

Tittel og intro

• Bruk samme tittel som brukes på produktsidene.
• Intro - Hva er “produktet” og kort om prosessen for å utvikle det.

Trinnvis oppskrift

Forsiden på utviklingsguiden skal inneholde en trinnvis oppskrift som tar for seg hele prosessen fra å skaffe tilganger til å produksjonssette tjenesten.

• Maks 10 trinn
• Maks 80 ord per trinn
• På trinnene som trenger mer forklaring, lenk til en underside som forklarer prosessen mer detaljert.

Undersider

• Bruk undersider for å vise detaljerte beskrivelser med kodeeksempler og skjermbilder.
• Opplys eventuelt om teknisk dokumentasjon utvikleren bør kjenne til eller relevante lenker.