De technische handleiding is een belangrijk onderdeel van een technisch product. Of je nu producent bent van machines, huishoudelijke apparaten of meubels die men zelf in elkaar dient te zetten; de handleiding is van belang om ze veilig en betrouwbaar te kunnen gebruiken. Het schrijven van een technische handleiding vergt echter behoorlijk wat kennis. Met de volgende adviezen schrijf jij een sluitende handleiding.
Duidelijke taal
Het meest belangrijke aan een handleiding is dat iedereen die het leest de taal begrijpt. Gebruik dus eenvoudige taal in je handleiding. Werk met korte en bondige zinnen en vermijd te veel bijzinnen. Hoe rechter door zee je bent, des te duidelijker is de handleiding. Houd ook rekening met je publiek. Als je weet dat niet alle gebruikers de Nederlandse taal machtig zijn en laat technisch vertaalbureau Interlingo je handleiding dan vertalen. Zo weet je zeker dat alles zorgvuldig wordt vertaald en er geen misverstanden kunnen ontstaan.
Breng structuur aan
Laten we bij het begin beginnen: de inhoudsopgave. Deze biedt – helemaal bij zeer lange handleidingen – de leidraad voor de lezer. Vooral wanneer men later slechts wil opzoeken hoe je de batterijen moet vervangen of waar een bepaalde functie op het apparaat wordt beschreven. De inhoudsopgave helpt om structuur aan te brengen aan de handleiding. Breng overigens ook structuur aan in de verschillende hoofdstukjes. Als je de functies bijvoorbeeld gaat beschrijven is het goed om voor iedere functie een apart tussenkopje te maken. Of zorg voor een duidelijke stap-voor-stap instructie als er onderdelen in elkaar gezet moeten worden.
Afbeeldingen helpen
Naast tekst is het goed om afbeeldingen te gebruiken. Bij een apparaat kun je door middel van lijntjes de verschillende knoppen en onderdelen van het apparaat aanwijzen en verderop in de handleiding uitleggen. Plaatjes helpen de gebruiker om een apparaat sneller in elkaar te zetten. Hier geldt eveneens dat het duidelijk, kort en bondig moet zijn. Je kan beter alle stapjes één voor één uitleggen dan vijf stappen in één afbeelding stoppen.
Onderdelen van een technische handleiding
Een technische handleiding bestaat uit verschillende onderdelen. Het is van groot belang dat je alle onderdelen even goed invult. Uiteraard kun je tijdens een Open Coffee sparren met andere ondernemers of een tekstschrijver vinden die een goede handleiding die aan alle eisen voldoet kan schrijven. De technische handleiding moet uit de volgende onderdelen bestaan:
- De technische specificaties van het apparaat of in elkaar te zetten product. Hier kun je zaken kwijt als afmetingen, energiebron, de mechanische en elektrische eigenschappen, de kleur, uitvoering, gebruikte materialen en meer.
- Welke voorzorgsmaatregelen en veiligheidsinstructies zijn er nodig voor het gebruik van het product of apparaat? Beschrijf hier bijvoorbeeld of het buiten bereik van kinderen moet worden bewaard en vanaf welke leeftijd het product gebruikt mag worden. Misschien moet men wel handschoenen aan of een veiligheidsbril. Alles wat met voorzorg en veiligheid te maken heeft, vermeld je in dit gedeelte van de handleiding.
- De productbeschrijving bestaat uit een duidelijke tekst over het product zelf. Bijvoorbeeld waar het voor dient, wat je met gebruik van een product kan bereiken. Tevens vind je in een productbeschrijving wat de inhoud is van een pakket. Zo kun je bijvoorbeeld aangeven bij een zelf in elkaar te zetten meubelstuk wat er allemaal in het pakket zit.
- a. Moet de gebruiker zelf nog onderdelen in elkaar zetten dan ga je over op de instructies voor de montage. Dit deel van de handleiding moet heel duidelijk en zorgvuldig worden beschreven. Je moet ten slotte voorkomen dat er met de montage iets fout gaat waardoor ongelukken gebeuren.
b. Is het product gemonteerd of kant-en-klaar geleverd en moet het worden geïnstalleerd dan geef je instructies voor de installatie. Denk hierbij aan het waterpas stellen van bijvoorbeeld een vaatwasmachine of het installeren van een nieuwe router.
c. Is het gemonteerd, geïnstalleerd of al kant-en-klaar voor gebruik dan beschrijf je in deze stap de procedure van ingebruikname. Hier kun je bijvoorbeeld in opnemen dat een nieuwe pan eerst even moet worden gewassen of dat je de nieuwe ovenschaal een keer zonder voedsel in de oven zet.
Sla in dit hoofdstuk van je handleiding geen stappen over. Zelfs al klinkt het wellicht een beetje belerend. Als iemand nog nooit een laptop heeft geopend, is het goed om bij de ingebruikname te vertellen hoe dat werkt.
- Als het product klaar is voor gebruik, dan moet men nog weten hoe je het kan bedienen. Dit geldt voor veel elektrische apparaten. Leg de verschillende functies uit en maak gebruik van tekeningen om alles te verduidelijken.
- Heeft een apparaat geregeld onderhoud nodig? Neem dit dan mee in de handleiding. Bijvoorbeeld met een schema en stappenplan.
- Het kan altijd gebeuren dat er iets misgaat met een apparaat waarvan de oplossing niet direct vermeld staat in de handleiding. Je kan immers niet alles afvangen. Neem daarom een hoofdstukje ‘Storingen en reparatie’ op met contactinformatie, zoals een storingsnummer of een website.
Tot slot kun je nog een aantal andere zaken in de handleiding meenemen, zoals een disclaimer dat je bij verkeerd gebruik niet aansprakelijk bent voor eventuele schade, hoe een apparaat buiten bedrijf gesteld kan worden – en wat je vervolgens moet doen, hoe een defect apparaat gedemonteerd of gesloopt moet worden en hoe het product het beste getransporteerd kan worden.
Een technische handleiding bestaat uit veel verschillende onderdelen. Probeer ze duidelijk te beschrijven, dan heb je een goede technische handleiding in handen waar iedereen iets aan heeft.
