Användarguider är en viktig del av digitala tjänster¶

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 information. En genomgång över telefon räcker inte längre; timmar av förklaringar kan illustreras bättre i dokumentation.

På Docsie förespråkar vi att alla företag skapar ett bibliotek med informativa användarguider för kunder. Detta möjliggör självbetjäning, minskar supportbelastningen och ger kunderna tillgång till information dygnet runt, så att de kan använda din produkt eller tjänst på bästa sätt.

10 bästa tipsen för användarguider och dokumentation i Docsie

Innan vi börjar, har du ett sätt att lagra, skriva och publicera dokumentation?

Gå till Docsie Onboarding för kundcentrerad samverkan, omfattande inbäddningsmöjligheter, skräddarsydda översättningar och kraftfull publicering inom räckhåll.

Nu när du gått med i klubben, låt oss titta på våra 10 bästa tips!

1 - Berika dina användarguider med media

Text, ord, bokstäver – vi använder dem varje dag. Tyvärr kan det skrivna ordet inte jämföras med kraften hos video eller inspirationen från bilder.

När du skapar dokumentation, läs den ur användarens perspektiv. Kunde detta avsnitt förklaras bättre med en GIF, inbäddad video eller förklarande bild? Om ja, lägg till det!

Du kan lägga till bilder, bädda in videor och integrera iFrame-innehåll i Docsie. Prova det!

2 - Skapa en ordning, nej, inte Jedi-typen!

Steg-för-steg-instruktioner är grundpelaren i alla kokböcker! När du följer ett recept, blandar du ägg med mjöl hur som helst? 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ändarguider med steg-för-steg-instruktioner. Om du följer dessa steg, får du faktiskt det avsedda resultatet? Felaktiga instruktioner som inte når målet är en varningssignal för kunder. Korrekta instruktioner bygger förtroende och ger värde genom informationsdelning.

Skapa en ordning med numrerade listor i Docsie eller med Docsie Book Articles för att segmentera din dokumentation.

3 - Anpassa för alla läsnivåer

Antar du att kunderna kan skilja på JavaScript och dina bästa tips? Användning av fackspråk och komplex terminologi rekommenderas vanligtvis i tekniska användarguider. För lekmän är dock enklare språk bättre!

De flesta läsare vill bara veta hur man gör något och upprepar det. Ett tillvägagångssätt är att presentera ett komplext koncept på en högre nivå – och sedan upprepa med en förenklad version för lekmän. Detta tillgodoser både tekniska användare och lekmän samtidigt.

"Artificiell intelligens innebär algoritmisk emulering av mänsklig intelligens för produktivitet; artificiell intelligens syftar till att få arbete gjort genom att matcha mänsklig intelligens med datorkod." – båda betyder 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 som hjälper båda målgrupperna, med fullständig publicering via Docsie Portal.

4 - Använd mallar och sluta sitta uppe sent!

Skriver du varje användarguide från grunden? Skapa istället mallar med grundläggande struktur och varumärkesbudskap, och bygg runt detta innehåll.

Att skriva från grunden tar tid, kräver ansträngning och riskerar inkonsekvens om flera skribenter arbetar inom samma projekt. Mallar är ett bra sätt att spara tid och skapa större konsekvens mellan sidor. Förtroende bygger på konsekvent kommunikation 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!

5 - Skriv snabbt, iterera ofta

I agil mjukvaruutveckling är mantrat att misslyckas snabbt och iterera ofta. När detta tillämpas på användardokumentation bör ditt team sträva efter att skriva snabbt och iterera ofta.

Detta betyder inte att kvalitet offras för hastighet. Istället möjliggör det kundfeedback med mindre initial ansträngning. Denna feedback kan användas i framtida iterationer och hjälper företaget att bli mer kundcentrerat.

Docsie Vocally tydliggör läsarfeedback med betyg och skärminspelningar som pekar ut exakt vilket innehåll de läst. Prova det när du skriver snabbt och itererar ofta!

6 - Nästlad kunskap med interna bakåtlänkar

Är din användardokumentation länkad till andra sidor? Genom att lägga till länkar till relevanta avsnitt hjälper du läsarna att förstå din produkt eller tjänst på en konceptuell nivå.

När du hänvisar till en specifik funktion, lägg alltid till en länk. Låt läsaren snabbt få tillgång till informationen istället för att tvinga dem att söka och ladda sidan själva. Pratar du om kontoinloggningar? Lägg till en inloggnings-URL i texten "logga in på ditt konto" på din sida och varje annan sida. Gör din dokumentation bekväm och navigerbar i brödtexten istället för ett oändligt bibliotek att söka igenom.

Docsie låter dokumentationsskribenter skapa interna bakåtlänkar. Markera text och klicka på 🖇️-knappen i Docsie-redigerarens verktygsfält. Du kan också göra länkar språk- och versionsagnostiska med relativa objektlänkar.

7 - Damma av spindelnäten och uppdatera gammalt innehåll

Har du gamla användarguider och dokumentation synliga online? Om du har version 1.2-dokumentation publicerad medan din produkt är på version 1.3 är din dokumentation inte längre relevant. Använd Docsie Versioning istället för att publicera ny dokumentation för varje version.

Docsie Versioning låter användare komma åt historiska och aktuella dokumentationsversioner. När nya versioner släpps arkiveras gamla versioner men förblir tillgängliga från en rullgardinsmeny. Allt detta på samma webbsida, vilket gör det enklare för användare att hitta relevant information.

Om din guide för 2021 fortfarande är publicerad 2022, uppdatera den! Ändra namnet, uppdatera citat och källor med ny forskning, och dubbelkolla att informationen fortfarande är relevant. Håll innehållet tidlöst – det kan alltid återanvändas.

8 - Bryt ner uppgifter, slutför i omgångar

När du skriver, skriver du hela sidan på en gång utan planering? En del handlar om personlig preferens. Genom att bryta ner uppgifter 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 istället för att oroa dig för hela sidan. Detta kallas disposition i skrivbranschen. Dispositionen ger möjlighet till feedback från redaktörer innan skrivandet börjar och fungerar som ett ramverk när skribenten skriver.

Skapa en ny bok i Docsie och lägg till några grundläggande rubriker och text för en disposition. Du kan också lägga till uppgifter via högermenyn och bryta ner arbetet i mindre omgångar när flera teammedlemmar samarbetar. 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!

9 - En innehållsförteckning för fler innehållsläsare

Med komplex och varierad användardokumentation kan en textvägg vara skrämmande för läsarna. Detta kan lösas med en omfattande innehållsförteckning. Vanligt använd i uppslagsverk hjälper detta användare att identifiera och hoppa till relevant information, samtidigt som det ger struktur till en kunskapsportal.

Docsie Articles, Shelves och Workspaces skapar en innehållsförteckning. Denna visas automatiskt på vänster sida av din kunskapsportal – ett enkelt sätt att navigera genom din kunskapsbas. Med detta tips gör Docsie jobbet åt dig!

10 - Behärska ditt ämne

Är din skribent en ämnesexpert? Är din skribent resursstark och bra på att undersöka ämnen de kanske inte känner till? I slutändan, trots alla våra tips, bestämmer skribenten kvaliteten på din dokumentation.

Ju mer de förstår din produkt, desto mer korrekt blir deras arbete. Ge skribenter flexibilitet att testa och bryta din produkt, eftersom användare kan stöta på liknande problem. Ännu bättre, gå igenom en produktdemo med ditt säljteam och ge dem praktisk erfarenhet av säljprocessen och kommunikationen. Detta driver konsekvens och förvandlar dina skribenter till användare. Alla skribenter blir inte användare, men alla användare kan bli bra skribenter med praktisk kunskap.

Använd dessa tips i praktiken i Docsie!

Tack för att du läste våra 10 bästa tips för bättre användarguider. Vi bjuder in dig att tillämpa dessa tips på din Docsie-dokumentation!

Docsie är en heltäckande plattform för dokumentationshantering som företag använder för att skapa webbaserade FAQ, produktdokumentation, användarguider, hjälpdokument och manualer. Plattformen erbjuder kundcentrerat samarbete, omfattande inbäddningsmöjligheter, skräddarsydda översättningar och kraftfull publicering inom räckhåll.

Ta steget genom att registrera dig hos Docsie idag och leverera dokumentationsupplevelser som glädjer dina kunder!