Maar wat moet je nou echt vragen aan je developers? Dit is onze top 5 met de belangrijkste vragen:
- Hoe wordt de code onderhouden?
- Hoe worden bugs opgespoord en verholpen?
- Hoe wordt de documentatie bijgehouden?
- Wat zijn de belangrijkste beveiligingsrisico’s?
- Hoe wordt de prestatie van de software geoptimaliseerd?
Leuk, zo’n lijstje met vragen. Maar waar moet je nou op letten? We zetten het per vraag op een rijtje voor je.
1 – Hoe wordt de code onderhouden? ⚒️
Vraag je developers hoe ze de code onderhouden en of ze gebruik maken van code reviews en refactoring.
Code reviews houden in dat developers elkaars code controleren. Als je een tijdje intensief aan iets gewerkt hebt, is het vaak lastig om fouten of inconsistenties te zien. De frisse blik van een tweede of derde developer helpt dan mee. Zo resulteren code reviews in betere code.
Code refactoring is het herstructureren en verbeteren van bestaande code, zonder de functionaliteit van de software te veranderen. Door regelmatig een refactoring toe te passen, wordt het makkelijker om de code te begrijpen. Dit maakt het toevoegen van nieuwe functionaliteiten of verder onderhoud weer makkelijker, sneller en dus goedkoper.
Verder wordt de code zelf efficiënter, wat weer ten goede komt van de prestaties van je applicatie.
2 – Hoe worden bugs opgespoord en verholpen? 🔍
Tijdens het bouwen van de software kunnen er allerlei bugs ontstaan die de werking van je applicatie verminderen. Om deze zoveel mogelijk te voorkomen, is het van belang dat er door je developers uitvoerig getest wordt of alles naar behoren werkt.
Je kan zelf ook je steentje bijdragen, en zelf ook de hele applicatie doorlopen om te kijken of alles werkt. Hiervoor is het van belang dat je developers een goed testplan opstellen, waarmee jij stap voor stap alle functionaliteiten kan nalopen en controleren.
Maar ook na de oplevering van je applicatie kunnen er nog bugs ontstaan. Daarom is het van belang dat er aandacht besteed wordt aan het opsporen en verhelpen van mogelijke nieuwe bugs.
Een handige tool hiervoor is het gebruik van automatische unit tests. Bij een unit test wordt een individueel onderdeel van de software getest op werkzaamheid.
Zelf zijn we groot fan van Playwright voor het automatiseren hiervan. Met Playwright hoeven de tests slechts eenmalig aangemaakt te worden, waarna je met één druk op de knop de functionaliteit van je gehele applicatie kan doorlopen. Telkens weer opnieuw, dat is lekker efficiënt.
3 – Hoe wordt de documentatie bijgehouden? 📄
Voor het gebruik en onderhoud van de software is goede documentatie ook een belangrijk onderdeel. Er bestaan allerlei vormen van documentatie, maar het draait voornamelijk rondom documentatie voor de eindgebruiker en documentatie voor andere developers. Dat laatste kan zowel voor intern gebruik zijn, als voor publiekelijk beschikbare onderdelen van je applicatie zoals API’s.
Interne documentatie is vooral belangrijk om nieuwe developers te onboarden. De interne documentatie staat in bijvoorbeeld de README bestanden, deze vind je direct in de code terug. README bestanden geven een korte introductie tot de software, installatie-instructies, basisconfiguratie en andere belangrijke informatie.
Andere belangrijke interne documentatiestukken zijn onder andere een emergency plan, een deployment plan en een test plan.
Voor de eindgebruiker kan je denken aan installatie-instructies, gebruikershandleidingen, FAQs en informatie over probleemoplossing.
4 – Wat zijn de belangrijkste beveiligingsrisico’s? 🔐
Misschien wel de grootste nachtmerrie van elke ondernemer is een hack van zijn systemen. Dit kan bijvoorbeeld gaan om een lek van persoonsgegevens of het platleggen van de services. Om dergelijke situaties te voorkomen, is het belangrijk dat er nagedacht wordt over beveiliging van de software.
Zelf werken we met Snyk, een tool die de codebase analyseert en verbeteringen aanbeveelt. Ook zorgen we voor two-factor authentication waar dat kan, en werken we met gebruikersrechten.
Tenslotte gebruiken we een extra, zelfontwikkelde security checklists waarin we een lijst met de belangrijkste beveiligingsprotocollen en technieken hebben opgesteld. Deze lijst lopen we voor elk project na.
5 – Hoe wordt de prestatie van de software geoptimaliseerd? 📈
Natuurlijk wil je zeker blijven weten dat je software optimaal functioneert. Naast het actief opsporen en verhelpen van bugs -zoals eerder besproken- is het ook belangrijk om continu de prestaties van je applicatie te monitoren en verbeteren waar nodig.
Enerzijds is het belangrijk om de algehele gezondheid van je applicatie te monitoren (monitoring), anderzijds wil je gericht knelpunten en inefficiënties opsporen (profiling).
Met monitoring houdt je de prestaties, zoals bijvoorbeeld GPU-verbruik van de server en response snelheid doorlopend bij. Neemt het GPU-verbruik of de response snelheid onverwachts toe? Dan gaat er ergens iets mis.
Profiling pas je juist toe op het moment dat er een probleem geconstateerd is. Een profiling tool loopt alle codeblokken na en analyseert waar de knelpunten of inefficiënties zich bevinden.
Conclusie
Custom software is nou eenmaal complex en veelzijdig, en het ontwikkelen en onderhouden hiervan houdt nooit op. Met deze 5 vragen kom je goed voorbereid bij je developers, en weet je zeker dat er goed nagedacht wordt over de gezondheid van je applicatie.
Meer weten? Bij Teamcoda denken we graag met je mee, en stellen we voor al onze klanten een checklist op zodat je software altijd up-to-date blijft. Neem gerust contact met ons op.