From 75fb540101b3b59e3611a76d4493af0b90198a14 Mon Sep 17 00:00:00 2001 From: Stas Mironov Date: Mon, 28 Oct 2024 14:12:25 +0100 Subject: [PATCH] Toevoegen data overheid en stelselcatalogus --- DesignRules.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/DesignRules.md b/DesignRules.md index 00ca575..8f9a314 100644 --- a/DesignRules.md +++ b/DesignRules.md @@ -67,7 +67,7 @@ A resource describing a single thing is called a [=singular resource=]. Resource -
+

Resources and underlying attributes should reuse definitions from English Glossaries and fall back on Dutch if none are available

Statement
@@ -76,8 +76,8 @@ A resource describing a single thing is called a [=singular resource=]. Resource
Rationale
- The exact meaning of concepts is often lost in translation. 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. + The exact meaning of concepts is often lost in translation. Publishing an API for an international audience might also be a reason to use English definitions and naming conventions. + Note that glossaries exist that define useful sets of attributes which SHOULD preferably be reused. Examples can be found at schema.org. For Dutch glossaries, one could consult data.overheid.nl and stelselcatalogus.nl
Implications
@@ -467,7 +467,7 @@ An API is as good as the accompanying documentation. The documentation has to be
Rationale
- In line with design rule /core/interface-language, the OAS document (e.g. descriptions and examples) SHOULD be written in Dutch. If relevant, you MAY refer to existing documentation written in English. + In line with design rule /core/resource-language, the OAS document (e.g. descriptions and examples) SHOULD be written in Dutch. If relevant, you MAY refer to existing documentation written in English.
Implications