Få styr på leverancer
Guide: Få dokumentationen på plads fra start
Gør dit valg af dokumentation til en plan, der holder hele vejen. Guiden hjælper dig med at planlægge, udarbejde, vedligeholde og overdrage den dokumentation, projektet har brug for.
Har du ikke valgt dokumentationen endnu? Start med Sådan arbejder du med dokumentation.
Sådan bruger du guiden
Brug guiden allerede som en del af projektplanlægningen. Vend tilbage til den ved faseovergange, større releases og væsentlige ændringer i projektets scope, krav, risici, organisering eller løsningsvalg. Projektlederen vil typisk drive trin 1 og 6, mens arkitekter og andre specialister vil have en større rolle i de øvrige trin.
Følg trinene
Lav en plan for projektets arkitekturprodukter
Fastlæg leverancer, ansvar og tidsplan
Udarbejd som en del af projektplanlægningen en overordnet plan for projektets arkitekturdokumentation.
Planen skal angive, hvilke arkitekturvisninger der skal udarbejdes, og hvilke krav der gælder for deres kvalitet og detaljeringsgrad.
De formelle arkitekturleverancer afklares med projektets styregruppe. Projektlederen, arkitekten og en eventuel arbejdsgruppe sparrer om, hvilke øvrige arkitekturprodukter der skal indgå i projektets samlede arkitekturdokumentation.
Planen bør tydeliggøre, hvilke roller der udarbejder, bidrager til og anvender arkitekturprodukterne, samt fastlægge tidsmæssige krav, så der er klare forventninger til, hvad der skal udarbejdes og hvornår. Tag højde for, at arkitekturdokumentationen udvikles iterativt og gradvist, og at projektet kan blive klogere undervejs.
Begynd med informationsbehovet
Tag udgangspunkt i den dokumentation, du har valgt ud fra interessenternes informationsbehov (se Sådan arbejder du med dokumentation). Prioritér genbrug og interoperabilitet.
Undersøg også, om det er relevant at supplere med andre arkitekturprodukter fra egen organisation, fagdomæne eller branche. Du kan fortsat bruge FDA’s perspektiver og arkitekturregler som pejlemærker for dine valg.
Inddrag europæiske krav tidligt
Skal løsningen understøtte tjenester, dataudveksling eller samarbejde på tværs af landegrænser, bør projektet tidligt afklare, om europæiske standarder eller en interoperabilitetsvurdering er relevant.
Gør dokumentationen beslutningsklar
Afklar, hvilken dokumentation der skal være i projektets beslutningsgrundlag og i forbindelse med eventuelle arkitekturreviews.
Som minimum anbefales arkitekturprodukterne vision/målbillede og systemkontekstdiagram til beslutningsgrundlaget. Vedlæg en første overordnet vision for målarkitekturen som bilag. Arbejder du efter Statens it-projektmodel, kan du se, hvor produkterne indgår, i Brug FDA i Statens it-projektmodel.
Hvis projektet skal gennem et arkitekturreview, skal du afklare tidspunktet tidligt og planlægge de produkter, der skal indgå i reviewgrundlaget
Gør planen konkret og styrbar
Fastlæg én tydelig kilde til hvert arkitekturprodukt, så den samme information ikke skal vedligeholdes flere steder.
Sørg også for, at der er et klart ansvar for at udarbejde, vedligeholde, anvende og genbruge arkitekturprodukterne. Aftal, hvor de hører hjemme – i projektet, andetsteds eller på tværs – og om de er midlertidige eller blivende. Tværgående governance skal sikre, at relevant dokumentation bevares og vedligeholdes, også når projektet afsluttes, og løsningen overgår til drift.
Fastlæg projektets metode
Beskriv den valgte fremgangsmåde
Brug arkitekturproduktet metodeanvendelse til at beskrive den overordnede fremgangsmåde. For eksempel om projektet er underlagt en særlig projektmodel, om der anvendes agile metoder, eller om der er aftalt et arkitekturrammeværk såsom FDA eller TOGAF . Vær samtidig opmærksom på, om overordnede metodebeskrivelser allerede er dækket i projektgrundlaget eller PID.
Tilpas metoder, formater og værktøjer
Angiv, hvordan metoder og notationer skal tilpasses projektets kontekst. Tilpas også valget af visningsformater , så de understøtter projektets plan for arkitekturdokumentationen.
Det er vigtigt at få projektets anvendte værktøjer, udvekslingsformater, navngivning og versionsstyring på plads så tidligt som muligt. Tag udgangspunkt i FDA’s retningslinjer og eventuelt andre standarder, der gælder i din organisation, fagdomæne eller branche.
Hold styr på tilpasninger og kilder
Vedligehold tilpasningerne gennem hele projektets levetid.
Gør det tydeligt, hvilke modeller og dokumenter projektet bruger, hvordan de hænger sammen, hvor de opbevares, og hvilken model der er den autoritative kilde.
Brug relevante åbne udvekslingsformater, når materiale skal deles på tværs af værktøjer. Supplér eventuelt den redigerbare og maskinlæsbare kildemodel med en læsbar version såsom en PDF. Så kan alle finde og anvende den gældende dokumentation.
Vælg modelsprog efter formål
Vælg modelsprog ud fra produktets formål og målgruppens behov. Brug som udgangspunkt ArchiMate til den overordnede arkitekturmodel og det tværgående helhedsblik. ArchiMate er særligt velegnet til at vise sammenhænge mellem mål, forretning, information, applikationer og infrastruktur og til at forbinde spørgsmålet om, hvorfor løsningen skal udvikles, med hvordan den forventes realiseret.
[ArchiMate-vejledningen]
Anvend som udgangspunkt UML til begrebs- og datamodeller og følg FDA’s regler for begrebs- og datamodellering
[Lav begrebsmodel]
[Lav informations- og datamodeller]
Til andre detaljerede modeller kan du anvende relevante metoder og notationssprog. Det kan være BPMN, DMN, UML eller wireframes. Lad produktets formål, målgruppe og krav til præcision afgøre valget. I Arkitekturreolen kan du se anbefalede formater og relevante metoder for det enkelte arkitekturprodukt.
[Vælg modeltype]
Brug en fælles terminologi
Etablér et fælles begrebsgrundlag tidligt
Identificér tidligt de centrale forretningsobjekter og begreber, som projektets parter skal forstå på samme måde, og saml dem i en begrebsliste eller begrebsmodel. Genbrug eksisterende begreber fra FDA, fagdomænet og organisationen, før du definerer nye.
Find og genbrug fælles begreber
Find den fælles terminologi i FDA-ordbogen, Modelkataloget og andre relevante ressourcer. Her fremgår ofte både foretrukne og tilladte termer, så du lettere kan vælge de formuleringer, der passer til anvendelsessituationen og målgruppen.
Følg reglerne for begrebs- og datamodellering, når modellerne skal udformes, deles og genbruges.
Skab sammenhæng på tværs af modeller
Brug terminologien konsekvent på tværs af projektets leverancer. Udarbejd dokumentationen, så der er sammenhæng og konsistens mellem arkitekturprodukterne, eksempelvis ved at lade procesmodeller bruge begreber og attributter fra begrebsmodeller, informationsmodeller og logiske datamodeller.
Tal til målgruppen
Tilpas formidlingen til målgruppen, og forklar altid de vigtigste pointer i et diagram.
[Læs mere om formidling af dokumentation]
Genbrug arkitektur og andre løsninger
Tag udgangspunkt i fælles arkitektur
Undersøg, om projektet kan tage udgangspunkt i eksisterende fælles arkitektur. Opsøg og brug relevante FDA-ressourcer.
Gennemgå først forskellige referencearkitekturer for at finde de mål, principper, begreber og ressourcer, som projektet skal forholde sig til. Vurdér, hvad der er relevant i din sammenhæng. Der kan være formelle krav til, at en løsning skal, bør eller kan anvendes.
[Hvad du skal, bør og kan genbruge]
Følg udviklingen og afklar krav
Søg også efter genbrugelige artefakter inden for egen organisation, fagdomæne og andre områder. Der kan for eksempel være brugbare, genbrugelige mønstre, som du kan anvende til at udarbejde projektets egen arkitektur.
Undersøg så vidt muligt, om andre projekter har planlagte leverancer, der kan få betydning for dit projekt. Det kan være nye referencearkitekturer, standarder eller andre typer arkitekturbyggeblokke.
Find løsningsbyggeblokke
Når projektets behov for arkitekturbyggeblokke er afklaret, skal du undersøge, om de kan realiseres med eksisterende løsningsbyggeblokke.
Søg tilsvarende i FDA-ressourcerne, i din egen organisation og i relevante fagdomæner efter eksisterende løsninger, standarder, infrastrukturkomponenter og andre genbrugelige elementer.
Løsningsbyggeblokkene kan være både danske og internationale, herunder løsninger fra EU.
[Søg blandt EU’s byggeblokke]
Vurder løsningerne fra flere perspektiver
Vurdér ikke en løsningsbyggeblok alene ud fra dens funktionalitet. Se også på dens understøttelse af fælles standarder, sikkerhed og privatliv, datakvalitet, drift og servicemål, vedligeholdelse, licenser, leverandørafhængighed og samlede omkostninger. Brug de tværgående FDA-perspektiver, principper og arkitekturregler, såsom sikkerhed og jura, til at belyse de vigtigste forhold.
Del og overdrag projektets arkitekturdokumentation
Planlæg deling og overdragelse i god tid
Tag stilling til deling og overdragelse, før projektet afsluttes. Dokumentationen skal ikke alene kunne findes af projektgruppen. Den relevante del skal kunne anvendes af de personer, der overtager ansvar for drift, vedligeholdelse og videreudvikling, og genbrugelige produkter skal kunne findes af andre projekter og organisationer.
[Læs mere om vedligehold]
Sortér dokumentationen
Skeln mellem midlertidige arbejdsprodukter og dokumentation, der skal bevares. Tidlige skitser og erstattede visninger kan normalt arkiveres, mens den konsoliderede løsningsarkitektur, centrale modeller, arkitekturbeslutninger, snitflader, sikkerhedskontroller samt konfigurations- og driftsdokumentation ofte skal overtages og vedligeholdes efter projektets afslutning.
Gør genbrugelige produkter tilgængelige
Vurdér, om projektets produkter for eksempel kan indgå i FDA eller et andet domænes fælles arkitektur og portefølje af fælles ressourcer. Det gør fremtidigt samarbejde lettere både for organisationen og på tværs af organisationer – og lettere at udveksle data mellem forskellige systemer.