Hoe schrijf je duidelijke en beknopte gebruikershandleidingen?
Wat is een gebruikershandleiding?
Er zijn verschillende namen voor een gebruikershandleiding. Technische documenten, onderhoudshandleidingen en instructiehandleidingen zijn allemaal namen die naar hetzelfde item verwijzen. Een gebruikershandleiding is gemaakt om klanten te helpen uw product of service correct te gebruiken of problemen op te lossen die tijdens het gebruik optreden. Ze kunnen beschikbaar worden gesteld in gedrukte, digitale of beide formaten.
Gebruiksaanwijzingen bieden de eindgebruiker uitgebreide, stapsgewijze instructies en enige ondersteuning bij problemen. Een inhoudsopgave moet aanwezig zijn in elke gebruikershandleiding, omdat het referentiemateriaal is in plaats van boeken die van begin tot eind gelezen moeten worden. U moet een quickstart of startup tutorial toevoegen aan uw gebruikershandleiding, zodat gebruikers zich meteen op hun gemak voelen bij het starten met het product.
soorten gebruikershandleidingen
Voor verschillende onderwerpen en doelstellingen kunnen gebruikershandleidingen worden geproduceerd. Hier zijn enkele van uw mogelijkheden, dus laten we ze eens bekijken.
- Gebruiksaanwijzing
Een gebruiksaanwijzing is een soort gebruikershandleiding met duidelijke instructies voor het gebruik van een product op de manier waarvoor het bedoeld is. - Trainingshandleiding
Dit soort gebruikershandleiding biedt een lijst met richtlijnen voor het voltooien van een bepaalde taak, project of klus. - Servicehandleiding
Servicehandleidingen zijn gebruikershandleidingen die beschrijven hoe u een machine of apparaat op verschillende momenten moet onderhouden.tages van zijn levensduur. - Gebruiksaanwijzing
Gebruikershandleidingen zijn technische publicaties waarin wordt uitgelegd hoe u een product op de juiste manier gebruikt of bedient. - Gebruiksaanwijzing
Rollen, taken en procedures die specifiek zijn voor een bedrijf of organisatie, worden beschreven in operationele handleidingen. - Handleiding voor organisatiebeleid
Een organisatiebeleidshandboek is de documentatie waarin het beleid, de werkwijzen en de beste werkwijzen van een bedrijf zijn vastgelegd. - Standaardwerkprocedures (SOP's) handleiding
Gebruikers hebben baat bij een standaardhandleiding met gedetailleerde instructies voor het uitvoeren van vastgestelde procedures.
Waarom heeft uw bedrijf gebruikershandleidingen nodig?
Mensen zijn beter toegerust om problemen zelf op te lossen met de ondersteuning van een gebruikershandleiding. Een fatsoenlijke gebruikershandleiding kan uw klanten de tools geven die ze nodig hebben om snel en effectief de waarde te bereiken die ze van uw product of dienst verlangen in de huidige cultuur van onmiddellijke bevrediging.
Uitstekende klantenservice moet worden aangevuld met gebruikershandleidingen. Het schrijven van uitstekende gebruikershandleidingen zal het volgende voordeel biedentages voor uw bedrijf:
- Om onboarding en training eenvoudiger te maken
Goed geschreven gebruikershandleidingen kunnen de onboarding- en trainingsprocedures eenvoudiger maken. Dat klopt, door het ontwikkelen en implementeren van eersteklas gebruikershandleidingen, kunnen zowel uw werknemers als uw consumenten profiteren.
Uw bedrijf kan gebruikershandleidingen gebruiken om nieuwe werknemers te helpen bij het doorlopen van een aantal processen en systemen die deel uitmaken van hun nieuwe rollen, in plaats van alleen moeilijke persoonlijke trainingssessies op te zetten, die aanzienlijke tijd- en financiële kosten met zich meebrengen. Omdat werknemers kunnen leren terwijl ze de taken uitvoeren die verband houden met hun functies dankzij de gebruikershandleidingen, kunnen er minder uren verloren gaan tijdens de onboarding. - Om de ondersteuningskosten te verlagen
Gebruikershandleidingen vormen een geweldige aanvulling op uw klantenservice voor de consument, maar ze zijn voor de bedrijfseigenaar ook een goed onderdeel van het klantenservicesysteem.
Klanten vinden sneller een oplossing en hoeven minder vaak contact op te nemen met een technicus of vertegenwoordiger voor gespecialiseerde ondersteuning als u ze snel toegang geeft tot een doorzoekbare gebruikershandleiding. - Om tijd te besparen
Zowel uw klanten als uw werknemers, van instappersoneel tot management, kunnen tijd besparen door gebruik te maken van gebruikershandleidingen. Wanneer gebruikershandleidingen beschikbaar zijn voor uw klanten, hoeven ze geen tijd te verspillen aan het zoeken naar informatie over hoe ze een product moeten gebruiken, omdat ze direct toegang hebben tot die informatie.
Wanneer uw medewerkers over handige gebruikershandleidingen beschikken, hoeven ze geen tijd meer te verspillen aan het zelf opzoeken van oplossingen of het monopoliseren van de aandacht van hun collega's en managers met vragen. Ze hebben namelijk direct toegang tot de oplossingen in hun gebruikershandleiding! - Om aansprakelijkheid te minimaliseren
Een manier om aan te tonen dat u uw product grondig hebt getest en weet hoe u het veilig kunt gebruiken, is door gebruikershandleidingen te schrijven en te verspreiden. Dit kan de verplichtingen die gepaard gaan met het produceren van iets voor het grote publiek aanzienlijk verlagen.
Het opschrijven van waarschuwingen en veiligheidsmaatregelen en deze via een gebruikershandleiding toegankelijk maken voor gebruikers is een effectieve (maar niet waterdichte) manier om juridische problemen te voorkomen met betrekking tot letsel of andere schade veroorzaakt door verkeerd gebruik, als het product dat u verkoopt gevaarlijk kan zijn voor gebruikers (denk aan straalkachels, elektrisch gereedschap, enz.).
Welke onderdelen bevatten de beste gebruikershandleidingen?
Er zijn een aantal best practices voor eindgebruikersdocumentatie die u hoe dan ook moet volgen, ook al is elk product uniek en heeft het aparte componenten nodig om echt uitstekende gebruikersdocumentatie te genereren.
- Duidelijke taal
Niets zal uw klanten meer irriteren - behalve het niet aanbieden ervan - dan ontdekken dat hun gebruikershandleiding vol jargon en moeilijk te begrijpen taal staat. Uw gebruikersinstructies zijn moeilijk te gebruiken vanwege deze taalkeuzes, wat ook niet bijdraagt aan een uitstekende klantenservice. Ervoor zorgen dat u schrijft voor de gebruiker, niet voor de ontwikkelaar, is een cruciaal onderdeel van het maken van geweldige gebruikershandleidingen. Ga er niet vanuit dat uw eindgebruiker iets weet of ermee vertrouwd is. Acroniemen, jargon en kantoorterminologie zorgen ervoor dat uw klanten zich verkeerd geïnformeerd, gefrustreerd en onvoorbereid voelen. De ideale balans voor het produceren van een gebruikershandleiding is het vinden van een balans tussen niet schrijven alsof uw consumenten kinderen zijn (tenzij ze dat natuurlijk zijn!) en hen de extra hulp geven die ze nodig hebben om volledig te begrijpen hoe ze het product moeten gebruiken, in eenvoudige taal. - Eenvoud
Het schrijven van een gebruikershandleiding vereist dat u dingen simpel houdt. Dit concept moet worden weerspiegeld in zowel de inhoud als het ontwerp. Als u uw documentatie overlaadt met ingewikkelde afbeeldingen en lange tekstpassages, zal het te geavanceerd en moeilijk te begrijpen lijken. Dit soort gebruikershandleiding zal uw gebruiker waarschijnlijk intimideren en ertoe aanzetten om uw hulplijn te bellen in plaats van te proberen hun probleem zelf op te lossen. - Visueel
Het gezegde "Show, don't tell" is een hoeksteen van het schrijven van gebruikershandleidingen. Geannoteerde screenshots, films en andere visuele content zijn extreem behulpzaam bij het begrijpen van concepten. Het is vaak veel nuttiger om iets in actie te zien dan erover te lezen. Visuele content breekt niet alleen lange tekstpassages op, maar vermindert ook de hoeveelheid tekst in gebruikershandleidingen die eng kan zijn. Het is aangetoond dat mensen visuele informatie 7% sneller onthouden dan geschreven informatie. In een Techsmith-onderzoek werd ook aangetoond dat 67% van de mensen taken effectiever uitvoerde wanneer ze instructies kregen die geannoteerde screenshots bevatten in plaats van alleen woorden om informatie over te brengen. - Concentreer je op het probleem dat opgelost moet worden
Het is heel waarschijnlijk dat iemand uw product heeft gekocht om een probleem aan te pakken. Het is essentieel om gefocust te blijven op dit probleem bij het opstellen van de gebruikershandleiding die bij het product wordt geleverd. In plaats van alle functies die uw product biedt of de intrigerende ontwerpelementen die u hebt opgenomen op te sommen en te bespreken, informeert u uw gebruikers hierover op een manier die het gebruik van het product vergemakkelijkt. Plaats het probleem dat wordt opgelost in de context van de functies en voordelen van uw product wanneer u ze beschrijft. - Logische stroom en hiërarchie
Om de gebruiker duidelijk te maken wat hij of zij van elk onderdeel van uw gebruikershandleiding leert, gebruikt u headers en subheadings die een duidelijke hiërarchische structuur volgen. Om uw klanten moeiteloos door alles wat ze moeten weten van begin tot eind te leiden, moet de hiërarchie die u kiest een logische stroom volgen. Zorg ervoor dat u begint met de basisprincipes en een logische progressie opneemt naar de meer geavanceerde functies van uw product. - Inhoudsopgave
Uw gebruikershandleiding is het meest behulpzaam voor lezers als deze begint met een inhoudsopgave. Zonder door veel pagina's met informatie te hoeven spitten die niets te maken hebben met het huidige probleem waarmee ze worden geconfronteerd, is het een vertrouwde aanpak voor iemand om snel en eenvoudig een document te verkennen. - Maak het doorzoekbaar
Zelfs als u uw gebruikershandleidingen afdrukt, is het waarschijnlijk dat digitale documentatie uw belangrijkste prioriteit zal zijn. Het is zeer waarschijnlijk dat uw gebruikershandleidingen het meest frequent in een digitaal formaat worden gebruikt in een wereld waarin de meerderheid van de mensen altijd een smartphone bij zich heeft. Het toevoegen van een doorzoekbare functie aan uw digitale gebruikershandleidingen zal een heerlijk gebruiksgemak bevorderen voor gebruikers die een probleem willen oplossen door er toegang toe te krijgen, vergelijkbaar met hoe een inhoudsopgave dient om gebruikers naar de juiste plaats in een afgedrukt document te leiden. - Toegankelijkheid
Het is mogelijk dat sommige mensen die uw gebruikershandleiding nodig hebben, baat kunnen hebben bij extra assistentie om ervoor te zorgen dat deze goed functioneert. Ongeacht of ze wettelijk verplicht zijn, zijn toegankelijkheidsvereisten over het algemeen een goede praktijk. Het handhaven van toegankelijkheidsvereisten in uw gebruikershandleidingen is gewoon een uitstekende zakelijke praktijk. Het ontwerpen van gebruikershandleidingen met inhoud die toegankelijk is voor gebruikers die visuele, auditieve of cognitieve uitdagingen kunnen hebben, is cruciaal. - Goed ontworpen
Houd bij het maken van uw gebruikershandleidingen rekening met uw publiek. Ze zullen veel meer geneigd zijn om het effectief te gebruiken als u iets maakt waar ze graag naar kijken! Vermijd het gebruik van lange tekstblokken en zorg voor voldoende witruimte. Door deze twee kenmerken te combineren, kunnen consumenten minder beangstigend overkomen en kan het leren van iets nieuws spannend lijken in plaats van bedreigend. De eerder beschreven aanpak van "toon, vertel niet" is hier ook van toepassing. Voor zowel gedrukte als digitale gebruikershandleidingen is het toevoegen van afbeeldingen en foto's aan de tekst een geweldig alternatief. Voor digitale gebruikershandleidingen bieden video's en GIF's interesse en een nuttig element. Als uw bedrijf een stijlgids heeft, moet uw ontwerp deze volgen; anders, als u er geen hebt, is het cruciaal om uw gebruikershandleiding consistent te houden. Het lettertype en de kleurenschema's die in het hele document worden gebruikt, en idealiter in al uw gebruikershandleidingen, moeten consistent zijn. - Reacties van echte klanten of bètatesters
U kunt niet bepalen of de gebruikershandleidingen die u hebt voorbereid zo succesvol mogelijk zijn totdat u feedback hebt gezocht en gehoord van de mensen die uw product daadwerkelijk zullen gebruiken. De gebruikershandleidingen die u voor uw product ontwikkelt, moeten rekening houden met de problemen die mensen ermee hebben. U leert misschien iets dat heel voor de hand liggend lijkt, maar de kans is veel groter dat u iets leert dat u helpt de behoeften van de klanten die u probeert te bereiken te begrijpen.
Hoe schrijf ik een gebruikershandleiding?
Het maken van een gebruikershandleiding is een cruciale taak die een grote impact kan hebben op zowel uw bedrijf als de consumenten die u wilt bedienen. We hebben het proces van het ontwikkelen van een gebruikershandleiding vereenvoudigd, zodat u het gemakkelijk kunt volgen, want het kan overweldigend zijn.
- Identificeer de gebruikers
Het vinden van de ontvanger van uw communicatie is een essentiële eerste stap, net als bij elke andere communicatie die u genereert. Het beoogde publiek van uw gebruikershandleiding zal u helpen beslissen over zaken als de toon, het detailniveau dat u wilt bieden en hoe u de inhoud wilt leveren. Het schrijven van een gebruikershandleiding voor de eindgebruiker van uw product verschilt aanzienlijk van het schrijven van een handleiding voor een technisch ingenieur. De allereerste stap is het bepalen van uw publiek. - Focus op het probleem
Gebruikershandleidingen zijn gemaakt om te helpen bij het oplossen van problemen of om iemand te instrueren hoe hij iets nieuws moet doen. U moet precies bepalen wat uw gebruikershandleiding moet doen en ervoor zorgen dat u die focus behoudt.
Het kan verleidelijk zijn om het onderwerp te verbreden en talloze functies of toepassingen voor uw product te bespreken. Dit kan gebruikers frustreren en leiden tot telefoontjes naar uw klantenservicelijn door het echte antwoord dat ze nodig hebben te vertroebelen.
Als uw klant een consument is die het product moet leren gebruiken of een technicus die het product moet repareren, concentreer u dan op de precieze oplossing die hij of zij nodig heeft. - Gebruik een sequentiële aanpak
De instructies in uw gebruikershandleiding moeten in de volgorde worden weergegeven die nodig is om het werk af te ronden. Maak een lijst van elke stap om te beginnen. Doe vervolgens een poging om de opdracht uit te voeren terwijl u zich houdt aan de precieze stappen die u in de gegeven volgorde hebt geschetst. Terwijl u uw oorspronkelijke lijst doorneemt, is het mogelijk, misschien zelfs waarschijnlijk, dat u stages die ontbreken. Bovendien kan het zijn dat u erachter komt dat iets waarvan u ooit dacht dat het een enkele taak was, in feite in meerdere activiteiten moet worden verdeeld omwille van de duidelijkheid.
Zorg ervoor dat u een duidelijke uitkomst hebt gespecificeerd voor elke opeenvolgende stap die u hebt toegewezen voordat u doorgaat naar de volgende fase van het schrijven van een gebruikershandleiding. Voordat u doorgaat naar het volgende niveau, moeten de lezers volledig duidelijk zijn over wat ze willen bereiken en hoe het eruit moet zien. - Gebruikersreis in kaart brengen
Begrijpen hoe uw consumenten van plan zijn uw product te gebruiken en het voor hen eenvoudig maken om dat te doen, zijn de doelen van het produceren van een gebruikershandleiding. U moet moeite doen om het probleem te begrijpen dat de consument probeert op te lossen of het doel dat hij probeert te bereiken door uw oplossing te gebruiken, evenals hoe hij met uw bedrijf omgaat. U kunt de stappen plannen die nodig zijn om de klant door het proces te leiden met behulp van deze details om hun reis van probleem naar oplossing te visualiseren. - Kies een sjabloon
De taak van het schrijven en ontwikkelen van gebruikershandleidingen kan veel eenvoudiger worden gemaakt dan u zou verwachten door een reeks sjablonen te maken. Uw procedure kan worden gestroomlijnd en consistentie zou een veel realistischer doel worden.
In uw gebruikershandleidingsjabloon moet u, naast details als lettertypen (lettertype en -grootte), contrastvereisten en kleurenschema's, ook het volgende opnemen:- Gebied toegewezen voor een introductie
- Duidelijke subsecties en secties
- Het door u gekozen formaat voor het overbrengen van een reeks acties
- Waarschuwingen en voorzorgsmaatregelen
- Gebied toegewezen voor een conclusie
- Schrijf eenvoudige en gemakkelijk te volgen inhoud
Het materiaal van uw gebruikershandleiding moet zo eenvoudig en begrijpelijk mogelijk zijn. Het is belangrijk om na te denken over en te analyseren over de opmaak en inhoud voor duidelijkheid en gemak.
Zorg ervoor dat elke fase van het proces slechts één taak beschrijft en gebruikmaakt van zo helder en kort mogelijke taal. Zorg ervoor dat u uw tekst goed aanpast totdat u een gebruikershandleiding hebt die alleen de informatie bevat die echt nodig is. - Benader elke gebruiker als een beginner
Ga ervan uit dat de lezer van uw gebruikershandleiding geen voorkennis heeft van uw product wanneer u deze maakt. Schrijf alsof u met een leek spreekt.
Elk gebruik van jargon of technische taal moet worden vermeden. Natuurlijk zullen er momenten zijn waarop het moet worden vermeden, maar dit zou de absolute uitzondering moeten zijn. - Test de instructies van het product met beginnende gebruikers
De testfase van het proces van het maken van de gebruikershandleiding is cruciaal. Het onderwerp van het experiment heeft een significante impact op de uitkomst.
Testen zou idealiter moeten worden uitgevoerd op mensen die uw product nog nooit hebben gebruikt of de documentatie hebben gezien. Terwijl u de gebruikershandleiding doorneemt, observeert u hen terwijl ze het proces voltooien en registreert u waar ze vastlopen. Vervolgens moet de informatie op de juiste manier worden bijgewerkt.
Alleen de hulp van de gebruikershandleiding zou nodig moeten zijn voor uw testers om het product te bedienen. Ze zouden niet om meer assistentie hoeven te vragen. De USSR-gids zou alle informatie moeten bevatten die ze nodig hebben. - Bouw content met een praktische aanpak
Er moet alles aan worden gedaan om concrete examples en gedetailleerde beschrijvingen van alle uitkomsten die gebruikers kunnen ervaren na het volgen van elke stap in de gebruikershandleiding. De gebruiker moet op de hoogte zijn van alle feedback die hij/zij van het product kan krijgen, evenals alle mogelijke beelden of geluiden die hij/zij onderweg kan tegenkomen. - Leg symbolen, iconen en codes vroegtijdig uit
U moet mogelijk pictogrammen, symbolen of codes gebruiken bij het schrijven van een gebruikershandleiding om de benodigde instructies te geven. Om verwarring of frustratie bij de lezer te voorkomen, is het cruciaal om deze zo vroeg mogelijk in uw gebruikershandleiding te identificeren.
Veelgestelde vragen over de gebruikershandleiding
Wat zijn gebruikershandleidingen precies?
Gebruikersdocumentatie is informatie die wordt verstrekt in de vorm van gebruikershandleidingen of gebruikersgidsen en is bedoeld om eindgebruikers te helpen succesvol met een product te communiceren.
- Welke soorten gebruikersdocumentatie zijn er?
Fysieke documentatie, zoals boekjes of handleidingen, werd traditioneel gebruikt om gebruikersdocumentatie aan te bieden. Tegenwoordig worden gebruikershandleidingen vaker digitaal geproduceerd en verspreid. - Wat staat er in gebruikershandleidingen?
Een instructiehandleiding of gebruikershandleiding gebruikt een goed ontwerp, duidelijke tekst en een focus op probleemoplossing. Ik moet een inhoudsopgave hebben, me houden aan een logische hiërarchie en flow en inhoud bieden die toegankelijk is. Bovendien is een goede gebruikershandleiding doorzoekbaar en houdt rekening met gebruikersreviews. - Hoe wordt een gebruikersdocument gemaakt?
Eenvoudige stappen kunnen worden gebruikt om gebruikershandleidingen te ontwikkelen. De doelstellingen van de gebruikershandleiding moeten eerst worden bepaald en er moet een strategie worden ontwikkeld om de verwezenlijking ervan mogelijk te maken. De gebruikershandleiding moet worden getest en bijgewerkt indien nodig voordat deze wordt gepubliceerd. Tot slot is het belangrijk om de gebruikershandleiding up-to-date te houden en wijzigingen aan te brengen wanneer er nieuwe updates of edities worden toegevoegd.