Documentatie van het semantische gegevensmodel

Een informatiemodel en een semantisch gegevensmodel kennen dezelfde documentatie. Een informatiemodel zal in de regel deel uitmaken van een rapport waarin ook de functionele specificaties van de processen zijn opgenomen. Binnen zo’n rapport dient het informatiemodel dan wel een zelfstandig onderdeel te vormen.

Een semantisch gegevensmodel maakt in de regel deel uit van de tollgate-producten die in het kader van een innovatieproject worden opgeleverd, in dit geval in fase 1. Op deze plek geven we de documentatierichtlijn voor een semantisch gegevensmodel in projectverband. De documentatie van het bedrijfs semantisch gegevensmodel wijkt op onderdelen af.

Aandacht Een semantisch gegevensmodel in een project wordt altijd vervaardigd op basis van het ontologisch model van het betreffende project. Dit betekent, dat alle primaire entiteittypen als objecttype in het ontologisch model moeten voorkomen.

(Mocht tijdens het uitwerken van het semantisch gegevensmodel geconcludeerd worden, dat de afbakening van het ontologisch model onjuist is, dient eerst dit ontologisch model aangepast te worden – uiteraard in overleg met de daarvoor verantwoordelijke functionarissen.)

Aandacht Waar voor het semantisch gegevensmodel gegevenstypen uit het bedrijfs semantisch gegevensmodel zijn overgenomen worden vanzelfsprekend de daar opgenomen beschrijvingen en definities overgenomen. De standaardindeling van de documentatie van een semantisch gegevensmodel ziet er als volgt uit:

  1. Inleiding en verantwoording.
    Dit deel omvat:
    1. gegevens over de totstandkoming van het model, de besluitvorming erover, de verspreiding en het beheer (vergeet niet aan te geven op welk ontologisch model (en welke versie ervan) het gebaseerd is);
    2. ingeval van wijzigingen op een eerder model: een verantwoording van de wijzigingen. Wat is waarom aangepast;
    3. een beschrijving en toelichting van de algemene modelleringsbeslissingen. Dit is wellicht het belangrijkste onderdeel van het model. Het bepaalt in hoge mate de overdraagbaarheid en onderhoudbaarheid ervan.
  2. De beschrijving van de gegevenstypen.
    1. Schema’s plus toelichting.
    2. Beschrijving van de gegevenstypen per primair entiteittype:
      • Alle gegevenstypen volgens schrijfconventie.
      • Afleidingsregels (indien van toepassing).
      • Transitieregels (waar relevant).
      • Beschrijving populatie.
      • Beschrijving beheer en gebruik: vooral de creator en de eigenaar.
      • Overige informatie (nauwkeurigheid, actualiteit, betrouwbaarheid, privacy aspecten, autorisatie, etc.).
    3. Beschrijving gegevensregels.
  3. De beschrijving van de secundaire entiteittypen.
    1. de definitie van het entiteittype (conform de definitie-eisen voor objecttypen).
    2. het aanduidingtype.
    3. specifieke regels.
  4. De beschrijving van de aanduidingtypen.
  5. Een samenhangend geheel van voorbeelden (aansluitend op het ontologisch model).