Pdf downloaden
Pdf downloaden
Gebruikershandleidingen zijn papieren of elektronisch documenten (pdf of XPS) met instructies om iets te doen of gebruiken. Hoewel er bij gebruikershandleidingen al snel gedacht wordt aan handleidingen voor software, worden ze ook heel vaak meegeleverd bij computers en andere elektronische apparaten zoals televisies, stereo-installaties, telefoonsystemen en MP3-spelers, evenals huishoudelijke apparaten en tuinspullen. Goede gebruikershandleidingen informeren gebruikers over de functies van een product en het effectief gebruiken van die functies, en zijn zo ingedeeld dat ze gemakkelijk te lezen zijn en kunnen worden geraadpleegd. Het volgende zijn een aantal dingen om te overwegen bij het maken van effectieve inhoud voor en het ontwerpen van de lay-out van een gebruikershandleiding.
Stappen
-
Definieer de gebruiker. Om een succesvolle gebruikershandleiding te kunnen schrijven, moet je een profiel ontwikkelen van je gebruiker, hetzij formeel door het creëren van een geschreven profiel of informeel, door de tijd te nemen voor redelijke aannames over de kenmerken van je gebruiker. Een dergelijk profiel is handig wanneer je deel uitmaakt van een team voor het schrijven van de gebruikersdocumentatie, en het kan ook nuttig zijn bij het ontwikkelen van het product van concept tot de uiteindelijke vorm. Dingen om over na te denken bij het ontwikkelen van een gebruikersprofiel omvatten:
- Waar de gebruiker de handleiding zal gebruiken, zoals thuis, op kantoor, op een afgelegen bouwterrein of in de auto. Dit kan niet alleen bepalend zijn voor de inhoud, maar ook voor de stijl van de gebruikershandleiding.
- Hoe gebruikers de handleiding gaan gebruiken. Als de handleiding slechts zelden zal worden geraadpleegd of alleen bedoeld is om informatie in op te zoeken, dan moet het voornamelijk de vorm aannemen van een referentiedocument. Als het iets is dat gebruikers in het begin vaak zullen raadplegen, moet de naslagsectie vergezeld gaan van een "Aan de slag"-sectie en instructies over de meest gangbare taken waar het product voor zal worden gebruikt.
- Hoeveel gebruikers ervaring hebben met het product of wat anderen eraan bevalt. Als je product nieuw is of sterk afwijkt van soortgelijke producten, moet je een uitleg erin opnemen in hoeverre het verschilt van andere producten evenals instructies hoe te beginnen. Als het product functies heeft waar andere gebruikers vaak moeite mee hebben, zoals diverse computertoepassingen, moet je op een begrijpelijke manier voorzien in passende voorlichting en details.
-
Richt je bij het schrijven op de behoefte van de gebruiker, op een manier die de gebruiker kan begrijpen. Tenzij de gebruiker een technische achtergrond heeft, is het waarschijnlijk het beste om te voorkomen zeer technische taal te vermijden en te kiezen voor een heldere, eenvoudige uitleg. De tekst moet ook op een wijze worden georganiseerd die de manier van denken van de gebruiker nabootst; het maken van een lijst van productfuncties gegroepeerd per functie, is vaak zinvoller dan het groeperen van functies die het meest worden gebruikt.
- Soms kom je er niet onderuit om technische termen te gebruiken, zoals voor een grafieken-genererende softwaretoepassing met Fibonacci-grafieken en de meer gangbare cirkel- en staafdiagrammen. In een dergelijk geval is het nuttig om de term te definiëren en achtergrondinformatie te geven, zoals een uitleg van wat Fibonacci grafieken zijn en hun gebruik in financiële analyse.
-
Leg uit wat het probleem is dat de gebruiker probeert op te lossen, en presenteer vervolgens de oplossing. Het aanbieden van een functie als oplossing voor een algemeen probleem werkt prima bij een commercieel product, maar zodra de gebruiker het product heeft, wil hij erachter komen hoe hij het kan te gebruiken. Geef specifieke problemen aan die de gebruiker kan tegenkomen, geef die aan in de gebruikershandleiding en volg met instructies om ze te lossen.
- Indien het probleem complex is, deel het dan op in kleine stukken. Maak een lijst van elk onderdeel met instructies voor het oplossen ervan of hoe ermee om te gaan, en behandel die achtereenvolgend. Informatie op deze manier opdelen heet 'chunking'.
Advertentie
-
Voeg er passende voor- en titelpagina's aan toe. Je hebt een voorblad nodig voor elke handleiding die meer omvat dan een referentiekaart, en een titelpagina voor een handleiding met meer info dan een gevouwen vel papier (vier of meer pagina's).
- Indien de handleiding auteursrechtelijk is beschermd, plaats je een verklaring inzake auteursrecht op zowel het voorblad als het op de titelpagina.
- Als er voorwaarden gekoppeld zijn aan het gebruik van de handleiding en het overeenkomstige product, plaats die dan aan de binnenkant van de voorpagina.
-
Zet verwijzingen naar verwante documenten in het voorwoord. Als de gebruikersdocumentatie uit meer dan een handleiding bestaat, verwijs hier dan naar de andere documenten, met de juiste versienummers. Het voorwoord is ook de plek waar een eventuele sectie "Hoe deze gids te gebruiken" komt.
-
Voeg een inhoudsopgave als de handleiding meer dan 10 pagina's beslaat.
-
Zet de instructies/procedures en het referentiemateriaal in de kern van de handleiding. In de meeste gevallen hebben alle procedures en referentiematerialen elk hun eigen secties, maar je kunt de gebruiker verwijzen naar specifieke inhoud vanuit de ene sectie naar een andere. Op deze manier kan de gebruiker de gezochte informatie sneller vinden.
- Procedures moeten in een consistente structuur worden geschreven in de instructies van de handleiding. Begin met een overzicht van de taak, beschrijf vervolgens wat de gebruiker moet doen en wat hij of zij als gevolg daarvan zou moeten waarnemen. Stappen moeten worden genummerd en geïntroduceerd met actiewerkwoorden, zoals de stappen in elke sectie van dit artikel zijn geschreven.
- Referentiematerialen kunnen lijsten met opties, tips, oplossingen en veel gestelde vragen bevatten. Glossaria en indexen kunnen ongeveer aan het einde van de handleiding erin worden opgenomen, hoewel een lijst met veelgebruikte termen kan worden weergegeven op de voorkant. De index kan worden weggelaten als de handleiding minder dan 20 pagina's bevat.
-
Gebruik zo nodig afbeeldingen ter ondersteuning van de tekst. Grafische afbeeldingen of screenshots, kunnen bepaalde punten in het handboek beter illustreren dan tekst, met name bij complexe procedures waar de gebruiker een visuele bevestiging nodig heeft dat de stappen goed zijn uitgevoerd. Grafische afbeeldingen kunnen met behulp van ontwerpsoftware of grafische software, digitale camera's en fotobewerkingssoftware worden geproduceerd, of in het geval van screenshots, vastgelegd met de schermopname-mogelijkheid van je pc of een grafisch programma.
- Zodra je een grafische afbeelding hebt gemaakt, kun je dit opslaan in een gecomprimeerd formaat dat geschikt is voor je tekstverwerkingsprogramma of DTP-programma. Je zult ook de fysieke grootte van de afbeelding willen verminderen zodat het iets gemakkelijker op de pagina past, zonder in te boeten aan details. (Indien nodig kun je de oorspronkelijke afbeelding in stukken opdelen en de relevante delen weergeven, samen met de ondersteunende tekst.)
- Als je gebruikmaakt van meerdere grafische afbeeldingen in procedures, geef ze dan een consistent formaat, met dezelfde afmetingen voor de lengte en de breedte of op eenzelfde manier verkleind. Dit zal de beelden aantrekkelijker maken voor de gebruiker. Ook bij het maken van screenshots moet je ervoor zorgen dat de computer gebruikmaakt van een standaardkleurenschema bij het vastleggen van beelden, als de gebruikershandleiding screenshots in kleur weergeeft.
- Hoewel grafische bewerkingsprogramma's zoals Photoshop en Paint Shop Pro de mogelijkheid bieden om een schermafbeelding te maken, beschik je met specifieke programma's, zoals SnagIt, over de mogelijkheid om beelden eenvoudig te wijzigen, catalogiseren en te voorzien van bijschriften.
Advertentie
-
Kies een paar leesbare lettertypen. Hoewel computers een aantal verschillende lettertypen kunnen ondersteunen, is het doel van een gebruikershandleiding om gemakkelijk leesbaar te zijn. Het kiezen van slechts een klein aantal lettertypen die goed bij elkaar passen is de beste manier om dit doel te bereiken. Lettertypen kunnen worden onderverdeeld in 2 types: schreefletters (serif) en schreefloze letters (sans serif).
- Schreeflettertypen zijn voorzien van kleine verfraaiingen aan de uiteinden van de belangrijkste lijnen die de letter vormen. Serif lettertypen bevatten lettertypen zoals Times New Roman, Baskerville en Book Antiqua. Serif lettertypen zijn het meest geschikt voor grote stukken tekst in een tekengrootte van 10 tot en met 12 in het hoofdgedeelte van een gedrukte handleiding.
- Sans serif lettertypen geven alleen de lijnen weer die de letters vormen, zonder versiering. Schreefloze lettertypen bevatten lettertypen zoals Arial, Calibri en Century Gothic. Schreefloze lettertypen kunnen worden gebruikt voor grote stukken tekst in maten van 8 tot 10 punten in een PDF of online handleiding, hoewel het gebrek aan schreven zinnen weergegeven in 12 punten of groter, moeilijker te lezen maakt. Ze kunnen echter effectief zijn in groter formaat voor het weergeven van titels en koppen, en ze zijn ook geweldig in kleinere maten voor voetnoten en getallen in de kolommen en tabellen.
- Gebruik over het algemeen gewone lettertypen zoals Arial of Times New Roman voor je gebruikershandleiding, hoewel je een decoratief lettertype kunt gebruiken voor belangrijke citaten of titels, wanneer je een handleiding schrijft voor een fantasie of sf-game. (In het geval van blikvangercitaten, kun je vaak een van de duidelijke lettertypen gebruiken en het blikvangercitaat cursief weergegeven.)
- Zodra je hebt gekozen voor bepaalde lettertypen die je wilt gebruiken, maak je een voorbeeldpagina op papier, om te controleren of de lettertypen goed bij elkaar passen. Je zult dit voorbeeld ook willen laten zien aan degene die goedkeuring moet geven aan de handleiding, voordat je verder gaat met het schrijven ervan.
-
Besteed aandacht aan de lay-out. Zodra je hebt gekozen voor een de lettertypen van de handleiding, moet je beslissen waar alles op de pagina's komt.
- In het algemeen plaats je de titel of de hoofdstuktitel in de kop- of voettekst, eventueel met de titel op de linker pagina en de hoofdstuktitel op de rechter pagina. Plaats ook paginanummers in de koptekst of voettekst, hetzij tegen de rand aan (kop- of voettekst) of in het midden (alleen in de voettekst). Je kunt elke eerste pagina van een sectie of hoofdstuk doen afwijken van de andere pagina's, door het bijbehorende paginanummer onderin het midden van pagina te plaatsen en die van de overige pagina's bovenin de hoek van de pagina.
- Misschien wil je toelichtingstekst aangeven in gekleurde of gearceerde vakken, om die te onderscheiden van de rest van de tekst. Kies een kleur of niveau van arcering zonder dat de leesbaarheid achteruit gaat.
- Kies voor redelijk ruime marges aan alle zijden, met extra ruimte bij de randen die zullen worden samengebonden.
-
Denk na over de soort binding voor de gebruikershandleiding. Als je gebruikershandleiding meer dan 4 pagina's beslaat, dan moeten de pagina's op een bepaalde manier met elkaar worden samengebonden. Hoewel bij interne documenten een nietje in de hoek kan volstaan, worden externe gebruikershandleidingen die worden meegeleverd met een product, gewoonlijk op 3 manieren gebonden:
- Nieten is geschikt voor handleidingen samengesteld uit gevouwen vellen papier: 21 x 27,5 cm, 21 x 35 cm of 27,5 x 42,5 cm. De goedkoop geproduceerde handleidingen van 48 pagina's of minder zijn op deze manier gebundeld.
- De zadelsteek wordt meer in het algemeen gebruikt voor referentiegidsen van derden dan voor gebruikershandleidingen die worden meegeleverd met andere producten dan auto's, hoewel sommige uitgebreidere gebruikershandleidingen op deze manier zijn gebonden. (Paint Shop Pro werd oorspronkelijk geleverd met een zadelsteek gebonden gebruikershandleiding, toen het nog uitgegeven werd door JASC Software.)
- Spiraalbinding is geschikt voor de gebruikershandleidingen die zijn ontworpen om te worden gebruikt in meer ruwere omgevingen, zoals het buiten, waar geniete of zadel-gestikte handleidingen uit elkaar zouden vallen. Sommige spiraal-gebonden handleidingen hebben gelamineerd pagina's om te voorkomen dat ze stuk gaan als de handleiding nat of modderig wordt.
-
Maak een sjabloondocument voor je handleiding. Veel tekstverwerking- en dtp-programma's bieden je de mogelijkheid om een sjabloondocument voor je gebruikershandleiding te maken, zodat terwijl je typt, de tekst automatisch wordt weergegeven in het lettertype dat je hebt geselecteerd voor het gedeelte van de handleiding waarmee je bezig bent. (In feite was dit artikel in eerste instantie geschreven met behulp van een Microsoft Word-sjabloon.) De meeste van deze programma's bevatten ook een verzameling vooraf gedefinieerde sjablonen die je aan je behoeften kunt aanpassen, in plaats van de sjabloon van de grond af op te bouwen.
- Tekstverwerkers en desktoppublishing-programma's bieden ook de mogelijkheid om 'stijlen', vooraf ingestelde lettertypes en formaten voor kopteksten, voetteksten, koppen en platte tekst te maken. Je kunt een van de namen van vooraf ingestelde stijlen kiezen (bijvoorbeeld 'Kop1,' 'Normaal', 'Citaat'), of een eigen stijl maken met een eigen naam. Probeer zoveel mogelijk de conventies van bestaande stijlnamen te volgen, mocht je meerdere stijlen gebruiken voor dezelfde tekstklasse. (Bijvoorbeeld Microsoft Word labelt tekststijlen voor koppen als 'Kop1,' 'Kop2,' etc., van de belangrijkste kop tot de verschillende niveaus van subkoppen.) Probeer alle stijlen vooraf te maken, zodat je het schrijfproces niet hoeft te onderbreken om ze dan alsnog te maken.
Advertentie
Tips
- Maak waar mogelijk gebruik van veldcodes of tekstvariabelen. Je kunt de veldcodes waarden toekennen, zoals de naam van een product, de handleiding of de titel van een hoofdstuk, en binnen je document plaatsen, in plaats van de te vermelden tekst. Wanneer je een voorbeeld bekijken, of de handleiding afdrukt, wordt de variabele vervangen door de tekst. Als de naam van het product wordt gewijzigd of als je de naam van de handleiding of een hoofdstuk wijzigt, is het gemakkelijker om de informatie te wijzigen door het aanpassen van de waarde van de tekstvariabele, dan middels zoeken en vervangen.
Advertentie
Benodigdheden
- Tekstverwerkings- of dtp-programma
- Grafische software of schermopnameprogramma
Bronnen
Over dit artikel
Deze pagina is 20.547 keer bekeken.
Advertentie
Meld je aan voor de gratis nieuwsbrief van wikiHow!
Je vindt dan elke week handige handleidingen in je inbox.
Meld me aan!
