Skip to content

Commit

Permalink
API-04 design rule herschreven op basis van issue #419 (Geonovum/KP-A…
Browse files Browse the repository at this point in the history
  • Loading branch information
mrtn78 committed Nov 17, 2021
1 parent 2dc5b43 commit 7768088
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions The Design Rules v1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,10 @@ A resource describing a single thing is called a [singular resource](#dfn-singul
</div>

<div class="rule" id="api-04">
<p class="rulelab"><strong>API-04</strong>: Define interfaces in Dutch unless there is an official English glossary available</p>
<p>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.</p>
<p>Note that glossaries exist that define useful sets of attributes which should preferably be reused. Examples can be found at <a href="http://schema.org/docs/schemas.html">schema.org</a>.</p>
<p class="rulelab"><strong>API-04</strong>: Define interfaces in Dutch unless there is an official English glossary or an international audience</p>
<p>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.</p>
<p class="note">Note that glossaries exist that define useful sets of attributes which should preferably be reused. Examples can be found at <a href="http://schema.org/docs/schemas.html">schema.org</a>.</p>
<p class="note">Note that commercial software development organisations are usually internationally oriented and use English as the main language to develop and document software.</p>
</div>

<div class="rule" id="api-48">
Expand Down

0 comments on commit 7768088

Please sign in to comment.