Communicatieprotocollen documentatie¶

Je beschrijft de bijbehorende communicatieprotocollen van je infrastructuur volledig en correct in je documentatie. Hierin leg je uit hoe onderdelen van de infrastructuur met elkaar communiceren en welke protocollen en poorten je gebruikt. Dit product past bij de leeruitkomst Infrastructuur.

Communicatieprotocollen bepalen hoe componenten data uitwisselen: HTTP/HTTPS, TCP-poorten, message queues, API-formaten, enzovoort. Door ze te documenteren begrijpt iedereen hoe de infrastructuur intern en extern communiceert en kunnen beveiliging en troubleshooting correct worden uitgevoerd. Het document sluit aan bij het ontwerp en de implementatiedocumentatie.

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 de infrastructuur.
Alle relevante communicatie tussen componenten is beschreven (welke componenten, welk protocol, welke poort of endpoint).
De protocollen zijn volledig en correct beschreven (formaat, versie, eventueel authenticatie).
Er is een overzicht (bijv. tabel of diagram) van de communicatiestromen.
De documentatie sluit aan bij het ontwerp en de implementatie en is consistent met wat er draait.
Er is aandacht voor beveiliging (encryptie, poorten, toegang) waar van toepassing.

Template¶

Om communicatieprotocollen te documenteren, kan je gebruik maken van de volgende template:

# Communicatieprotocollen: [infrastructuur / project]

Korte introductie: wat is het doel van deze documentatie en welke infrastructuur beschrijft het?

## Overzicht communicatiestromen

Welke componenten communiceren met elkaar? (eventueel diagram)

## Per verbinding of protocol

| Bron         | Doel         | Protocol / poort   | Opmerkingen (auth, encryptie)   |
|--------------|--------------|--------------------|----------------------------------|
| [component]  | [component]  | [bijv. HTTPS 443]  | ...                               |

## Uitwerking (optioneel)

Per belangrijk protocol: versie, formaat (bijv. REST, JSON), authenticatie, eventueel voorbeeld.

## Beveiliging

Welke maatregelen zijn genomen voor veilige communicatie? (TLS, firewalls, etc.)