De documentatie bij de verwerkingenlogging API-standaard bestaat uit API-standaard documentatie en achtergrondinformatie. De achtergrondinformatie maakt geen onderdeel uit van de API-standaard maar vergroot het begrip en biedt achtergronden bij de genomen besluiten en gedane aanbevelingen.
De onderstaande documentatie maakt deel uit van de verwerkingenlogging API-standaard.
Bij de uitvoering van het project wordt een Definition of Done (DoD) gehanteerd. Deze DoD is de checklist met criteria waar de API-standaard bij oplevering aan moet voldoen.
Bij het informatieanalyse is gebruik gemaakt van een aantal brondocumenten. De informatieanalyse is onderdeel van het ontwerp van de API-standaard en is gericht op het helder krijgen van de functionele vereisten. De uitkomsten van de informatieanalyse zijn input voor het opstellen van een gegevens- en informatiemodel en de vertaling daarvan naar APIs. De volgende zaken zijn in de informatieanalyse uitgewerkt:
Een overzicht van de relatie tussen besluiten en cases is hier te vinden.
Gemeenten, systemen, leveranciers en derden zullen de komende jaren allemaal in een verschillend stadium verkeren t.a.v. het implementeren van de vastlegging van verwerkingen in verwerkingenlogging. Het lijkt goed om in een dashboard bij te gaan houden hoe gemeenten en de gemeentelijke software ervoor staan. Hierbij zou gebruik gemaakt kunnen worden van volwassenheidniveaus ten aanzien van verwerkingenlogging. Hiertoe zijn een aantal Verwerkingenlogging Maturity Levels ontwikkeld die gebruikt kunnen worden door gemeenten.
De API-standaard kan doordat de meeste attributen in het uitwisselgegevensmodel optioneel zijn eenvoudig worden geimplementeerd. Hoe meer veldden worden ingevuld hoe zinvoller de informatie die wordt vastgelegd is en hoe duidelijker de informatie voor de burger is. Het streven moet dus zijn zoveel mogelijk attributen vast te leggen. Op de pagina volledigheid van verwerkingenlogging worden de verschillen van volledigheid van invulling geillustreerd.