Implementatiedocumentatie¶

Je realiseert de infrastructuur en legt in bijbehorende documentatie volledig en correct vast wat je hebt opgezet. Hierin staan de componenten, configuratie en stappen die je hebt doorlopen om de infrastructuur werkend te krijgen. Dit product past bij de leeruitkomst Infrastructuur.

Implementatiedocumentatie is de technische beschrijving van wat er daadwerkelijk draait: welke images, containers, virtuele machines, netwerken, poorten en configuratiebestanden. Het sluit aan op het ontwerp en maakt het mogelijk om de infrastructuur te reproduceren, te onderhouden en te testen. Het kan bestaan uit een hoofddocument met verwijzingen naar configuratiebestanden of scripts in een repository.

Kwaliteitsindicatoren¶

Bij het waarderen van dit product zal er worden gekeken naar de volgende kwaliteitsindicatoren:

De documentatie is een op zichzelf staand overzicht met een duidelijke koppeling naar het ontwerp.
Alle relevante componenten van de gerealiseerde infrastructuur zijn beschreven.
Configuratie (of verwijzing ernaar) is vastgelegd zodat de infrastructuur reproduceerbaar is.
De stappen om de infrastructuur op te zetten zijn beschreven (of verwezen naar scripts/playbooks).
De documentatie is volledig en correct in lijn met wat er daadwerkelijk draait.
Er is een koppeling met testprotocol en eventueel beveiligingsrapport.
Communicatieprotocollen zijn beschreven of verwezen.

Template¶

Om implementatiedocumentatie te schrijven, kan je gebruik maken van de volgende template:

# Implementatiedocumentatie: [infrastructuur / project]

Korte introductie: wat is er gerealiseerd en wat is het doel van deze documentatie?

## Overzicht gerealiseerde componenten

Lijst of tabel van componenten: naam, rol, techniek (bijv. Docker container, VM), poorten, dependencies.

## Configuratie

Per component of per laag: welke configuratie is gebruikt? Verwijzing naar bestanden of key-value overzicht.

## Stappen om op te zetten

Welke stappen moet iemand doorlopen om deze infrastructuur op te zetten? (volgorde, commando's, vereisten)

## Communicatieprotocollen

Samenvatting of verwijzing naar het document met communicatieprotocollen.

## Testen en beveiliging

Verwijzing naar testprotocol en beveiligingsrapport.