Inhoud
Instructiehandleidingen zijn een uitstekende toepassing op het gebied van technisch schrijven. Een goede handleiding zal de gebruiker alles vertellen wat hij moet doen om een bepaalde taak efficiënt en veilig te kunnen uitvoeren.
routebeschrijving
-
Identificeer de mensen aan wie de taak zal worden toegewezen en schrijf na te denken over hun niveau van begrip. Het kennen van je doelgroep is een belangrijk onderdeel van de schrijftechniek.
-
Schrijf een samenvatting op de voorkant van de handleiding als deze meer dan een paar pagina's bevat. Als de handleiding te lang is, voeg dan een index toe aan de achterkant.
-
Schrijf een korte inleiding die de taak in kwalitatieve termen beschrijft. Geef de gebruiker een idee van de taak en wat het eindresultaat zal zijn. Deze mogelijkheid moet worden gebruikt om belangrijk advies te geven dat de gebruiker helpt om het werk correct en efficiënt te doen.
-
Geef zonodig een lijst met relevante apparatuur en items die de gebruiker nodig heeft om de taak te voltooien. Als uw instructiehandleiding bedoeld is voor het samenstellen van een product en het te monteren product begeleidt, voeg dan een afzonderlijke lijst toe van alle onderdelen die aan de gebruiker moeten zijn geleverd.
-
Geef duidelijk een significant risico aan dat letsel, overlijden, schade aan eigendommen en andere gevaren kan veroorzaken. Gebruik de juiste taal met de wetten van de plaats waar de handleiding wordt verkocht.
-
Schrijf elke statement-actie in een aparte stap en geef alle informatie die de gebruiker nodig heeft om die stap te voltooien. Het schrijven moet letterlijk zijn, rechtlijnig en niet dubbelzinnig.
-
Als er ruimte is in uw handleiding, voeg dan cijfers en diagrammen toe telkens wanneer u een moeilijke stap voor de gebruiker wist.
-
Maak indien nodig een lijst met adviezen om de gebruiker te begeleiden om de taak te voltooien.