Dokumentationsmodel

 

Dokumentationsmodel for fællesoffentlig it-infrastruktur

Version 1.0

Infrastrukturelement

Anvendelse

Metode/Dokumentationsform

Navn

Det entydige navn gør at en specifik løsning/komponent nemt kan fremfindes.

Forebygger misforståelser i kommunikation

Udkast udarbejdes af ejer

Alternativt navn

Alternativt navn på løsning/komponent, som anvendes i kommunikations- eller projekt-regi

Udkast udarbejdes af ejer. Kan være et navn bestående af flere ord

Kort beskrivelse

Umiddelbar vurdering af om løsning/komponent er relevant at studere nærmere i forhold til løsnings funktionelle krav

Udformes af ejer. Kvalitetssikres og justeres eventuelt i forhold til helheden

Funktionalitet

Vurdering af hvorvidt den funktionelle dækning kan leve op til en given løsnings funktionelle krav

Ejer udformer kort tekst og leverer henvisninger. Kvalitetssikres og justeres eventuelt i forhold til helheden

Rationale/Værdi

Grundlag for at vurdere rationale for at anvende løsning/komponent og vurdere/beregne værdien af denne i en given løsning

Oprindelige rationale for at udarbejde løsning/komponent beskrives kort samt værdien ved at gøre løsning/komponent genbrugelig. Udkast udarbejdes af ejer og justeres evt. af redaktion

Krav til anvendelse

Vurdering af om løsning/komponent skal anvendes i den givne kontekst for en løsning

Må fremgå af eksisterende dokumentation hvis der er obligatorisk anvendelse i den givne kontekst.

STORM-løsningstype

Vurdering af hvorvidt den funktionelle dækning kan leve op til en given løsnings funktionelle krav

Udformes af ejer. Kvalitetssikres og justeres eventuelt i forhold til helheden.

Reference til STORM

FORM-Forvaltningsopgave

Vurdering af hvorvidt den opgavemæssige (forretningsmæssige) dækning lever op til en given løsnings krav.

Udformes af ejer. Kvalitetssikres og justeres eventuelt i forhold til helheden.

Reference til FORM

Anvendelsestype

Vurdering af hvorledes komponent/løsning indgår i den samlede arkitektur. Skal den kaldes som ekstern service eller indlejres i løsningen

Ud fra arkitektur for komponent/løsning angives anvendelsestype. Vurderes af ejer.

NB.: En komponent/løsning kan være både service og komponent

Løsningsarkitektur

Vurdering af hvorvidt infrastrukturelementet passer ind i en given løsnings arkitektur.

 

Ejer interviewes om komponenten ”set udefra” samt snitflader. Ud fra det og evt. eksisterende dokumentation udarbejder vi et diagram samt en oversigt over væsentlige snitflader (navn på funktioner, ikke detaljerede interface-beskrivelser)

Arkitekturtegning 1 – URL

Giver overblik over løsning/komponent i forhold til det viewpoint som arkitekturtegning er udarbejdet for

Arkitekturtegning udarbejdes af arkitekt på baggrund af eksisterende materiale og indsamlet viden. Behov for yderligere information indsamles via interview.

Udarbejdes i ArchiMate (anvend Archi tool)

Arkitekturtegning 2 – URL

Giver overblik over løsning/komponent i forhold til det viewpoint som arkitekturtegning er udarbejdet for

Arkitekturtegning udarbejdes af arkitekt på baggrund af eksisterende materiale og indsamlet viden. Behov for yderligere information indsamles via interview.

Udarbejdes i ArchiMate (anvend Archi tool)

Arkitekturtegning 3 – URL

Giver overblik over løsning/komponent i forhold til det viewpoint som arkitekturtegning er udarbejdet for

Arkitekturtegning udarbejdes af arkitekt på baggrund af eksisterende materiale og indsamlet viden. Behov for yderligere information indsamles via interview.

Udarbejdes i ArchiMate (anvend Archi tool)

Video 1-URL

En kort pædagogisk visuel beskrivelse af løsning/komponent, der hurtigt bibringer et overblik over løsning/komponent

Arkitekt udarbejder tekst-beskrivelse i ”story”-format, som kan anvendes som drejebog for optagelse af video

Video 2-URL

En kort pædagogisk visuel beskrivelse af løsning/komponent, der hurtigt bibringer et overblik over løsning/komponent

Arkitekt udarbejder tekst-beskrivelse i ”story”-format, som kan anvendes som drejebog for optagelse af video

Status

Vurdering af hvorvidt status for løsning/komponent er i overensstemmelse med planerne for en given løsning

Oplyses af ejer.

Tidspunkt for ibrugtagning

Vurdering af hvorvidt planer for løsning/komponent er i overensstemmelse med planerne for en given løsning.

Oplyses af ejer.

Tilslutningskrav

Vurdering af hvorvidt komponenten kan anvendes i den forretningsmæssige kontekst.

Kort tekst udformes af ejer. Redaktion kvalitetssikrer og justerer eventuelt i forhold til helheden.

Sprog

Hvilke sprog understøtter løsning/komponent. Eks. Dansk, Engelsk, Tysk.

Anvendes til at afgøre om løsning/komponent kan anvendes sprogmæssigt i en løsning og den tilhørende sprogkontekst

Udfyldes af arkitekt.

Sprog angives som landekode, da dette nem kan transformeres ved præsentation (flag, fulde navn, f.eks dansk)

Afhængighed-platform

Vurdering af om eventuelle afhængigheder/krav til underliggende platform kan indpasses forhold til løsning og anvendt teknologi

Udfyldes af arkitekt.

Kort beskrivelse af platform med angivelse af hvori afhængighed består

Afhængighed – andre løsninger

Vurdering af konsekvenser for løsning som afhængigheder til andre løsninger medfører

Udfyldes af arkitekt.

Reference til ”andre løsninger” med beskrivelse af hvad afhængighed omfatter

Krav til tekniske standarder

Vurdering af om krav til tekniske standarder kan indpasses i/overholdes af løsning

Udfyldes af arkitekt for løsning/komponent

SLA

Vurdering af om eventuelle SLA krav for løsning kan opfyldes af løsning/komponent

Oplyses af ejer

Ejer-information

Ejer af løsning/komponent kan altid fremfindes via ejer-information

Oplyses af ejer

Kontaktinformation

Ejer kan kontaktes for yderlige oplysninger og dokumentation

Oplyses af ejer

Link-projekthjemmeside

Er løsning/komponent del af et projekt, kan projektet fremfindes via dette link

Oplyses af ejer

Link-hjemmeside

Er der oprettet en hjemmeside for løsning/komponent kan denne fremfindes via dette link

Oplyses af ejer

Link- Teknisk dokumentation

Den tekniske dokumentation kan fremfindes via dette link

Oplyses af ejer

Link – Kildekode

Kildekode kan fremfindes via dette link

Oplyses af ejer

Link – Community

Findes der et community omkring løsning/komponent kan information fremfindes via link og evt. deltagelse kan også foregår

Oplyses af ejer

Link – Referenceimplementering

Referenceimplementering/”det gode eksempel” kan findes via dette link, hvis det er udpeget

Ejer interviewes. Vi udarbejder kort tekst med henvisninger til yderligere dokumentation.

Link – SLA information

Specifik SLA information/specifikation kan fremfindes via dette link

Oplyses af ejer

Link – Driftsstatus

Er løsning/komponent i produktion kan aktuel driftsstatus fremfindes via dette link

Oplyses af ejer

 

 

Permanent URL til denne artikel: http://arkitekturguiden.digitaliser.dk/node/570