Hur man skapar en användarhandbok i 2023

Avatar of Author
Tal F
on May 04, 2021 · · filed under Product Documentation Product Management Documentation Portals Product Updates Best Practices
Enkel steg för steg-guide

Så du har äntligen bestämt dig för att skriva en ny användarhandbok om din fantastiska produkt.

Det man inser 2021 är att det fortfarande är en manuell process att skapa en användarguide. Du skaffar den näst bästa appen för att skapa din användarguide och börjar sätta ihop innehållet.

Så hur börjar man, varför börjar man, varför behöver man ens en användarguide (duh...)? Jag kommer att försöka besvara några av de vanligaste frågorna om att skapa användarguider samt ge dig en guide för att hjälpa dig att skapa din första användarguide i Docsie, men du kan bokstavligen använda vilket annat verktyg som helst...

Skäl och fördelar med att skapa en användarhandbok

Det finns många anledningar att skapa användarguider. Användarhandledningar är mycket användbara och spelar en avgörande roll för konsumenter, elektronik, programvaror och alla aspekter av materiella eller immateriella produkter. Användarhandböcker ger dina användare enkla steg-för-steg-instruktioner om hur man använder och/eller monterar produkterna.

Dina kunder behöver få information om de produkter som du säljer, de tjänster som du tillhandahåller eller de metoder och rutiner som de måste följa. De erbjuder en steg-för-steg-process där dina kunder kan lära sig hur man använder och utbilda sig om din produkts olika egenskaper och funktioner.

Att skapa korrekta användarhandböcker begränsar det juridiska ansvaret för produkter:

Användarguider begränsar också ansvaret för felaktig användning av dina produkter. En användarguide är mycket praktisk för produkter som kan orsaka personskador eller till och med dödsfall om de inte används eller monteras på rätt sätt. Till exempel: högspänningsutrustning, brandgenererande utrustning och till och med lasrar kräver omfattande manualer för att skydda kunden från felaktig användning.

Att skapa bra användarhandböcker sparar tid:

Användarhandböcker av god kvalitet innehåller instruktioner om hur dina produkter ska användas, vilket kan spara mycket tid för ditt tekniska team som måste förklara saker eller säljteam som måste göra demos. Många komplicerade programvaruprodukter kräver bra tekniska användarhandböcker för att hjälpa sina kunder att lära sig hur man använder produkterna på bästa sätt. Programvaror bombarderas normalt av många funktioner och att ha rätt mängd användarguider för att förse kunden med användbar information kan på lång sikt hjälpa till att behålla kunder och spara tid på att förklara hur olika aspekter av programvaran och komplicerade produkter ska användas.

Utbilda dina kunder om hur dina produkter används:

Att utbilda kunderna om tekniska produkter är mycket viktigt. Utan ordentliga användarguider kan dina kunder bli förvirrade av en mängd dolda funktioner och inte veta hur de ska använda den tekniska produktens fulla potential. Användarguider gör det enkelt för dina kunder att lära sig de olika tekniska aspekterna av din produkt och känna sig bekväma med att ha en användarguide till hands när de behöver fördjupa sig i dina produkter. Det kommer att minska stressen för dem att försöka lista ut saker utan formell skriftlig vägledning. Även för produkter som är farliga att använda kan användarguider innehålla varningar mot att missbruka produkterna på ett farligt sätt.

Vad gör en bra användarguide

Så för att börja göra en användarguide måste du förstå vilket problem du försöker hjälpa till att lösa för en specifik kund. Att göra en användarguide för allt om allt förvandlar den till en obegriplig röra som ingen kommer att förstå inklusive dess målgrupp. Om du tittar på några av de bästa exemplen på användarguider online, skrivna av superstjärnföretag som Stripe eller Slack. Du kommer att märka ett särskilt mönster.

Varje användarguide fokuserar på att lösa ett visst problem.

Så vad ska varje guide göra? Den bör fokusera på enkla åtgärder som din användare kan utföra genom att följa den här guiden. Det finns inget behov av komplikationer. Tvärtom, om du fokuserar på att ta upp vanliga enkla åtgärder som hjälper dina användare att lösa vanliga enkla problem med din produkt, kommer du att få en uppsättning fantastiska användarguider som dina kunder kommer att älska.

Så låt oss titta närmare på några användarguider för att förstå vad som är strukturen i en fantastisk användarguide så att vi kan ta det som en referenspunkt för hur vi själva kan skriva en fantastisk användarguide.

Så vad krävs för en bra användarguide?

Låt oss titta på Managing Book-guiden ovan och ta fram några punkter för

Organisera dina användarhandböcker

Använda Docsie för att skapa användarhandböcker

Docsie har olika verktyg och funktioner som gör att du kan skapa fantastiska användarguider. Låt oss först ta en titt på hur Docsie fungerar. Docsie fungerar med utgångspunkt från böcker, hyllor och samlingar.

Samlingarna används för att isolera olika böcker som du vill visa för olika typer av kunder. Till exempel används denna samling för att endast visa Business Users. Detta innebär att vi endast valde 3 böcker från alla de böcker som skapats för att visa dessa specifika kunder.

Detta är användbart när du har flera olika typer av kunder som använder olika delar av dina produkter. Detta görs smidigt på Docsie genom att klicka på de tre punkterna bredvid "All" och trycka på add.

När du är i Docsies Collection-verktygsfält kan du skapa namnet på din samling och också välja vilka användarhandböcker du vill ha i den här specifika samlingen. Anledningen till att detta är viktigt är att olika kunder kan behöva känna till olika användarguider för dina produkter och detta verktyg gör att du bara kan visa de specifika användarguider som de behöver se.

Låt oss nu komma igång med att skriva din första användarguide med Docsie, detta görs med Docsies "Book"

Tänk på en bok som din användarguide eller manual. I din öppnade bok kommer du att se redigeraren, en plats att skapa "artiklar" och rubriker.

Redaktören överst, möjligheten att skapa olika versioner och språk i det övre vänstra hörnet och naturligtvis "Artiklar och underrubriker till vänster.

Redaktören är enkel att använda, den låter dig lägga till videor, bilder och kod med vår enkla att använda dra och släpp-process. Det gör också att du kan stilisera din kontekt som du tycker passar.

Artiklar är verkligen lätta att skapa; skriv bara in din titel. I det här fallet är titeln "Vad är Docsie", men du kan skriva in vad du vill som titel på din användarhandbok.

För att skapa underavsnitt i dina användarhandböcker som visas som 1.1,1.2..ext behöver du bara välja platsen för din text och ange texten som "Header", detta görs genom att klicka på H i redigeringsfliken.

Med Docsie kan du också skapa olika versioner och språk av dina användarguider. Detta är mycket användbart och praktiskt för lokalisering och för att prata om olika ändringar av dina produktanvändarhandböcker.

När du har förberett dina användarhandledningar, skrivit dem, stiliserat dem med foton som hjälper dig att förklara de olika aspekterna av dina produkter och funktioner är nästa steg att publicera dem.

För att sammanfatta, här är tips och tricks för att skapa en användarhandbok

De flesta programvaror och tekniska produkter är mycket komplexa och mångfacetterade. För att lösa problemet med att skapa en användarguide för komplexa produkter är det en bra idé att bryta ner informationen och instruktionerna i mindre delar. Det innebär att man skapar flera små användarhandledningar och sammanställer dem i en användarhandledning.

Dina kunder är inte bekanta med din produkt eller tjänst. Ju mer teknisk din produkt är, desto mer beskrivande bör dina användarguider vara i skapandefasen. Vaga ord och fraseologi kommer inte att vara din vän i den här processen. Var så specifik som möjligt så att din kund kan förstå även de mer avhjälpande aspekterna av din produkt.

En bild är värd mer än tusen ord. Detta gäller i synnerhet för användarguider och manualer. Detta steg försummas av de flesta företag, men det är mycket viktigt att ha rätt foton eller ögonblicksbilder av dina produktfunktioner och aspekter av din produkt samtidigt som du förklarar dem i dina användarguider. På så sätt kan din kund förstå vilka aspekter av din produkt du hänvisar till.

Dina användarguider är utformade för att hjälpa dina kunder att förstå de olika användningsområdena för dina produkter. Förklara saker på ett så enkelt sätt som möjligt så att de lätt kan förstå deras olika funktioner och aspekter.


Subscribe to the newsletter

Stay up to date with our latest news and products