designdokumentasjon

Designdokumentasjon er den dokumentasjonen som beskriver hovedtrekkene i et systemdesign, inkludert arkitektur, komponenter, grensesnitt og valg av tekniske løsninger. Den brukes for å kommunisere designet mellom utviklere, arkitekter, prosjektledere og andre interessenter, og fungerer som en veiledning gjennom utviklings- og vedlikeholdsfasen.

Innholdet i designdokumentasjon kan omfatte arkitekturbeskrivelse, modul- og komponentdesign, grensesnitt og API-beskrivelser, datamodell og datalagring, designmønstre og vurdering av kvalitetsatferd som ytelse, sikkerhet, pålitelighet og tilgjengelighet. Den bør også inneholde beslutningslogg for viktige designvalg, avgrensninger, avhengigheter, konfigurasjon og migrasjons- og vedlikeholdsbehov. Dokumentet kan knytte seg tett til kravdokumentasjon, teknisk spesifikasjon og implementasjonsdokumentasjon for å sikre konsistens.

Hvem bruker den: utviklere og arkitekter som implementerer, testteam for akseptanse og kvalitetsmål, drift og forvaltning for vedlikehold, samt interessenter og regulatoriske krav.

Prosessen innebærer at designdokumentasjon utarbeides tidlig i prosjektet og oppdateres ved betydelige beslutninger eller endringer. Den bør håndteres i et versjonskontrollerbart format og være lett tilgjengelig for relevante parter. Internasjonale standarder som ISO/IEC/IEEE 42010 beskriver arkitekturbeskrivelser; i praksis tilpasses dokumentasjonen prosjektets behov og organisasjonens styringsmodell.

Dokumentasjonen er et levende verktøy som må vedlikeholdes og revideres når systemet utvikles.