Een lowbudgetoplossing voor het maken van handleidingen

Als je grote hoeveelheden documentatie moet maken, heb je al gauw behoefte aan een Component Content Management Systeem (CCMS), wat een flinke investering in tijd en geld vergt. Dit wordt doorgaans snel terugverdiend, omdat je er efficiënter door kunt werken en de kwaliteit van de documentatie verbetert. Wat echter als de hoeveelheid documentatie minder omvangrijk is, maar toch zo veel dat je soms door de bomen het bos niet meer ziet: te klein voor het tafellaken van een CCMS, maar te groot voor het servet van simpele Word-documenten?

Hembrug

Een van onze klanten, Hembrug uit Haarlem, maakt en verkoopt gespecialiseerde, hoge precisie draaibanken. Per jaar leveren ze er zo’n dertigtal op aan hun klanten en die machines moeten natuurlijk allemaal volgens de richtlijnen zijn voorzien van documentatie. De draaibanken zijn vrijwel altijd specifiek voor een klant. Dit houdt in dat een groot deel van opbouw, uitvoering en functionaliteit van de machines hetzelfde is, maar dat er per klant wel verschillen kunnen zijn.

Bij het maken van de handleiding was de werkwijze tot nu toe:

  1. Neem de handleiding van een eerder opgeleverde, vergelijkbare machine.
  2. Zoek de verschillen en pas de handleiding aan.
  3. Voeg beschrijvingen toe van eventuele nieuwe functionaliteit.
  4. Vertaal indien nodig.

Mede omdat alles in InDesign – een programma dat naar onze mening minder geschikt is voor het maken van technische documentatie – opgemaakt moest worden, was dit een tijdrovende methode en viel het dikwijls niet mee de handleidingen op tijd af te hebben. Aanleiding om geregeld een beroep te doen op Xplain voor hulp.

Een meer efficiënte methode?

Terwijl we met een nieuwe handleiding bezig waren, kwam Hembrug met de vraag om het maken van handleidingen te vereenvoudigen. Wij dachten hiervoor aan een speciale auteursomgeving zoals Author-it, Paligo of IDS. Maar al gauw was duidelijk dat Hembrug een typisch voorbeeld is van een ‘tafellaken/servet’-situatie en dus gingen we op zoek naar een alternatief. Samen met Bart de Wolf van Hembrug hebben we vervolgens een methode ontwikkeld met MS Word als basis. Hieronder leggen we in het kort uit hoe dit werkt.

Oude situatie

Hembrug werkte met Adobe InDesign. Aangezien dit pakket meer geschikt is voor vormgeving dat voor het schrijven van een handleiding, was het aanbrengen van wijzigingen tijdrovend. Omdat elke handleiding bij een nieuwe machine een oude handleiding als startpunt had, werd er veel tijd verloren door de keuze voor InDesign.

Een ander probleem was dat de (standaard)onderdelen, die identiek behoorden te zijn, dat niet waren. Dit was het gevolg van het veelvuldig kopiëren, wijzigingen aanbrengen en dan weer kopiëren naar een volgende handleiding.

Oplossing in Word: standaardiseren en organiseren

In nauwe samenwerking met Bart de Wolf hebben we een budgetvriendelijke oplossing bedacht om het ontwikkelen van nieuwe handleidingen in de toekomst een stuk efficiënter te maken.

Bij een opdracht voor het maken van een nieuwe handleiding hadden we al gekozen om bestaande content om te zetten naar MS Word en niet langer te werken met InDesign. Een voor de hand liggende stap was om daarna ook alle nieuwe handleidingen in Word te ontwikkelen. Andere opties als Author-it, Paligo of IDS bleken te veel investeringen met zich mee te brengen, zowel in tijd als in kosten (licenties). Ook zag Hembrug op tegen het moeten leren werken met nieuwe software. MS Word was bekend en de licenties waren er.

Werkwijze

Als eerste hebben we een structuur gemaakt waar alle standaard content in kon worden ondergebracht. Vervolgens hebben we, samen met Hembrug, zo veel mogelijk beschrijvingen universeel gemaakt. Alle (onnodige en daardoor ongewenste) verschillen moesten weggewerkt worden. Daarna is alles opgeknipt in kleine, op zichzelf staande onderdelen. In CCMS-termen zouden we dit topics of objecten noemen, in de nieuwe structuur is elk topic een afzonderlijk Word-document. Zo ontstond er een grote verzameling van basiselementen. Door het toepassen van strakke conventies voor de naamgeving is snel te zien waar elk basiselement thuis hoort. Ten slotte is er een speciale macro gemaakt waarmee, in combinatie met MS Excel, snel een standaard handleiding kan worden samengesteld.

Groot voordeel van deze werkwijze is dat je zoveel mogelijk standaard content gebruikt en dat deze content zelf op een centrale plaats staat: in de map met brondocumenten.

De handleidingen worden naar verschillende talen vertaald. Dit betekent dat we de hiervoor beschreven structuur voor elke afzonderlijke taal moesten kopiëren.

Uiteraard hebben er ook voor gezorgd dat de documentatie voldoet aan de Machinerichtlijn.

Conclusie

Leveranciers van de verschillende CCMS-en zullen hier waarschijnlijk hun neus voor ophalen en het een ‘houtje touwtje’ oplossing vinden, maar wij zijn ervan overtuigd dat Hembrug hiermee in de toekomst tijd (en geld) bespaart en dat de kwaliteit en consistentie van de documentatie een stuk beter zullen zijn. Dit allemaal voor een relatief bescheiden investering.

Hembrug Low Budget Oplossing