U zoekt op: {{ keyword }}

Hoe je met modulair werken flexibeler manuals kunt maken

INSTRKTIV Blog - Tools & efficiency

Nu kun je denken, modulariseren, als je alles in brokstukken opknipt creëer je alleen maar meer chaos. Toch kan het veel voordeel opleveren, niet alleen voor jezelf maar ook voor je gebruikers.

Modulariseren

Bij een handleiding schrijven wordt Informatie ook altijd al opgedeeld in hoofdstukken. Per hoofdstuk worden de verschillende onderwerpen beschreven. Door de informatie per onderwerp apart te beschrijven en te beheren in losse delen creëer je herbruikbare informatiemodules. De onderwerpen kunnen daarna ook goed afzonderlijk onderhouden worden door de auteur en geraadpleegd worden door de gebruiker. Een gebruiker kan dan in een web-omgeving zoeken op het onderwerp waar zij interesse in heeft. Zij kan het online lezen of uitprinten in een printervriendelijke opmaak.

Deze informatiemodules worden vaak “topics” genoemd. Ze kunnen apart beheerd worden met hun eigen kenmerken en versiebeheer. De kenmerken kunnen vervolgens de gebruikers weer helpen om snel de gewenste informatie te vinden.

De modules kunnen op allerlei plekken hergebruikt worden. Bij een serie vergelijkbare machines kun je in de specifieke manuals de informatiemodules hergebruiken voor de onderdelen die gelijk zijn. Met condities kun je vervolgens de verschillende informatievarianten nog verfijnen. Ook algemene informatie zoals waarschuwingen of CE-verklaringen kunnen als module opgenomen worden. Als er een onderdeel wijzigt hoef je dat maar op één plek aan te passen om alle informatie weer up-to-date te hebben.

Onderhouden

Voor het beheer van informatiemodules kun je gebruik maken van een beheersysteem. Dit wordt een “Component Content Management Systeem” (CCMS) genoemd. Een CCMS maakt het mogelijk om herbruikbare stukken informatie te maken, beheren en snel in elke samenstelling te publiceren naar ieder gewenst output medium. Zo kun je eenvoudig manuals publiceren naar zowel papier als naar een interactieve website. 

Een CCMS werkt vanuit een centrale opslag van informatiemodules en publiceert die naar meerdere outputvormen (“single-sourcing to multiple output”). Dat maakt het beheer en releasen van informatie een stuk efficiënter. Publiceren vanuit één bron verkort de doorlooptijd van het documentatieproces aanzienlijk.

Als alle informatie in modules is opgedeeld is dat ook veel efficiënter te vertalen. Alleen die delen die je nodig hebt of die gewijzigd zijn worden vertaald. In de praktijk kan dat tot 50% op de vertaalkosten schelen.

ccms

Informatie op maat voor je gebruikers

Met een CCMS kun je voor al je productvarianten en uitvoeringen vanuit dezelfde bron snel informatie op maat genereren voor iedere doelgroep zoals, installateurs, gebruikers en onderhoudsmedewerkers. En dat kan zelfs klant specifiek.

Op maat informatie leveren op het web, mobiel én op papier vergt zonder CCMS een enorme inspanning om iedere keer alle informatie up-to-date te maken. Alle teksten, figuren en foto’s moeten bijgehouden worden en op een consequente en aantrekkelijke manier bij je gebruikers belanden. Een CCMS levert  het overzicht en geeft controle op de informatieketen en neemt al het handwerk uit handen.

Een voorbeeld van een goed CCMS is IDS van Eluxis. Het is een bewezen en uiterst betrouwbaar pakket. Het wordt gebruikt bij onder andere, Nedap, Priva, Luchtverkeersleiding Nederland en Gasunie

IDS geeft controle en overzicht over alle informatie; op maat en klant specifiek, eenvoudig te maken en te beheren.

Andere systemen zijn Author-it, Paligo en easyDITA.

Kees de Grauw


Dit is misschien ook interessant voor jou

  • 01 juli 2021

    Learn How the New Market Surveillance Regulation Affects Non-EU Businesses And What You Should Do To Keep Selling Products On The European Market (and UK)

    In this webinar we will outline what the effects for non-EU businesses selling products on the European market are when the new Market Surveillance Regulation comes into force. ...

    LEES VERDER

  • 30 juni 2021

    Wat zijn goede voorbeelden van technische documentatie?

    Dit artikel laat aan de hand van voorbeelden zien waar je op moet letten bij het maken van professionele technische documentatie voor machines, software etc....

    LEES VERDER