De praktijkgevallen in dit onderdeel van de website moeten worden gezien als voorbeelden. De ene keer organiseren we een cursus "handleidingen schrijven", de andere keer vinden we een manier om de betrokkenen zelf de documentatie te laten schrijven, en in nog weer andere situaties verzinnen we slimme manieren om de kennisstroom te sturen. Elke situatie is altijd weer anders.

E-publishing met een beperkt budget: de zaak van de elektronische codex

Een kleine uitgeverij van collecties wet- en regelgeving voelde zich door de markt gedwongen om aan cd-roms te beginnen. Per definitie was hun klantenkring beperkt, en van elke collectie ("codex") konden ze maximaal een paar honderd exemplaren verkopen. Bovendien kwam van elke collectie regelmatig een bijgewerkte versie uit. Bestaande tools voor cd-rom-produktie waren daarom gewoon onbetaalbaar.

Lees meer...

Een samenhangende collectie documenten: de zaak van de luchtvaartdocumenten

Een luchtvaartmaatschappij moest regelmatig een documentatieset maken in PDF. De brondocumenten werden bijgehouden in Word. Ze wilden graag een overkoepelende inhoudsopgave voor de hele set, die in elke afzonderlijke PDF zichtbaar was en van waaruit alle andere documenten geopend konden worden. Het lukte de eigen programmeurs niet om dat effect te bereiken.

Lees meer...

Word-formulieren om een boek te maken: de zaak van de typende juristen

Een uitgeverij, een juristenkantoor en een internationale organisatie wilden samen een bundeling uitgeven van gerechtelijke uitspraken. De uitgeverij had daarvoor een formulier gemaakt waarin de juristen de gegevens zouden invoeren. Je kon daar echter alles in stoppen wat je maar wilde, zonder enige controle. Een ander probleem was dat er geen manier was om de ingevoerde gegevens er uiteindelijk weer uit te halen voor publicatie. Op het moment dat wij werden gebeld was het project vastgelopen.

Lees meer...

Van Excel naar opgemaakte PDF: de zaak van de auto-analisten

Een groep analisten van de auto-industrie verstuurde elke maand een aantal rapportages, met een vaste indeling. Om deze te maken waren ze soms dagen bezig. Eerst moesten er PDF's worden gemaakt vanuit Excel, dan moesten daar op de een of andere manier standaardteksten worden ingevoegd, en als alles er dan een beetje goed uit zag moesten ook nog knoppen en hyperlinks en zo met de hand worden aangebracht. Het hele proces was zo veel werk dat ze op het punt stonden het maar op te geven.

Lees meer...

PDF's aanpassen: de zaak van de moeizame bewerkingen

Een bedrijf in de voedingsindustrie kreeg van zijn leveranciers informatie toegestuurd over voedseltoevoegingen, in PDF-formaat. Ze stuurden die dan weer door naar hun klanten, met hun eigen logo, hun eigen contactgegevens en hun eigen artikelnummer. Dat kan niet zonder meer in PDF en de productie was tijdrovend en foutgevoelig. De resulterende PDF's waren bovendien van slechte kwaliteit en soms wel twintig keer zo groot als het origineel.

Lees meer...

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...