Voor het ontwikkelen van professionele productdocumentatie zijn verschillende tools inzetbaar. Microsoft Word is handig voor een geringe hoeveelheid documenten. Met Adobe FrameMaker pakt u het professioneler aan door een strakkere scheiding van inhoud en stijl. Wilt u grote hoeveelheden productinformatie effectief inkleden, dan gebruikt u een component content management systeem (CCMS). Dit is een systeem waarin u informatiebouwstenen beheert (volgens gangbare standaarden zoals DITA en XML) en zoveel mogelijk informatiebouwstenen probeert her te gebruiken. Ideaal voor informatie die in meerdere handleidingen voorkomt (bijvoorbeeld modulair opgebouwde producten/documentatie).

Microsoft Word, Adobe FrameMaker, Author-it en IDS; het zijn allemaal pakketten die u kunnen helpen bij het ontwikkelen, beheren en vertalen van uw productinformatie. Aan elk pakket zitten voor- en nadelen. Het belangrijkste is dat het gebruikte pakket geschikt is voor uw eigen situatie. De aanschafkosten van een component content management systeem zijn hoger dan Microsoft Word, maar kan in praktijk veel effectiever zijn, bijvoorbeeld als u veel productdocumentatie heeft. Hieronder een overzicht van onze ervaringen met deze vier programma’s en de positieve en negatieve kanten ervan.

Microsoft Word is ondanks haar beperkingen een prima programma. Het is laagdrempelig en iedereen kan er mee werken. Voor het ontwikkelen van professionele productdocumentatie kan Microsoft Word perfect ingezet worden. Zorg ervoor dat er goede templates ontwikkeld worden en dat de auteurs instructies krijgen voor het correcte gebruik van de templates, et voilà. Microsoft Word is geschikt als programma wanneer de productdocumentatie te overzien is. Bijvoorbeeld wanneer u 2 producten in 4 talen heeft, zonder veel hergebruik tussen de documenten. Het ontwikkelen en up-to-date houden van deze documenten is dan goed te doen.

Adobe FrameMaker is een pakket dat we de laatste jaren wat minder zien. Desondanks is het een betrouwbaar pakket voor het ontwikkelen van grote hoeveelheden productdocumentatie. FrameMaker is gericht op het ontwikkelen van papieren handleidingen en webhelp. Het gebruik van stijlen is veel solider ingekleed dan Microsoft Word. Hierdoor heeft u meer grip op de uiteindelijke look-and-feel van het document. Ook is hergebruik van document-objecten (hoofdstukken) mogelijk. Relaties (waar hergebruikt) zijn echter niet zichtbaar, dus het gevaar van ‘bomen en een bos’ licht op de loer. Bewerken van XML is goed mogelijk met Structured FrameMaker, er zijn echter meer gebruiksvriendelijkere pakketten op de markt. FrameMaker is een degelijk pakket en kan worden ingezet wanneer uw auteurs iets beter onderlegd zijn en wanneer u uw uitstraling belangrijk vindt.

Dan komen we bij component content management systemen. Author-it is daarvan een bekende. Het vindt haar oorsprong in Nieuw-Zeeland en wordt wereldwijd ingezet bij toonaangevende bedrijven. Voor auteurs is de verandering van documentgebaseerd schrijven naar topic-gebaseerd schrijven de grootste uitdaging. Dit principe werkt wat anders en daarom is het in projecten belangrijk dat de auteurs goed geschoold worden (informeer naar onze cursus topic-gebaseerd schrijven). In een CCMS worden topics / informatiebouwstenen aangemaakt. Deze kunnen hergebruikt worden. Het voordeel hiervan is dat het topic slechts eenmaal beheerd en vertaald hoeft te worden. Dit zorgt voor consistentie in de uiteindelijke productinformatie en draagt bij aan lagere vertaalkosten. De vertalingen verlopen via XML-bestanden; het bestandstype dat aangeraden wordt door vertaalbureaus. Verder heeft een CCMS versiebeheer en tools voor het beheren van relaties tussen documenten. Author-it heeft een toegankelijke auteursinterface en is geschikt voor bedrijven die veel productinformatie hebben in meerdere talen.

IDS is een component content management systeem gebaseerd op de internationale standaarden DITA en XML. Het heeft een uiterst betrouwbare auteursinterface en de overzichtelijke beheersomgeving zorgt ervoor dat u het gevoel heeft grip te hebben op alle inhoud. Het wordt gebruikt bij grote organisaties, zoals de Luchtverkeersleiding Nederland, Gasunie, Priva en Prorail. Het schrijven van inhoud is voor auteurs eenvoudig; men kan kiezen uit een standaard set aan stijlen (DITA gebaseerd). Het standaard-pakket is zeer volledig en wanneer nodig kunt u als bedrijf zelf functies integreren. Het kan makkelijk gekoppeld worden met informatie uit bestaande systemen, zoals SAP en onderhoudsbeheersystemen. Technische specificaties bijvoorbeeld worden dan rechtstreeks uit bestaande softwarepakketten gehaald. Vertalingen verlopen via XML; het bestandstype dat wordt geadviseerd door vertaalbureaus. IDS is geschikt voor bedrijven die veel productinformatie hebben in meerdere talen en voor bedrijven die bedrijfsbrede informatie slim willen beheren.