Afstudeeropdracht in Software Development: Documentation as Code: een levende documentatie en visualisatie van het systeem Veenendaal • Info Support

Zorgen dat jaren lang opgebouwde systeemdocumentatie actueel, centraal beschikbaar en bruikbaar blijft. Daar ga je mee aan de slag. In deze opdracht breng je technieken zoals Specification by Example, Arc42 en PlantUML samen in een ‘Living Documentation’. Je ontwikkelt een Proof of Concept waarin je deze technieken automatisch integreert, zodat documentatie voortdurend wordt bijgewerkt. Daarnaast onderzoek je hoe Large Language Models ingezet kunnen worden om de documentatie beter doorzoekbaar en bruikbaar te maken.

ð¡Interessegebieden: Specification by example, PlantUML, C4-Model, Large Language Model, Living documentation

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?

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.

Over Info Support

Info Support is specialist in maatwerksoftware, data/AI solutions, beheer en trainingen en actief in de sectoren Finance, Industry, Agriculture, Food & Retail, Mobility & Public en Healthcare. Wij bieden solide en innovatieve oplossingen voor complexe en bedrijfkritische softwarevraagstukken. Onze hoofdkantoren zijn gevestigd in Veenendaal (NL) en Mechelen (BE). Op dit moment zijn er circa 500 medewerkers bij Info Support in dienst.

De werkwijze van Info Support kenmerkt zich door een aantal kernwaarden: soliditeit, integriteit, vakmanschap en passie. Deze kernwaarden zijn verweven in ons werk en de manier waarop we met elkaar omgaan.

Om te zorgen dat alle medewerkers altijd op de hoogte kunnen zijn van de nieuwste ontwikkelingen beschikt Info Support over een inhouse kenniscentrum waar graag wordt voldaan aan de honger naar meer of andere kennis en vaardigheden.

Om deze opdracht te kunnen doen is B2-taalvaardigheid in het Nederlands vereist.