U heeft een product ontwikkeld! Tijdens het ontwikkelproces heeft u allerlei technische informatie over uw product gemaakt en verzameld, die gedurende de productiefase omgezet moet worden naar technische documentatie: een handleiding, bijvoorbeeld. Veel mensen realiseren zich niet dat een handleiding veel meer is dan slechts een verplichte bijkomstigheid van een product. Een goede handleiding stelt gebruikers namelijk ook in staat om goed en veilig aan de slag te kunnen met het product. En dat kan alleen wanneer de handleiding goed aansluit bij de doelgroep.
Maar hoe schrijft u nu een goede handleiding? In deze blog vertellen we meer over de uitdagingen die komen kijken bij het maken van een handleiding.
Uitdagingen bij een handleiding maken of een handboek schrijven
Een handboek maken of handleiding maken is niet alleen een technisch proces: het is vooral een creatief proces. Een handleiding moet glashelder aangeven hoe het product moet worden geproduceerd, gebruikt of onderhouden.
Veel organisaties die met handleidingen en handboeken aan de slag willen lopen tegen verschillende uitdagingen aan:
- Het schrijven van handleidingen is in veel bedrijven geen dagelijkse activiteit: het gaat met pieken en dalen. Daardoor zijn er vaak twee keuzes: besteedt u het projectmatig uit aan een partij zoals DCT of zoekt u iemand binnen uw organisatie die met uw handleidingen aan de slag kan? Welke productengineer vindt het leuk om handleidingen te schrijven én is er ook goed in?
- Het is essentieel dat degene die handleidingen schrijft iets kan uitleggen op het niveau van de doelgroep. De details hoeft hij of zij, tot op zekere hoogte, niet eens te weten of te begrijpen: het gaat meestal juist om de basiskennis. De technisch schrijver hoeft geen engineer te zijn om een goede handleiding te schrijven: dat zijn de meeste technisch schrijvers van DCT ook niet. Diepgaande technische kennis is vaak eerder een beperking dan een kracht: elementaire zaken, die vaak juist relevant zijn voor de doelgroep, lijken dan snel voor de hand liggend en worden al gauw overgeslagen.
- Misschien nog wel het belangrijkste punt voor uw handleiding: wie is de doelgroep eigenlijk? Hoe bereikt u hen? Hierover leest u meer in onze blog over schrijven en publiceren voor uw doelgroep.
Hoe maakt u een handleiding?
Natuurlijk kunt u zelf aan de slag met de handleiding. Dat kan een strategische keuze zijn, een kostenoverweging, of misschien heeft u er een andere reden voor. Hoe dan ook is goed beheer het uitgangspunt van alle goede technische documentatie. Op die manier kan informatie zo optimaal mogelijk (her)gebruikt worden. De juiste versie van de handleiding is dan altijd binnen handbereik, ongeacht de hoeveelheid aanpassingen die u sinds de eerste versie heeft aangebracht.
Een handleiding moet goed en logisch opgebouwd worden, om deze zo overzichtelijk en toegankelijk mogelijk te maken voor uw doelgroep. Daarnaast moet een handleiding alleen informatie bevatten die ook daadwerkelijk van belang is voor een doelgroep, in begrijpelijke taal (meestal in de gebiedende wijs) geschreven zijn, en terminologie moet consistent gebruikt worden. Deze consistentie en logische opbouw kunt u realiseren door het gebruik van DITA.
U maakt de handleiding dus altijd met de doelgroep als rode draad. Hoe nemen zij informatie het beste tot zich? Is dat in het Nederlands of in een andere taal? Als papieren boekje of digitaal? Door middel van tekst, foto’s, afbeeldingen, technische tekeningen of een combinatie hiervan?
Een handleiding laten maken door DCT
Tijd om aan de slag te gaan met het maken van een handleiding of handboek. Heeft u nog advies nodig voordat u aan het schrijven gaat? De experts van DCT adviseren u graag.
Wilt u absoluut zeker weten dat de handleiding perfect aansluit op uw doelgroep? Of besteedt u het gehele proces van het schrijven, beheren en publiceren van handleiding toch liever uit? DCT kan u ontzorgen.
