De 15 bästa metoderna för dokumentation av produktreleaser

Detta misstag lärde mig att jag måste se på vår produkt genom kundens perspektiv. Då klickade den ordspråksmässiga ljusbrytaren "på". Om jag levererar en produkt som tar itu med kundens problem och sedan stöder den med professionell produktdokumentation kommer vi att ha en vinnare.

Och jag upptäckte också att det inte var någon lätt uppgift att skapa professionell, estetiskt tilltalande och lättläst produktdokumentation. Men om den görs på rätt sätt kan produktdokumentation göra nöjda kunder extatiska 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 lättanvänd produktdokumentation. Om du följer dessa riktlinjer kan du leverera produktdokumentation som kan göra en bra kund till en bra kund. Och bra kunder hjälper i slutändan företagen att öka intäkterna, och produktdokumentationen är en viktig del av kundupplevelsen.

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

Det är viktigt att [veta vilka förväntningar din målgrupp har] (https://www.stickyminds.com/article/writing-requirements-documentation-multiple-audiences). Är produktdokumentationen till exempel avsedd för administratörer eller slutanvändare? Målgruppens omfattning kan kräva att dokumentationen skrivs tekniskt för administratörer eller i tydligt definierade termer och instruktioner för slutanvändare.

En bästa praxis för att skapa professionell produktdokumentation är att förstå kundernas förväntningar på administratörs- eller slutanvändarnivå. Några av metoderna för att samla in information om målgruppen är följande:

• Frågeformulär och undersökningar

• Feedback från den upplevda publiken.

• Företagets brainstorming

• Återkoppling på populära kundåsikter

• Rundabordssamtal med kunderna

2. Skapa en dokumentationsplan som bästa praxis

Att skriva en dokumentationsplan kan hjälpa till att se eventuella flaskhalsar under projektets genomförande. Att skapa produktdokumentation kan vara en utmaning, och en bästa praxis är att skapa en dokumentationsplan för att hjälpa till att förutse problem som kan dyka upp under dokumentationsprocessen.

Bland fördelarna med att skapa en dokumentationsplan finns följande:

• Aktier som kan åtgärdas - Granskning av befintlig dokumentation för att sälja tillämplig information som kan återanvändas i den nya produktdokumentationsplanen.

Observera mallar och stilguider - Om produktdokumentationen gäller en ny produkt, se till att den håller sig inom branschens röst och stil, eller om dokumentationen gäller en befintlig produkt, behåll de nuvarande stilguiderna och mallarna för att säkra varumärkets kontinuitet.

• Dokumentprocessverktyg - Dokumentverktyg kan definiera och effektivisera produktdokumentationsprocessen samtidigt som de säkerställer kontinuitet i teamarbetet och en bättre förståelse för dokumentutvecklingsprocessen.

3. Förenkla produktdokumentationen som en bästa praxis

En studie genomfördes 2016 för att fastställa hur många användare som läser produktdokumentationen. Resultaten var uppseendeväckande eftersom de upptäckte att endast [25 % av användarna inte läser produktdokumentationen.] (https://academic.oup.com/iwc/article-abstract/28/1/27/2363584?redirectedFrom=fulltext&login=false) Undersökningen visade att bristen på slutanvändare som inte läser produktdokumentationen delvis beror på följande:

• Användarna är otåliga - I och med att information kan fås omedelbart via webben har användarna vanligtvis mindre tålamod när det gäller att hitta svar på sina problem. Att läsa produktdokumentation online eller offline kan vara mödosamt på grund av de stora mängder information som krävs för en viss produkt.

Skip-ahead-syndromet** - Användarna hoppar ofta över nödvändig produktdokumentation och går direkt till grunderna för hur produkten ska användas. Användare lär sig och förstår hur produkter fungerar genom att interagera med produkten snarare än att läsa detaljerade instruktioner. Anvisningarna 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 och blir frustrerade och avskräcks från att läsa manualen. Ofta har företaget inte genomfört en detaljerad målgruppsundersökning och inte förstått korrekt vad användaren behövde, och blev för förvirrad för att läsa färdigt.

4. Inkludera skärmdumpar och grafisk information

Tänk på produktdokumentation som en färdplan som berättar en historia om en produkt. Led kunden längs en väg som är lätt att i[dentifiera med skärmdumpar eller annan grafik] (https://theideanest.ca/5-types-graphics/?doing_wp_cron=1666462401.5462460517883300781250) och hur de olika grafikerna interagerar med varandra. Förklara tydligt vad användaren tittar på eller när en funktion aktiveras, hur den reagerar på produkten och vad han eller hon kan förvänta sig härnäst. Se till att varje grafik är ändamålsenlig och att produktens arbetsflöde fungerar med varandra.

5. Använd korslänkar för en mer exakt förståelse av ämnen.

Jag har funnit att [korslänkar är ovärderliga när jag läser produktdokumentation.] (https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/WritingReST/Reference/Content/Links.html) Att förstå vad en funktion eller en funktionsprocess gör hjälper enormt att korslänka till ett tillhörande ämne. Genom att korslänka associerade datapunkter blir dessutom helhetsbilden tydligare när det gäller hur systemet interagerar och hur arbetsflödet 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] (https://www.wrike.com/blog/understanding-kiss-principles-project-management/#What-does-KISS-stand-for). Det är dock viktigt att dokumentera processen grundligt, men inte till den grad att det blir en överdimensionering av dokumentationen. Dessutom kan det hända att dokumentationsanvändaren letar efter viss information om specifika saker, så om man följer KISS-principen blir det mycket lättare att navigera och förstå dokumentationen.

Det kan till exempel räcka med enkla noteringar för att förklara en funktion, kanske med en hänvisning (korslänk) till huvudämnet. Håll fakta ren och inte överdrivet uttalad, så att användaren lätt kan söka efter information som är relevant för hans eller hennes behov. De kanske inte är intresserade av att läsa alla aspekter av produkten.

7. Anpassa till olika inlärningsstilar

Varje person har en [olika inlärningsstil] (https://www.ukessays.com/essays/social-work/people-learn-in-different-ways.php). Vissa föredrar ingående beskrivningar, medan andra kanske föredrar grafik och visuella representationer. Vissa användare lär sig dock mer genom praktisk handling än genom fokuserad läsning.

Se till att alla inlärningsstilar beaktas när du skapar effektiv och informativ produktdokumentation. Genom att till exempel infoga grafik som skärmdumpar, grafer, strukturerad text eller videolänkar kan man se till att alla inlärningsstilar förstår produktdokumentationen.

8. Personalisera och strukturera innehållet i introduktionen

Personalisera produkten [dokumentationen utifrån målgruppens roll] (https://www.deanhouston.com/news/knowing-audience-document-right-document/). Skapa olika versioner av dokumentationen baserat på den avsedda målgruppens roller vid onboarding av innehållet. Till exempel är en administratörs frågor kanske inte relevanta för en power user som har frågor om dokumentationen.

Dokumentationen kan införa ett lager av personalisering genom att skapa något olika versioner av dokumentet som är mer inriktade på den avsedda målgruppens roll. Genom att ändra innehållet i introduktionen baserat på målgruppens roll får dokumentationen ett element av personalisering.

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

Beroende på den avsedda målgruppen är det en bra metod att förklara innebörden av varje term som används i dokumentationen. Du kan använda mer komplexa termer med vissa förtydliganden om målgruppen är intern. Men när externa användare får tillgång till dokumentationen finns det inget sätt att veta vilken expertis användarna har.

En tydlig definition av unika eller komplexa termer skapar en mycket bättre och effektivare kommunikation för alla interna intressenter och externa användare.

10. Ge en metod för att samla in feedback från användarna.

Återkoppling från dokumentationen ger viktig information om dokumentets effektivitet. Ge en länk eller en enkel knapp med "Gillar/Diss gillar" för att samla in värdefull information om dokumentationens kvalitet. Genom att [samla in användarfeedback] (https://www.k15t.com/rock-the-docs/documentation-guide/collaborative-writing/collect-user-feedback) kan dokumentationen förfinas och förbättras.

11 Undvik dokumentation med en platt struktur.

När du skapar produktdokumentation ska du se till att dokumentationen inte är skriven som en "platt struktur". Att läsa ett dokument fullt av platt text är arbetskrävande, och det kan också bli tråkigt. Dessutom ökar läsarens intresse för dokumentationen om informationen är relevant för det diskuterade ämnet och läsaren snabbt kan konsumera 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 UX. Genom att leverera dokumentinnehållet i "bitar" får läsaren dessutom en roligare upplevelse och blir mindre tveksam till att läsa dokumentationen.

12. Skapa dokumentation som är SEO-vänlig

En bästa praxis för produktdokumentation online är att se till att den är skriven i en stil som är [dokumentation SEO-vänlig] (https://www.pragm.co/post/making-your-documentation-seo-friendly). Se till att dokumentationen är skriven för att maximera sökresultaten på internet för din dokumentation. Kunderna kan behöva söka efter sin dokumentation, och när de inte har en uttrycklig länk till värdwebbplatsen, genom att ange söktermer, blir svaren snabbare och mer koncisa om de är SEO-vänliga.

13. Håll produktdokumentationen uppdaterad

Att upprätthålla underhållet av produktdokumentationen är avgörande, främst om den nås online. Ofta ändras kraven på en produkt och dokumentationen online måste återspegla alla nya ändringar eller uppdateringar. Därför måste användardokumentationen vara aktuell och uppdateras för eventuella senaste uppdateringar och se till att kunden informeras och är medveten om ändringar i produktdokumentationen.

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

En 2014 års studie visade att användarna inte läste hela produktdokumentationen fullständigt. De främsta orsakerna till att de inte läste dokumentationen var:

• Produktdokumentationen var alltför komplex.

• Dokumentationen tog inte direkt upp deras frågor

• Användarna använde inte många funktioner i produkten eftersom de inte läste dokumentationen.

• Många användare föredrog att lära sig praktiskt i stället för att läsa dokumentationen.

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

Produktdokumentationen utvecklas kontinuerligt med uppdateringar, nya funktioner, korrigerat innehåll, uppdaterade underhållsvarningar och annat. Denna uppdatering betraktas som ett levande dokument som ständigt utvecklas i enlighet med produktens krav.

Statiskt innehåll ger användaren data som inte ändras under produktens hela livstid. Tanken 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 en innehållsrik dokumentation, men det får vanligtvis stå tillbaka för den dynamiska dokumentationen.

Det är lättare att underhålla dokumentationen när innehållet är [klassificerat som antingen dynamiskt eller statiskt] (https://brainly.com/question/24688083). Dokumentationen för produktens livscykel kan genomföras och valideras lättare när dokumentationen kategoriseras som dynamisk eller statisk. Det kan förekomma mindre ändringar i dokumentationen vid uppdateringar av nya funktioner (statisk) eller detaljerade produktuppdateringar (dynamisk).

16. Bästa praxis för produktdokumentationens tillgänglighet

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

Oavsett hur produktdokumentationen levereras är det viktigt att ha lättillgängliga åtkomstpunkter. Därför är de vanligaste metoderna för att tillhandahålla dokumentation i dag följande:

• Offline-dokumentation - Många produkter levereras med tryckta manualer eller snabbstartsblad. Dessa dokument är vanligtvis engångsartiklar och kan inte lätt distribueras. Många handböcker kan dock tillhandahållas i ett inkapslat PDF-format, vilket gör att de är lätta att bära med sig eller kan skrivas ut på begäran.

Online-dokumentation- Varje gång du söker på Google efter ett svar på ett problem tar du förmodligen del av en bit av online-dokumentationen. Webben har ersatt handböcker och produktdokumentation för slutanvändare. Några av fördelarna med online-dokumentation är följande:

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

2. Samarbete - Med en lättillgänglig online-dokumentationsportal kan teammedlemmarna dela information i farten och skapa lagarbete, vilket ofta är omöjligt på kontoret.

3. Mobilvänligt - Tillkomsten av mobila enheter som iPads och smartphones har långsamt ersatt datorer för dagliga interaktioner. Du kan enkelt få tillgång till onlinedokumentation med en smartphone, och alla tjatande produktproblem kan lätt undersökas, även på ditt favoritcafé under lunchen.