Stappenplan voor het maken van een handleiding

RTFM: Read the friendly manual! Een bekende opmerking door beheerders uitgesproken of gedacht, wanneer weer een gebruiker is geholpen met een vraag of probleem wat geen probleem was. Voor beide partijen een vervelende ervaring. De gebruiker denkt last te hebben van een fout, ervaart beperkingen in de werkzaamheden en heeft een negatieve ervaring met de applicatie. De beheerder baalt dat het tijd heeft gekost om het ogenschijnlijke probleem op te lossen en had liever die tijd besteedt aan een verbetering.

Wat ons betreft moet dit beter. Door gebruik te maken van een handleiding kan de eindgebruiker zonder verstoringen doorwerken. En heeft de beheerder tijd om te werken aan de toekomst van de applicatie. In deze blog nemen we jou mee langs enkele onderwerpen die wij op basis van onze kennis en ervaring belangrijk achten voor het gebruik van een handleiding.

In algemene zin is een handleiding bedoeld voor de gebruiker. De inhoud is gericht op het in elkaar zetten, installeren, gebruiken, repareren, storingen oplossen en onderhouden van producten. Het is een digitale of schriftelijke instructie waarin beschreven staat hoe men een product of dienst gebruikt.

In deze blog gebruiken we het woord handleiding als aanduiding voor documentatie waar de gebruiker (beheerder of de eindgebruiker) correcte en actuele informatie vindt over de applicatie. Daarbij zien wij bij applicaties vooral aandacht voor installeren, gebruiken, veelvoorkomende vragen en oplossen van storingen.

Volgens ons heeft een handleiding zeker toegevoegde waarde. Het draagt bij aan:

• De gebruiker op een gestructureerde en actuele manier ondersteuning geven bij het gebruik van de applicatie.
• De eerste of veel voorkomende vragen van een gebruiker beantwoorden om hiermee de gebruiker te faciliteren zelfstandig tot een oplossing te komen.
• Doordat de gebruiker zelf de vragen of problemen oplost heeft de beheerder meer tijd voor het verbeteren van de applicatie.
• Kennisoverdracht van de applicatie binnen en buiten de organisatie.
• Het inwerken van nieuwe collega’s.

Aan de hand van onderstaande onderwerpen introduceert Qquest een leidraad voor het maken van een handleiding die waarde toevoegt aan de werkzaamheden in je team.

Voordat je begint met maken van een handleiding of updaten van een verouderde handleiding raden wij aan om te beginnen met antwoord geven op de volgende vragen:

• Wat is het doel van de handleiding die jij gaat maken?
• Waar moet het aan bijdragen?
• Welk probleem lost het gebruik van een handleiding op?

Om ervoor te zorgen dat de handleiding effectief is, moet je altijd het doel van de handleiding als uitgangspunt gebruiken. Is het bedoeld om antwoord te geven op de meest voorkomende vragen en fouten, dan gebruik je een handleiding met duidelijke structuur in de vragen en bijpassende antwoorden. Is het doel om zo gedetailleerd mogelijk een proces van werkzaamheden uit te leggen, kies dan een uitgebreide handleiding met veel afbeeldingen.

Met het doel van de handleiding uitgewerkt is de volgende stap het formuleren van de doelgroep aan de hand van de volgende vragen:

• Wie is de gebruiker of de gebruikersgroep?
• Wie gaat de handleiding lezen?
• Hoe gaat de doelgroep de handleiding gebruiken?
• Welk detailniveau van informatie komt er in de handleiding?

Bij het schrijven van de handleiding is het belangrijk om te weten wie de handleiding gaat gebruiken. Probeer je in te leven in de lezer. Denk hier bijvoorbeeld aan het opleidingsniveau, ervaring, gesproken taal en leeftijd.

Afhankelijk van de doelgroep hanteer je een ander taalgebruik. Voor branchegenoten gebruik je vaktermen, maar schrijf je het voor algemene gebruikers dan moet de handleiding zo simpel of gedetailleerd mogelijk.
Het is belangrijk om tijdens het schrijven continu de doelgroep in het achterhoofd te houden, zodat de informatie op een voor hun begrijpelijke manier overkomt.
Hanteer daarbij actief taalgebruik in de handleiding. Enkele tips om actief te schrijven:

• Voorkom de woorden “zal” en “zul”. Deze hulpwerkwoorden komen vaak voor. Uit de context blijkt al of iets in de toekomst plaatsvindt.
• Voorkom de woorden “kun” of “kan”. Als je terugleest dan merk je dat deze woorden in de meeste gevallen niets toevoegen.
• Voorkom de woorden “word” of zijn”. Deze hulpwerkwoorden staan in de lijdende vorm en maken de tekst vaak passief.

Enkele voorbeelden:
Passief: Alle gebruikers van de applicatie hebben een mail met de handleiding van ons gekregen.
Actief: Alle gebruikers van de applicatie kregen een mail met de handleiding van ons.

Passief: De gebruikers kunnen door de servicemedewerkers geholpen worden.
Actief: De servicemedewerkers helpen de gebruikers.

Passief: De beheerder kent de applicatie als geen ander en kan je helpen bij het oplossen, voorkomen en onderzoeken van problemen.
Actief: De beheerder kent de applicatie als geen ander en helpt je bij het oplossen, voorkomen en onderzoeken van problemen.

Wat voor schrijven in het algemeen geldt: houd het zo kort mogelijk. Dit geldt zeker voor handleidingen. Hoe minder overbodige informatie hierin staat, hoe beter het is. Bij beknopt schrijven gaat het natuurlijk niet alleen om informatie die je schrapt, maar zeker ook om zaken zo kernachtig mogelijk uit te leggen.

Een handleiding geef je op meerdere manieren vorm. Dit is opnieuw afhankelijk van het doel en de doelgroep. Een (Word-)document met daarin een stappenplan is een vaak gekozen oplossing. Maar wat dacht je van een FAQ of een infographic? Dit heeft als voordeel dat je de informatie snel en overzichtelijk opzoekt en niet hele documenten of boeken door hoeft te lezen. Dit kan de gebruiker ook paraat hebben voor een eerste geheugensteun.
Zorg voor een duidelijke hoofdstukindeling met heldere titels, zodat de gebruiker aan de hand van de titels al een beeld heeft in welk hoofdstuk de informatie staat. Het gebruik van een inhoudsopgave is noodzakelijk zodat een gebruiker meteen doorklikt naar het bedoelde hoofdstuk.

Verder is het belangrijk om visuele informatie in de handleiding te verwerken. Zeker als het om een visueel product gaat. Maak bijvoorbeeld een schematische weergave van alle knoppen op je product.
Ook hier geldt “een afbeelding zegt meer dan duizend woorden.” Het voorkomt een grote hoeveelheid aan tekst maar zorgt ook dat instructies duidelijker overkomen. Let op dat je de afbeeldingen in een handleiding ook bijwerkt als de applicatie veranderd.
Ga telkens na of een afbeelding mogelijk effectiever is dan het schrijven van een stuk tekst.

Als bijlage voeg je een woordenlijst toe met de juiste betekenis. De gebruiker kan de betekenis van een woord zo makkelijk terugvinden en het dwingt om deze woorden ook consequent te gebruiken in de handleiding. Naast de woorden neem je hier ook de afkortingen op.
Door de titels van de hoofdstukken goed te kiezen is het voor de lezer in één oogopslag duidelijk waar het betreffende hoofdstuk over gaat.
Tip: Met de optie Navigatiedeelvenster in Word geef je de inhoudsopgave weer aan de linkerkant van het document. Hiermee is altijd de inhoudsopgave zichtbaar en aanklikbaar terwijl de tekst gelezen wordt.

Met het doorlopen van de voorgaande stappen is de handleiding klaar om in gebruik te nemen. Informeer met regelmaat de gebruikers over de handleiding en waar de actuele versie is te vinden. Voeg de handleiding toe aan de overige documentatie van de applicatie zoals in OneDrive of SharePoint. Hierdoor maak je ook gebruik van versiebeheer op de handleiding. Zo is voor de gebruikers te zien welke versie actueel is.
Andere mogelijkheid is de handleiding onderdeel maken van de code-repository of minimaal zo dicht mogelijk bij de code. Hier kies je voor het uitwerken van de handleiding in platte tekst waarmee de handleiding als code is opgeslagen en meteen onderdeel is van de gehele repository.
Een infographic is geschikt om ook in fysieke vorm te overhandigen aan de gebruikers. Vaak staat dit op 1 A4 en door gebruikers toegepast als geheugensteun.

Als de handleiding klaar is, is het belangrijk om de handleiding met regelmaat bij te werken. Door veranderende systemen en verbeterde user interfaces raakt de handleiding gedateerd. De gebruiker heeft dan geen goede leidraad meer en gebruikt de handleiding minder. Neem het bijwerken van de handleiding op als onderdeel van de Definition of Done. Daarmee hecht je als team waarde aan het opleveren van nieuwe functionaliteit in de applicatie en de aanpassingen in de handleiding om de vernieuwing te beschrijven. Het resultaat bij oplevering van de sprint is nieuwe functies en een actuele handleiding.

Afhankelijk van de branche en de snelheid van veranderingen raden wij aan om de handleiding minimaal 1x per jaar te testen. Met het testen van de handleiding neem je de volgende stappen:

• Toepassen van de spellingchecker of editor functie in Word
• Gebruik Toegankelijkheid controleren in Word
• Zoek op de woorden genoemd bij het kopje “taalgebruik” en vervang ze door een alternatief.
• Kies een onderwerp in de handleiding en doorloop deze aan de hand van het elf gebruiken van de applicatie. Je controleert nu of de gegeven informatie nog juist is en de te nemen stappen nog kloppen.
• Controleer alle schermprints in de handleiding en of die nog overeenkomen met de applicatie.
• Nog andere stappen toe te voegen?

Binnen de IT volgen de veranderingen elkaar in rap tempo op met als gevolg dat applicaties eigenlijk continue in ontwikkeling zijn. De gebruiker wil zonder verstoringen gebruik maken van de applicatie en tevens profiteren van de actuele ontwikkelingen. Waarbij de beheerder regelmatig afwegingen moet maken tussen deze veranderingen en verstoringen.

Door gebruik te maken van een handleiding voor de applicatie geef je de gebruikers, met een kleine investering van tijd, de kans om hun vragen of problemen zelfstandig te verhelpen. Hiermee krijgen  beheerders de ruimte om  zich nog meer focussen op creëren van waarde voor de klant en zet de   organisatie weer een stap vooruit.