Informatievlaanderen / OSLO-Standaarden

The content of the OSLO Standaardenregister on data.vlaanderen.be
18 stars 9 forks source link

Inhoud vd specificatie documenten #51

Open GeertThijs opened 7 years ago

GeertThijs commented 7 years ago

Nu ik een zgn voorbeeld-inleiding voor de vocs/ap’s aan het schrijven ben (voor Persoon) zit ik met volgende vragen over de inhoud vd spec documenten:

  1. Toch een volledige beschrijving geven vh vocabularium, zelfs als het amper nieuwe of zelfs geen termen bevat. Kwestie van een samenhangend verhaal te hebben en ook: een verhaal in het Nederlands aangezien elk vocabularium verwijst naar bestaande vocabularia. Vereist ook een figuur met het datamodel maar dan zonder de restricties vh applicatieprofiel.
  2. Een gedeeltelijke beschrijving vh vocabularium, maw enkel die termen die het vocabularium aan bestaande vocabularia toevoegt. Kan soms raar zijn: bvb we voegden contactinfo en gebruikteVoornaam toe aan de bestaande eigenschappen van ISA-Persoon en zouden dus moeten volstaan met een beschrijving van deze eigenschappen (die eigenlijk ook bij de definities zal gevonden worden).
  3. Geen algemene beschrijving vh vocabularium. Sowieso zegt de beschrijving meer over hoe de termen geïnterpreteerd (gebruikt?) moeten worden waardoor ze eerder thuishoort in het applicatieprofiel (of de applicatieprofielen).
  4. Een apart document met de beschrijving. Zowel vocabularium als applicatieprofielen kunnen daarnaar verwijzen. Dat document is een beschrijving van het domeinmodel vh betrokken thema en houdt naast de beschrijving dus ook een datamodel in evenals verwijzingen naar andere modellen, literatuur etc.

In afwachting van jullie commentaar ga ik alvast oor de laatste optie.

GeertThijs commented 7 years ago

Voorbeeld van optie 3 (eigenlijk meer een variant) is CPSV-AP: zij hebben geen voc-specificatiedocument voor de uitbreiding die CPSV-AP doet op CPSV, zij publiceren gewoon een CPSVAP-RDF (met kardinaliteiten in de comment!?) en het ap-specificatiedocument licht zowel de nieuwe termen als het profiel toe. Problematisch toch ook wel: alles loopt door elkaar: wanneer slaat de beschrijving op de applicatie en wanneer niet? En optie 4 wordt toegepast bij Web Annotation: datamodel https://www.w3.org/TR/annotation-model/ en vocabularium https://www.w3.org/TR/annotation-vocab/ zijn aparte documenten.

jensscheerlinck commented 7 years ago

Voor mij is de HTML versie van het vocabularium een document dat in de eerste plaats bruikbaar moet zijn door de gebruikers (mensen). De "échte" definitie van het vocabularium zit vervat in het Turtle bestand.

Een apart document, zoals het Web Annotation datamodel is een mogelijkheid, maar dan moet het Voc een ondersteunende rol hebben en niet zo prominent aanwezig zijn (bv. de eerste pagina weer mensen naartoe surfen is dan het data model document). Ook praktisch gezien lijkt dit een hoop extra werk, plus dat voor wat betreft ISA Persoon of CPSV-AP wij (AIV-OSLO) misschien niet het best geplaatst zijn om dit te schrijven.

Een mogelijkheid zou zijn om in een apart hoofdstuk, op het einde, de klassen en eigenschappen op te nemen die werden hergebruikt uit andere vocabularia, samen met het label en eventuele definitie in het Nederlands.

Een voorbeeld hiervan is: https://www.w3.org/TR/annotation-vocab/ (hoofdstuk 3)

Het domein en bereik van de hergebruikte termen zou rechtstreeks kunnen opgehaald worden uit de desbetreffende namespaces (automatisch, via een script).

Tot slot, in plaats van een volledig domein model weer te geven zoals bij de APs (waar impliciet de klassen en attributen al in een bepaald stramien gegoten worden), kan zoals bij de Web Annotation Ontology gekozen worden om kleine diagrammen op te nemen bij de klassen en eigenschappen zelf.