Home

referentiehandleidingen

Referentiehandleidingen zijn technische documenten die een systeem, component of dienst volledig beschrijven en dienen als gezaghebbende bron voor correct gebruik, implementatie en integratie. Ze geven gebruikers, ontwikkelaars en integrators exact inzicht in wat een interface doet, welke regels gelden en hoe fouten voorkomen of op te lossen zijn. In tegenstelling tot gebruikers- of installatiehandleidingen richten referentiehandleidingen zich op volledigheid en nauwkeurigheid van specificaties en gedrag op detailniveau.

De inhoud kan onder andere bestaan uit scope en definities, terminologie, API-referenties met endpoints, parameters en

Doelgroepen zijn ontwikkelaars, integrators, systeembeheerders en technisch personeel dat met het systeem werkt. Referentiehandleidingen zijn meestal

returnwaarden,
datatype-
en
foutcodes,
commando-
en
CLI-syntaxis,
codevoorbeelden,
gegevensindelingen
en
validatieregels.
Daarnaast
verschijnen
vaak
diagrammen,
tabellen,
versiegeschiedenis
en
backward-compatibiliteitsnotities.
Een
goed
samengestelde
referentiehandleiding
biedt
duidelijke
secties,
een
index
en
koppelingen
naar
gerelateerde
termen.
online
beschikbaar
als
webdocumentatie
of
PDF's,
waaronder
API-documentatie
met
OpenAPI/Swagger
en
interactieve
voorbeelden.
Ze
worden
doorgaans
gemaakt
en
onderhouden
door
technische
schrijvers
in
nauwe
samenwerking
met
engineers
en
worden
versioned
en
bijgewerkt
bij
elke
release
om
consistentie
en
traceerbaarheid
te
waarborgen.