VNG-Realisatie / API-Kennisbank

Afspraken, werkinstructies, tutorials, enz. voor de co-creatie en het beheer van API standaarden
https://vng-realisatie.github.io/API-Kennisbank/
6 stars 8 forks source link

Gebruik benamingen zoals gedefinieerd in een gegevenswoordenboek #82

Open melsk-r opened 3 years ago

melsk-r commented 3 years ago

Wanneer er een gegevenswoordenboek (gegevenscatalogus, informatiemodel) bestaat, gebruiken we voor corresponderende resources of voor corresponderende properties in een resource de naam zoals die in het gegevenswoordenbook staat, met inachtneming van de Design Rules voor naamgeving, zoals gebruik (Upper)snakeCase.

Van de naam in het gegevenswoordenboek kan worden afgeweken in o.a. de volgende situaties:

melsk-r commented 3 years ago

JBo: Discussie HK: RM: Discussie MV: Prima om te bespreken GJ: Bespreken JBi: Bespreken

JBo: Deels overnemen, deels bespreken. RM: DD niet presenteren als een regel maar als een richtlijn. JBi: Kwalificatie Regel, Richtlijn etc toevoegen lijkt me een goed idee. Verder lijkt het me een prima punt. Waarom heb je anders een gegevenswoordenboek. Dus gebruiken tenzij je uit kan leggen waarom niet (bijvoorbeeld omdat je aan 1 van de genoemde uitzonderingen voldoet). MV: Ik zou geen afkortingen gebruiken in een informatiemodel, ook om de vertaling naar API's makkelijker te maken.