Een gebruikershandleiding is een handleiding in papieren of elektronische vorm (PDF of XPS) die instructies geeft over een procedure of gebruik van iets. Hoewel "gebruikershandleidingen" vaak worden geassocieerd met handleidingen voor computertoepassingen, worden gebruikershandleidingen ook geleverd bij computers en andere elektronische apparaten zoals televisies, stereo's, telefoonsystemen, mp3-spelers en huishoudelijke en tuinapparatuur. Een goede gebruikershandleiding informeert gebruikers over productfuncties en leert hen hoe ze deze functies effectief kunnen gebruiken. De gebruikershandleiding is zo opgebouwd dat deze gemakkelijk te lezen en te raadplegen is. Hier zijn enkele stappen die u moet overwegen bij het ontwikkelen van effectieve inhoud en het ontwerpen van lay-outs voor gebruikershandleidingen.
Stap
Deel 1 van 3: Een geschikte gebruikershandleiding maken
Stap 1. Bepaal wie de gids gaat gebruiken
Om een goede gebruikershandleiding te schrijven, moet u een gebruikersprofiel ontwikkelen, hetzij formeel door een schriftelijk profiel op te stellen, hetzij informeel door de tijd te nemen om redelijke aannames te doen over gebruikerskenmerken. Dergelijke profielen zijn handig wanneer u deel uitmaakt van een schrijfteam voor gebruikershandleidingen en wanneer u van concept tot definitieve vorm aan het beoogde product werkt. Houd rekening met de volgende factoren bij het maken van een gebruikersprofiel:
- De locatie van de gebruiker zal de gids gebruiken, bijvoorbeeld thuis, op kantoor, op een externe werkplek of in de auto. Deze factor bepaalt niet alleen de inhoud, maar ook de schrijfstijl die de gids zal aannemen.
- Hoe de gebruiker de gids zal gebruiken. Als ze het zelden gebruiken of alleen nodig hebben om informatie te vinden, is het het beste als de gids wordt gemaakt in de vorm van een referentiedocument. Aan de andere kant, als de gebruiker het in het begin regelmatig zal gebruiken, moet het referentiegedeelte vergezeld gaan van een gedeelte "Aan de slag" en instructies over de meest voorkomende functies die het product zal uitvoeren.
- Hoeveel ervaring de gebruiker heeft met het product of soortgelijk artikel. Als het product nieuw is of heel anders is dan vergelijkbare producten, moet u uitleggen hoe het verschilt van andere producten en instructies voor het gebruik ervan. Als het product te maken heeft met iets dat gebruikers vaak moeilijk vinden, zoals een computertoepassing, moet u op een begrijpelijke manier de juiste informatie en details verstrekken.
Stap 2. Maak een handleiding die past bij de behoeften van de gebruiker op een manier die ze kunnen begrijpen
Als de gebruikers geen technisch onderlegde mensen zijn, is het waarschijnlijk het beste om zeer technische taal te vermijden en duidelijke en eenvoudige uitleg te geven. Tekst moet ook worden georganiseerd op een manier die lijkt op de manier waarop de gebruiker denkt. Het is vaak logischer om productfuncties op functie te groeperen dan op de meest gebruikte functies.
Soms is het gebruik van technische termen onvermijdelijk, bijvoorbeeld voor het in kaart brengen van toepassingen die Fibonacci-diagrammen bevatten, samen met cirkeldiagrammen en de meer gebruikelijke staafdiagrammen. In een dergelijk geval zou het beter zijn als u de termen definieert en informatie geeft, bijvoorbeeld een uitleg over wat de Fibonacci-grafiek is en hoe deze wordt gebruikt in financiële analyses
Stap 3. Beschrijf het probleem dat de gebruiker probeert op te lossen en geef vervolgens een oplossing voor dat probleem
Het aanbieden van functies als oplossing voor veelvoorkomende problemen is prima bij het adverteren voor een product, maar zodra een klant het product bezit, moet hij of zij begrijpen hoe het te gebruiken. Identificeer het probleem dat de gebruiker zal tegenkomen, beschrijf het in de gebruikershandleiding, gevolgd door instructies om het op te lossen.
Als het probleem complex is, verdeel het dan in kleinere stukjes. Schrijf elk onderdeel op met instructies over hoe je het kunt oplossen of ermee om kunt gaan, en volg elkaar dan op volgorde op. Het op deze manier opsplitsen van informatie staat bekend als de clustering- of splitsingsmethode
Deel 2 van 3: Onderdelen van de gebruikershandleiding
Stap 1. Maak een passende omslag- en titelpagina
U hebt een omslag nodig voor elke gebruikershandleiding die meer is dan een referentiekaart en een titelpagina voor een handleiding die meer bevat dan een gevouwen vel papier (4 pagina's of meer lang).
- Als de gids auteursrechtelijk beschermd is, moet de copyrightvermelding op de voor- en achterkaft worden vermeld, evenals op de titelpagina.
- Als er algemene voorwaarden zijn voor het gebruik van de gids en de bijbehorende producten, vermeld deze dan aan de binnenkant van de omslag.
Stap 2. Zet in de inleiding een verwijzing naar het betreffende document
Als er meer dan één gebruikershandleiding is, verwijs dan hier naar een ander document, inclusief het juiste versienummer. Het voorwoord is ook een plaats om de sectie "Hoe deze handleiding te gebruiken" te plaatsen, als die er is.
Stap 3. Voeg een inhoudsopgave toe als de gids langer is dan 10 pagina's
Stap 4. Plaats instructies/procedures en referentiemateriaal op de hoofdtekst van de handleiding
In de meeste gevallen moeten zowel de procedure als het referentiemateriaal elk een eigen sectie hebben. U kunt gebruikers echter vertellen om naar specifieke inhoud in één sectie te verwijzen en deze te onderscheiden van andere secties. Op deze manier kan de gebruiker snel de informatie vinden die hij zoekt.
- Procedures moeten in een consistente structuur worden geschreven door de instructies in de handleiding. Begin met een overzicht van de functionaliteit van het product, leg vervolgens uit wat de gebruiker moet doen en welke resultaten hij of zij krijgt of ziet. De stappen moeten worden genummerd en beginnen met een actiewerkwoord, net zoals de stappen in elke sectie van dit artikel zijn geschreven.
- Referentiemateriaal kan checklists, tips voor het oplossen van problemen en veelgestelde vragen bevatten. Een verklarende woordenlijst en index kunnen aan het einde van de gids worden toegevoegd, hoewel aan het begin een woordenlijst met veelgebruikte termen kan worden gegeven. De index kan worden weggelaten als de gids minder dan 20 pagina's heeft.
Stap 5. Gebruik zo nodig grafische afbeeldingen om tekst te ondersteunen
Grafische afbeeldingen of schermafbeeldingen kunnen bepaalde punten in een handleiding beter illustreren dan tekst, vooral in complexe procedures waarbij gebruikers visuele bevestiging nodig hebben om ervoor te zorgen dat ze de stappen correct volgen. Grafische tekeningen kunnen worden gemaakt met behulp van computer-aided drafting (CAD) of grafische bewerkingstoepassingen, digitale camera- en fotoverwerkingstoepassingen, of als u schermafbeeldingen wilt gebruiken, gebruik dan de schermafbeeldingsfuncties die in uw computer zijn ingebouwd of een grafisch programma met schermopnamemogelijkheden.
- Nadat u een grafische afbeelding hebt gemaakt, slaat u deze op in een gecomprimeerde indeling, zodat u deze kunt gebruiken in een tekstverwerkings- of desktoppublishingtoepassing. U moet ook de grootte van de afbeelding verkleinen om beter op de pagina te passen, maar de gebruiker toch volledige details geven. (Indien nodig kunt u de originele afbeelding in secties bijsnijden en de relevante secties samen met ondersteunende tekst weergeven).
- Als u meerdere grafische afbeeldingen in de procedure gebruikt, zorg er dan voor dat de afbeeldingen worden gemaakt met een consistente grootte, ofwel in dezelfde lengte- en breedteafmetingen of in verhouding tot de grootte van de originele afbeelding. Op die manier zal de afbeelding er aantrekkelijker uitzien voor gebruikers. Hetzelfde geldt voor het maken van schermafbeeldingen vanaf een computer; zorg ervoor dat de computer het standaardkleurenschema weergeeft bij het maken van foto's, anders geeft de wizard een kleurenscreenshot weer.
- Hoewel apps voor het bewerken van afbeeldingen zoals Photoshop en Paint Shop Pro goede mogelijkheden voor het vastleggen van afbeeldingen hebben, bieden programma's die speciaal zijn bedoeld voor het maken van schermafbeeldingen, zoals Snagit, ook de mogelijkheid om schermafbeeldingen eenvoudig aan te passen, te catalogiseren en te annoteren.
Deel 3 van 3: Een gebruiksvriendelijke gebruikershandleiding ontwerpen
Stap 1. Kies enkele gemakkelijk leesbare lettertypen
Hoewel een computer een aantal lettertypen kan ondersteunen, is het doel van het maken van een gebruikershandleiding gemakkelijk te lezen. Het selecteren van meerdere overeenkomende lettertypen is de beste manier om dat doel te bereiken. Lettertypen kunnen in twee typen worden gegroepeerd: schreef en schreefloos.
- Serif-lettertypen hebben kleine decoratieve lijnen aan de uiteinden van de hoofdlijnen waaruit de letters bestaan. De serif-lettertypen zijn onder andere Times New Roman, Baskerville en Book Antiqua. Serif-lettertypen zijn perfect voor de meeste tekst die wordt weergegeven in de maten 10-12 in het hoofdgedeelte voor afdrukhandleidingen.
- Sans serif-lettertypen bevatten alleen de lijnen waaruit de letters bestaan, zonder versieringen. Lettertypen die tot de schreefloze groep behoren, zijn Arial, Calibri en Century Gothic. Sans serif-lettertypen kunnen worden gebruikt voor de meeste tekstgroottes 8 tot 10 in PDF-bestanden of online handleidingen, hoewel ze zonder opsmuk ervoor zorgen dat zinnen die worden weergegeven in lettertypen 12 of groter moeilijker te lezen zijn. Lettertypen kunnen echter effectief worden gebruikt in grotere formaten om koppen en koppen weer te geven, en in kleinere formaten zijn ze perfect voor voetnoten en getallen in kolommen en tabellen.
- Over het algemeen is het het beste om een eenvoudig lettertype zoals Arial of Times New Roman voor je gids te kiezen, hoewel je een decoratief lettertype kunt gebruiken voor aanhalingstekens of titels als je een handleiding schrijft voor een videogame die zich afspeelt in een fantasie- of sciencefiction-omgeving. (In het geval van citaten kunt u vaak een eenvoudig lettertype gebruiken en het volledige citaat cursief weergeven).
- Nadat u hebt besloten welke lettertypen u wilt gebruiken, maakt u voorbeeldpagina's om te controleren of ze er op papier goed uitzien. U moet deze voorbeeldpagina ook laten zien aan de persoon die verantwoordelijk is voor het verlenen van goedkeuring voor de weergave van de handleiding voordat u verder gaat met het schrijfproces.
Stap 2. Denk na over de lay-out
Nadat u een lettertype voor de handleiding heeft geselecteerd, moet u beslissen hoe u de inhoud bovenaan de pagina wilt structureren.
- Over het algemeen moet u de documenttitel of hoofdstuktitel waarschijnlijk in de kop- of voettekst plaatsen, misschien met behulp van de gidskoppen aan de linkerkant van de pagina en de hoofdstukkoppen aan de rechterkant van de pagina. U moet het paginanummer in de koptekst of voettekst plaatsen, ofwel buiten (koptekst of voettekst) of gecentreerd (alleen in voettekst). Mogelijk moet u ook de eerste pagina van elke sectie of hoofdstuk onderscheiden van andere pagina's door het paginanummer in het midden van de voettekst te plaatsen en de volgende pagina in de buitenste hoek van de koptekst.
- Mogelijk moet u de invoegtekst in een gekleurd vak of een blokvak plaatsen om het te onderscheiden van de rest van de tekst. Zorg ervoor dat u een kleur- of blokkeringsniveau kiest, zodat de tekst niet moeilijk leesbaar wordt.
- Laat aan alle kanten een vrij brede marge, met extra ruimte aan de te binden randen.
Stap 3. Overweeg het type volume voor de gebruikershandleiding
Als de gids langer is dan 4 pagina's, moeten de pagina's op een bepaalde manier worden ingebonden. Hoewel interne documenten kunnen worden geniet met een nietmachine in de hoek van de pagina, wordt de externe gebruikershandleiding die bij het product is geleverd gewoonlijk geniet op een van de volgende drie manieren:
- De zijnietmethode (met een nietmachine aan de zijkanten van de pagina geklemd) voor hulplijnen afgedrukt op gevouwen papier van 21 x 27,5 cm, 21 x 35 cm of 27,5 x 42,5 cm. De meeste goedkope gidsen van 48 pagina's of minder zijn op deze manier gebonden.
- De zadelsteekmethode (aan de zijkant van de pagina genaaid) wordt vaker gebruikt voor naslaggidsen van derden dan gidsen die bij andere producten dan auto's worden geleverd, hoewel sommige langere gidsen op deze manier zijn gebonden. (De Paint Shop Pro Guide bevatte oorspronkelijk een zadelsteekgids, maar wordt nog steeds geproduceerd door JASC Software).
- Spiraalbinding is het meest geschikt voor geleiders die worden gebruikt in ruwere omgevingen, zoals buitenshuis (in dat geval zijn de methoden voor zijnieten en rugnieten niet sterk genoeg om pagina's te laten wegglijden). Sommige spiraalgebonden handleidingen kunnen ook pagina's hebben die zijn gelamineerd met plastic om te voorkomen dat ze beschadigd raken als ze nat zijn of worden blootgesteld aan modder.
Stap 4. Maak een sjabloondocument ter begeleiding
Veel tekstverwerkings- en desktoppublishingtoepassingen bieden de mogelijkheid om sjabloondocumenten voor gebruikershandleidingen te maken. Dus terwijl u typt, verschijnt de tekst automatisch met het lettertype dat u hebt geselecteerd voor het deel van de wizard waaraan u werkt. (Eigenlijk is dit artikel oorspronkelijk geschreven met een Microsoft Word-sjabloon). De meeste van deze programma's bevatten ook een standaardset met sjablonen die u naar behoefte kunt aanpassen, zodat u er niet zelf een hoeft te maken.
