Documentatie volgens wettelijke regels: de zaak van de labapplicaties

Een maker van wetenschappelijke apparatuur had, in de loop van jaren, tal van applicaties gemaakt voor gebruik in een laboratorium. Soms ging het daarbij om het uitvoeren van berekeningen, soms ook om de besturing van apparatuur in het lab. Wat de applicaties gemeen hadden was het totale gebrek aan documentatie. Onderhoudbaarheid begon een probleem te worden. Bovendien waren er kritische kanttekeningen gekomen van het accreditatieinstituut. Voor hen was de software een zwarte doos waarvan ze de werking op goed vertrouwen moesten aannemen.

Lees meer...

Van ontwikkelaar naar technisch schrijver: de zaak van de Java-ontwikkelaars

Een grote internationale maker van computersystemen droeg systematisch bij aan de ontwikkeling van open source software. Tal van werknemers hadden als taak het ontwikkelen van stukken code die vervolgens kosteloos aan de gemeenschap ter beschikking werd gesteld. Die code moest natuurlijk worden gedocumenteerd, maar ook nog een technisch schrijver inzetten ging onze opdrachtgever net iets te ver.

Lees meer...

Alle documentatie beschikbaar en vindbaar: de zaak van de overwerkte systeembeheerders

In een groot ziekenhuis waren meer dan honderd verschillende systemen actief, variƫrend van medische beeldverwerkingssystemen tot het systeem dat bijhoudt wie welke witte jas aan heeft. Al die systemen werden in de lucht gehouden door een handvol systeembeheerders. Ook als ze vrij hadden moesten die hun mobieltje bij de hand houden, want als er iets mis ging was er niemand anders die wist wat te doen.

Lees meer...

Handleidingen: de zaak van de bruikbare gebruikersinstructies

Dit is een "zaak" met vele gezichten. Keer op keer komen we ergens waar gewoon geen bruikbare gebruikersdocumentatie beschikbaar is. De handleiding is er niet, of hij is niet gericht op eindgebruikers, of hij is niet duidelijk. Het resultaat is dan dat mensen zelf moeten uitzoeken hoe het systeem werkt. Daarbij verspillen ze enorme hoeveelheden tijd en energie en uiteindelijk zijn ze nog steeds niet echt handig bezig.

Lees meer...

Een set handleidingen onder tijdsdruk: de zaak van het dreigende boetebeding

Een gespecialiseerd bedrijf had voor een externe klant alle hardware en software gebouwd waarmee die klant in de woestijn een gasveld kon gaan exploiteren. Alles was klaar, behalve de contractueel overeengekomen documentatie. De productie daarvan was moeilijker gebleken dan verwacht, en opeens was de opleveringsdatum wel heel dichtbij. Het contract bevatte een stevige boeteclausule.

Lees meer...

Samen werkinstructies schrijven: de zaak van de ongelukkige boekhouders

Een fabrikant van kunstvezels had een bedrijfsomvattende SAP-implementatie succesvol afgerond. Zoiets heeft weerslag op de totale organisatie. De financiƫle afdelingen van de drie werkmaatschappijen vonden het echter moeilijk om te wennen aan de nieuwe situatie. De invoerschermen van het nieuwe systeem waren op zich vrij eenvoudig, maar toch werden tal van fouten gemaakt bij de invoer. Dit zou tot ernstiger fouten kunnen gaan leiden bij andere afdelingen. Erger nog was dat zich langzaam maar zeker een algemene ontevredenheid begon te verspreiden door het bedrijf.

Lees meer...

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.

Lees meer...