Systeemdocumentatie ondersteunt outsourcing: de zaak van de ontbrekende specificaties

Een snel groeiende leverancier van diensten op het gebied van e-publishing wilde in toenemende mate programmeerwerk uitbesteden aan subcontractors, vaak in het buitenland. Hoe sneller zo'n subcontractor begrijpt wat er al is en welke wijzigingen van hem worden verwacht, hoe beter. Veel tijd ging verloren bij het uitleggen hiervan en dat kostte geld. Het betekende ook dat onze klant niet zo snel als gewenst kon reageren op verzoeken uit de markt.

Wat we deden

Naast de beschrijving van het gevraagde werk ontvangen subcontractors tegenwoordig een document waarin precies beschreven staat hoe het systeem in elkaar zit. Bij oplevering van de nieuwe versie leveren ze meteen ook een bijgewerkte versie op van dit document. Op die manier is altijd duidelijk welke code is geschreven, waarom, en hoe. Uitbesteden van werk gaat sneller en er worden minder fouten gemaakt. Wijzigingsverzoeken van klanten kunnen in minder tijd worden beoordeeld, geoffreerd en uitgevoerd.

Hoe we het deden

Op basis van nationale en internationale standaards en normen werd een structuur voor de technische documentatie vastgesteld. We besteedden een volle dag aan gesprekken met de opdrachtgever om alle vereisten en overwegingen helemaal duidelijk te krijgen. Daarna bestudeerde we de bestaande technische documentatie van het systeem, goten deze in de nieuwe structuur, en maakten daar een voorlopig Wordsjabloon van. Dit werd door de mensen van onze opdrachtgever gebruikt om de lege plekken in te vullen. Als laatste stap werd de structuur definitief vastgesteld en werd het Wordsjabloon klaar gemaakt voor gebruik door derden.