From 77680885ee636b9ccd0d0b02385aa090f54e981c Mon Sep 17 00:00:00 2001 From: Martin van der Plas Date: Wed, 17 Nov 2021 12:26:48 +0100 Subject: [PATCH] API-04 design rule herschreven op basis van issue #419 (https://github.com/Geonovum/KP-APIs/issues/419) --- The Design Rules v1.0.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/The Design Rules v1.0.md b/The Design Rules v1.0.md index 9298fa6..d9c293a 100644 --- a/The Design Rules v1.0.md +++ b/The Design Rules v1.0.md @@ -43,9 +43,10 @@ A resource describing a single thing is called a [singular resource](#dfn-singul
-

API-04: Define interfaces in Dutch unless there is an official English glossary available

-

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 available. Publishing an API for an international audience 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.

+

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.