API-4 niet duidelijk in verschillende situaties - Feedback Publieke Consultatie

[mrtn78]

Originele bericht van Provincie Zuid-Holland:

API-04: Define interfaces in Dutch unless there is an official English glossary available
Dit is niet te hanteren in een situatie waarin die glossary er nog niet is. Twee situaties:

1. een open source ontwikkeltraject waarin je nog niet beschikt over een engelstalige glossary maar toch de code internationaal wilt delen om de community zo groot mogelijk te maken. Engels is dan de te hanteren standaardtaal.
2. interfaces met een COTS toepassing. De leverancier is internationaal georiënteerd en hanteert Engels als voertaal.

Interpretatie vanuit Logius voor aanpassing van de ADR:

• we gaan duidelijk onderscheid maken tussen het hergebruik van bestaande glossary/schema en het ontwikkelen van een eigen (nieuwe) glossary
• toevoegen dat samenwerking met COTS (Commercial Off The Shelf ) software leveranciers ook een reden kan zijn om engels te hanteren.

[mrtn78]

Voorgesteld om de tekst van deze regel verder uit te breiden tot de volgende tekst:

API-04: Define interfaces in Dutch unless there is an official English glossary or an international audience

Since the exact meaning of concepts is often lost in translation, resources and the underlying attributes should be defined in the Dutch language unless there is an official English glossary being developed or already available. Publishing an API for an international audience or commercial software development organisations might also be a reason to define interfaces in English.

Note that glossaries exist that define useful sets of attributes which should preferably be reused. Examples can be found at schema.org.

Note that commercial software development organisations are usually internationally oriented and use English as the main language to develop and document software.

zie ook het pull request 118 in de ADR repository