search

Geonovum / KP-APIs

26 stars 40 forks source link

API-17: Publishing language - Feedback Publieke Consultatie #421

Open mrtn78 opened 2 years ago

mrtn78 commented 2 years ago

Originele bericht van Provincie Zuid-Holland:

API-17: Publish documentation in Dutch unless there is existing documentation in English Zie de opmerking bij API-04. Er zijn situaties waarbij Nederlandstalig niet gewenst is. In een ontwikketraject beschik je nog niet over Engelstalige documentatie, maar die is wel erg gewenst voor de community of voor de internationaal georienteerde leverancier. De voorkeur zou zijn: Engels is verplicht en optioneel Nederlands.

mrtn78 commented 2 years ago

persoonlijk ben ik het er mee eens dat we minder strikt Nederlandse OAS documenten moeten voorschrijven. we doen een voorstel om in lijn met de aanpassing in API-04 (nav issue #419) in meer situaties engels toe te staan.

mrtn78 commented 2 years ago

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

API-17: Publish documentation in Dutch unless there is existing documentation in English or an international audience

In line with design rule API-04, the OAS document (e.g. descriptions and examples) should be written in Dutch. If relevant, you may use or refer to existing documentation written in English. Publishing an OAS documents for an international audience or commercial software development organisations might also be a reason to define documentation in English.

zie ook het pull request 119 in de ADR repository

mrtn78 commented 4 months ago

Nagaan of het onderscheid specificatie tov documentatie kunnen maken met als bij DON