Innehåll
dölja
Hur man skriver tydliga och koncisa användarmanualer
Vad är en användarmanual?
Det finns olika namn på en användarmanual. Tekniska dokument, underhållsmanualer och bruksanvisningar är alla namn som refererar till samma artikel. En användarmanual är gjord för att hjälpa kunder att använda din produkt eller tjänst korrekt eller lösa problem som uppstår under användning. De kan göras tillgängliga i tryckt, digitalt eller båda formaten.
Användarmanualer ger slutanvändaren omfattande steg-för-steg-instruktioner och visst stöd för problem. En innehållsförteckning bör finnas i varje användarmanual eftersom de är referensmaterial snarare än böcker som bör läsas från början till slut. Du bör lägga till en snabbstarts- eller starthandledning i din användarmanual så att användarna lätt kan känna sig bekväma med att börja använda produkten.
typer av användarmanualer
För en mängd olika ämnen och syften kan användarmanualer tas fram. Här är några av dina möjligheter, så låt oss titta på dem.
- Instruktionsmanual
En bruksanvisning är en typ av användarhandledning som ger enkla instruktioner för att använda en produkt på det sätt som den var tänkt att användas. - Träningsmanual
Denna typ av användarhandbok erbjuder en lista med riktlinjer för att slutföra en viss uppgift, projekt eller jobb. - Servicemanual
Servicemanualer är användarguider som beskriver hur man sköter och underhåller en maskin eller utrustning på olika platsertagdess livslängd. - Användarmanual
Användarmanualer är tekniska publikationer som förklarar hur man använder eller använder en produkt på rätt sätt. - Bruksanvisning
Roller, uppgifter och procedurer som är specifika för ett företag eller en organisation beskrivs i bruksanvisningar. - Handbok för organisationspolicy
En organisationspolicymanual är den dokumentation som definierar ett företags policyer, praxis och bästa praxis. - Handbok för standarddriftsprocedurer (SOP).
Användare drar nytta av en standardmanual med detaljerade instruktioner för att utföra etablerade procedurer.
Varför behöver ditt företag användarmanualer?
Människor är bättre rustade att hantera problem på egen hand med stöd av en användarmanual. En anständig användarmanual kan ge dina kunder de verktyg de behöver för att snabbt och effektivt uppnå det värde de önskar av din produkt eller tjänst i dagens omedelbara tillfredsställelsekultur.
Utmärkt kundservice behöver kompletteras med användarmanualer. Att skriva utmärkta användarmanualer ger följande fördeltages för ditt företag:
- För att göra onboarding och utbildning enklare
Välskrivna användarguider kan göra introduktions- och utbildningsprocedurerna enklare. Det är korrekt, genom att utveckla och implementera förstklassiga användarmanualer kan både dina anställda och dina konsumenter vinna.
Ditt företag kan använda användarguider för att hjälpa nyanställda att gå igenom några av de processer och system som ingår i deras nya roller snarare än att bara sätta upp svåra personliga utbildningssessioner, som har betydande tid och ekonomiska kostnader. Eftersom anställda kan lära sig medan de utför de uppgifter som är relaterade till deras positioner tack vare användarguiderna, kan det gå färre timmar förlorade under onboarding. - För att minska supportkostnaderna
Användarguider är ett bra komplement till dina kundtjänstinsatser för konsumenten, men de tjänar också företagsägaren väl som en del av kundsupportsystemet.
Kunder är mer benägna att hitta lösningar direkt och är mindre benägna att behöva kontakta en tekniker eller representant för specialiserad support när du ger dem snabb tillgång till en sökbar användarguide. - För att spara tid
Både dina kunder och dina anställda, från nybörjarpersonal till ledning, kan spara tid genom att använda användarmanualer. När användarmanualer är tillgängliga för dina kunder behöver de inte slösa tid på att försöka hitta information om hur man använder en produkt eftersom de kommer att ha direkt tillgång till den informationen direkt.
När dina anställda är utrustade med användbara användarmanualer behöver de inte slösa tid på att självständigt leta upp lösningar eller monopolisera uppmärksamheten från sina medarbetare och chefer med förfrågningar eftersom de har tillgång till lösningarna direkt i sin användarmanual! - För att minimera ansvar
Ett sätt att visa att du har testat din produkt grundligt och vet hur du använder den säkert är att skriva och distribuera användarmanualer. Detta kan avsevärt minska eventuella skyldigheter i samband med att producera något för allmänheten.
Att ha varningar och säkerhetsföreskrifter nedskrivna och tillgängliga för användarna via en användarguide är ett effektivt (men inte idiotsäkert) sätt att undvika juridiska problem relaterade till skador eller andra skador orsakade av felaktig användning om produkten du säljer kan vara farlig för användarna (tänk rumsvärmare, elverktyg etc.).
Vilka komponenter utgör de bästa användarmanualerna?
Det finns några bästa metoder för slutanvändardokumentation att följa oavsett vad, även om varje produkt är unik och kommer att behöva distinkta komponenter för att skapa verkligt utmärkt användardokumentation.
- Klartext
Ingenting kommer att irritera dina kunder mer – förutom att inte erbjuda en sådan – än att upptäcka att deras användarmanual är fylld av jargong och svårt att förstå språk. Dina användarinstruktioner är svåra att använda på grund av dessa språkval, som inte heller främjar enastående kundservice. Att se till att du skriver för användaren, inte utvecklaren, är en avgörande komponent för att skapa bra användarguider. Anta inte att din slutanvändare vet eller är bekant med någonting. Akronymer, jargong och kontorsterminologi kommer att få dina kunder att känna sig felinformerade, frustrerade och oförberedda. Den söta punkten för att producera en användarmanual är att hitta en balans mellan att inte skriva som om dina konsumenter är barn (såvida de inte är det såklart!) och att ge dem den extra hjälp de behöver för att helt enkelt förstå hur man använder produkten, på ett enkelt sätt språk. - Enkelhet
Att skriva en användarhandbok kräver att det är enkelt. Detta koncept bör återspeglas i både innehållet och designen. Om du överfyller din dokumentation med intrikata bilder och långa textavsnitt kommer den att framstå som för sofistikerad och svår att förstå. Denna typ av användarmanual kommer sannolikt att skrämma din användare och få dem att ringa din hjälplinje istället för att försöka reda ut problemet på egen hand. - Visuals
Maximen "Visa, berätta inte" är en hörnsten i skrivandet av användarmanualer. Annoterade skärmdumpar, filmer och annat visuellt innehåll är oerhört hjälpsamma för att förstå koncept. Det är ofta mycket mer användbart att se något i aktion än att läsa om det. Visuella bilder bryter inte bara upp långa textavsnitt, utan de minskar också mängden text i användarmanualer som kan vara skrämmande. Det har visat sig att människor behåller visuell information 7 % snabbare än skriftlig information. I en Techsmith-studie visades det också att 67 % av människorna utförde uppgifter mer effektivt när de fick instruktioner som inkluderade kommenterade skärmdumpar snarare än ord ensamma för att förmedla information. - Fokusera på problemet som ska lösas
Det är ganska troligt att någon har köpt din produkt för att åtgärda ett problem. Det är viktigt att hålla fokus på denna fråga när du utarbetar den användarmanual som kommer att inkluderas med produkten. Istället för att räkna upp och diskutera alla funktioner som din produkt erbjuder eller de spännande designelementen du har införlivat, informera dina användare om dem på ett sätt som underlättar produktens användning. Sätt problemet som löses i sammanhanget med din produkts funktioner och fördelar när du beskriver dem. - Logiskt flöde och hierarki
För att göra det uppenbart för användaren vad de kommer att lära sig från varje avsnitt i din användarmanual, använd rubriker och underrubriker som följer en tydlig hierarkisk struktur. För att utan ansträngning kunna leda dina kunder genom allt de behöver veta från början till slut, bör hierarkin du väljer följa ett logiskt flöde. Se till att du börjar med grunderna och införlivar en logisk utveckling mot produktens mer sofistikerade funktioner. - Innehållslista
Din användarhandbok kommer att vara till stor hjälp för läsarna om den börjar med en innehållsförteckning. Utan att behöva gräva igenom många sidor med information som inte är relaterad till det aktuella problemet de står inför, är det ett välbekant tillvägagångssätt för någon att snabbt och enkelt utforska ett dokument. - Gör det sökbart
Även om du kanske skriver ut dina användarmanualer, är det troligt att digital dokumentation kommer att vara din främsta prioritet. Det är ganska troligt att dina användarmanualer kommer att användas oftast i digitalt format i en värld där majoriteten av människor har en smartphone med sig hela tiden. Att lägga till en sökbar funktion i dina digitala användarmanualer kommer att främja en härlig användarvänlighet för användare som vill lösa ett problem genom att komma åt det, liknande hur en innehållsförteckning tjänar till att leda användare till rätt plats i ett tryckt dokument. - Tillgänglighet
Det är möjligt att några av de personer som behöver din bruksanvisning kan dra nytta av extra hjälp för att säkerställa att den fungerar korrekt. Oavsett om de är lagstadgade är tillgänglighetskrav i allmänhet god praxis. Att upprätthålla tillgänglighetskraven i dina användarmanualer är bara utmärkt affärspraxis. Att designa användarguider med innehåll som är tillgängligt för användare som kan ha visuella, hörbara eller kognitiva utmaningar är avgörande. - Väldesignad
Tänk på din målgrupp när du skapar dina användarguider. De kommer att vara mycket mer benägna att använda det effektivt om du gör något de tycker om att titta på! Undvik att använda långa textblock och ge gott om vitt utrymme. Att kombinera dessa två egenskaper kan hjälpa konsumenterna att verka mindre skrämmande och få att lära sig något nytt att verka spännande snarare än hotfullt. Metoden "visa, säg inte" som vi beskrev tidigare gäller även här. För både tryckta och digitala användarmanualer är det ett fantastiskt alternativ att lägga till bilder och foton i texten. För digitala användarmanualer erbjuder videor och GIF intresse och ett användbart inslag. Om ditt företag har en stilguide bör din design följa den; Annars, om du arbetar utan en, är det avgörande att hålla din användarhandbok konsekvent. Teckensnitt och färgscheman som används i hela papperet, och helst i alla dina användarhandböcker, bör vara konsekventa. - Kommentarer från faktiska kunder eller betatestare
Du kommer inte att kunna avgöra om användarguiderna du har förberett är så framgångsrika som möjligt förrän du har sökt upp och lyssnat på feedback från personerna som faktiskt kommer att använda din produkt. Användarguiderna du utvecklar för din produkt bör ta hänsyn till de problem som människor har med den. Du kanske lär dig något som verkar extremt uppenbart, men det finns mycket större chans att du lär dig något som hjälper dig att förstå behoven hos de kunder du försöker nå.
Hur skriver jag en användarmanual?
Att göra en användarmanual är en avgörande uppgift som kan ha stor inverkan på både ditt företag och de konsumenter du vill betjäna. Vi har förenklat processen att utveckla en användarmanual så att du enkelt kan följa med eftersom det kan vara överväldigande.
- Identifiera användarna
Att hitta mottagaren av din kommunikation är ett viktigt första steg, precis som med all annan kommunikation du genererar. Din användarmanuals avsedda målgrupp hjälper dig att bestämma frågor som tonen, detaljnivån som ska tillhandahållas och hur du ska leverera innehållet. Att skriva en användarhandbok för slutanvändaren av din produkt skiljer sig markant från att skriva en för en teknisk ingenjör. Det allra första steget är att bestämma din publik. - Fokusera på problemet
Användarmanualer är gjorda för att hjälpa till med problemlösning eller instruera någon om hur man gör något nytt. Du måste bestämma exakt vad din bruksanvisning är avsedd att göra och se till att behålla det fokuset.
Det kan vara frestande att bredda ämnet och diskutera många funktioner eller tillämpningar för din produkt. Detta kan frustrera användare och leda till samtal till din kundsupportlinje genom att grumla det genuina svar de behöver.
Om din kund är en konsument som lär sig att använda produkten eller en tekniker som behöver fixa det, koncentrera sig på den exakta lösning de kommer att kräva. - Använd ett sekventiellt tillvägagångssätt
Instruktionerna i din bruksanvisning bör läggas ut i den ordningsföljd som krävs för att avsluta det aktuella arbetet. Lista varje steg för att börja. Gör sedan ett försök att utföra uppgiften samtidigt som du följer de exakta stegen du har beskrivit i den givna ordningen. När du går igenom din ursprungliga lista är det möjligt, kanske till och med troligt, att du hittar några stagsom saknas. Dessutom kanske du upptäcker att något du en gång trodde var en enda uppgift faktiskt måste delas upp i flera aktiviteter för tydlighetens skull.
Se till att du har specificerat ett tydligt resultat för varje steg i följd du har tilldelat innan du går vidare till nästa fas av att skriva en användarhandbok. Innan du går vidare till nästa nivå bör läsarna vara helt klara över vad de vill ha uppnått och hur det ska se ut. - Kartlägg användarens resa
Att förstå hur dina konsumenter planerar att använda din produkt och göra det enkelt för dem att göra det är målen med att ta fram en användarguide. Du måste anstränga dig för att förstå problemet som konsumenten försöker lösa eller målet de försöker uppnå genom att använda din lösning, samt hur de engagerar sig i ditt företag. Du kan planera de steg som krävs för att vägleda kunden genom processen genom att använda dessa detaljer för att visualisera deras resa från problem till lösning. - Välj en mall
Uppgiften att skriva och utveckla användarmanualer kan göras mycket enklare än du kan förvänta dig genom att skapa en serie mallar. Din procedur kan strömlinjeformas och konsekvens skulle bli ett mycket mer realistiskt mål.
I din mall för användarmanualen bör du, förutom att definiera detaljer som typsnitt (typ och storlek), kontrastkrav och färgscheman, även inkludera följande:- Område avsett för en introduktion
- Distinkta underavdelningar och avsnitt
- Ditt valda format för att förmedla en rad åtgärder
- Varningar och varningar
- Område tilldelat för avslutning
- Skriv enkelt och lätt att följa innehåll
Materialet i din bruksanvisning ska vara så enkelt och enkelt att förstå som möjligt. Det är viktigt att tänka på och analysera formatet och innehållet för tydlighet och bekvämlighet.
Se till att varje fas i processen bara beskriver en uppgift och använder ett så tydligt och kort språk som möjligt. Se till att ändra din text ordentligt tills du har en användarmanual som bara innehåller den information som verkligen är nödvändig. - Närma dig varje användare som en nybörjare
Antag att läsaren av din bruksanvisning inte har några förkunskaper om din produkt när den skapas. Skriv som om du pratar med en lekman.
All användning av jargong eller tekniskt språk bör undvikas. Naturligtvis kommer det att finnas tillfällen då det måste undvikas, men dessa bör vara det absoluta undantaget. - Testa produktens instruktioner med nybörjare
Testfasen av processen för att skapa användarmanualen är avgörande. Ämnet för experimentet har en betydande inverkan på resultatet.
Tester bör helst göras på personer som aldrig har använt din produkt eller sett dokumentationen. När du går igenom användarmanualen, se dem när de slutför processen och registrera var de fastnar. Sedan bör informationen uppdateras på lämpligt sätt.
Endast hjälp av användarmanualen bör vara nödvändig för att dina testare ska kunna använda produkten. De borde inte behöva be om mer hjälp. USSR Guide bör ha all information de behöver. - Bygg innehåll med hjälp av ett praktiskt tillvägagångssätt
Alla ansträngningar bör göras för att erbjuda konkreta exampfiler och detaljerade beskrivningar av eventuella resultat som användare kan uppleva efter att ha följt varje steg i användarmanualen. Användaren bör vara medveten om all feedback de kan få från produkten, såväl som alla potentiella syner eller ljud som de kan stöta på på vägen. - Förklara symboler, ikoner och koder tidigt
Du kan behöva använda ikoner, symboler eller koder när du skriver en användarmanual för att ge nödvändiga instruktioner. För att förhindra förvirring eller frustration hos läsaren är det viktigt att identifiera dessa så tidigt som möjligt i din användarmanual.
Användarmanual Vanliga frågor
Vad är användarmanualer egentligen?
Användardokumentation är information som tillhandahålls i form av användarmanualer eller användarguider och är avsedd att hjälpa slutanvändare att interagera med en produkt framgångsrikt.
- Vilka typer av användardokumentation finns det?
Fysisk dokumentation, såsom häften eller manualer, har traditionellt använts för att erbjuda användardokumentation. Numera produceras och distribueras användarmanualer allt oftare digitalt. - Vad finns i användarmanualerna?
En bruksanvisning eller användarguide använder bra design, tydlig skrift och ett problemlösningsfokus. Jag måste ha en innehållsförteckning, hålla mig till en logisk hierarki och flöde och erbjuda innehåll som är tillgängligt. Dessutom kommer en bra användarmanual att vara sökbar och ta hänsyn till användarenviews. - Hur görs ett användardokument?
Enkla steg kan användas för att utveckla användarmanualer. Användarguidens mål måste först fastställas och en strategi måste utvecklas för att de ska kunna uppnås. Användarmanualen måste testas och uppdateras vid behov innan den publiceras. Slutligen är det viktigt att hålla användarhandboken uppdaterad och göra ändringar när nya uppdateringar eller utgåvor läggs till.