Enkel steg-för-steg guide¶

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

Det man inser 2021 är att skapandet av en användarguide fortfarande är en mestadels manuell process. Du skaffar den bästa tillgängliga appen för att skapa din användarguide och börjar sammanställa innehållet.

Hur börjar du, varför börjar du, varför behöver du ens en användarguide (självklart...)? Jag kommer försöka svara på några vanliga frågor om skapandet av användarguider samt hjälpa dig att skapa din första användarguide i Docsie, men du kan egentligen använda vilket verktyg som helst...

Anledningar och fördelar med att skapa en användarguide¶

Det finns många anledningar att skapa användarguider. Användarguider är extremt användbara och spelar en avgörande roll i konsumentvärlden, elektronik, mjukvaruprogram och alla typer av fysiska eller digitala produkter. Användarguider ger dina användare enkla, steg-för-steg-instruktioner om hur de använder och/eller monterar produkterna.

Dina kunder behöver lära sig om produkterna du säljer, tjänsterna du erbjuder eller metoder och procedurer de måste följa. Guiderna erbjuder en steg-för-steg-process där kunderna kan lära sig använda och utbilda sig själva om din produkts olika funktioner.

Bra användarguider begränsar produkters juridiska ansvar:¶

Användarguider begränsar också ansvar vid felaktig användning av dina produkter. En användarguide är mycket användbar för produkter som kan orsaka potentiella skador eller till och med dödsfall om de inte används eller monteras korrekt. Exempelvis: högspänningsenheter, brandfarliga apparater och även lasrar kräver omfattande manualer för att skydda kunden från felaktig användning.

Bra användarguider sparar tid:¶

Användarguider av hög kvalitet innehåller instruktioner om hur man använder dina produkter, vilket kan spara mycket tid för ditt tekniska team som annars behöver förklara saker eller säljteam som genomför demonstrationer. Många komplicerade mjukvaruprodukter kräver bra tekniska användarguider för att hjälpa kunderna att lära sig använda produkterna till sin fulla potential. Programvara har vanligtvis 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 din produkts användningsområden:¶

Att utbilda kunder om tekniska produkter är mycket viktigt. Utan ordentliga användarguider kan dina kunder bli förvirrade av mängden dolda funktioner och inte veta hur de ska använda den tekniska produktens fulla potential. Användarguider möjliggör en enkel process där dina kunder kan lära sig att engagera sig i produktens olika tekniska aspekter 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 tar bort stressen av att försöka lista ut saker utan formell skriftlig vägledning. För produkter som är farliga att använda kan användarguider också ge varningar mot missbruk av produkter på ett farligt sätt.

Vad gör en bra användarguide¶

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

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

Så vad bör varje guide göra? Den bör fokusera på enkla åtgärder som din användare kan utföra medan de följer guiden. Det finns inget behov av komplicerade förklaringar. 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 ha en uppsättning fantastiska användarguider som dina kunder kommer att älska.

Låt oss titta närmare på några användarguider för att förstå strukturen hos en fantastisk användarguide så att vi kan använda det som referenspunkt för hur vi själva kan skriva en bra användarguide.

Vad ingår i en bra användarguide?¶

Låt oss titta på guiden "Managing Book" ovan och komma fram till några punkter

Organisera dina användarguider¶

Använda Docsie för att skapa användarguider

Docsie har olika verktyg och funktioner som låter dig skapa fantastiska användarguider. Låt oss först titta på hur Docsie fungerar. Docsie arbetar med konceptet 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. Den här samlingen används till exempel för att visa endast företagsanvändare. Det betyder att vi valde bara 3 böcker av alla skapade böcker för att visa dessa specifika kunder.

Detta är användbart när du har olika typer av kunder som använder olika nivåer av dina produkter. Detta görs enkelt i Docsie genom att klicka på de tre punkterna bredvid "All" och trycka på lägg till.

När du är i Docsies samlingsfält kan du skapa namnet på din samling och också välja vilka användarguider du vill ha i den specifika samlingen. Anledningen till att detta är viktigt är för att olika kunder kan behöva känna till olika användarguider för dina produkter, och det här verktyget låter dig bara visa de specifika användarguider de behöver se.

Nu ska vi börja 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.

Redigeraren högst upp, möjligheten att skapa olika versioner och språk i övre vänstra hörnet och naturligtvis "Artiklar och underrubriker" till vänster.

Redigeraren är enkel att använda, den låter dig lägga till videoklipp, bilder och kod med vår enkla dra-och-släpp-process. Den låter dig också formatera ditt innehåll som du vill.

Artiklar är verkligen enkla att skapa; skriv bara in din titel. I det här fallet är typen "Vad är Docsie" men du kan skriva vad du vill som titel för din användarguide.

För att skapa underavsnitt i dina användarguider som kommer att visas som 1.1, 1.2 osv. behöver du bara välja placeringen av din text och ställa in texten som "Rubrik", detta görs genom att klicka på H i redigerarfliken.

Docsie låter dig också skapa olika versioner och språk av dina användarguider. Detta är mycket användbart för lokalisering och för att prata om olika varianter av dina produktguider.

När du har förberett dina användarguider, skrivit dem, format dem med foton som hjälper till att förklara de olika aspekterna av dina produkter och funktioner, är nästa steg publicering.

Sammanfattning: Tips och tricks för att skapa en användarguide¶

De flesta mjukvaru- och tekniska produkter är mycket komplexa och mångsidiga. För att lösa detta problem när du skapar en användarguide för komplexa produkter är det en bra idé att dela upp informationen och instruktionerna i mindre delar. Det innebär att skapa flera små användarguider och sammanställa dem i en användarguidemanual.

Dina kunder är inte bekanta med din produkt och/eller tjänst. Ju mer teknisk din produkt är, desto mer beskrivande bör dina användarguider vara i skapandefasen. Vaga ord och fraser kommer inte att vara till hjälp i denna process. Var så specifik som möjligt så att din kund kan förstå även de enklaste aspekterna av din produkt.

En bild säger mer än tusen ord. Detta är sant, särskilt för användarguider och manualer. Detta steg försummas ofta av de flesta företag, men att ha rätt foton eller skärmdumpar av dina produktfunktioner och aspekter av din produkt medan du förklarar dem i dina användarguider är mycket viktigt. 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 enkelt kan förstå olika funktioner och aspekter.