We hebben het al vaker gezegd: het belangrijkste uitgangspunt bij het maken van een handleiding en van goede technische documentatie is goed beheer. Goed (digitaal) documentatiebeheer kan bereikt worden door middel van modulaire opbouw. In deze publicatie focussen we op de aanpak achter deze opbouw van documentatie: DITA (Darwin Information Typing Architecture); een standaard die voor elke organisatie vrij te gebruiken is.
Wat is DITA?
DITA is een open XML-gebaseerde wereldstandaard voor het creëren, beheren en publiceren van modulair opgebouwde teksten. DITA werkt met ‘onderwerpen’: stukjes herbruikbare tekst. Elk onderwerp behandelt een specifiek thema, zoals een procedure of een handeling. De stukken kunnen worden gecombineerd, om zo bijvoorbeeld een gebruikershandleiding of online helpsysteem te vormen.
DITA kan dus helpen met het structureren van content. Zo kan deze content hergebruikt worden voor verschillende platformen en doelgroepen. Omdat ieder onderwerp eindeloos opnieuw kan worden gebruikt, wordt de consistentie van documenten verbeterd en kan er efficiënter worden gewerkt. Kopiëren en plakken van stukken tekst is namelijk verleden tijd.
De voordelen van DITA
Werken met DITA heeft verschillende voordelen. Elk onderwerp, ieder stuk tekst, hoeft maar één keer te worden geschreven. Deze tekst kan daarna zo vaak als nodig en op iedere gewenste plek hergebruikt of opgeroepen worden. Een noodzakelijke wijziging of toevoeging kan worden doorgevoerd in één van de modules. De aanpassing wordt dan ook direct doorgevoerd in alle hergebruikte versies van het onderwerp. U hoeft dus niet meer ieder stukje op te zoeken en individueel aan te passen.
Onderhoud en publicaties veel beter beheer(s)baar
Versiebeheer blijft een uitdaging voor veel bedrijven. Wanneer meerdere personen aan een document werken, is het lastig bij te houden wat de meest recente versie het document is. DITA biedt daarom ook een aantal functies waarmee wijzigingen en revisies beter beheerd kunnen worden. Zo kunnen meerdere versies van hetzelfde document worden gepubliceerd, zonder dat deze verwarring veroorzaken. Dit kan bijvoorbeeld nodig zijn wanneer één document moet worden afgestemd op verschillende doelgroepen, talen of (publicatie)kanalen.
Content kan zo dus in verschillende formaten worden gepubliceerd, zonder dat er voor iedere doelgroep of kanaal een ander document moet worden gemaakt. Ook voor meertalige publicaties heeft DITA een oplossing: het beschikt ook over speciale lokaliseringsfuncties die de content gemakkelijk naar verschillende talen en culturen kan aanpassen.
Een waardevolle investering
Het implementeren van DITA is weliswaar een investering in tools en training, maar de voordelen zullen al snel duidelijk worden. Het zorgt op den duur ook voor een kostenvermindering, zeker in organisaties die veel en/of complexe documentatie produceren. DITA zorgt voor structuur, efficiëntie en toegankelijkheid, kwaliteit én een hoge gebruikerstevredenheid.
Heeft u vragen over DITA of heeft u een andere uitdaging op het gebied van technische documentatie? Het team van DCT adviseert u graag. Neem contact met ons op!
