Software handleiding maken?


Een software handleiding maken?

Een software handleiding is bedoeld om informatie van een softwareproduct naar de gebruiker ervan over te brengen. Onder software verstaan we zowel software pakketten als software op apparaten, zoals smartphones, slimme thermostaten en meta producten. Een software handleiding heeft als doel de gebruiker taken te laten uitvoeren en eventuele fouten helpen op te lossen.

Vraag direct een offerte aan >

Een software handleiding maken in 17 stappen

Een software handleiding maken vraagt om een andere aanpak dan het maken van een handleiding voor een fysiek product. Een goede kennis van de verschillen draagt bij aan de kwaliteit van de handleiding. De onderstaande opsomming beschrijft beknopt de belangrijkste eigenschappen van een software handleiding.


																														

17 aandachtspunten bij een handleiding voor software

1.  Focus op relevante informatie

Gebruikers moeten zich niet door eindeloze  hoeveelheden papier met ‘slechts informatie’ hoeven te werken. Daarom is het zaak slechts het absolute minimum van ‘moeten weten’ informatie te vermelden. Alle ‘leuk om te weten’ informatie dient uit de manual te worden gelaten om de aandacht te behouden bij het leren van de betreffende vaardigheid. (Minimalisme principe no. 1a)

2.  Focus op actie

Het is belangrijk om een handleiding te ontwerpen waarmee de gebruikers direct de kans wordt verschaft om de kunnen handelen. Dit betekent minder conceptuele informatie geven en een grotere focus op het laten oefenen van de gebruiker met basis procedures. Mensen willen iets met een product doen en niet erover lezen. Een van de grootste uitdagingen is een goede balans te vinden tussen het ondersteunen van de acties van de gebruiker en het geven van conceptuele informatie. (Minimalisme principe no. 1b)

3.  Stimuleer ontdekking

Gebruikers dienen regelmatig te worden uitgenodigd om andere opties van het programma te ontdekken. Probeer ontdekking en innovatie aan te moedigen en te ondersteunen. Dergelijke uitnodigingen jegens de gebruiker hebben vaak een vorm als ‘Please try it’, ‘Try and see for yourself’ en ‘See what happens’ (in tegenstelling uitnodigingen als ‘You can also …’ en ‘Another possibility is …’). Dergelijke formuleringen leiden tot 33% meer verkenningen. Geef de uitnodiging om de boel te verkennen aan het einde van een hoofdstuk of sectie. De optimale balans tussen het geven van een instructie en het aanmoedigen van verkenning varieert aanzienlijk per project. Zorg er echter te alle tijden voor dat de verkenning door de gebruiker een redelijke slagingskans heeft en redelijk veilig is. De gebruiker dient eenvoudig weer naar het vertrekpunt terug te kunnen keren.  (Minimalisme principe no. 1c)

4.  Geef conceptuele informatie

Geef conceptuele informatie op het moment dat de gebruiker hier het meest open voor staat. Gebruikers van software zijn meer geïnteresseerd in het lezen van conceptuele informatie nadat ze dingen hebben uitgeprobeerd. (Minimalisme principe no. 1d)

5.  Respecteer de integriteit van de gebruiker

Het doel van een gebruiker is vaak een korter termijn doel en minder geraffineerd dan dat van de ontwerper. Zorg er als ontwerper voor dat je niet teveel de dingen oplegt waarvan jij denkt dat het (ook) belangrijk is voor de gebruiker om te weten. Een voorbeeld hiervan is een passieve helpfunctie, welke door de gebruiker ingeschakeld kan worden om het moment dat deze denkt dit nodig te hebben. (Minimalisme principe no. 1e)

6.  Richt op taken

Ontwerp instructies als echte taken. De gebruiker streeft het liefst doelen en activiteiten na die worden herkend als zijnde ‘echt’. Dit kan bijvoorbeeld zijn How to customize my Telephone of taken bij Word processors zoals  How to Print of How to Save a Document. (Minimalisme principe no. 2a)

7.  Besteed extra aandacht aan de headings

De opbouw van de handleiding dient de structuur van de taak te reflecteren (Minimalisme principe no. 2b). De headings dienen duidelijk te maken welke informatie  op de betreffende pagina gevonden kan worden. De gebruiker dient bij het lezen van de heading te weten waarom hij tijd gaat investeren om dit te lezen. Werk topic-based. Ieder hoofdstuk of sectie dient een antwoord op slechts één vraag te geven.

Het gebruiken van headings als Saving your Work en Printing your Document is beter dan een headings als Tips for Use of Microsoft Word. Evenzo is de heading Check The Time Around The World beter dan World Clock View. Probeer in de headings ook altijd naar het onderwerp te refereren. Zie hiervoor het onderstaande voorbeeld.

8.  Reduceer de kans op fouten

Zorg dat de kans dat er fouten worden gemaakt zo klein mogelijk is (Minimalisme principe no. 3a). Gebruikers maken veel fouten en zijn vaak 25-50% van de tijd bezig met het herstellen van hun fouten. De beste manier om fouten te voorkomen is door de software zelf door en door te testen. Daarnaast kan overwogen worden om een trainingsmodus in te stellen waarbij bepaalde functies niet gebruikt kunnen worden tijdens de trainingsperiode. In de handleiding kunnen de basisregels richtlijnen voor het schrijven van goede teksten worden toegepast, zoals:

  • Het geven van veilige activiteiten
  • Het gebruik van korte en simpele zinnen
  • Gebruik van actieve en sterke werkwoorden
  • Het geven van signaal-actie informative
  • Minimaliseren van jargon (zie punt 15 voor een nuance hierin)
  • Het geven van hints

9.  Doe gebruikerstests

De ontwerper dient de tijd te nemen om de software handleiding te testen met gebruikers. Aan de hand hiervan kan de handleiding worden verbeterd en/ of kan er informatie worden gegeven. Geef informatie wanneer een uit te voeren actie conflicteert met de real-world ervaring van de gebruiker of wanneer  correctie van de actie moeilijk is. (Minimalisme principe no. 3b)

10.  Los fouten op

Gebruik een stapsgewijs model om problemen/ fouten op te lossen. De stappen in dit model zijn:

  • Detecteren van de fout;
  • Vaststellen van de fout;
  • Herstellen van de fout.

Detecteren en herstellen zijn altijd nodig. Vaststelling is niet altijd nodig om de fout ook daadwerkelijk op te lossen. Informatie over fouten is vaak waardevolle conceptuele informatie. (Minimalisme principe no. 3c).

11.  Wees kort en bondig

Gebruikers gaan niet systematisch door een handleiding heen. Meestal lezen ze om iets te doen, maar soms ook om de studeren of gericht informatie op te zoeken. Door kort en bondig te zijn en niet alle informatie te geven die er is worden alle leesstrategieën ondersteund. Korte zinnen, taken, topics, hoofdstukken etc. geven de gebruiker het idee dat niet heel veel inspanning kost om tot het gewenste resultaat te komen. Door niet alle informatie te geven wordt de gebruiker gestimuleerd om zelf op onderzoek uit te gaan en zelf na te denken. Laat ook alle informatie die de gebruiker zou kunnen afleiden weg. Manualise tip: verschaf informatie over hoe lang het duurt een taak te volbrengen. Vuistregel is dat dit sowieso niet langer dan 20 minuten zou mogen zijn. (Minimalisme principe no. 4a)

12.  Sluit een hoofdstuk af

Een afgesloten hoofdstuk, oftewel  een modulair hoofdstuk, zorgt ervoor dat de gebruiker slechts die hoofdstukke hoeft te raadplegen waar zijn interesse naar uit gaat. Echter, volledige modulariteit is niet altijd mogelijk. (Minimalisme principe no. 4b)

13.  Kies de juiste presentatievorm

Besteed aandacht aan de presentatie. Voorkom dat een handleiding een telefoonboek wordt. Leg gebruikers de interface uit (vergelijkbaar dit met een quick start). Gebruik voldoende witruimte in de kantlijn, tussen de regels en rondom afbeeldingen. Dit verbetert de leesprestaties en begrijpelijkheid van een tekst. Besteed aandacht aan het font. Overweeg om voor online publicatie een schreefloos lettertype te kiezen en voor publicatie op papier een letter met schreef.

14.  Zorg voor consistente informatie

Zorg dat de inhoudsopgave en de productinterface een complementaire informatie architectuur hebben. De handleiding structureert informatie thematisch, terwijl de interface dit visueel doet. Wanneer de thematische structuur niet consistent is met de visuele structuur kan dit gebruikers in de war brengen. Kijk voor een voorbeeld op UX Magazine.

15.  Vermijd (deels) jargon

Vermijd jargon, maar doe dit genuanceerd. Vaak wordt er voor gekozen om simpele zinnen te schrijven en jargon en technische termen te vermijden. Meestal bevat de interface echter al terminologie. Om consistent te blijven kan de gebruikte terminologie het beste in een verklarende woordenlijst van de handleiding worden uitgelegd.

16.  Let op de volgorde van handelingen

Besteed aandacht aan de volgorde van handelingen. Een gebruiker wil dat hij moet handelen in de volgorde zoals hij leest. Gebruik bijvoorbeeld “Ga naar file en dan naar print” in plaats van “Druk op print in het file menu”.

17.  Gebruik bouwstenen

Overweeg het gebruik van bouwstenen voor verschillende informatievormen per topic. Ook kan er worden gekozen om min of meer standaard de volgende blokken te gebruiken:

  • Geven van hints
  • Uitleg gebruik van de software/ verschaffen van de taak
  • Herkennen en herstellen van fouten
  • Het geven van conceptuele informatie

Bouwstenen zorgen voor een herkenning en consistentie.

Werkwijze om een software handleiding te maken

Welke vorm de software handleiding ook heeft, bij het maken van de handleiding doorlopen wij altijd de volgende stappen:

Stap 1
Inhoud bepalen

De totale software informatie wordt in kaart gebracht. Teksten worden geschreven en de ondersteunende screendumps worden gemaakt.

Stap 2
Vorm en stijl vastleggen

We bepalen hoe de software informatie het beste gestructureerd en georganiseerd kan worden. De visuele stijl wordt vastgelegd.

Stap 3
Handleiding samenstellen

Nu de vorm en inhoud zijn vastgelegd gaan we de daadwerkelijke handleiding maken door vorm en inhoud samen te voegen.

Onze referenties

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

 

“Manualise is een frisse en professionele club. We doen steeds meer dingen samen en ik zie ze als een fijne samenwerkingspartner.”

- Teun Willems , CAD2M -


Wilt u ook uw software handleiding door ons laten maken?

Vraag direct een offerte aan >

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