25 | 06 | 2015 | door: Erik van der Spek

Handleiding schrijven

Moet u als softwareontwikkelaar, consultant of technicus wel eens zelf een handleiding schrijven bij uw product en weet u niet hoe dit aan te pakken? Hieronder helpen wij u een eindje op weg met tien tips om betere en gebruiksvriendelijkere handleidingen te schrijven.

Tip 1: Bepaal uw doelgroepHandleidingen schrijven
Het is belangrijk dat u weet voor wie u de handleiding schrijft. Maakt u een handleiding bij een programma voor de afhandeling van effectenverkeer voor ervaren, hoog opgeleide bankmedewerkers? Dan hoeft u niet uitgebreid uit te leggen wat bijvoorbeeld derivaten zijn. Is het programma bedoeld voor particuliere beleggers? Dan kan die uitleg weer wel zinvol zijn.

Tip 2: Schrijf actief
Schrijf de instructies in de gebiedende wijs. De lijdende vorm kan leiden tot onduidelijkheid. Als u schrijft: ‘De veiligheidspal wordt hierna gesloten door de zwarte schuif krachtig naar links te bewegen.’ weet de lezer niet of hij die pal zelf moet sluiten of dat het apparaat dit doet. Schrijft u echter ‘Ten slotte sluit u de veiligheidspal. Beweeg de zwarte schuif hiervoor krachtig naar links.’, dan is het meteen duidelijk dat de lezer deze handelingen zelf moet verrichten.

Tip 3: Onderscheid informatiesoorten
Belangrijk is het onderscheid tussen conceptuele en instructieve informatie:

  • Conceptuele informatie legt iets uit, bijvoorbeeld uit welke modulen het boekhoudpakket bestaat of hoe een machine in grote lijnen is opgebouwd.
  • Instructieve informatie legt uit hoe de lezer bepaalde taken kan uitvoeren.

U kunt handelingen die de gebruiker moet uitvoeren opknippen in verschillende stappen en deze stappen nummeren. De nummering laat dan niet alleen zien dat het hier om instructieve, taakgerichte informatie gaat, maar geeft ook aan dat er een noodzakelijke volgorde is in de stappen.

Tip 4: Overweeg een digitale handleiding
Een digitale handleiding biedt belangrijke voordelen. Om te beginnen zijn digitale handleidingen makkelijker doorzoekbaar. Ook is een digitale handleiding goedkoper te maken en sneller te distribueren. Bovendien is een digitale handleiding gemakkelijker te updaten.

Tip 5: Houd het beknopt
Wat voor schrijven in het algemeen geldt – houd het zo kort mogelijk – geldt zeker voor handleidingen: hoe minder overbodige informatie erin staat, hoe beter het is. Bij beknopt schrijven gaat het natuurlijk niet alleen om informatie die je kunt schrappen, maar zeker ook om de zaken zo kernachtig mogelijk uit te leggen.

Tip 6: Gebruik illustraties
Voor sommige onderwerpen geldt dat ze zonder illustraties vrijwel niet zijn uit te leggen. Documentatie bij machines en apparaten moet rijkelijk zijn voorzien van ‘exploded views’, foto’s en andere illustraties. Maar ook voor softwarehandleidingen geldt dat een uitvoerig gebruik van illustraties – en dan vooral schermafdrukken – is aan te bevelen.

Tip 7: Zorg voor een goede navigatie
De doorsnee handleidingengebruiker is, helaas, erg ongeduldig en aan u de schone taak om dat ongeduld niet te lang op de proef te stellen. U moet dus zorgen voor een goede navigatie binnen de handleiding. Daarvoor zijn een aantal middelen:

  • Zorg ervoor dat de hoofdindeling van uw handleiding logisch en goed doordacht is. Zo zal informatie die bij elkaar hoort, ook bij elkaar komen te staan.
  • Gebruik kopjes en tussenkopjes met juist gekozen titels. In feite is een kopje een zeer bondige samenvatting van de tekst die erna komt en kan de lezer hierdoor met één oogopslag zien of de pagina voor hem relevant is.

Tip 8: Index: maak uw handleiding toegankelijk
Of u uw handleiding nu op papier aanbiedt of digitaal: een uitgebreide index of trefwoordenregister is een noodzaak. Tenminste, als de handleiding omvangrijker is dan een pagina of twintig. Het is de kunst hierbij niet alleen de zoektermen zelf op te nemen, maar ook zoveel mogelijk synoniemen.

Tip 9: Laat uw handleiding beoordelen
Schrijvers doen er goed aan hun handleidingen af en toe door een ander laten lezen en dan het liefst door een eindgebruiker. De handleidingenschrijver moet steeds opnieuw proberen zich te verplaatsen in de gedachtewereld van de uiteindelijke gebruiker. En dat valt lang niet altijd mee!

Tip 10: Raadpleeg een specialist
Tot slot: het schrijven van handleidingen is een vak apart. Technisch schrijvers hebben zich er helemaal op toegelegd. Het kan zeker geen kwaad eens te rade te gaan bij een technisch schrijver met uw vragen op het gebied van handleidingen. Bij Hendrikx Van der Spek zijn verschillende technisch schrijvers werkzaam.

Meer informatie
Wilt u meer weten over handleidingen schrijven? Neemt u dan gerust contact met ons op voor advies op maat. Dat kan telefonisch via 035 – 623 77 85 en per mail via info@hvds.nl. Ook bieden we trainingen aan in het ontwerpen en schrijven van gebruikersdocumentatie.

Wij schreven onder andere al handleidingen voor het GVB en Pi Development. Neem eens een kijkje op onze projectpagina om hun verhaal te lezen en dat van andere bedrijven waarvoor wij handleidingen schreven.

25 | 06 | 2015 | door: Erik van der Spek

Handleiding: doelgroep bepalen

Voordat u een handleiding gaat schrijven, is het verstandig om te weten voor wie u schrijft. Een handleiding voor scholieren is anders van toon dan een handleiding voor senioren. Hoe leert u nu uw doelgroep kennen en wat zijn de consequenties voor de inhoud, stijl en opbouw van de tekst? Een doelgroepanalyse kan verheldering bieden.

Belangrijke doelgroepkenmerkenMonteur bekijkt werkbeschrijving
Het is belangrijk de volgende kenmerken van de doelgroep achterhalen:

  • Leeftijd (Kan ik de lezer met je/jij aanspreken?)
  • Opleidingsniveau (Beperk ik me alleen tot instructies of schets ik ook achtergronden?)
  • Ervaring (Moet ik eerst uitleggen wat een bepaalde term betekent?)
  • Voorkennis over de materialen die ze gaan gebruiken (Kan ik eventueel verwijzen naar een voorgaande versie of vergelijkbare materialen?)
  • Reden waarom de doelgroep de gebruikersdocumentatie zou raadplegen (Kan ik volstaan met alleen taakgerichte instructies; hoeveel ruimte moet ik reserveren voor een ‘problemen & oplossingen’-sectie?)

Handleiding opzetten
Met de verzamelde doelgroepgegevens gaat u de handleiding opzetten. Stel dat u een handleiding voor software moet schrijven waarbij u twee doelgroepen hebt: scholieren en senioren. Kies in dit geval voor twee aparte handleidingen omdat de doelgroepen te ver uit elkaar liggen. Met de kenmerken en de vaste eisen voor een handleiding komt u al een heel eind.

Kenmerken van scholieren:

  • Zijn opgegroeid met computers, kennen de conventies, zijn niet bang om iets fout te doen
  • Laten de handleiding liefst liggen, proberen zelf

Kenmerken van senioren:

  • Werken met computers is relatief nieuw, vinden ’t eng
  • Willen alles wat ze moeten doen, beschreven zien staan

Handleiding voor scholieren:

  • Gebruik ‘je’ en ‘jij’.
  • Ze hebben geen informatie nodig over algemeen computergebruik.
  • Geef geen achtergrondinformatie, maar houd het to-the-point.
  • Geef handreikingen, maar kauw niet alles voor; geef de ruimte om te experimenteren.
  • Gebruik afbeeldingen (of cartoons?) om de handleiding visueel interessant te maken.
  • Geef aan wat mis kan gaan en bied oplossingen.

Handleiding voor senioren:

  • Gebruik ‘u’ en ‘uw’.
  • Geef informatie over algemeen computergebruik, ouderen weten dat vaak nog niet.
  • Geef achtergrondinformatie (o.a. metaforen gebruiken om werking van programma toe te lichten).
  • Beschrijf elke handeling alles stap-voor-stap (zowel instructie als resultaat), zodat ze een gevoel van herkenning houden.
  • Gebruik afbeeldingen en schema’s voor herkenning. Zo kunnen ze zien of ze de juiste handelingen doen.
  • Wees spaarzaam met waarschuwingen om te voorkomen dat ze onzeker worden.

Meer informatie
Wilt u meer weten over handleidingen schrijven? Bekijk dan de informatiepagina. Of neem direct contact met ons op voor advies op maat.

14 | 05 | 2015 | door: admin

Handleiding – index maken

Eigenlijk geldt het voor alle grotere documenten, maar zeker voor handleidingen: een goede index erbij is absolute noodzaak. Belangrijke voorwaarde is echter wel dat de index met zorg is samengesteld. Wij geven u een aantal tips om een goede index te maken, waarbij de eerste twee het belangrijkst
zijn.

Tip 1: Verwijs duidelijk

Verwijs alleen naar plaatsen waar het betreffende onderwerp ook echt wordt besproken en dus niet naar pagina’s waar het slechts zijdelings aan de orde komt.

Tip 2: Gebruik synoniemenIndex maken bij handleiding
Gebruik, waar mogelijk, meerdere ingangen (synoniemen) om naar één onderwerp te verwijzen. Zo zou bijvoorbeeld het maken van reservekopieën in de index te vinden moeten zijn onder: ‘Reservekopie’, ‘Back-up’ en ‘Veiligstellen gegevens’.

Tip 3: Wees consequent

Wees consequent in het gebruik van zoektermen: dus niet ‘Seinnummer’ naast ‘Seinnummers’. Wees ook consequent met het gebruik van hoofdletters: trefwoorden beginnen óf met een hoofdletter óf met een kleine letter, maar niet allebei.

Tip 4: Werk met subniveau’s

Gebruik bij uitgebreide indexen hoofd- én subniveau’s.

Tip 5: Laat de index nakijken

Wat ook voor de tekst zelf geldt: het is een goede gewoonte de index te testen. Laat een of meer proeflezers een aantal zaken via de index opzoeken en noteer eventuele problemen.

Meer informatie

Wilt u meer weten over handleidingen schrijven? Bekijk dan de informatiepagina. Of neem direct contact met ons op voor advies op maat.

Contact? Bel 035 - 623 77 85 of mail info@hvds.nl