In vrijwel iedere organisatie speelt documentatie, bijvoorbeeld in de vorm van handleidingen, (online-)helpsystemen of werkinstructies, wel een rol. Dat kan intern zijn, om medewerkers instructies te geven, om werkprocessen vast te leggen, processen te stroomlijnen of machines te onderhouden, maar ook extern, om consumenten uit te leggen hoe ze zo goed mogelijk aan de slag kunnen met een product of dienst.
Hoe beter de eindgebruiker de documentatie begrijpt, hoe beter deze ook aan de slag kan met een product of dienst. Maar hoe zorgt u er nu voor dat uw documentatie ook daadwerkelijk zo begrijpelijk mogelijk is? Goed beheer van uw documentatie is het halve werk. Dat kan onder andere door het inzetten van een Component Content Management System (CCMS).
Component Content Management System (CCMS)
Een CCMS is een omgeving waarin technisch schrijvers technische documentatie modulair kunnen opbouwen. Dit betekent dat de documentatie wordt opgedeeld in tekstdelen. Door te werken in onderdelen en niet in gehele teksten, kan een aanpassingen van informatie automatisch worden toegepast in alle stukken documentatie. Dit maakt het ook gemakkelijker om teksten (gedeeltelijk) te hergebruiken. Dit zorgt voor consistentie in de documentatie en een constante hoge kwaliteit, tegen lagere kosten.
Hoe werkt een CCMS?
Een CCMS is een contentmanagementsysteem (CMS) dat content beheert op basis van onderdelen in plaats van het gehele document. Elk onderdeel bevat een stuk tekst, een afbeelding, een tabel, een productbeschrijving of een procedure, die zo groot kan zijn als een hoofdstuk of zo klein als een woord.
In een regulier contentmanagementsysteem zouden deze modules constant moeten worden gekopieerd en geplakt, mochten ze op meerdere plekken gebruikt moeten worden. Doordat deze dan op veel verschillende plekken staan, wordt het terugvinden van alle delen lastiger. Daardoor kan het gebeuren dat één of meerdere van de geknipte en geplakte tekstdelen onverhoopt wordt overgeslagen bij het doorvoeren van wijzigingen, waardoor ze incompleet, achterhaald of zelfs onjuist kunnen worden.
In een CCMS wordt elke onderdeel één keer opgeslagen, waardoor er ook maar één basisbron van het onderdeel is. Deze basisbron wordt (her)gebruikt binnen het document of binnen meerdere documenten. Hierdoor blijft de inhoud consistent en correct, ongeacht op hoeveel plaatsen of in hoeveel publicaties de module terugkomt.
Modulair schrijven: het vak van de technisch schrijver
Een van de uitdagingen van een technisch schrijver is het schrijven van gestructureerde en herbruikbare modules, in plaats van het schrijven van een tekst van begin tot eind. Er moet namelijk niet nagedacht worden over de tekst als geheel, met een logische kop en staart. Alle onderdelen vormen een tekst op zichzelf. De onderdelen worden uiteindelijk samengevoegd tot een tekst die goed leesbaar en bovenal begrijpelijk is.
Voordelen van een CCMS
Het gebruik van een CCMS zorgt voor een hogere kwaliteit en betere consistentie, en bespaart zowel tijd als geld. Modules hoeven ook maar één keer aangepast te worden. Het risico dat er een tekstdeel overblijft dat niet geüpdatet is, bestaat dus niet meer. Daarnaast is een tekstdeel ook veel eenvoudiger te zoeken en te vinden.
Daarnaast kunnen teksten ook veel eenvoudiger en efficiënter vertaald worden. In plaats van dat een gehele tekst vertaald wordt, hoeft elk tekstdeel maar één keer vertaald te worden. Hierdoor gaan de vertaalkosten significant omlaag. Ook wanneer er na de originele vertalingen nog wijzigingen in de documentatie aangebracht worden, wordt een nieuwe vertaling eenvoudig gemaakt. Alleen de onderdelen waarin de aanpassingen zijn gemaakt hoeven dan namelijk nog onder handen genomen te worden.
De ervaring van DCT met CCMS
DCT helpt organisaties om hun documentatie zo efficiënt mogelijk te creëren, beheren en publiceren in vrijwel elke taal. Onze professionals hebben uitgebreide kennis van en ervaring met het werken met CCMS’en en het selecteren van een CCMS dat bij uw organisatie past.
Wilt u aan de slag met een CCMS of kunt u wel wat advies gebruiken op het gebied van documentatiebeheer? Misschien heeft u een hele andere vraag of uitdaging. Door middel van onderstaand formulier geeft u deze gemakkelijk aan. We komen dan zo snel mogelijk bij u terug!
