Een handleiding schrijven


Technisch schrijven en redigeren van handleidingen

Een handleiding kan nodig zijn voor de bediening, de installatie of het onderhoud van een product. Een product kan van alles zijn: een (huishoudelijk) apparaat, een productiemachine, een complete industriële installatie of een softwareapplicatie. Manualise schrijft handleidingen voor deze producten en voorziet ze van sprekende illustraties.

Vraag direct een offerte aan >

Technisch schrijven is een vak

Een handleiding schrijven is een vak. Onze technisch schrijvers weten wat dat vak inhoudt. Steeds houden ze een aantal uitgangspunten voor ogen. Eén daarvan is: als illustraties het werk kunnen doen van 1.000 woorden, laat een plaatje dan ook meer zeggen dan die 1.000 woorden. Een goede technisch schrijver denkt dus ook meteen aan zijn collega, de technisch illustrator. Onze technisch schrijvers en illustratoren vormen altijd een hecht team.

Met de keuze ‘tekst of illustratie’ hebben we meteen onze eerste afweging te pakken. Maar er zijn nog veel andere!

Hier volgen de keuzes die elke technisch schrijver moet maken:

  • Wat wordt de toonzetting van de handleiding? Een senior die een noodoproepsysteem moet kunnen bedienen benader je heel anders dan een installateur van brugpontons.
  • Ligt alle productinformatie op tafel zodat een technisch schrijver niets over het hoofd ziet en zeer concreet kan schrijven? Als er bijvoorbeeld nog te weinig onderhoudsinformatie voorhanden is, komen technisch schrijvers vaak niet verder dan het advies om een machine goed schoon te houden. Maar dat advies is niet genoeg om de bedrijfszekerheid van een machine te garanderen over een zo lang mogelijke tijd.
  • Hoe fijnmazig moet de inhoudsopgave zijn? Is de gebruiker al zo ervaren dat hij meteen deeltaken onderscheidt (‘Drukmeting invoerwater controleren’) of gaat hij juist globaal te werk (‘Controleren nabezinktank’) en moet hij verder aan de hand worden genomen?
  • Voldoet een handleiding behalve aan Europese richtlijnen ook aan de NEN5509? De NEN5509 is de Nederlandse norm die de Europese richtlijnen concreet invult met adviezen over zaken als: een volledige hoofdstukkenindeling, een passende vormgeving, de noodzaak om bepaalde kwesties op een bepaalde manier in een bepaalde volgorde te behandelen (installatie, ingebruikname, bediening, onderhoud, technische specificaties) enzovoort.
  • Is de productveiligheid voldoende aan de orde gekomen? Zo is op consumentenproducten de richtlijn 2001/95/EG van toepassing. Deze richtlijn richt zich op een veilig gebruik van consumentenproducten. Een consumentenproduct kan niet alleen zelf gebrekkig zijn, ook de handleiding kan dat zijn! In geval van een gebrekkige handleiding geldt net zo goed de aansprakelijkheid van de producent!

Drie schrijfprincipes

Als plaatjes meer kunnen zeggen dan 1.000 woorden (en dus de voorkeur verdienen), zijn er dan vervolgens nog andere manieren om op de kosten van technisch schrijven te besparen? Ja, die zijn er. Zo zijn er drie schrijfprincipes waarmee elke technisch schrijver rekening dient te houden: minimalisme, Simplified Technical English en topic-based authoring.

Minimalisme
Minimalisme gaat uit van minimaal tekstgebruik. Schrijf dus alleen wat je van de gebruiker vraagt: als dat olie bijvullen is, vertel dan niet waarom dat zo belangrijk is. Vertel wel wat de interval moet zijn, want dat is wezenlijke informatie.

Simplified Technical English
Simplified Technical English (STE) is een eenvoudige vorm van Engels die leidt tot minder misverstanden. De zinnen in STE zijn korter dan in normaal Engels. Alleen het gebruik van eenvoudige woorden (‘to do’ in plaats van ‘to carry out’) is toegestaan.

Topic-based authoring
Een gouden vuistregel voor iedere technisch schrijver is ‘topic-based authoring’. Topic-based schrijven is schrijven in herbruikbare informatieblokken. Een blok met werkinstructies over het tweemaandelijks schoonmaken van een industriële stofzuiger, past zowel in de handleiding van stofzuiger A als stofzuiger B. Een technisch schrijver maakt informatie dus modulair. Op die manier wordt die informatie herbruikbaar. Als u een tabel met werkinstructies kunt gebruiken in zowel handleiding A als B, bespaart u fors op productiekosten. Maar dat niet alleen: u houdt uw informatie ook consistent.

Een handleiding laten maken door Manualise

Manualise is specialist in het schrijven en redigeren van teksten voor handleidingen. Gebruiksvriendelijke teksten voorzien wij van sprekende illustraties en vullen wij aan met alle wettelijke vereisten. Elke handleiding stemmen wij af op in uw huisstijl. Het resultaat: een volledige handleiding met alle relevante informatie voor uw eindgebruiker!

Onze referenties

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

“Ik ervaar de samenwerking met Manualise als nagenoeg perfect. Het contact is eerlijk en open. Gestelde deadlines worden altijd probleemloos gehaald.”

- Arjo van Geest , Big Green Egg Europe -


Wilt u ook uw handleiding door ons laten schrijven?

Vraag direct een offerte aan >

Heeft u een vraag over een van onze diensten?
Wij beantwoorden uw vragen graag persoonlijk.