Een gebruikershandleiding maken

Een gebruikershandleiding is een geschreven document op papieren of elektronisch (PDF) formaat dat instructies geeft over hoe je een applicatie moet gebruiken. Een goede gebruikershandleiding informeert gebruikers over de functies van de software. Daarbij leggen we uit hoe ze deze functies effectief kunnen gebruiken. Handleidingen ontwerpen we zo dat men ze gemakkelijk zijn te doorzoeken en te lezen.

Voor wie is de gebruikershandleiding?

Bepaal wie je gebruiker is

Om een ​​goeie gebruikershandleiding te schrijven, moet je een profiel van de gebruiker maken en de tijd nemen om redelijke beeld te krijgen over de kenmerken van de gebruiker. Een dergelijk profiel is ook handig als je deel uitmaakt van een team dat de gebruikersdocumentatie schrijft. In het gebruikersprofiel komen de volgende zaken naar voren:

• De locatie waar gebruikers de gebruikershandleiding zullen gebruiken, thuis, op kantoor, op een externe werklocatie of in de auto. Dit bepaalt niet alleen de inhoud, maar ook de opzet van de gebruikershandleiding.
• Hoe gebruikers de gebruikershandleiding gaan gebruiken. Als men de handleiding slechts zelden zal raadplegen, moet deze de vorm krijgen van een naslagwerk. Als het een document is dat gebruikers in het begin vaak zullen raadplegen, moeten er een “Aan de slag” -sectie en instructies over de meest voorkomende taken in voor komen.
• Achtergronden van de gebruikers, zoals opleidingsniveau en skills.
• Hoeveel ervaring gebruikers hebben met de software hebben. Als de software nieuw is of aanzienlijk verschilt van andere producten, moet je uitleggen waar het verschilt en instructies geven over hoe je aan de slag kunt gaan. Als de software complex is moet je op begrijpelijke wijze de juiste informatie en details verstrekken.

Schrijf op een manier die alle gebruikers kunnen begrijpen

Tenzij de gebruiker een technische achtergrond heeft, is het waarschijnlijk het beste om technische taal te vermijden. Gebruik daarvoor in de plaats een duidelijke, eenvoudige uitleg. De gebruikershandleiding moeten we ook zo organiseren dat ze lijkt op de manier waarop gebruikers werken. Het vermelden van softwarefuncties gegroepeerd op taak heeft vaak meer zin dan een opsomming op alfabet.

• Soms is er geen alternatief voor het gebruik van technische termen. In zo’n geval is het nuttig om de term te definiëren en achtergrondinformatie te geven.
• Daarbij kan je gebruik maken de digitale IT consultant.

Detailleer het probleem

In de handleiding staat altijd de oplossing. Het aanbieden van software als oplossing voor een algemeen probleem werkt prima bij het op de markt brengen. Zodra de gebruiker de software heeft, moet hij of zij erachter komen hoe je de software moet gebruiken. Identificeer specifieke problemen waarmee de gebruiker te maken krijgt, vermeld deze in de gebruikershandleiding, gevolgd door instructies om ze op te lossen.

• Als het een ingewikkeld probleem is, knip het dan op in kleinere delen. Maak een lijst met instructies per deel.

Standaard opzet en indeling van de gebruikershandleiding

Omslag en titelpagina’s

Iedere gebruikershandleiding heeft een omslag die meer is dan een referentiekaart. Elke handleiding die meer is dan een gevouwen vel papier heeft een titelpagina.

• Als de handleiding auteursrechtelijk is beschermd, dan geven we zowel op het voorblad als op de titelpagina een auteursrechtvermelding weer.
• Als er gebruikersvoorwaarden zijn voor het gebruik van de software, plaatst je deze op de binnenzijde van de omslag.

Plaats verwijzingen naar gerelateerde documenten

Als de gebruikersdocumentatie meer documenten bevat dan de handleiding, verwijs dan in het voorwoord naar deze documenten met de juiste versienummers. Het voorwoord is ook de plaats voor een “Hoe gebruik je deze handleiding” sectie.

Voeg een inhoudsopgave toe als de gebruikershandleiding meer dan 10 pagina’s bevat

Zet instructies / procedures en referentiemateriaal in de hoofdtekst

In de meeste gevallen zouden procedures en referentiematerialen elk hun eigen secties krijgen. Daarbij kan je de gebruiker verwijzen naar specifieke inhoud in de andere secties. Op deze manier kan de gebruiker sneller de informatie vinden waarnaar hij of zij op zoek is.

• Procedures moeten in een consistente structuur worden opgenomen in het begin met een overzicht van de taak, beschrijf wat de gebruiker moet doen en welk resultaat hij of zij zou moeten zien. De stappen moeten we nummeren en beginnen met actiewerkwoorden.
• Referentiemateriaal bestaat uit lijsten met opties, tips voor probleemoplossing en veelgestelde vragen. Woordenlijsten en indexen kunnen we aan het einde van de handleiding toevoegen. De index kan worden weggelaten als de gebruikershandleiding minder dan 20 pagina’s telt.

Gebruik grafische afbeeldingen

Grafische afbeeldingen of schermafbeeldingen kunnen bepaalde punten in de handleiding beter illustreren dan tekst. Vooral bij complexe procedures waarbij gebruikers een visuele bevestiging nodig hebben om de stappen correct uit te voeren.

• Zodra je een grafische afbeelding hebt gemaakt, slaat je deze gecomprimeerde op. Zodoende kan je tekstverwerkingsprogramma het goed toevoegen. Let ook op de fysieke grootte van de afbeelding. Deze kan je verkleinen tot iets dat gemakkelijker op de pagina past en toch voldoende details voor de gebruiker oplevert.
• Als je meerdere grafische afbeeldingen gebruikt in een procedure, geef ze dan een consistente grootte. Dezelfde lengte en breedte en in dezelfde proportionele verkleining van hun oorspronkelijke grootte. Dit geeft een rustiger beeld voor de gebruiker. Zorg er bij het maken van schermafbeeldingen voor dat de computer een kleurenschema weergeeft dat hoort bij de gebruikershandleiding of de huisstijl.

Leesbaarheid van de gebruikershandleiding

Kies leesbare lettertypen

Het kiezen van slechts een klein aantal lettertypen die er goed uitzien, is de beste manier om een leesbare handleiding te krijgen. Lettertypen kunnen we onderverdelen in 2 typen: schreefloze en schreefloze lettertypen. Experimenteer eerst met een aantal lettertypes en groottes.

• Nadat je hebt besloten welke lettertypen je wil gebruiken, maakt je een voorbeeldpagina om te controleren of de lettertypen goed op papier passen. Je kunt dit voorbeeld laten zien aan iedereen die over het uiterlijk van de handleiding gaat voordat je doorgaat met het schrijven.

Denk goed na over de lay-out

Nadat je de lettertypen voor de gebruikershandleiding hebt gekozen, moet je beslissen hoe je de pagina’s indeelt.

• Meestal wil je de titel van de handleiding in de kop- of voettekst plaatsen, eventueel met hoofdtitel op de linkerpagina en de hoofdstuktitel op de rechterpagina. Je wil ook de paginanummers in de kop- of voettekst. Misschien wil je dat de eerste pagina van iedere sectie of hoofdstuk verschilt van de andere pagina’s.
• Misschien wil je tekst in gekleurde of gearceerde vakken zetten om deze van de rest te scheiden. Zorg ervoor dat de kleur of niveau van arcering niet te overheersend is.
• Zorg voor redelijk marges aan alle kanten, met extra ruimte aan de randen die aan elkaar worden verbonden.

Maak een sjabloondocument voor de gebruikershandleiding

Veel tekstverwerkingsprogramma’s bieden de mogelijkheid om een ​​sjabloondocument voor je gebruikershandleiding te maken. Zodoende wordt tijdens het typen de tekst automatisch het lettertype voor het gedeelte van de handleiding waaraan je werkt weergegeven. De meeste van deze programma’s bevatten ook een reeks vooraf gedefinieerde sjablonen die je kan aanpassen aan je eigen behoeften.

Beschikbaarheid van de gebruikershandleiding

Nog niet zolang geleden werden handleidingen uitgeprint en aan de medewerkers uitgereikt. SaaS, Het Papierloos Werken en Het Nieuwe Werken brachten daar verandering in. De Gebruikershandleiding is nu meestal een PDF bestand dat we kunnen downloaden. Het is beschikbaar op internet of in de portal van ons bedrijf.

Let daarom ook op de elektronische doorzoekbaarheid van de handleiding. Gebruik de juiste keywords en toon niet te veel tekst in één keer.

Discussieer mee op LinkedIn.