Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Open
mrtn78 opened this issue Nov 11, 2021 · 3 comments · May be fixed by Logius-standaarden/API-Design-Rules#119
Open

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

mrtn78 opened this issue Nov 11, 2021 · 3 comments · May be fixed by Logius-standaarden/API-Design-Rules#119
Assignees
@mrtn78
Labels
Consultatie Issue uit consultatie Scope: minor change minor changes in the API Design Rules WG: Normatieve rules issues regarding the normative part of the API design rules
Milestone
ADR v2.1.0

Comments

@mrtn78
Copy link
Collaborator

mrtn78 commented Nov 11, 2021 •
edited
Loading

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 mrtn78 added WG: Normatieve rules issues regarding the normative part of the API design rules Consultatie Issue uit consultatie labels Nov 11, 2021
@mrtn78 mrtn78 self-assigned this Nov 11, 2021
@mrtn78 mrtn78 added the Scope: minor change minor changes in the API Design Rules label Nov 12, 2021
@mrtn78 mrtn78 added this to the ADR v1.0.1 milestone Nov 12, 2021
@mrtn78
Copy link
Collaborator Author

mrtn78 commented Nov 17, 2021 •
edited
Loading

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 mrtn78 linked a pull request Nov 17, 2021 that will close this issue
Draft
@mrtn78
Copy link
Collaborator Author

mrtn78 commented Nov 17, 2021

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 mrtn78 modified the milestones: ADR v1.0.1, ADR v2.1.0 Apr 25, 2024
@mrtn78
Copy link
Collaborator Author

mrtn78 commented Apr 25, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mrtn78 mrtn78

Labels
Consultatie Issue uit consultatie Scope: minor change minor changes in the API Design Rules WG: Normatieve rules issues regarding the normative part of the API design rules
Projects
None yet
Milestone
ADR v2.1.0
1 participant
@mrtn78