Användarguider är en viktig del av digitala tjänster. Digitala kunder förväntar sig tillgång till självbetjäning och kräver omedelbar tillgång till information. Det räcker inte längre med en genomgång via telefon; timmar av tid går åt till att förklara saker som kan illustreras bättre i användardokumentationsguider.
På Docsie förespråkar vi att alla företag ska skapa ett bibliotek med informativa användarhandböcker för kunderna. Detta kommer att möjliggöra självbetjäning, minska din arbetsbelastning för support och ge tillgång dygnet runt i realtid till den information som dina kunder behöver för att kunna njuta av och arbeta med din produkt eller tjänst.
10 bästa tips för användarguider och dokumentation i Docsie
Innan vi börjar, har du ett sätt att lagra, skriva och hysa dokumentation?
Gå över till sidan Docsie Onboarding för kundcentrerat samarbete, omfattande inbäddning, skräddarsydda översättningar och kraftfull publicering inom räckhåll.
Nu när du har anslutit dig till klubben, låt oss hoppa in i våra 10 bästa tips!
1 - Berika dina användarhandledningar med media
Text, ord, bokstäver - vi använder dem varje dag. Tyvärr kan det skrivna ordet inte jämföras med videons sanningshalt eller bildernas inspiration.
När du skapar guider för användardokumentation ska du läsa den ur användarens perspektiv. Skulle det här avsnittet kunna förklaras bättre i en GIF, inbäddad video eller kommenterad bild? Om så är fallet, lägg till en sådan!
Du kan lägga till bilder, bädda in videor och integrera iFrame-innehåll i Docsie. Prova det!
![Bilder, videor och GIF:er i Docsie] (https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_CdhFEVXwXaefNXxxg/boo_dqsfhc7ObadQ3xWmV/e0eda1c6-284a-3e0f-5c43-0ff4099966d0BlogGIF10TipsforUserGuides.gif)
2 - Skapa en order, inte av Jedi-typ!
Steg-för-steg-instruktioner är pelaren i kokböcker överallt! När du följer ett recept, blandar du då ihop ägg och mjöl? Det är vad du ska göra, och du vet det eftersom du följer stegen!
Skämt åsido, se till att du går igenom alla användarhandböcker med steg-för-steg-instruktioner. Om du följer stegen, får du då verkligen det resultat som du tänkt dig? Felaktiga instruktioner som inte ger det avsedda resultatet är en stor röd flagga för kunderna. Korrekta instruktioner å andra sidan inger förtroende och ger kunderna och företaget värde genom informationsdelning.
Skapa en ordning med hjälp av de numrerade listorna i Docsie eller med Docsie Book Articles för att segmentera din dokumentation.
3 - Anpassning till alla läsnivåer
Tror du att kunderna kan JavaScript från dina bästa tips? Att använda jargong och komplex terminologi rekommenderas vanligtvis i samband med tekniska användarhandböcker. För lekmän är det dock bättre att använda ett enklare språk!
De flesta läsare vill bara veta hur man gör en sak, och upprepa den. En metod är att leverera ett komplext koncept på hög nivå på papper - och sedan upprepa det igen i en förenklad version för lekmän. På så sätt kan både tekniska användare och lekmän nås på en och samma gång, genom att två sidor skrivs in med en penna.
"Artificiell intelligens innebär algoritmisk emulering av mänsklig intelligens i strävan efter produktivitet; artificiell intelligens syftar till att få arbetet gjort genom att matcha mänsklig intelligens med hjälp av datorkod." - De betyder båda samma sak, men riktar sig till olika målgrupper.
Använd Docsie för att skapa hyllor för lekmän och hyllor för tekniska användare. På så sätt kan du ha böcker för båda målgrupperna, med fullt värdskap tillgängligt via Docsie-portalen.
![Komplex kod förenklad för lekmän i Docsie-exempel] (https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_cnLx3DDYwihXopx74/boo_dqsfhc7ObadQ3xWmV/411ea34c-096b-3bf2-fde0-2f8fdaddd55aLaypersonSimplificationforDocsie.png)
4 - Använd mallar och sluta vara uppe sent!
Skriver du om varje användarhandbok från grunden? Istället bör du skapa mallar med grundläggande strukturering och varumärkesbudskap och bygga runt detta innehåll.
Att skriva från grunden tar tid, ansträngning och riskerar inkonsekvens om flera skribenter arbetar inom samma projekt. Mallar är ett utmärkt sätt att spara tid vid skrivandet och skapa större enhetlighet mellan sidorna. Förtroende byggs på konsekventa budskap och värdeskapande, vilket mallar främjar.
Klicka på ...Mer och välj Mallar i Docsie. Här kan du lagra mallar och starta nya böcker med mallen som källa!
![Mallar i Docsie] (https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_Hv9JSg74vQE1zgYjT/boo_dqsfhc7ObadQ3xWmV/833830aa-871c-d3ba-19e7-0fbbba2adbfbTemplatesinDocsie.png)
5 - Skriv snabbt, gör ofta om det
Inom agil mjukvaruutveckling är mantrat att misslyckas snabbt och iterera ofta. Om man tillämpar detta på användardokumentationsguider bör din personal sträva efter att skriva snabbt och iterera ofta.
Detta innebär inte att du måste offra kvalitet för att få fart. Istället gör detta det möjligt att få feedback och svar från kunderna med mindre initialt arbete. Denna feedback kan utnyttjas i ytterligare iterationer av användardokumentationsguider och hjälper företaget att bli mer kundorienterat.
Docsie Vocally belyser läsarfeedback, med betyg och skärminspelningar för att fastställa exakt vilket innehåll de läste. Pröva det när du skriver snabbt och itererar ofta!
6 - Nästad kunskap med interna baklänkar
Är dokumentationen i din användarhandbok backlinkad med andra sidor? Genom att lägga till länkar till relevanta delar av dokumentationen hjälper du läsarna att konkretisera och förstå din produkt eller tjänst på en konceptuell nivå.
När du hänvisar till en viss funktion eller ett specifikt inslag ska du alltid lägga till en länk. Låt läsaren snabbt få tillgång till informationen, i stället för att tvinga honom eller henne att söka och ladda sidan själv. Pratar du om inloggningar till konton? Lägg till en URL för inloggning till texten "logga in på ditt konto" på din sida, och på alla andra sidor. Gör din dokumentation bekväm och navigerbar i brödtexten, i stället för att vara ett oändligt bibliotek att gå igenom.
Docsie gör det möjligt för författare av användarhandböcker att skapa interna baklänkar. Markera bara lite text och klicka på knappen 🖇️ i verktygsfältet i Docsie Editor. Dessutom kan du göra länkar språk- och versionsdiagnostiska med Relativa objektlänkar .
![Backlinking in Docsie With Object Reference Links] (https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_dclZdrsTWJrB8WETc/boo_dqsfhc7ObadQ3xWmV/7d8c9e37-3aa6-580d-644b-0d7a8039fa89DocsieObjectLinksforBacklinking.png)
7 - Borsta bort spindelväven och uppdatera gammalt innehåll
Har du gamla användarhandböcker och dokumentation som är synliga på nätet? Om du har dokumentation för version 1.2 publicerad medan din produkt är i version 1.3 är din dokumentation inte längre relevant. Använd Docsie Versioning i stället för att publicera ny dokumentation för varje version.
Docsie Versioning gör det möjligt för användare att få tillgång till historiska och aktuella dokumentationsversioner. När nya versioner släpps arkiveras de gamla versionerna i redundanssyfte samtidigt som de är tillgängliga från en rullgardinsmeny. Allt detta finns på samma webbsida, vilket gör det lättare för användarna att bläddra och hitta relevant information.
På samma sätt, om din guide med bästa tips för 2021 fortfarande publiceras 2022, uppdatera den! Ändra namnet, uppdatera alla citat och källor med uppdaterad forskning och dubbelkontrollera att informationen fortfarande är relevant. Borsta bort spindelväven och se till att allting är ständigt aktuellt; innehåll kan alltid användas på nytt.
![Versionsplockare för att hitta äldre innehåll i Docsie] (https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_OaCUumTVGz3CQ2ha2/boo_dqsfhc7ObadQ3xWmV/4edbd225-b61b-0921-4f63-e55b3052ed28DocsieVersionsPickerMenu.png)
8 - Miniatyrisera uppgifter, slutför dem i omgångar
När du skriver, skriver du hela sidan i ett svep utan någon som helst förplanering? En del av detta handlar om personliga preferenser för skribenter. Genom att miniatyrisera uppgifterna kan arbetet dock slutföras snabbare och med mer fokus.
Skapa en enkel struktur med H1- och H2-taggar och korta beskrivningar för varje avsnitt. Använd detta när du skriver och ta itu med enskilda avsnitt i stället för att oroa dig för hela sidan. Detta kallas för en översikt i skrivbranschen. Översikten ger möjlighet till återkoppling med redaktörer innan skrivandet påbörjas och fungerar som en vägledande ram när skribenten skriver.
Skapa en ny bok i Docsie och lägg till några grundläggande rubriker och text för en översikt. Du kan också lägga till uppgifter i menyn till höger, så att arbetet kan delas upp i mindre partier när flera gruppmedlemmar samarbetar om innehållet. Versionshistorik innebär att du kan gå tillbaka om en skribent lägger till mindre bra innehåll - perfekt för att skriva snabbt och iterera ofta!
![Kalender för uppgiftsfördelare i Docsie] (https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_4JCx9FdXnyXu3quMX/boo_dqsfhc7ObadQ3xWmV/d3468298-7bc2-7f51-7afe-2437f6321658TaskMiniaturizeCalendarDocsie.png)
9 - En innehållsförteckning för fler läsare av innehåll
När det gäller komplex och varierad användarhandboksdokumentation kan en vägg av text vara skrämmande för läsarna. Detta kan lösas med en omfattande innehållsförteckning. Detta används vanligen i uppslagsverk och hjälper användarna att identifiera och hoppa till relevant information, samtidigt som det ger struktur åt en kunskapsportalmiljö.
Docsie Articles, Shelves och Workspaces fungerar för att skapa en innehållsförteckning. Den visas automatiskt på vänster sida i din kunskapsportal och ger ett enkelt sätt att navigera i din kunskapsbas. Med detta topptips gör Docsie det åt dig!
![Innehållsförteckning som genereras automatiskt av Docsie] (https://cdn.docsie.io/workspace_tovPs7rKnzB4cmaiR/doc_GzKTESk1IUWjA77hg/file_oxDNcw0pA6rCZa3J7/boo_dqsfhc7ObadQ3xWmV/35d48662-895e-b83f-c7c3-abb0ce6edd0dTableofContentsDocsie.png)
10 - Bemästra ditt ämne
Är din skribent en ämnesexpert? Är din skribent på samma sätt uppfinningsrik och duktig på att undersöka ämnen som han eller hon kanske inte är bekant med? I slutändan, trots alla våra tips, är det författaren som bestämmer kvaliteten på dina användardokumentationsguider.
Ju mer de förstår din produkt, desto mer korrekt kommer deras arbete att vara. Ge skribenterna flexibilitet att testa och bryta din produkt, eftersom användarna kan stöta på liknande problem. Ännu bättre är det om du låter din skribent gå igenom en produktdemonstration tillsammans med ditt säljteam och ger dem praktisk erfarenhet av försäljningspipelinen och de budskap som finns i den. Även detta leder till enhetlighet och gör dina skribenter till användare. Alla skribenter blir inte användare, men alla användare kan bli bra skribenter med praktisk kunskap.
Tillämpa de här tipsen i Docsie!
Tack för att du läste våra 10 bästa tips för bättre användarhandböcker. Vi uppmanar dig att tillämpa dessa tips på dina Docsie-dokument!
Docsie är en plattform för dokumentationshantering från början till slut som företag använder för att skapa webbaserade vanliga frågor och svar, produktdokument, användarhandböcker, hjälpdokument och användarhandböcker. Plattformen har kundcentrerat samarbete, omfattande inbäddning, skräddarsydda översättningar och kraftfull publicering till hands.
Ta steget genom onboarding med Docsie idag och leverera dokumentationsglädje till dina kunder!