Få styr på leverancer
Sådan arbejder du med dokumentation
Vælg arkitekturprodukter og detaljeringsniveau ud fra, hvem der skal bruge dokumentationen, og hvad de skal kunne beslutte eller gøre
Begynd med de beslutninger og opgaver, projektet står over for – ikke med en liste over dokumenter. God dokumentation er den, modtagerne kan bruge, og som er tilstrækkelig til formålet.
Find modtagerne
Find først ud af, hvem der skal bruge dokumentationen, og hvem der skal træffe beslutninger om, udvikle, drifte eller forvalte løsningen. Brug interessentanalysen til at skabe overblik over, hvem løsningen berører.
Overvej blandt andre:
ejere og beslutningstagere, fx styregruppen
forretningen og brugerne
arkitekter, udviklere og leverandører
jurister, sikkerhedsansvarlige og dataansvarlige
drift, support og forvaltning
samarbejdspartnere med ansvar for fælles data, processer eller infrastruktur.
Den samme person kan have flere roller og dermed forskellige behov. Inddrag de modtagere, hvis behov dokumentationen skal dække – du behøver ikke dokumentere for alle.
Afklar informationsbehovet
Afklar fire ting for hver modtager:
Skriv svarene ned. De hjælper dig med at begrunde, hvilke produkter du vælger, og hvilket detaljeringsniveau der er nødvendigt.
Vælg arkitekturprodukter og detaljeringsniveau
Brug Arkitekturreolen til at finde og begrunde dine valg. Når du åbner et perspektiv, kan du se, hvem de typiske interessenter er, hvad de har brug for at vide, og hvilke principper og arkitekturregler der hører til. Sammenhold det med de behov, du har afklaret, og vælg de arkitekturprodukter, der dækker dem. Læs mere om perspektiverne og produkterne på siden Arkitekturreolen,
Vælg derefter et detaljeringsniveau, der passer til formålet:
Niveau | Vælg det, når modtageren skal … |
Overblik – konceptuelt | forstå formålet, de vigtigste dele og sammenhængene |
Design – logisk | forstå, hvordan elementerne hænger sammen, og hvilke definitioner og relationer der gælder |
Realisering – fysisk | udvikle, implementere eller drifte løsningen |
Vælg niveau efter modtagerens behov – ikke kun efter projektets fase. En tidlig beslutning kan kræve en grundig afklaring af en kritisk integration, mens styregruppen stadig har brug for et overblik.
Tjek og begrund valget
Gå valget igennem, før du går videre:
Får hver modtager svar på sine spørgsmål?
Har hvert produkt en modtager og et tydeligt formål?
Er detaljeringsniveauet tilstrækkeligt til de beslutninger og opgaver, dokumentationen skal understøtte?
Hvilke principper og arkitekturregler er relevante, og hvordan belyser dokumentationen de hensyn, de beskriver?
Et produkt opfylder ikke automatisk en arkitekturregel, fordi det er knyttet til reglen i Arkitekturreolen. Vurdér konkret, om dokumentationen håndterer det relevante hensyn.
Når valget er på plads, skal arbejdet planlægges: Aftal, hvem der udarbejder produkterne, hvornår de skal være klar, og hvem der overtager dem. Brug Guide: Få dokumentationen på plads fra start til at planlægge arbejdet. Skal dokumentationen bruges i et udbud, så se Sådan bruger I FDA i et udbud.
Eksempel: Et begrundet valg
En ny løsning skal udveksle data med et eksisterende system.
Modtager | Skal kunne … | Perspektiv i Arkitekturreolen | Arkitekturprodukt | Niveau |
Styregruppe | vælge løsning og forstå afhængigheder og risici | Strategi og styring | resumé af målarkitekturen med en enkel illustration | Overblik – konceptuelt |
Udviklere | forbinde systemerne og fastlægge, hvilke data der skal udveksles | Information og applikation | datamodel og snitfladebeskrivelse | Design – logisk og realisering – fysisk |
Drift | holde integrationen kørende og vedligeholde den | Infrastruktur | dokumentation af den realiserede løsning og dens konfiguration | Realisering – fysisk |
Vis den samme arkitektur på den måde, der hjælper hver modtager med sin opgave. Lad visningerne bygge på ét sammenhængende grundlag, så de ikke giver modstridende svar.