Pdf downloaden
Pdf downloaden
Software, computers, games en apparaten vereisen gebruikershandleidingen; gidsen waarin wordt uitgelegd hoe het product moet worden gebruikt (en hoe niet). Een gebruikershandleiding is een formeel document met een specifieke structuur, en moet geschreven worden door iemand die het product door en door kent, zoals een technisch schrijver of de productontwerper. Het schrijven van een doeltreffende gebruikershandleiding vereist dat je weet wie het product gaat gebruiken, en dat je de handleiding schrijft met deze gebruikers in gedachten. Houd je schrijven duidelijk, precies en eenvoudig, om een probleemloze gebruikerservaring te garanderen.
Stappen
-
Doe een gebruikersanalyse. De gebruikershandleiding moet geschreven worden voor de gebruikers -- degenen die je product of dienst zullen kopen en de gebruikershandleiding zullen lezen. Een gebruikersanalyse zal je vertellen wie je belangrijkste of doelpubliek zal zijn en zal je bij het schrijven van de tekst begeleiden.
- Praat met mensen die je apparaat zullen gebruiken. Bied testgebruikers prototypes van het apparaat en een concept van de gebruikershandleiding aan onder gecontroleerde omstandigheden. Vraag deze testgebruikers om feedback over zaken die niet duidelijk of verwarrend zijn in de gebruikershandleiding en breng op basis van deze feedback wijzigingen aan in je gebruikershandleiding.
- Je kunt nooit je hele publiek tevreden stellen; schrijf de handleiding op maat van het doelpubliek of het grootste publiek.
- Denk na over de leeftijd, de gezondheid (hebben ze ziekten, leerproblemen of handicaps?) en het opleidingsniveau van het publiek, om te bepalen wat de beste aanpak is voor het schrijven van de gebruikershandleiding.
-
Coördineer het ontwerp van de gebruikershandleiding. Als je deel uitmaakte van het team dat hielp bij het ontwerpen en ontwikkelen van het apparaat of product, dan kan het moeilijk zijn om objectief naar het product te kijken om de werking ervan uit te leggen. Je zou daarom het advies kunnen inwinnen van een schrijver (bij voorkeur iemand met ervaring in het schrijven van instructies) en een grafisch ontwerper, om je te helpen bij het opstellen van de gebruikershandleiding. Je zou deze personen kunnen kiezen via een extern adviesbureau of uit je eigen bedrijf of organisatie.
-
Doe een taakanalyse. Een taakanalyse is het proces van het identificeren en organiseren van de stappen die nodig zijn om het apparaat te gebruiken. Een grondige taakanalyse identificeert de materialen en uitrusting (zoals batterijen, medicijnen of andere door de gebruiker verstrekte producten) die voor elke stap nodig zijn, evenals de handelingen, fouten en adviezen voor het oplossen van problemen die elke stap zou kunnen vereisen.
- Als je een product hebt dat veel verschillende taken of subtaken kan uitvoeren, moet je een taakanalyse uitvoeren voor elke taak. Bijvoorbeeld: in een auto kun je toeteren, jezelf vastmaken en je koplampen aan of uit zetten. Maak een taakanalyse voor elk van deze, indien nodig.
-
Zorg ervoor dat je product voldoet aan de vereisten voor etikettering en markttoelating. Deze vereisten zorgen ervoor dat producten worden geproduceerd met de veiligheid van de gebruiker in gedachten, en dat de blootstelling van de gebruiker aan gevaarlijke omstandigheden, zoals straling en elektrocutie, wordt beperkt. Advertenties moeten duidelijk aangeven wat het doel en de fundamentele operationele richtlijnen van een product zijn, en je moet deze bronnen gebruiken bij het schrijven van je gebruikershandleiding.
- Om de gebruikershandleiding van een product effectief te laten zijn, moet deze worden geschreven in overeenstemming met de labels die direct op het product zijn aangebracht.
- Zorg ervoor dat je apparaat officiële licenties heeft voor verkoop, voordat je de gebruiksaanwijzing schrijft.
-
Beslis over de lay-out van je handleiding. Er zijn verschillende belangrijke manieren waarop je je handleiding kunt stroomlijnen. Je moet aan het begin van elke sectie een vetgedrukte kop plaatsen met elk woord in hoofdletters. Bijvoorbeeld: 'Uw apparaat instellen', 'Uw apparaat bedienen' en 'Problemen oplossen' kunnen allemaal vetgedrukte sectiekoppen zijn.
- Een andere manier om je handleiding te stroomlijnen is het gebruik van twee kolommen, één aan de rechterkant met tekst en de andere net links van de tekst, met opsommingstekens, nummers, of kleine pictogrammen, zoals waarschuwingstekens of rode uitroeptekens. [1] X Bron
- De handleiding kan voornamelijk uit beelden bestaan met wat tekst onder elk beeld om het apparaat uit te leggen, of het kan hoofdzakelijk tekst zijn met slechts een paar begeleidende beelden. Je kunt ook een stroomdiagram gebruiken om de gebruiker aanwijzingen te geven. Denk na over je product en hoe elke methode van nut kan zijn bij het schrijven van je handleiding. Vermijd echter het vermengen van verschillende lay-outs binnen een handleiding. Kies er één en blijf daarbij.
Advertentie
-
Organiseer de handleiding logisch. De handleiding moet zo opgebouwd zijn dat de gebruiker er het meeste voordeel uit zal halen. Verdeel de handleiding in hoofdstukken of secties die zinvol zijn voor het gebruik van het product, en voeg een inhoudsopgave toe aan de voorkant van de handleiding, zodat elke sectie snel gevonden kan worden.
- Een inhoudsopgave is vooral nodig voor langere handleidingen.
- Een woordenlijst of index is nodig als er veel termen uitgelegd moeten worden die je publiek misschien niet kent. Een woordenlijst wordt echter niet aanbevolen; de beste keuze is om verwarrende termen uit te leggen in de tekst van de handleiding zelf. Als je ervoor kiest om een verklarende woordenlijst op te nemen, plaats hem dan vooraan in de handleiding, net na de inhoudsopgave.
- Een lijst met tabellen of figuren is alleen nodig als er meer dan een paar tabellen of figuren in de handleiding staan.
- Een appendix is nodig voor dingen die uitgelegd moeten worden maar niet op een andere plaats in de handleiding uitgelegd kunnen worden, omdat het de flow en focus zou verstoren.
-
Neem er noodzakelijke waarschuwingen in op. De algemene waarschuwingen of voorzorgsinformatie moeten informatie geven over mogelijke gevaren die een onjuist gebruik van het product met zich mee kan brengen, waaronder dood of ernstig letsel. Deze waarschuwingen moeten helemaal vooraan in de handleiding worden geplaatst, na de voorpagina, zodat de gebruiker ze als eerste ziet. Specifieke waarschuwingen moeten ook worden opgenomen in de tekst van de handleiding net na of net voor een potentieel gevaarlijke stap wordt voorgesteld.
- Bijvoorbeeld: een algemene waarschuwing voor een elektrisch apparaat zou kunnen zijn om het niet te gebruiken tijdens regen.
- Een specifieke aanwijzing zou kunnen zijn om ervoor te zorgen dat zowel je handen als het apparaat droog zijn voordat je het apparaat in het stopcontact steekt.
- Geef afbeeldingen (zoals een schedel en gekruiste botten) of tekst in een andere kleur (zoals rode tekst) om de waarschuwing te onderscheiden van de rest van de aanwijzingen in de gebruiksaanwijzing en de aandacht van de gebruikers erop te vestigen.
-
Beschrijf het apparaat. Je beschrijving moet zowel een schriftelijke uitleg van het doel van het apparaat bevatten als een kleine grafische voorstelling van hoe het apparaat eruit ziet. De afbeelding moet alle schakelaars, knoppen en bevestigbare onderdelen die het apparaat bevat labelen en benoemen.
-
Geef installatie-instructies. De installatiesectie moet basisinformatie bevatten over hoe je je moet voorbereiden op het gebruik van het product of apparaat. Als het apparaat niet door een thuisgebruiker kan worden gebouwd of ingesteld, vermeld dit dan duidelijk in een vetgedrukte kop bovenaan de installatiesectie. Je moet ook het volgende erin opnemen:
- Een onderdelenlijst
- Uitpakinstructies
- Waarschuwingen met betrekking tot de installatie
- Gevolgen van een foutieve installatie
- Wie te bellen in geval er moeilijkheden ontstaan bij de installatie
-
Geef informatie over de bediening. Dit gedeelte is het belangrijkste deel van de gebruikershandleiding en moet concrete, gedetailleerde informatie geven over het gebruik van het toestel. Begin met de basisvoorbereiding voor het gebruik van het toestel, zoals de stekker in het stopcontact steken of de handen wassen. Ga verder met logische, genummerde stappen die beschrijven hoe het apparaat moet worden gebruikt, evenals feedback (bijvoorbeeld: 'U hoort een klik...') die de gebruiker kan verwachten als hij het apparaat op de juiste manier gebruikt.
- Aan het eind van dit hoofdstuk moeten gebruikers worden verwezen naar het hoofdstuk over het oplossen van problemen, om problemen op te lossen die niet snel kunnen worden uitgelegd.
- Plaats afbeeldingen waar nodig. Sommige stappen kunnen het beste worden uitgelegd met zowel afbeeldingen als woorden. Denk aan het gebruik van foto's of illustraties in je handleiding.
- In dit deel, zoals in elk deel, moet je relevante veiligheidswaarschuwingen opnemen over onjuist gebruik of onjuiste bediening. Bijvoorbeeld: je zou gebruikers van een kettingzaag kunnen waarschuwen geen alcohol te drinken of de kettingzaag te gebruiken terwijl ze bepaalde medicijnen gebruiken.
- Als je denkt dat gebruikers er baat bij hebben, dan kun je overwegen links op te nemen naar online video's die het juiste gebruik en de juiste bediening van het apparaat demonstreren. Je kunt deze video's ofwel aan het begin van deze sectie opnemen, of (in het geval van video's die slechts één stap illustreren) aan het einde van elke stap.
-
Voeg aan het eind een samenvatting van het product toe. De samenvatting moet aan het eind van de handleiding komen, net voor de index, om de basisstappen van de bediening te geven. Dit moet een vereenvoudigde, uitgeklede versie zijn van de operationele informatie, en mag niet meer dan één pagina beslaan. Vat samen hoe het apparaat of product moet worden gebruikt. Neem basiswaarschuwingen op, genummerde stappen die uitleggen hoe het product gebruikt moet worden, en telefoonnummers of e-mailadressen die gebruikers doorverwijzen naar hulp.
- Als je verwacht dat de gebruiker het samenvattingsblad zal verwijderen of het vaak zal moeten raadplegen, kun je het afdrukken op een verwijderbare gelamineerde kaart of dik karton , om het voor de gebruiker gemakkelijker te maken om bij zich te dragen en te raadplegen.
- Als alternatief kun je een samenvatting direct op het product aanbrengen, zodat de gebruiker deze snel en gemakkelijk kan raadplegen.
Advertentie
-
Leg uit hoe het apparaat moet worden schoongemaakt. Als je apparaat of product moet worden gereinigd, leg dan uit hoe dit moet gebeuren. Geef een opsomming van de benodigde schoonmaakmiddelen. Vertel de lezer hoe vaak hij moet schoonmaken. Neem vervolgens, net als in elk ander deel van de handleiding, genummerde stap-voor-stap instructies op over hoe het schoonmaken in zijn werk moet gaan.
- Als voor het schoonmaken het product gedemonteerd moet worden, of een bepaald onderdeel of bepaalde onderdelen verwijderd moeten worden, vermeld dan hoe het product gedemonteerd moet worden.
- Geef een waarschuwing over de resultaten van het nalaten om het apparaat te reinigen. Je zou bijvoorbeeld kunnen zeggen: 'Als het apparaat niet wordt schoongemaakt, zullen de prestaties minder dan optimaal zijn.'
-
Tel de gebruiker hoe hij basisonderhoud kan uitvoeren. Als het product of apparaat door de gebruiker kan worden onderhouden om prestatieproblemen te verhelpen, vermeld dan genummerde aanwijzingen over hoe de gebruiker dit kan doen. Bijvoorbeeld: als de batterijen na elke 300 gebruiksuren vervangen moeten worden, vermeld dan aanwijzingen over hoe te controleren of de batterijen vervangen moeten worden, hoe je de lege batterijen moet verwijderen en hoe de nieuwe batterijen geplaatst moeten worden.
- Als er bepaalde onderhoudstaken zijn die alleen door een gecertificeerde technicus kunnen worden uitgevoerd, verdeel het onderhoudsgedeelte van de handleiding dan in twee delen.
-
Bespreek de opslagmogelijkheden. In de handleiding moet, indien nodig, worden uitgelegd hoe het product of apparaat op de juiste manier moet worden opgeslagen. je dient ook informatie op te nemen over waarom opslag noodzakelijk is, en wat de gevolgen zijn van onjuiste opslag. Bijvoorbeeld: je zou kunnen schrijven:
- 'Bewaar het product op een koele, droge plaats. Onjuiste opslag kan de levensduur van je product verkorten als gevolg van de ophoping van vocht.'
- 'Stel het product niet bloot aan hitte en bewaar het niet bij temperaturen boven 50 graden Celsius. Doe je dit wel, dan kan dit leiden tot ontbranding.'
-
Geef informatie over het oplossen van problemen. Je zou deze sectie kunnen organiseren als een lijst van veel voorkomende problemen en hun oplossingen. Groepeer gelijksoortige problemen onder een logische kop. Op deze manier kunnen gebruikers specifieke problemen snel vinden.
- Bijvoorbeeld: als er verschillende problemen zijn met de computer die een blauw scherm weergeeft, groepeer ze dan onder een subkopje, zoals 'Veel voorkomende schermproblemen'.
- Je moet ook een telefoonnummer en/of e-mail voor de klantendienst in deze sectie vermelden.
Advertentie
-
Lees andere gebruikershandleidingen. Voordat je een handleiding voor je eigen product schrijft, kijk je naar andere effectieve gebruikershandleidingen. Let op de structuur, woordkeuze en zinsbouw. Grote merken zoals Apple, Google en Microsoft produceren sterke, effectieve gebruikershandleidingen die je kunnen helpen bij het produceren van een doordachter geschreven gebruikershandleiding. [2] X Bron
- Lees niet zomaar alle gebruikershandleidingen. Lees de handleidingen van soortgelijke producten die je verkoopt. Bijvoorbeeld: als je babyproducten verkoopt, lees dan babyhandleidingen, geen technische.
-
Selecteer je normen. Het standaardiseren van spelling, woordkeus en formulering zal de gebruikershandleiding gebruikersvriendelijker maken. De Chicago Manual of Style en de Microsoft Manual of Style kunnen ook nuttige stijlgidsen zijn bij het schrijven van je gebruikershandleiding; raadpleeg beide om te zien of er een geschikt is voor je handleiding. [3] X Bron
- Bijvoorbeeld: in plaats van zowel 'aan/uit-schakelaar' als 'aan/uit-knop' te gebruiken in je handleiding, kies je één van de twee termen en houd je het daarbij.
-
Gebruik de actieve stem. De actieve stem is een manier van schrijven die dingen uitlegt vanuit het perspectief van de gebruiker. Het is gemakkelijker te begrijpen dan het alternatief, de passieve stem, waarin het onderwerp ongedefinieerd is. [4] X Bron
- Probeer de Hemingway App (www.hemmingwayapp.com) om passieve passages in je schrijven te herkennen.
- Bestudeer deze twee voorbeeldzinnen -- de eerste is actief is en de tweede passief:
- Je moet het pakje langzaam en voorzichtig openmaken.
- Het pakje moet langzaam en voorzichtig opengemaakt worden.
-
Schrijf genummerde instructies. Numeriek geordende instructies helpen de lezer zich beter te concentreren op het proces van het gebruiken, aansluiten of bouwen van het product in kwestie. In plaats van een lange, breedsprakige alinea te schrijven, of een reeks ongenummerde alinea's, schrijf je gebruikershandleiding met eenvoudige, expliciete stappen, elk duidelijk genummerd. [5] X Bron
-
Begin elke stap met een gebiedende wijs. Een gebiedende wijs is een actiegericht werkwoord. Door elke stap te beginnen met een werkwoord, geef je de lezer een hint over de actie die nodig is om de stap te voltooien. Afhankelijk van het product waarover je schrijft, kun je bijvoorbeeld je stappen beginnen met een opdracht als 'Verbind', 'Bevestig' of 'Schuif'. Begin je stappen echter niet met een reactie van het systeem. [6] X Bron
- Bijvoorbeeld: als het scherm blauw wordt en gaat knipperen, begin de stap dan niet met: 'Het scherm zal knipperen en blauw worden.' Probeer: 'Druk op de home-toets en houd deze ingedrukt. Het scherm zal knipperen en blauw worden.'
-
Bepaal welke woordenschat je gaat gebruiken. Als je een gebruiksaanwijzing voor een jojo schrijft, zal je publiek vooral uit jonge kinderen bestaan. Gebruik eenvoudige woorden en woordenschat om uit te leggen hoe de jojo werkt. Als je een handleiding voor een scanning-elektronenmicroscoop schrijft, bestaat je publiek uit hoogopgeleide wetenschappers die zeer gedetailleerde informatie kunnen begrijpen, dus schrik in dat geval niet terug voor het gebruik van gespecialiseerde woordenschat of genuanceerde uitleg.
- In het algemeen probeer je jargon en technisch taalgebruik te vermijden.
- Om effectief te zijn voor een zo breed mogelijke gebruikersgroep, probeer je op een niveau te schrijven van de zesde tot de zevende klas van de basisschool.
-
Zorg ervoor je vertalingen nauwkeurig zijn als je een product overzee verscheept. Huur een vertaler in om je gebruikershandleiding te vertalen in de moedertaal van het land waar je je product naartoe verzendt. Je kunt ook een online vertaalprogramma gebruiken, maar vraag een moedertaalspreker om de vertaling te lezen en op fouten te controleren.
- Als er meerdere taalgroepen in je publiek vertegenwoordigd zijn, voeg dan vertalingen van de gebruikershandleiding in elke relevante taal bij.
- De vertaler moet vertrouwd zijn met het product, aangezien er in de doeltaal andere woorden kunnen zijn voor specifieke termen die geen woord-voor-woord vertalingen zijn.
-
Schrijf in korte zinnen. In plaats van een paar lange alinea's gebruik je veel korte alinea's. Zoek naar logische onderbrekingen in elke sectie en verwerk nuttige informatie in brokjes van één of twee zinnen. Hetzelfde geldt op zinsniveau. Houd je zinnen kort en eenvoudig, in plaats van lang en breedsprakig. [7] X Bron
- Als een stap te lang begint te worden, breek hem dan op in kleinere stappen. Dit zal het aantal woorden niet omlaag brengen, maar de regelafbrekingen maken het makkelijker te lezen.
-
Controleer de handleiding op fouten. Een handleiding kan aan geloofwaardigheid inboeten door grammatica- en spelfouten. Laat een collega of technisch schrijver de handleiding ook redigeren en proeflezen. Naast spelling en grammatica moet een proeflezer letten op het volgende: [8] X Bron
- Passieve stem
- Onduidelijk of verwarrend taalgebruik
- Gewikkelde zinsbouw
- Overdreven lange alinea's
Advertentie
Tips
- Mensen leren op verschillende manieren; voeg indien mogelijk en gepast visuele hulpmiddelen of links naar online video's in de handleiding toe, om visueel georiënteerde lezers tegemoet te komen.
Advertentie
Bronnen
- ↑ https://books.google.com/books?id=FmggBAAAQBAJ&lpg=PR1&pg=PA83#v=onepage&q&f=false
- ↑ https://books.google.com/books?id=FmggBAAAQBAJ&lpg=PR1&pg=PA80#v=onepage&q&f=false
- ↑ http://online-learning.com/five-tips-writing-user-manual/
- ↑ http://online-learning.com/five-tips-writing-user-manual/
- ↑ http://online-learning.com/five-tips-writing-user-manual/
- ↑ http://online-learning.com/five-tips-writing-user-manual/
- ↑ https://books.google.com/books?id=FmggBAAAQBAJ&lpg=PR1&pg=PA83#v=onepage&q&f=false
- ↑ https://books.google.com/books?id=FmggBAAAQBAJ&lpg=PR1&pg=PR1#v=onepage&q&f=false/
Over dit artikel
Deze pagina is 1.718 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!
