Documentatie wordt vaak slecht bijgehouden en leeft versnipperd. In de beheerfase jaren later is het wenselijk dat de functionele werking snel en makkelijk te achterhalen is. Er zijn diverse technieken beschikbaar waarmee documentatie en tekeningen gegenereerd kunnen worden via code. Specification by example, PlantUML en het C4-model zijn enkele van deze technieken die vaak worden ingezet.
Maar hoe zorg je er voor dat al deze input, over meerdere teams heen, op een centrale plek beschikbaar, actueel en bruikbaar blijft?
De opdracht
Grootschalige en complexe systemen gaan vaak jaren mee en worden door meerdere teams samen ontwikkeld. De opgedane kennis en gemaakte keuzes moeten door de tijd heen gewaarborgd, actueel en bruikbaar blijven. In een beheerfase, jaren later, moet informatie nog altijd snel te achterhalen zijn. De volgende technieken, die documentatie en tekeningen kunnen genereren via code, worden vaak ingezet:
- Specification by example voor het beschrijven en testen van de functionele werking.
- Arc42 voor het documenteren van de werking en gemaakte keuzes.
- PlantUml om ondersteunende diagrammen mee te maken.
- Structorizer voor het modelleren van de architectuur.
Onderzoek hoe deze technieken samengebracht kunnen worden tot een centrale 'Living documentation'. Deze documentatie moet altijd actueel blijven en kennis van alle teams die eraan gewerkt hebben bevatten. Wanneer deze verschillende perspectieven van een systeem zijn samengebracht op een centrale plek, moet het ook mogelijk zijn om hedendaagse technieken zoals een Large Language Model in te zetten als assistent om inhoudelijke vragen over het systeem aan te kunnen stellen.
Toon middels een Proof of Concept aan hoe je deze technieken op een geautomatiseerde manier samenbrengt tot een 'Living documentation' die echt bruikbaar is. De mate van bruikbaarheid is groter als er bijvoorbeeld door de inzet van Large Language Model snel informatie ingewonnen kan worden.
Kijk voor al onze afstudeeropdrachten op www.afstuderenbijinfosupport.com