1 Innledning
Høynivå beskrivelse som henvender seg til de med liten detaljeforståelse, men med mulig interesse i systemet/tjenesten.
Få med:
- Formål med systemet/tjenesten
- Ikke-teknisk oversikt
- Systemeier, andre kontaktpunkter
- Referanse til applikasjonsbeskrivelsen i BNT sin applikasjonsoversikt (hvis systemet er sluttbrukerrelatert)
(Burde vi si noe om tjenesteorientering og hva tjenesten dekker av tjenestebehov?)
1.1 Brukerroller
Primære brukerroller til tjenesten (direkte og indirekte brukere av applikasjonen).
2 Redegjørelse
Dette punktet skal informere om tjenestens formål, krav og føringer, samt gi en oversikt over revisjoner og historiske valg.
- Gjøre rede for avhengigheter, antagelser, fordeler, risikoer, mangler, premisser, etc. (Viktig å ha dette samlet ett sted i dokumentet.)
- Risikoer, mangler eller andre hindre slettes ikke fra dokumentet når problemet løses, men beholdes for informasjon; merk som løst og hvorfor det ikke lenger er problem.
- Sier noe om suksess for system/tjeneste.
Skriv gjerne dette punktet etter at resten av dokumentet er ferdig.
3 Detaljebeskrivelse
Herunder ligger de aspekter som anses å være «bottom-up». Punktene er forslag til struktur, ikke en absolutt mal.
3.1 Teknisk formål
Hvis innledning ikke sier noe tilstrekkelig om det tekniske målet, så utbroderes dette her. Ellers refererer punktet kun til innledningen.
3.2 Høynivådesign (Overordnet design)
Samhandling mellom komponenter.
3.3 Lavnivådesign (Design av enkeltkomponenter)
Her lages ett punkt for hver komponent/systemdel.
4 Avhengigheter
Konkrete systemer/tjenester og en kort beskrivelse av hva avhengigheten går ut på.
4.* Systemet avhenger av
Eventuelle avhengigheter
4.* Andre systemer er avhengige av
... dersom det finnes.
5 Relaterte systemer (optional)
Navn og en kort beskrivelse om hvorfor systemet er relatert.
6 Lenker og referanser
- Lenke til kode og relevant dokumentasjon
- Lenke til applikasjonsbeskrivelsen til tjenesten
- Andre referanser