Word, FrameMaker, MadCap of DITA? Welke tool is het meest geschikt voor jouw documentatie?

Bijna elk technisch bedrijf is ooit op dezelfde manier begonnen met het produceren van handleidingen. Iemand wordt benoemd tot 'technisch schrijver', die gaat aan de slag met Word, schrijft een handleiding en slaat het resultaat op in een netwerkmap. Dat herhaalt zich naarmate er andere producten bijkomen of er nieuwe versies ontstaan.

In het begin werkt dat prima. Aanpassingen zijn makkelijk door te voeren, de oplossing is goedkoop en nog redelijk goed te managen. Het wordt al lastiger als die handleidingen vertaald moeten worden. Er ontstaan steeds meer versies van het document en het documentmanagement wordt steeds meer een uitdaging.

Naarmate het bedrijf en het productaanbod groeien, wordt die uitdaging almaar groter. Het bestandsformaat waarin je je documentatie maakt wordt steeds minder een technisch verhaal en steeds meer een strategische keuze. Hoe je handleidingen maakt, bepaalt hoe makkelijk je omgaat met nieuwe producten en versies, hoe snel en eenvoudig je taalversies kunt toevoegen en hoe je het steeds groter wordende archief aan content beheert.

Uiteindelijk bepalen al die factoren bij elkaar wat je documentatiekosten zijn en of je proces beheersbaar en overdraagbaar is. Je wilt de kosten natuurlijk zo laag mogelijk houden, maar ook zorgen dat het documentatieproces niet afhankelijk is van één persoon of externe partij. De keuze voor de tool en het bestandsformaat waarin je werkt, wordt dus steeds belangrijker, zeker ook als je documentatie in meerdere talen beschikbaar moet zijn.

Welke opties heb je als documentatiemanager?

Wanneer je verantwoordelijk bent voor het schrijven of beheren van productcontent en dan met name gebruikersdocumentatie, wil je graag weten welke opties je hebt om de documentatie te schrijven, te vertalen en te beheren. De producten van je bedrijf moeten duidelijk, veilig en conform de regelgeving worden beschreven, zodat gebruikers er probleemloos mee kunnen werken.

Onderstaand vind je een kort overzicht van de belangrijkste opties die je in verschillende stadia van de ontwikkeling van een documentatie-afdeling hebt en wat specifiek de implicaties zijn voor het vertaalproces. Dat laatste is nu eenmaal een belangrijke overweging voor bedrijven die internationaal opereren. Hoe meer markten je gaat bedienen, hoe groter de impact van het vertaalproces op het documentatiebudget.

Microsoft Word (.docx)

Voordelen. Iedereen kan ermee overweg en de instapkosten zijn zeer laag. Ook is het proces eenvoudig overdraagbaar binnen de organisatie. Voor vertaling is Word prima geschikt: alle moderne vertaaltools lezen .docx rechtstreeks in. Bij updates of hergebruik van teksten tussen verschillende apparaten wordt een vertaalgeheugen ingezet. Dat zorgt voor consistentie in stijl en terminologie en verlaagt de vertaalkosten.

Nadelen. Zodra de documentatiebehoefte toeneemt, worden de beperkingen van Word steeds duidelijker. Versiebeheer is beperkt. Hergebruik van tekstelementen is omslachtig en foutgevoelig. Opmaakproblemen worden in vertaalde versies versterkt. Hoe groter de documenten worden, hoe trager en slechter Word werkt. En Word laat zich niet online publiceren.

Geschikt voor: kleine documentatiesets, weinig hergebruik, lage herzieningsfrequentie.

Adobe FrameMaker

FrameMaker bestaat in twee smaken, en het onderscheid is cruciaal.

Ongestructureerd FrameMaker is een krachtige tool voor lange technische handleidingen: paginering, kruisverwijzingen, automatische inhoudsopgaven en indexen werken goed en stabiel, ook bij honderden pagina's.

Gestructureerd FrameMaker werkt met XML of DITA onder de motorkap en combineert een gestructureerde bronopslag met professionele opmaak.

Voordelen: biedt veel controle over opmaak, verwijzingen, indexering e.d. ook in grote handleidingen.

Nadelen. FrameMaker vereist licenties en opgeleide auteurs; de leercurve is stevig en de gebruikersgroep krimpt, waardoor auteurs schaarser worden. Voor vertaling is het goed te verwerken (via MIF of .fm), maar de opmaak moet na vertaling meestal nog worden bewerkt. Die nabewerking kost tijd en geld. FrameMaker-bestanden zijn ook niet online te publiceren.

Geschikt voor: middelgrote tot grote organisaties beperkte aantallen grote manuals met veel verwijzingen en afbeeldingen maken. Vooral als deze als PDF gepubliceerd of gedrukt moeten worden.

Generieke XML (DocBook of een eigen schema)

Met XML scheid je de inhoud volledig van opmaak. Je beschrijft alleen wat de tekst voorstelt ("waarschuwing", "stap", "onderdeelnummer"), maar niet hoe die wordt opgemaakt. Die laatste stap gebeurt pas bij publicatie via stylesheets. Zo kun je vanuit één bron bijvoorbeeld een PDF, een helpsysteem of een mobiele weergave publiceren.

Voordelen. Toekomstbestendig, leveranciersonafhankelijk en uitstekend geschikt voor vertaling. XML kan worden omgezet naar XLIFF, het internationale uitwisselingsformaat voor vertalingen. De DTP-nabewerking verdwijnt grotendeels.

Nadelen. Een eigen schema betekent dat je zelf de standaard onderhoudt: stylesheets, validatie, publicatiepijplijn. Dat is een IT-project en geen documentatietaak en wordt niet zelden bij één medewerker belegd. Als die medewerker afwezig is of afscheid neemt, ligt het documentatieproces stil.

DITA

DITA is een open XML-standaard die specifiek is ontworpen voor het schrijven van technische documentatie. In plaats van documenten schrijf je topics: kleine, op zichzelf staande eenheden (taken, concepten, referentietabellen). Een manual is dan niet een bestand, maar een map: een inhoudsopgave die verwijst naar de topics die er deel van uitmaken.

Voordelen. Alles draait in DITA om hergebruik. Een veiligheidswaarschuwing maak je één keer, maar kan in vierentwintig verschillende handleidingen worden ingevoegd. Een aanpassing op één plek wordt direct in al die handleidingen doorgevoerd. Conditional text gebruik je om vanuit dezelfde bron zowel een uitgebreide servicehandleiding en een beknopte gebruikersversie. DITA is dus zeer flexibel.

Voor vertaling is het effect direct meetbaar: alleen gewijzigde topics worden vertaald, niet het hele document. Klanten die overstappen zien hun terugkerende vertaalkosten regelmatig met tientallen procenten dalen. Bovendien is DITA een open standaard met een breed leveranciersaanbod.

Nadelen. De aanvangsinvestering in tijd en geld is aanzienlijk: auteurs moeten met het systeem leren werken, bestaande documentatie moet worden omgezet en zonder ondersteunend CCMS is DITA onwerkbaar. Als je een klein aantal handleidingen hebt die niet vaak worden bijgewerkt, verdient de investering zich niet terug.

Geschikt voor: leveranciers van productfamilies, content met veel overlap, frequente updates, meerdere talen.

Tools zoals MadCap Flare

Tussen "Word met discipline" en "DITA met een CCMS" gaapt een gat, en daar zitten tools zoals MadCap Flare, Paligo, ClickHelp, RoboHelp en Author-it. MadCap Flare is de bekendste en meest gebruikte authoring tool, die intern met XHTML-bestanden werkt. Ook hier schrijf je topics in plaats van documenten, en publiceer je vanuit één bron naar HTML5-helpsystemen, PDF, Word en print.

Voordelen. Flare biedt veel van de voordelen van DITA, maar is veel gebruiksvriendelijker. Hergebruik verloopt via snippets (herbruikbare tekstblokken) en variabelen (productnamen, versienummers, spanningswaarden). Met conditional tags publiceer je uit dezelfde bron meerdere outputs. De inhoudsopgave bouw je visueel op in plaats van in een XML-map. Auteurs die Word gewend zijn, kunnen er binnen enkele dagen mee werken, bij DITA kan dat maanden duren. Flare is ook zeer geschikt om online documentatie te publiceren. Nadelen. Flare is een product van één leverancier en je betaalt voor licenties per gebruiker. Latere migratie naar DITA is weliswaar mogelijk, maar zeker geen sinecure. Ook opschalen wordt op een gegeven moment lastig. Bij honderden topics die door tientallen productlijnen heen worden gedeeld, mis je strengere contentmodellen en rechtenbeheer. Die vind je wel in een volwaardig CCMS, zoals Paligo of SCHEMA ST4.

Ander groot nadeel is dat het lastig is om MadCap Flare-bestanden te vertalen in de gangbare vertaalgeheugentools. Die zijn essentieel voor hergebruik van vertalingen, dus als vertalen een belangrijk onderdeel is van het documentatieproces, moet dit zeker worden meegenomen in de overwegingen. Een goed technisch onderlegd vertaalbureau zoals Interlingo kan uitkomst bieden.

Geschikt voor: organisaties die met Word niet verder komen, maar (nog) niet klaar zijn voor de stap naar DITA en een CCMS.

Wat is een CCMS — en waarom heb je er een nodig?

Zodra je in topics gaat schrijven, wordt de uitdaging anders. Je content is niet meer verdeeld over dertig documenten, maar over honderden losse bouwstenen die in wisselende combinaties samen die dertig handleidingen vormen. En dat vermenigvuldigd met het aantal talen waarin je de handleiding nodig hebt. Dat valt niet meer te beheren in een mappenstructuur of op een gedeelde drive.

Een CCMS (Component Content Management System) is een contentdatabase die op componentniveau werkt in plaats van op bestandsniveau. Bekende systemen zijn Paligo, SCHEMA ST4, Tridion Docs en Heretto. Daarin houd je bijvoorbeeld bij waar welke topic wordt gebruikt, doe je nauwkeurig versiebeheer, zie je de vertaalstatus per taal, kun je content makkelijker laten reviewen enzovoort. En als je het CCMS koppelt aan een vertaalomgeving, is het uitbesteden van vertalingen een fluitje van een cent. Een CCMS is echter wel een complex systeem, dus je hebt een of meer mensen nodig die het systeem kennen en onderhouden.

Welke aanpak past bij jou?

Profiel 1 — enkele handleidingen, weinig wijzigingen, één tot drie talen. Blijf bij Word, maar discipline loont: werk uitsluitend met stijlen, gebruik één sjabloon en houd een eenvoudig versieregister bij. Laat je vertaalbureau vertaalgeheugens en terminologie opbouwen, dat zorgt voor lagere kosten, kortere doorlooptijden en consistentie in de vertalingen.

Profiel 2 — vijf tot vijftien handleidingen, merkbare overlap, drie tot zes talen. Hier begint de pijn, en hier is een tool als MadCap Flare vaak de verstandigste stap. Je kunt hiermee topic-based schrijven zonder een volledig DITA-traject op te tuigen. Alternatieven zijn gestructureerd FrameMaker of DocBook. Begin in elk geval met het isoleren van stukken tekst die vaak terugkeren: waarschuwingen, specificaties, onderhoudsinstructies, etc.

Profiel 3 — tientallen handleidingen, sterke overlap, zes of meer talen, frequente productupdates. DITA in combinatie met een CCMS en koppeling met een vertaalomgeving. De investering in tijd en mensen betaalt zich na verloop van tijd uit.

Stel jezelf niet alleen de vraag wat nu en volgend jaar de beste oplossing is, maar ook waar je over drie jaar en daarna wilt staan met je productaanbod, je doelmarkten en het bijbehorende documentatieproces. Verdubbelt je assortiment? Komen er talen bij? Heeft veranderende regelgeving een grote impact op je documentatie? Voor advies kun je contact opnemen met Joël Sigling: joel.sigling@interlingo.nl. Samen met onze specialisten kunnen we kijken welke oplossing het beste bij jouw situatie past.