Technische handleiding maken?


Een technische handleiding maken

Met een technische handleiding brengt u productinformatie over naar de beoogde doelgroep. Een technische handleiding kan uitleggen hoe een product geïnstalleerd, geassembleerd, gerepareerd, gebruikt of onderhouden kan worden. Een goede technische handleiding stimuleert goed en veilig gebruik van producten!

Vraag direct een offerte aan >

Een technische handleiding maken

Met een technische handleiding brengt u productinformatie over naar de beoogde doelgroep. Een technische handleiding kan uitleggen hoe een product geïnstalleerd, geassembleerd, gerepareerd, gebruikt of onderhouden kan worden. Een goede technische handleiding stimuleert goed en veilig gebruik van producten!

Wat moet er in een technische handleiding?

Bij het maken van een handleiding kijken wij altijd naar wat de richtlijnen zeggen. Soms kunnen de richtlijnen vrij specifiek zijn. Zo betreft een van de vele eisen die de machinerichtlijn stelt, het vermelden van de aard en de frequentie van het onderhoud en de inspecties die om veiligheidsredenen noodzakelijk zijn. Een andere eis is het aangeven van de onderdelen welke aan slijtage onderhevig zijn. Vaak is er in de richtlijnen echter sprake van een wat hoger abstractieniveau. Zo stelt de richtlijn voor gastoestellen dat “in de gebruiks- en onderhoudsaanwijzingen voor de gebruiker alle nodige inlichtingen voor een veilig gebruik moeten worden gegeven”. Het komt er dan min of meer op neer dat de richtlijn stelt dat er een deugdelijke handleiding bij het product moet worden geleverd. Een manier om technisch invulling te geven aan richtlijnen is door het volgen van normen. Op het gebied van handleidingen is er de NEN 5509  Gebruikershandleidingen. Deze norm geeft een minimum aan vereisten voor de informatieve inhoud, de structuur, de formulering en de presentatie van gebruikershandleidingen. De norm spreekt over de volgende inhoud die een goede technische handleiding zou moeten bevatten:

Inhoud voor maken van technische handleiding

  1. Technische specificaties

  2. Voorzorgsmaatregelen en veiligheidsinstructies

  3. Beschrijving van het product; samenstelling van het product

  4. Montage; installatie; ingebruikname

  5. Beschrijving van de bediening; wijze van gebruik

  6. Onderhoud en onderhoudsschema

  7. Buitenbedrijfstelling

  8. Demontage, sloop; opslag en transport

  9. Storingen en reparatie

  10. Milieu

  11. Afdanken

Wat is een goede technische handleiding?

Naast het kunnen maken van een accurate, juiste en dekkende handleiding, vinden wij dat een aantal andere aspecten extra aandacht moeten krijgen. Dit zijn de doelgroep, de illustraties en de technieken die de gebruiker het beste ondersteunen om de informatie tot zich te nemen.

Communicatie naar de doelgroep

De communicatie bij technische handleidingen, ook wel de technische communicatie genoemd is erg belangrijk. Het is de kunst om accuraat en effectief feitelijke informatie aan de doelgroep over te brengen. Naast dat het erg belangrijk is kundig te zijn in de taal waarin de technische handleiding wordt geschreven, is het van belang de doelgroep goed te kennen. Iedere groep gebruikers heeft namelijk verschillende eigenschappen, zoals leeftijd, kennis, taalvaardigheid, opleidingsniveau, geslacht enz. Een technisch handleiding kan bedoeld zijn voor een consument, installateur of onderhoudstechnicus. De installateur kan de installateur van een tuinbouwkas zijn, een waterzuiveringsinstallatie of van de internettelevisie.

Bij het maken van een technische handleiding dienen meestal meerdere experts te worden geraadpleegd voor het verkrijgen van de juiste productinformatie. Dit kunnen experts zijn op het gebied van mechanica, elektronica, engineering, installatietechniek, software, user-interface, garantievoorwaarden, interne communicatie etc. etc. De informatie afkomstig van de experts moet worden omgezet naar begrijpelijke taal voor de beoogde doelgroep. Principes zoals Simplified Technical English en Minimalisme kunnen, indien van toegevoegde waarde, daarbij helpen.

Wij zijn van mening dat iedere handleiding, ongeacht de doelgroep to the point en zo kort mogelijk moet zijn. Een handleiding dient zo weinig mogelijk inspanning van de gebruiker te vragen om de informatie tot zich te moeten nemen. Daarnaast dient een handleiding makkelijk te begrijpen zijn. Speciale aandacht dient uit te gaan naar hoofdstuk- en paragraafkoppen (headings) en introducties, zodat de informatie zo effectief mogelijk zijn weg vindt naar de gebruiker. Visuele en tekstuele content moeten elkaar ondersteunen. De productinformatie, technologie en features van producten moeten vertaald worden naar begrijpbare menselijke instructies. Voorbeelden en scenario’ zorgen ervoor dat de gebruiker informatie effectiever tot zich neemt. Tot slot dient een handleiding warm, toegankelijk en plezierig zijn.

Illustraties maken

Een plaatje vertelt meer dan 1000 woorden is iets wat zeker geldt voor een afbeelding in een technische handleiding. Afbeeldingen zijn in staat effectiever de werking van een product of een handeling uit te leggen dan tekst dat kan doen. Illustraties verkorten de tijd om iets te leren en zorgen ervoor dat de aandacht van de gebruiker beter vast gehouden wordt. Illustraties dragen bij aan de eerder genoemde warme, toegankelijke en plezierige uitstraling van een handleiding; ze voegen levendigheid en kleur toe. En in het kader van internationalisering erg belangrijk: alles wat in een illustratie wordt uitgelegd hoeft iet vertaald te worden. Het feit dat 1,1 miljoen Nederlanders niet goed blijkt te kunnen lezen benadrukt nog eens extra de waarde van illustraties.

Technieken gebruiken

Vanuit de regelgeving is het in principe verplicht een technische handleiding als papieren document bij producten te verschaffen. Er zijn echter vaak betere manieren om productinformatie bij de gebruiker te krijgen dan via de papieren handleiding. Zo is het vaak handiger om een QR code te scannen waarbij een app of browser zich opent met de productinformatie, dan dat de papieren handleiding op dat moment gezocht moet worden. Een andere medium waarvan het gebruik explosief blijft stijgen is video.

Stap 1

Inhoud bepalen

De totale productinformatie wordt in kaart gebracht. Teksten worden geschreven en de ondersteunende illustraties worden gemaakt.

Stap 2

Vorm en stijl vastleggen

We bepalen hoe de productinformatie het beste gestructureerd en georganiseerd kan worden. De visuele stijl wordt vastgelegd.

Stap 3

Handleiding samenstellen

Nu de vorm en inhoud zijn vastgelegd gaan we de daadwerkelijke handleiding maken door vorm en inhoud samen te voegen tot de gewenste output vorm.

Onze referenties

Wilt u een technische handleiding maken en zoekt u naar een partner die al uw zorgen uit handen neemt? Wij begeleiden onze klanten bij het maken, verbeteren en/ of beheren van hun handleidingen. Tot onze klanten behoren onder andere:

“Manualise is kundig en denkt mee. Het is fijn erop te kunnen vertrouwen dat alles wat wij aanleveren met een kritische blik wordt bekeken.”

 

- Christy Hendrix , Categorie Manager Smartwares -


Wilt u ook uw technische handleiding door ons laten maken?

Vraag direct een offerte aan >