Documentation

Definition

Types of documentation
Figure 1. Types of documentation

Identification

The considerations and justifications for the choices made are documented here.

All URI templates conform to [RFC6570].
Part URI template

Documentation project

https://{domain}/{documentation}

where:

{documentation}

Path component — possibly nested — that identifies the documentation project.
Avoid assigning stable URIs to document parts such as pages and sections.
Examples
Project URI

URI Policy

https://{domain}/uri-policy

Representation

Resource Machine-processable Human-readable

Controlled vocabulary

SKOS, RDF

BegrippenXL, HTML

Vocabulary term

n/a

n/a

Versioning

Controlled vocabularies follow an evolution strategy where breaking changes are never allowed.

Through deprecation and introduction of new URIs and statements, newer and older versions of the vocabulary model all live in one schema.