Datamodellen skal dokumenteres

Nummer:
5.9
Version:
1.0.0
Udgået
Regel godkendt den:
3. February 2014
Regel udfaset den
20. January 2015
Regel

Datamodellen skal dokumenteres gennem beskrivelser af elementerne i UML-modellen. Beskrivelserne etableres og vedligeholdes sammen med modellen som beskrevet i bilag 3.

Rationale

Dokumentationen gør det muligt for modellens brugere at forstå modellens elementer. Både når man udvikler og anvender modellen, er det essentielt at kommunikere og forstå betydningsindholdet af de enkelte dele af modellen. Det at dokumentationen er indlejret i datamodellen muliggør automatisk dannelse af et katalog over klasser, attributter og relationer. Yderligere kan dokumentationen indgå i datasnitfladerne, hvis der er ønske herom. Skabelonen for dokumentation i bilag 3 stammer fra INSPIRE, som har et gennemprøvet setup for dokumentation af UML-modeller.

Implikationer

Datamodellens klasser, attributter og relationer skal dokumenteres som beskrevet i bilag 3.

 

 

 

Bilag 3: Dokumentation af datamodellen

Datamodellen skal dokumenteres gennem beskrivelser af elementerne i UML-modellen. Datamodellens klasser, attributter og relationer skal dokumenteres som beskrevet i skabelonen herunder. Skabelonen for dokumentation stammer fra INSPIRE, som har et gennemprøvet setup for dokumentation af UML-modeller [INSPIRE dokumentation].

Dokumentation i UML

Klasser, attributter og relationsender dokumenteres ved brug af Notes-tekstfeltet, som er en del af UML-standarden. Dokumentationen skal følge skabelonerne herunder, således at det er muligt at autogenerere et katalog med dokumentation af datamodellen. Nogle af felterne i skabelonen vil i et modelleringsværktøj kunne autoudfyldes ud fra diagrammet.

Dokumentation af klasser

Klasser i datamodellen beskrives ud fra følgende skabelon:

 

Navn

Navn på klassen i UpperCamelCase. Navnet skal som minimum være entydigt inden for UML-pakken.

Stereotype

Klassens stereotype

Definition

Kort og præcis definition. Kan også indeholde et afsnit med en længere beskrivelse, fx med eksempler og henvisning til definitioner.

Dokumentation af attributter

Klassens attributter beskrives hver især ud fra følgende skabelon:

Navn

Navn på attributten i lowerCamelCase. Navnet skal som minimum være entydigt inden for klassen.

Evt. stereotype

Hvis der er anvendt en stereotype til attributten

Datatype

Standardiseret datatype fra ISO eller et klassenavn for en DataType eller en KodeListe

Multiplicitet

Her angives antalsregler for, hvor mange værdier, attributten kan rumme på en enkelt instans af klassen.

Fx: 0..1, 1..1, 0..*, 0..4, 1..*, 2-4, ...

Definition

Kort og præcis definition. Kan også indeholde et afsnit med en længere beskrivelse, fx formål, referencer, eksempler og kilde.

Dokumentation af relationsender

Relationer, der ender på klassen beskrives hver især ud fra følgende skabelon:

Navn

Entydigt navn på relationsenden i lowerCamelCase. Navnet er som minimum entydigt inden for UML-pakken.

Evt. stereotype

Hvis der er anvendt en stereotype til relationsenden

Kardinalitet

Her angives antalsregler for begrebets deltagelse i relationen.

Fx: 0..1, 1..1, 0..*, 1..*

Definition

Kort og præcis definition. Kan også indeholde et afsnit med en længere beskrivelse, fx formål, referencer og eksempler.

 

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