Ben je ooit gefrustreerd geraakt door verouderde documentatie tijdens het ontwikkelen van een nieuwe feature? Deze stageopdracht daagt je uit om een tool te bouwen die automatisch controleert of documentatie moet worden bijgewerkt bij codewijzigingen. Je ontwikkelt een slimme “Code Detective” die codewijzigingen analyseert, vergelijkt met documentatie, en pull requests blokkeert totdat de documentatie actueel is. Hiermee verbeter je niet alleen je eigen werk, maar ook dat van toekomstige ontwikkelaars.

💡Interessegebieden: Code-analyse, CI/CD Tooling, Artificial Intelligence, Documentatie

Je kent het wel; je bent bezig met het implementeren van een nieuwe feature in een project en vindt daarvoor de ideale library. Met volle moed begin je aan de implementatie, alleen… het werkt niet?! Na uren frustratie, waarin code niet wil compileren of de applicatie bij start-up crasht, ontdek je dat de documentatie compleet verouderd is.

Iedereen heeft bovenstaand scenario als softwareontwikkelaar wel eens meegemaakt. De documentatie van een library, framework of applicatie komt niet meer overeen met de laatste versie. Hoe kunnen we ervoor zorgen dat wanneer er code gewijzigd wordt, er automatisch wordt gecontroleerd of de bijbehorende documentatie moet worden bijgewerkt?

De opdracht

Stel je voor dat je een tool kunt bouwen die effectief kan worden ingezet om automatisch te controleren of projectdocumentatie moet worden bijgewerkt wanneer de code verandert. Dit is niet alleen voor jou, maar voor iedereen die later met jouw code in contact komt. De opdracht is om als proof of concept (PoC) een slimme “Code Detective” te ontwikkelen.

Wat moet de Code Detective doen?

1. Codewijzigingen analyseren.
2. Deze wijzigingen vergelijken met de bestaande documentatie.
3. Signaleren wanneer de documentatie mogelijk verouderd is.
4. Pull requests blokkeren totdat de documentatie is bijgewerkt.

Hierbij komen de volgende uitdagingen naar boven:

• Complexiteit code-analyse: het nauwkeurig analyseren van codewijzigingen en bepalen of ze impact hebben op de documentatie.
• Contextbegrip: begrijpen welke codewijzigingen relevant zijn voor welke delen van de documentatie.
• Vals-positieven en -negatieven: hoe voorkomen we onnodige meldingen bij pull requests voor irrelevante wijzigingen?

Bonusopdracht: maak je tool nog beter door AI te integreren. Kan de tool suggesties geven voor documentatie-updates op basis van de codewijzigingen?

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 Mechelen (BE) en Veenendaal (NL). 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.