undefined 0.0.3

Logius Handreiking
Vastgestelde versie

Deze versie:
https://gitdocumentatie.logius.nl/publicatie/dk/def-hr-template-20230621
Laatst gepubliceerde versie:
https://gitdocumentatie.logius.nl/publicatie/dk/template
Laatste werkversie:
https://logius-standaarden.github.io/ReSpec-template/
Vorige versie:
https://gitdocumentatie.logius.nl/publicatie/dk/wv-hr-template-20220624
Redacteur:
Logius Standaarden (Logius)
Auteur:
Logius Standaarden (Logius)
Doe mee:
GitHub Logius-standaarden/ReSpec-template
Dien een melding in
Revisiehistorie
Pull requests

Dit document is ook beschikbaar in dit niet-normatieve formaat: pdf

Dit document valt onder de volgende licentie: Logo Creative Commons Attribution 4.0 International Public License
Creative Commons Attribution 4.0 International Public License

Samenvatting

Tekst

Status van dit document

Dit is de definitieve versie van dit document. Wijzigingen naar aanleiding van consultaties zijn doorgevoerd.

1. Richtlijnen voor Extensies in Logboek Dataverwerkingen

Dit onderdeel is niet normatief.

1.1 1. Inleiding

Beschrijf hier kort waarom extensies nodig kunnen zijn en hoe ze gebruikt worden binnen de standaard.

1.2 2. Randvoorwaarden

Bij het ontwerpen van een extensie moet rekening worden gehouden met:

1.3 3. Verschil tussen de Extensie en de Core Standaard

Beschrijf hoe de extensie zich verhoudt tot de core standaard. Bijvoorbeeld:

1.4 4. Wat moet er in een extensiedocumentatie staan?

Elke extensie moet minimaal de volgende onderdelen bevatten:

1.5 5. Wat mag niet? (Limitaties)

Extensies mogen niet:

1.6 6. Hoe voorkom je conflicten tussen extensies?

1.7 7. Wat mag wel? (Invulmogelijkheid)

1.8 8. Structuur van een extensie

Elke extensie moet de volgende structuur hebben:

1.8.1 1. Naam en beschrijving

1.8.2 2. Doel en nut

1.8.3 3. Technische specificatie

1.8.4 4. Gebruiksscenario’s

1.8.5 5. Beperkingen

1.8.6 6. Versiebeheer

1.9 9. Schrijfwijze en Stijl

1.10 10. Relevante Standaarden

Voeg hier links toe naar andere relevante standaarden om dubbel werk te voorkomen.

2. Meer inhoud

2.1 Definities

Definitie: Een definitie is een beschrijving van een woord. Een ander woord voor definitie is betekenis of beschrijving.

2.2 Afbeeldingen

Afbeeldingen krijgen een nummer en vermelding in de figurenlijst 5. Lijst met figuren.

Tekstueel alternatief voor toegankelijkheid
Figuur 1 Onderschrift

2.3 Referenties

Referentie uit locale lijst [SemVer]. Lijst staat in organisation-config.js. Alleen referenties die in de tekst voorkomen worden getoond.

We gebruiken een definitie om een woord te omschrijven.

In een extensie kunnen ook referenties worden toegevoegd naar definities van de core. Bijvoorbeeld Logboek of Betrokkene.

2.4 Optioneel

De onderstaande secties (Conformiteit e.d.) zijn optioneel, zie index.html:

<body>
  <section id="abstract" data-include-format="markdown" data-include="abstract.md"></section>
  <section id="sotd"></section><!-- Wordt automatisch gevuld -->
  <section data-include-format="markdown" class="informative" data-include="ch01.md"></section>
  <section data-include-format="markdown" data-include="ch02.md"></section>
  <!-- Hieronder optionele secties. Worden automatisch gevuld -->
  <section id='conformance'></section>
  <section id='tof'></section>
  <section id="index"></section>
</body>

3. Mermaid diagram

A
B
C
D
Figuur 2 Mermaid voorbeeld

4. Conformiteit

Naast onderdelen die als niet normatief gemarkeerd zijn, zijn ook alle diagrammen, voorbeelden, en noten in dit document niet normatief. Verder is alles in dit document normatief.

5. Lijst met figuren

A. Index

A.1 Begrippen gedefinieerd door deze specificatie

A.2 Begrippen gedefinieerd door verwijzing

B. Referenties

B.1 Normatieve referenties

[SemVer]
Semantic Versioning 2.0.0. T. Preston-Werner. June 2013. URL: https://semver.org
Logius Handreiking - Vastgestelde versie