Hoe creëer je perfecte technische documentatie?

Als het aankomt op je kennisbank, dan is het uiterst belangrijk dat je alle informatie daarin op overzichtelijke wijze indeelt. Zeer technische informatie verdient hierbij wat extra aandacht, want dit is voor de lezer (die meestal geen techneut is) lastiger te begrijpen. Hoe geef je dus technische informatie de beste vorm? Hier komen verschillende aspecten bij kijken.

Technische documentatie digitaal beschikbaar maken, zoals in een kennisbank, heeft vele voordelen. Zo is het veel gemakkelijker te verspreiden en milieuvriendelijk omdat er geen bomen voor gekapt hoeven te worden. Maar daarnaast is het ook nog eens veel gemakkelijker te updaten in het geval er iets gewijzigd wordt aan het product of apparaat waarop de documentatie betrekking heeft. Ook zijn digitale handleidingen heel gemakkelijk te doorzoeken.

Soorten technische documentatie

Bij technische documentatie kan gedacht worden aan verschillende soorten handleidingen en instructies. Bijvoorbeeld een gebruikshandleiding of een installatiehandleiding. Daarnaast kunnen er handleidingen gemaakt worden voor het onderhoud van een product of apparaat. Al deze verschillende soorten technische documentatie kun je gemakkelijk in je kennisbank plaatsen.

Bepaal de doelgroep

Als het aankomt op technische informatie is het belangrijk om deze toegankelijk te maken voor een specifieke groep mensen; je klanten of een andere doelgroep. In het kort gezegd richt je je op mensen waarvan je denkt dat ze baat kunnen hebben bij jouw informatie. Deze mensen maken gebruik van specifieke apparaten, software, machines of bepaalde producten.

Omdat je te maken hebt met lastige informatie, moet je er extra voor zorgen dat je lezers het kunnen begrijpen. En daarvoor moet je weten voor wie je schrijft. Bepaal dus allereerst wie je doelgroep is. Voor wie is de documentatie bedoeld? Zijn dit je klanten? Hoe oud zijn ze? Wat is het opleidingsniveau van deze specifieke groep mensen en in wat voor soort taal communiceren ze doorgaans? Pas je manier van communiceren aan op de doelgroep.

Bepaal wie het gaat schrijven

Dan komt het punt waarop je gaat beginnen met schrijven. Voor zeer technische documentatie kan het verstandig zijn om hiervoor een technisch schrijver in te huren. Het kan ook een idee zijn om een aantal personeelsleden van de IT-afdeling of ervaren monteurs te vragen dit te doen. Echter hebben zij vaak geen schrijfervaring die wel nodig is bij het goed overbrengen van de informatie. Een externe technisch schrijver inhuren is daarom geen overbodige luxe.

Hou de taal gemakkelijk

Om te beginnen is het bij technische informatie heel belangrijk om te spreken in taal die voor de lezer het beste te begrijpen is. Jargon en moeilijke woorden kun je hierbij het beste vermijden, tenzij je een hele specifieke doelgroep hebt waarvan je weet dat deze hiermee bekend is. Als het lastige informatie betreft die toch al moeilijk te volgen is, raakt de gemiddelde lezer bij ingewikkelde woorden en termen al snel de draad helemaal kwijt en zal deze dus elders op zoek gaan naar dezelfde informatie die wél te begrijpen is.

Weet dus wat je doelgroep zal begrijpen. Als je geen duidelijke doelgroep hebt of je doelgroep is heel breed (zoals bijvoorbeeld bij een internetprovider of de Rabobank), dan is het belangrijk om het taalgebruik zo algemeen mogelijk te houden. Lees voor meer tips over het schrijven van de artikelen ons artikel ‘Hoe schrijf je het perfecte kennisbankartikel?’ eens.

Maak het visueel

Een handig onderdeel van het begrijpelijk maken van technische informatie, is om de tekst zoveel mogelijk visueel te maken. Voeg dus niet alleen foto’s en video’s toe, ook illustraties kunnen goed helpen. Op die manier hoef je niet alleen te omschrijven wat je bedoelt, maar kun je het ook laten zien. Vooral bij technische informatie zijn illustraties belangrijk.

Wees duidelijk en to the point

Goede illustraties zijn duidelijk en to the point; er worden geen irrelevante voorwerpen afgebeeld en er wordt het liefst met zwarte lijnen op een witte achtergrond gewerkt. Kleuren aanbrengen kan, maar alleen als dit een doel of functie heeft voor hetgeen je wilt vertellen. Hetzelfde geldt voor afmetingen.

Juiste afmeting

Maak de afbeeldingen niet te groot want je wilt niet dat ze teveel ruimte innemen, ideaal zou zijn om ze in of naast de tekst te kunnen plaatsen. Maar maak ze ook weer niet te klein, zodat de lezer wel goed kan zien in welke ingang dat ene kabeltje nu precies moet. Ook moeten eventuele tekst en afmetingen goed te lezen zijn.

Denk eens aan de handleidingen van welk IKEA-meubelstuk dan ook. Gemakkelijker is het de klant bijna niet te maken. Er wordt precies verteld, duidelijk en stap voor stap, hoe het meubel in elkaar gezet moet worden, welke onderdelen en gereedschappen daarvoor nodig zijn en in welke hoek of positie de planken geplaatst moeten worden. Voor softwareprogramma’s voeg je printscreens toe, voor meubels en het installeren van apparatuur tekeningen of foto’s en bij beide onderwerpen kun je ook video’s plaatsen.

Maak onderscheid in het soort informatie

Bij zeer technische informatie is het belangrijk om onderscheid te maken tussen conceptuele en instructieve informatie. Of in andere woorden: wanneer je uitlegt waarvoor het apparaat dient of wanneer je zegt hoe de lezer iets moet doen. De conceptuele informatie verdeel je het liefst in verschillende onderdelen en de instructieve informatie in stappen.

Conceptuele informatie

Door uitleg in kleine hapjes beschikbaar te maken is het voor de lezer gemakkelijker te verwerken en kan hij tegelijkertijd kiezen welke informatie hij wil lezen. Misschien weet hij wel een beetje af van het onderwerp, maar van bepaalde onderdelen juist helemaal niets. Met kleine beetjes informatie kan hij beter zelf kiezen.

Instructieve informatie

De instructieve informatie geef je het liefst per stap weer, onderverdeeld in kleine handelingen, het liefst genummerd. Op die manier kun je ook een volgorde van handelingen aangeven. Afbeeldingen hierbij zijn heel belangrijk en moeten niet vergeten worden. Een voorbeeld:

Stap 1: pak de rode kabel en sluit deze aan op ingang A,

Stap 2: pak de zwarte kabel en sluit deze aan op ingang B,

Stap 3: pak nu apparaat 2 erbij en sluit deze met de gele kabel aan op ingang C,

Stap 4: druk op knop A van apparaat 2 en houdt deze 5 seconden ingedrukt.

Geef het een logische indeling

Een van de laatste stappen in het maken van je technische documentatie is het indelen ervan. Zorg ervoor dat de lezer gemakkelijk door de informatie kan navigeren en scannen en dat het zoeken tussen hoofdstukken en tussenkopjes gemakkelijk gaat. Deel het geheel in logische categorieën in, met daarbij alle onderliggende informatie overzichtelijk onderverdeeld over verschillende tussenkopjes.

Zorg er ook voor dat de titels in één of twee woorden zeggen wat er in de onderliggende tekst te vinden is. De doorsnee gemiddelde lezer is ongeduldig en druk en wil dus snel kunnen zien waar de informatie staat die hij op dat moment nodig heeft.

Voeg toe: trefwoordenregister (index)

Als het een handleiding betreft van meer dan 20-25 pagina’s, is het belangrijk om een index of trefwoordenregister toe te voegen aan het einde van het document. Als de lezer even niet kan vinden waar hij naar op zoek is, kan hij het trefwoordenregister raadplegen. Hierin staan alle woorden waarop gezocht kan worden, alle onderwerpen waar je het over hebt in het document.

Bij de woorden plaats je dan een paginanummer en (beter nog) een link naar de betreffende pagina. Vergeet als je een index toevoegt overigens niet om synoniemen toe te voegen, want misschien gebruikt de lezer wel een ander woord voor een bepaald onderwerp of voorwerp dan jij.

Test het geheel uit

Als je eenmaal je technische documentatie klaar hebt, dan is het tijd voor de allerlaatste stap het geheel uittesten. Dit is een belangrijke stap die niet overgeslagen mag worden. Want alleen door de handleiding te laten testen weet je of het zijn doel kan vervullen. Het beste idee is om hiervoor de eindgebruiker te vragen om te helpen, maar een derde partij die niet betrokken is geweest bij het maken van de handleiding kan ook voldoen. Bij het testen is het belangrijk dat de tester zich verplaatst in de lezer, omdat er vanuit dat perspectief naar de informatie gekeken moet worden.

Wil jij meer weten over wat een kennisbank voor jouw bedrijf kan betekenen? Lees dan eens over de voordelen van het hebben van een interne kennisbank of over hoe kennisbanken je klantenservice kunnen verbeteren.

Comments (1)

‘’Voor zeer technische documentatie kan het verstandig zijn om hiervoor een technisch schrijver in te huren’’. Hier zijn wij het zeker mee eens. Zo nu en dan wordt het schrijven van goede technische documentatie onderschat. Troubleshooting-content schrijven is namelijk niet voor iedereen weggelegd.

Vriendelijke groet,

Het Manualise-team

laat een reactie achter

Meld u zich aan voor onze nieuwsbrief
Meld u zich aan voor onze maandelijkse nieuwsbrief boordevol tips over kennismanagement
Dit venster nooit meer tonen