Onze op Scrum gebaseerde werkwijze heeft als belangrijk principe dat het besteden van tijd, geld en energie aan overbodige activiteiten (met als resultaat: ‘waste’) zo veel mogelijk moet worden voorkomen. Dat is een uitgangspunt dat is overgenomen van de ‘lean manufactoring’ aanpak zoals die oorspronkelijk door Toyota is uitgedacht. Het doel van onze aanpak is om zo snel mogelijk werkende, waardevolle en gebruiksvriendelijke functionaliteit aan eindgebruikers te leveren en om eventueel voortschrijdend inzicht (in het product én het proces) snel te verwerken.

Er wordt soms -onterecht- gedacht dat het maken van documentatie niet bij deze manier van werken past, omdat het vertragend zou werken en geen directe waarde voor de eindgebruiker oplevert. Maar documenteren is wel degelijk heel belangrijk; de uitdaging is om slim te documenteren, zodat er geen overbodige ‘waste’ ontstaat. De sleutel tot effectieve documentatie is om alleen de écht belangrijke informatie vast te leggen zonder het creatieve proces te beperken en de organisatie op kosten te jagen.

Een Entity Relationship Diagram (ERD) toont gebruikers en objecten (entiteiten), hun onderlinge relaties en de bijbehorende attributen in een grafische vorm. Met name in complexe projecten met grotere ontwikkelteams kunnen ERD’s bijdragen aan een gedeeld begrip over de relaties tussen de verschillende objecten, voordat de ontwikkeling daadwerkelijk start.

Hoewel het belangrijk is om de requirements op hoog niveau in kaart te brengen voordat de ontwikkeling van de webapplicatie begint, kan teveel of te gedetailleerde documentatie het proces vertragen en het team hinderen in het ontwikkelen van de beste oplossingen. Bovendien kan blijken dat de geproduceerde documentatie overbodig is als nieuwe eisen, inzichten en details tijdens het project naar voren komen.

Het is belangrijk om tijdens de ontwikkeling van de software de high-level architectuur en afwijkingen van eventuele standaarden vast te leggen. Tijdens deze fase vindt het documenteren meestal niet handmatig plaats, maar ontstaat het min of meer automatisch doordat de programmeurs specifieke programmeerprincipes aanhouden. Die principes hangen onder meer af van het gebruikte framework, de programmeertaal en vastlegging van wijzigingen in de broncode in een versiebeheersysteem.

Frameworks zijn in feite gespecialiseerde softwarebibliotheken, die vaak niet alleen een grote hoeveelheid standaardfunctionaliteit leveren, maar ook een vaste structuur voor de broncode en functies bieden. Ruby on Rails was het eerste framework dat specifiek is bedacht voor de ontwikkeling van webapplicaties en wordt door velen gezien als de ‘gouden standaard’ waarop veel andere frameworks zijn gebaseerd.

De keuze voor de programmeertaal beïnvloedt de mate en de vorm van documentatie binnen de broncode zelf, bijvoorbeeld in de vorm van commentaarregels. Bij programmeertalen die relatief dicht bij natuurlijke taal liggen, is het minder noodzakelijk om externe documentatie of aanvullend commentaar aan de broncode toe te voegen. Eén van de voordelen van Ruby, de programmeertaal die we bij Inspire gebruiken, is dat het een zeer duidelijke vorm en structuur heeft, waardoor het als een zichzelf beschrijvende taal kan worden gezien.

Documentatie die na de initiële ontwikkeling wordt geproduceerd heeft over het algemeen tot doel om de developers die de software onderhouden te ondersteunen of als handleiding voor eindgebruikers.

Als de hierboven beschreven documentatievormen goed zijn toegepast, dan is het vastleggen van alle ideeën en overwegingen uit het project meestal niet nodig. Wel is het belangrijk om nauwkeurig te beschrijven hoe de webapplicatie moet worden geïnstalleerd en geconfigureerd, zodat beheerders en toekomstige ontwikkelaars de software snel kunnen opzetten. Bij Inspire noemen we dat een delivery document, waarin we voor de hostingprovider en andere belanghebbenden beschrijven wat de eisen aan de hostingomgeving zijn en hoe de software geinstalleerd en geconfigureerd dient te worden.

Wij zien dat de noodzaak voor uitgebreide gebruikershandleidingen afneemt nu webapplicaties steeds intuïtiever en gebruiksvriendelijker worden. Bovendien geven veel mensen nu de voorkeur aan audiovisuele screencasts en presentaties ten opzichte van tekstuele handleidingen.

Door de juiste middelen toe te passen, kunnen webapplicaties adequaat gedocumenteerd worden zonder dat het de creativiteit en productiviteit van het team in de weg zit en het een zware financiële last op de organisatie legt. Het ontwikkelen van effectieve documentatie gaat hand in hand met het doel om zo snel mogelijk waardevolle, gebruiksvriendelijke functionaliteit aan eindgebruikers op te leveren.