Acht redenen om een Quick reference guide te maken

quick ref guide

Weer eens een handleiding van honderden pagina’s over de schutting gemikt? Alles tot in detail beschreven, niets overgeslagen, maar niemand echt enthousiast over je werk? Probeer dan eens een quick reference guide (QRG), een handig document waarin de belangrijkste functionaliteit van je applicatie, machine of product wordt beschreven. Sommige zijn niet meer dan enkele pagina’s en als je het tot èèn pagina weet te beperken heb je een topprestatie geleverd.

In dit blog wanneer je een QRG kunt gebruiken.

Wanneer gebruiken

Niet elke applicatie of elk product is geschikt om een QRG voor te schrijven. Bij het beschrijven van een grote machine heeft het geen zin. Ook installaties met een uitgebreid stappenplan raak je niet kwijt in een QRG.
Denk bij de keuze voor een QRG aan de volgende criteria:

Beperkte functionaliteit

Hoe bedien ik mijn bureaustoel? Een paar handels en knoppen, intuïtief te gebruiken. Dat hoopt de producent. Bespaar je de moeite van een handleiding, schrijf een QRG.

Chair QRF

Eenmalige set-up

Nieuwe software installeren? Een product dat na een eenmalige set-up werkt, kan zonder een handleiding. Lever wel een troubleshooting documentje mee. Minder is meer, een QRG geeft toegevoegde waarde. Setup Remote Access Windows 10 is een voorbeeld.

Verschillende soorten gebruikers

Het probleem bij een handleiding is de doelgroep. Als je weet dat er verschillende rollen zijn, kun je dit probleem oplossen met een aantal QRG’s. Over het algemeen heb je dan een applicatie met uitgebreide functionaliteit beschreven. De QRG’s zijn een extraatje waar de klant blij mee zal zijn. Bij een machine zou je dus een QRG kunnen maken voor een operator die een eenvoudig software panel bedient.

user groups

 

Veelgebruikte functionaliteit

U kent ze wel, die uitgebreide handleidingen bij een apparaat, terwijl je informatie zoekt over een paar simpele acties. Waar zit nou toch die aan-uit knop! Deze repetitieve acties kun je uitstekend in een QRG kwijt. Van de functionaliteit van een apparaat wordt meer dan 50% meestal niet eens gebruikt. Je kunt zo’n QRG ook gebruiken voor API-documentatie om bepaalde functionaliteit extra onder de aandacht te brengen.

QRF functionality

Nieuwe versie

Bij een nieuwe versie horen release notes. Daarin wordt ook de toegevoegde functionaliteit beschreven. Waarom die niet in een gelikte QRG zetten?! De jongens en meisjes van marketing zullen er blij mee zijn. Zo deed Siemens een QRG bij zijn Phonemail 6.4 Release.

Eenvoudige instructie

Doe dit, doe dat, doe zus, doe zo. Een enkelvoudige pagina met instructies zegt meer dan duizend woorden.

cardiac QRF.png

Druk, druk, druk

U kent ze wel, de gebruikers die geen tijd hebben om dikke handleidingen te lezen. De managers met je hun overvolle agenda’s en de ontwikkelaars met hun deadline. Doe hen een plezier. Neem de essentie van je applicatie of product en beschrijf die in een QRF.  De dikke handleiding dient in zo’n geval als naslagwerk.

druk druk druk.jpg

Een dikke handleiding

Dikke handleidingen leest eigenlijk niemand.

dikke handleiding.jpg

Bedankt voor de moeite, maar wat is de belangrijkste functionaliteit voor de gebruiker? Maak daar een QRG van en vul die aan met oplossingen voor problemen met bepaalde functionaliteit, die de helpdesk meldt. Maak per kwartaal een nieuwe versie beschikbaar en werk zo aan een betere klantondersteuning.

QRF helpdesk

 

 

Een gedachte over “Acht redenen om een Quick reference guide te maken

Voeg uw reactie toe

Geef een reactie

Vul je gegevens in of klik op een icoon om in te loggen.

WordPress.com logo

Je reageert onder je WordPress.com account. Log uit /  Bijwerken )

Google photo

Je reageert onder je Google account. Log uit /  Bijwerken )

Twitter-afbeelding

Je reageert onder je Twitter account. Log uit /  Bijwerken )

Facebook foto

Je reageert onder je Facebook account. Log uit /  Bijwerken )

Verbinden met %s

Blog op WordPress.com.

Omhoog ↑

%d bloggers liken dit: