Top 15 Best Practices for Product Release Documentation

Det här misstaget lärde mig att jag måste se på vår produkt genom kundens ögon. Då tändes plötsligt ljuset. Om jag levererar en produkt som adresserar kundens problem och stödjer den med professionell produktdokumentation, kommer vi att ha en vinnare.

Jag upptäckte också att det inte är lätt att skapa professionell, estetiskt tilltalande och lättläst produktdokumentation. Men när det görs rätt kan produktdokumentation göra nöjda kunder ännu gladare och i slutändan öka intäkterna.

Vilka är de bästa metoderna för att skapa professionell produktdokumentation?¶

Dessa bästa metoder skapar estetiskt tilltalande, informativ och användarvänlig produktdokumentation. Genom att följa dessa riktlinjer kan du leverera produktdokumentation som förvandlar en bra kund till en fantastisk kund. Fantastiska kunder hjälper i slutändan företag att öka intäkterna, och produktdokumentation är en viktig del av kundupplevelsen.

1. Förstå din målgrupp och ge dem vad de vill ha¶

Det är viktigt att känna till din målgrupps förväntningar. Är produktdokumentationen till exempel avsedd för administratörer eller slutanvändare? Din målgrupp kan kräva teknisk skrivning för administratörer eller tydligt definierade termer och instruktioner för slutanvändaren.

En bra metod för att skapa professionell produktdokumentation är att förstå kundernas förväntningar på både administratörs- och slutanvändarnivå. Några sätt att samla information om målgruppen är:

• Frågeformulär och enkäter

• Upplevd återkoppling från målgruppen

• Brainstorming inom företaget

• Återkoppling från vanliga kundåsikter

• Rundabordssamtal med kunder

2. Skapa en dokumentationsplan¶

Att skriva en dokumentationsplan kan hjälpa dig att förutse potentiella flaskhalsar under projektets genomförande. Att skapa produktdokumentation kan vara utmanande, och en bra metod är att skapa en dokumentationsplan för att förutse problem som kan dyka upp under dokumentationsprocessen.

Bland fördelarna med att skapa en dokumentationsplan finns:

• Åtgärdspunkter - Granska befintlig dokumentation för att återanvända relevant information i den nya produktdokumentationsplanen.

• Observera mallar och stilguider - Om produktdokumentationen är för en ny produkt, se till att den följer branschens röst och stil. Om dokumentationen gäller en befintlig produkt, håll dig till nuvarande stilguider och mallar för att säkerställa varumärkets kontinuitet.

• Dokumentera processverktyg - Dokumentationsverktyg kan definiera och effektivisera produktdokumentationsprocessen samtidigt som de säkerställer teamarbetets kontinuitet och bättre förståelse för dokumentutvecklingsprocessen.

3. Förenkla produktdokumentationen¶

En studie från 2016 undersökte hur många användare som läser produktdokumentation. Resultaten var överraskande då de upptäckte att endast 25% av användarna läser produktdokumentationen. Undersökningen visade att anledningarna till att slutanvändare inte läser produktdokumentation delvis beror på:

• Användare är otåliga - Med tillgången till omedelbar information via webben blir användare mindre tålmodiga när de söker svar på sina problem. Att läsa produktdokumentation online eller offline kan vara mödosamt på grund av den stora mängden information som krävs för en viss produkt.

• Hoppa över-syndromet - Användare hoppar ofta över nödvändig produktdokumentation och går direkt till grunderna för hur produkten används. Användare lär sig och förstår hur produkter fungerar genom interaktion med produkten snarare än genom att läsa detaljerade instruktioner. Instruktionerna måste vara så tydliga och informativa som möjligt.

• Förvirrande layout och struktur - Manualer är ofta skrivna i ett format som är svårt att förstå och följa. Många användare tycker att produktdokumentationen är förvirrande eller irrelevant för deras fråga, blir frustrerade och tvekar att läsa manualen. Ofta har företaget inte genomfört detaljerad målgruppsanalys och inte korrekt förstått vad användaren behövde, vilket gjort dem för förvirrade för att fortsätta läsa.

4. Inkludera skärmbilder och grafisk information¶

Tänk på produktdokumentation som en vägkarta som berättar en historia om en produkt. Led kunden längs en väg som enkelt kan identifieras med skärmbilder eller annan grafik och hur varje grafik samverkar med de andra. Förklara tydligt vad användaren tittar på eller vad som händer när en funktion aktiveras, hur den reagerar på produkten och vad man kan förvänta sig härnäst. Se till att varje grafik har ett syfte och att produktens arbetsflöde fungerar tillsammans.

5. Använd korshänvisningar för tydligare förståelse av ämnen¶

Jag har upptäckt att korshänvisningar är ovärderliga vid läsning av produktdokumentation. Att förstå vad en funktion eller process gör underlättas enormt av korshänvisningar till relaterade ämnen. Genom att länka samman associerade datapunkter blir den övergripande bilden tydligare när det gäller hur systemet interagerar och fungerar.

6. Kom ihåg KISS-principen för produktdokumentation¶

Kom ihåg att använda KISS-principen (Keep It Simple, Stupid) när du skapar dokumentation. Det är viktigt att dokumentera processen grundligt men inte till den punkt där dokumentationen blir överdriven. Dokumentationsanvändaren kanske letar efter specifik information om vissa objekt, så att följa KISS-principen möjliggör mycket enklare navigering och förståelse av dokumentationen.

Till exempel kan enkla noteringar räcka för att förklara en funktion, kanske med en referens (korshänvisning) till huvudämnet. Håll fakta rena och inte överdrivna, så att användaren enkelt kan söka efter information som är relevant för deras behov. De kanske inte är intresserade av att läsa om varje aspekt av produkten.

7. Anpassa för olika inlärningsstilar¶

Varje person har en egen inlärningsstil. Vissa föredrar djupgående beskrivningar, medan andra kanske föredrar grafik och visuella presentationer. Vissa användare lär sig mer genom praktisk involvering än genom fokuserad läsning.

Se till att omfatta alla inlärningsstilar när du skapar effektiv och informativ produktdokumentation. Att infoga grafik som skärmbilder, diagram, strukturerad text eller videolänkar hjälper till att säkerställa att alla inlärningsstilar förstår produktdokumentationen.

8. Personalisera och strukturera introduktionsinnehåll¶

Anpassa produktdokumentationen baserat på målgruppens roll. Skapa olika versioner av dokumentationen baserat på den avsedda målgruppens roller vid introduktion av innehållet. En administratörs frågor kanske inte är relevanta för en avancerad användares frågor om dokumentationen.

Dokumentation kan införa ett lager av personalisering genom att skapa något olika versioner av dokumentet som är mer riktade mot den avsedda målgruppens roll. Att modifiera introduktionsinnehållet baserat på målgruppens roll ger dokumentationen ett personligt element.

9. Definiera tydligt termer för specifika målgrupper¶

Beroende på den avsedda målgruppen är det god praxis att förklara betydelsen av varje term som används i dokumentationen. Du kan använda mer komplexa termer med viss förklaring om målgruppen är intern. Men när externa användare får tillgång till dokumentationen finns det inget sätt att veta användarnas expertis.

Att tydligt definiera unika eller komplexa termer skapar mycket bättre och effektivare kommunikation för alla interna intressenter och externa användare.

10. Tillhandahåll en metod för att samla in användarfeedback¶

Feedback på dokumentation ger kraftfull information om dokumentets effektivitet. Tillhandahåll en länk eller en enkel knapp med "Gilla/Ogilla" för att samla värdefull information om dokumentationens kvalitet. Genom att samla in användarfeedback kan dokumentationen förfinas och förbättras.

11. Undvik dokumentation med platt struktur¶

När du skapar produktdokumentation, se till att dokumentationen inte är skriven som en "platt struktur". Att läsa ett dokument fullt av platt text är arbetsamt och kan också bli tråkigt. Läsarens intresse för dokumentationen ökar om informationen är relevant för det diskuterade ämnet och om läsaren snabbt kan ta till sig den.

Bryt upp den kontinuerliga, platta texten genom att markera utvald information eller integrera videor, bilder, länkar och andra metoder för att ge en bättre användarupplevelse. Genom att leverera dokumentinnehåll i "små bitar" får läsaren en trevligare upplevelse och blir mindre motvillig att läsa dokumentationen.

12. Skapa SEO-vänlig dokumentation¶

En god praxis för produktdokumentation online är att se till att den är skriven i en stil som är SEO-vänlig. Se till att dokumentationen är skriven för att maximera sökresultaten på internet för din dokumentation. Kunder kan behöva söka efter sin dokumentation, och när de inte har den direkta länken till webbplatsen är svaren snabbare och mer koncisa när dokumentationen är SEO-vänlig.

13. Håll produktdokumentationen uppdaterad¶

Att underhålla produktdokumentation är avgörande, särskilt om den är tillgänglig online. Ofta ändras produktkraven och online-dokumentationen måste återspegla eventuella nya ändringar eller uppdateringar. Användardokumentationen måste vara aktuell och uppdaterad för nyligen gjorda ändringar, och kunden måste meddelas om och bli medveten om ändringar i produktdokumentationen.

14. Förstå att användare kanske inte läser produktdokumentationen¶

En studie från 2014 visade att användare inte läste all produktdokumentation. De främsta orsakerna till att inte läsa dokumentationen var:

• Produktdokumentationen var alltför komplex

• Dokumentationen adresserade inte direkt deras frågor

• Användare använde inte många funktioner i produkten på grund av att de inte läste dokumentationen

• Istället för att läsa dokumentation föredrog många användare "praktiskt lärande"

15. Hantera både dynamiskt och statiskt innehåll¶

Produktdokumentation utvecklas kontinuerligt med uppdateringar, nya funktioner, korrigerat innehåll, uppdaterade underhållsmeddelanden och andra objekt. Denna uppdatering ses som ett levande dokument som ständigt utvecklas efter produktens krav.

Statiskt innehåll ger användaren data som inte förändras under produktens livstid. Idén med statiskt innehåll är att ge referenser till användare, särskilt nya användare, information som förblir statisk under produktens livscykel. Statiskt innehåll är viktigt för omfattande dokumentation men hamnar vanligtvis i bakgrunden jämfört med dynamisk dokumentation.

Att underhålla dokumentationsuppsättningen är enklare när innehåll klassificeras som antingen dynamiskt eller statiskt. Dokumentationen för produktens livscykel kan implementeras och valideras enklare när dokumentationen kategoriseras som dynamisk eller statisk. Det kan finnas mindre ändringar i dokumentationen för nya funktionsuppdateringar (statiskt) eller detaljerade produktuppdateringar (dynamiskt).

16. Bästa metoder för tillgänglighet av produktdokumentation¶

Även om användare inte nödvändigtvis läser mycket produktdokumentation, när de behöver den vill de ha den omedelbart. Den traditionella leveransmetoden för dokumentation var att ha en tryckt manual som följde med produkten. Men i dagens digitala, online-värld levereras dokumentation ofta via webben.

Oavsett hur produktdokumentationen levereras är det viktigt att ha lättillgängliga åtkomstpunkter. De dominerande metoderna för att tillhandahålla dokumentation idag är:

• Offline-dokumentation - Många produkter levereras med tryckta manualer eller "Snabbstart"-guider. Dessa dokument är vanligtvis engångsdokument och är inte lätta att distribuera. Många manualer tillhandahålls dock som alternativ i PDF-format, vilket främjar bärbarhet eller möjligheten att skriva ut på begäran.

• Online-dokumentation - Varje gång du söker på Google efter ett svar på ett problem hämtar du förmodligen ett utdrag av online-dokumentation. Webbens framväxt har ersatt utskrift av manualer eller produktdokumentationsmaterial för slutanvändare. Några av fördelarna med online-dokumentation är:

• Distansarbete - En sak som pandemin lärde oss är att arbeta hemifrån kan vara lika produktivt som på kontoret, särskilt när våra frågor besvaras med online-dokumentation.

• Samarbete - Med en lättillgänglig online-dokumentationsportal kan teammedlemmar dela information på direkten och skapa teamarbete, vilket ofta är omöjligt på kontoret.

• Mobilanpassning - Framväxten av mobila enheter som surfplattor och smartphones har långsamt ersatt datorer för daglig interaktion. Du kan enkelt komma åt online-dokumentation med en smartphone, och alla besvärande produktproblem kan enkelt undersökas, även på ditt favoritcafé under lunchen.