15 bästa metoder vid lansering av ny produktdokumentation

En av de bästa metoderna vid lansering av en ny produkt är att förbereda produktlanseringen. Vi vill särskilt fokusera på att skriva ny produktdokumentation för att stödja en produktlansering. Utan den kommer potentiella användare inte att ha relevant information att använda som referenspunkt efter att ha köpt din nya lösning.

Som en del av en bredare marknadsföringsstrategi bör produktchefer och produktteammedlemmar fortsätta läsa för att lära sig mer om 15 bästa metoder att följa vid nästa lansering. I slutändan kommer du att förstå hur du gör dessa viktiga dokument till de bästa de kan bli!

Vilka typer av produktdokumentation bör jag vara medveten om?

Innan vi går in på listan över bästa praxis bör vi klargöra vilka typer av produktdokumentation som finns och vad som är målet med varje typ av dokumentation:

• Produktkravsdokumentation - Ett produktkravsdokument eller PRD är en typ av intern produktdokumentation som används för att hjälpa företag att uppfylla lanseringskriterier. Det förklarar vad den slutliga produkten ska åstadkomma för en användare, utan att specifikt definiera hur eller var. Sedan använder utvecklings- och testteam ett PRD för att anpassa produkten till verksamhetens krav inför lanseringen. PRD:er är vanliga för mjukvaruprodukter, men kan användas för att följa vilken produktfärdplan som helst.

Användarguider och självbetjäning - Produktteam måste skapa användarguider som en mjuk förutsättning för en framgångsrik produktlansering. Som namnet antyder är det här dokumentation som hjälper slutanvändarna att maximera sin produktivitet när de använder en ny produkt. Här bör alla viktiga användarvänliga funktioner förklaras i sin helhet, så att kunderna kan få ut mesta möjliga av produkten. Ännu bättre är att dela dessa guider i en extern kunskapsbas med självbetjäning så att kunderna kan hjälpa sig själva!

• Installations-, installations- och konfigurationsguider - Om en produkt kräver installation och konfiguration är detta en annan teknisk produktdokumentationstillgång som du måste skapa. Målet är att tydligt illustrera dessa processer ur ett användarperspektiv, och ett utvecklarperspektiv om tillämpligt. Detta kan sträcka sig över flera enheter och flera operativsystem om det gäller programvarudokumentation; något att tänka på.

• Marknadsföringstillgångar - Du kanske inte tror att det här är produktdokumentation, men det är det! Stilen och formatet på marknadsföringstillgångarna påverkar hur kunderna uppfattar din produkt innan de börjar använda den. Att göra ett gott intryck är avgörande. Hur beskriver du produktens nya funktioner? Vilken målgrupp är den avsedd för? Hur kommer den att förbättra någons arbetsliv eller privatliv? Är det så här du och hela företaget vill att kunderna ska tänka?

15 Best Practices för dokumentation när du släpper nya produkter

Efter denna grundkurs om produktdokumentation är nästa steg listan över bästa praxis:

1: Gör en start!

Har du precis börjat med produktdokumentation? Jättebra! Tveka nu inte att göra en början. Många vill få produktdokumentationen PERFEKT och i jakten på perfektion blir de paralyserade av uppgiften. Få ner grundkonceptet för dina tjänster på papper och fokusera sedan på att städa upp så att du är redo att imponera på dina kunder. Release notes är bra för att definiera grunderna, sedan kan du bygga ut från det här dokumentet.

2: Håll det enkelt, dumt ...

Förkortat KISS, är detta en verklig designprincip som flöt runt (ordvits avsedd) i den amerikanska flottan på 60-talet. Samma regel kan tillämpas på produktdokumentation. Ställ frågan till dig själv: "Hur kan du förmedla nödvändig information på ett sätt som alla demografiska grupper kan förstå?"

För att tillämpa detta på din produktvision rekommenderar vi Flesch-Kincaids läsbarhetstest. Verktyg för innehållsbedömning som Grammarly använder ofta detta system. Det ger dig en poäng som motsvarar ett amerikanskt gymnasiebetyg när du analyserar skriftligt innehåll. Sikta på årskurs 8 eller 13-14 år som skolålder för att maximera innehållets tolkningsbarhet - vänta, vi kunde ha sagt... hur lätt det är att förstå det du skriver.

3: Förstå målgruppen

Så, du har börjat och hållit det enkelt. Nu måste du veta vem du faktiskt skriver för... Till exempel kommer målgruppen för programvaruföretag att vara mycket annorlunda än för en fordonstillverkare.

Låt oss föreställa oss ett programvaruföretag som fokuserar på enkla verktyg för att hjälpa unga studenter att steg för steg lära sig begrepp. Den första tanken i ditt huvud kanske är "så målgruppen är barn, eller hur?". Inte nödvändigtvis... Målgruppen är den primära beslutsfattaren för programvarupaket på en förskola eller gymnasieskola - till exempel IT-avdelningen och interna intressenter som ansvarar för upphandling. En sekundär målgrupp är de unga eleverna, som kanske ser utbildningsprogramvaran i naturen och förespråkar att den ska användas på deras skola.

4: Fokusera på värdet, snarare än på en berättelse

Även om alla älskar en bra historia vill kunderna veta vilket värde din produkt kommer att erbjuda. Kommer den att förenkla en uppgift eller ett arbetsflöde? Finns din produkt tillgänglig offline, jämfört med konkurrenter som bara finns online? Gör din produkt en sak snabbare än andra konkurrerande produkter?

Dessa exempel utgör unika försäljningsargument (USP) för ett visst erbjudande. Genom att fokusera på och lyfta fram USP:er kan du locka potentiella kunder och hjälpa dem att förstå vad du har som andra inte har, och på så sätt öka sin marknadsandel. Du kan definiera USP:er genom att göra en konkurrensanalys av konkurrenterna i din bransch.

5: Utnyttja formatering för att kategorisera information

Dokumentation bör inte bestå av ett stort textblock. Det är svårt för slutanvändarna att skanna igenom och navigera i. Använd istället rubriker och andra formateringsalternativ för att bryta upp texten.

H1-rubriker är det första man ser när man klickar sig in på en sida. H2 och H3 fungerar som underrubriker för ämnen som behandlas på sidan. Du kan använda punktlistor eller numrerade listor för att gruppera innehåll så att det blir lättläst, och till och med bli berättigad till Rich Snippets för att förbättra SEO och SERPS-synlighet. Om du har kunskap om Markdown erbjuder en online Markdown Editor som Docsie många formateringsalternativ för att få dina produktdokument att sticka ut!

6: Förvara din dokumentation på en central plats

Det finns inget värre än att släppa teknisk dokumentation och sedan inse hur komplicerat det kommer att bli att övervaka och hantera den på lång sikt. Vad händer om dokumentationen behöver uppdateras? Var finns originaldokumentet och hur kan vi släppa nya versioner av sidan? Vad sägs om att översätta innehållet till andra språk?

För denna bästa praxis måste vi nämna Docsie! Med en programvara för kunskapsbaser online kan du lagra dokument på en enda centraliserad plats i molnet. Härifrån kan anställda och entreprenörer samarbeta om innehåll för att påskynda färdigställandet inför lanseringen. Docsie erbjuder versionshantering när du behöver uppdatera kunskap och språkhantering för lokalisering av globalt innehåll. Om du vill automatisera skapandet av globalt innehåll har vi också en smart språköversättningsbot med spök-AI som översätter åt dig i bakgrunden!

7: En bild säger mer än tusen ord

Även om det fungerar att skriva en långdragen förklaring om hur man gör en sak är det inte ett effektivt sätt att lära slutanvändarna. Visa dem istället med bilder, eller till och med rörliga bilder!

Försök att skapa en medföljande videohandledning för varje produktdokument. På så sätt kan de som föredrar att läsa skanna igenom texten, medan visuella elever kan välja videon. På samma sätt kan GIF:ar och bilder hjälpa användarna att se vad du hänvisar till, särskilt i ett användargränssnitt (UI) för programvara. Genom att ta hänsyn till olika inlärningsstilar kan du hjälpa ett större antal användare, vilket innebär större potential för din produkt.

8: Lärande vs Mål vs Förståelse vs Information

Vad är avsikten med dokumentet? Användarens avsikt är avgörande för produktdokumentation online och hjälper dig att anpassa ditt innehåll till delar av användarresan.

• Inlärning - Om en person aldrig har sett en sak förut hjälper inlärningsinnehåll dem att förstå de grundläggande principerna.

• Mål - Den här typen av innehåll ska hjälpa användarna att nå ett mål, till exempel "Hur man exporterar en PDF-fil från Docsie". I slutändan kommer användaren att ha uppnått målet: att exportera en PDF.

Förståelse - Detta kallas även forskning och är för kunder som redan har kunskap om ett ämne, men som vill förstå det mer på djupet.

• Information - Personen har en fråga och vill ha ett specifikt svar. Det kan handla om något så enkelt som realtidsvädret på en viss plats eller en video om hur man bygger en koja i ett träd.

9: Gör den sökbar

Innan du gör dokumentationen offentlig, kan dina användare söka efter nyckelord i texten?

Om inte, rekommenderar vi att du hittar en dokumentationsplattform som stöder detta. Det som avskräcker användarna mest är att de inte snabbt kan hitta information. Detta leder till frustration, ytterligare arbetsbelastning för kundsupportteamet om de inte kan hitta informationen och en negativ övergripande kundupplevelse (CX). Åh, Docsie stöder global sökning om du undrade!

10: Förberedelser för att samla in användbar feedback

Dokumentationsskribenter är medvetna om att den första versionen av innehållet kommer att ändras under arbetets gång. Fram till dess att allmänheten ser dokumentationen kan dina skribenter bara bolla idéer och feedback med varandra.

När dokumentationen väl har publicerats anser vi att det är viktigt att ha ett system för insamling av feedback. På så sätt kan dina skribenter vända alla innehållsrelaterade negativa aspekter till positiva genom att lyssna på riktiga kunder och slutanvändare. Du behöver inte leta någon annanstans, du kan dra nytta av feedbackinsamling i Docsie!

11: Länka till en sida när du nämner ett ämne

Denna bästa praxis lutar sig mot SEO och webbsidans navigationsstrukturer.

När du nämner ett nyckelord, länkar du då till det? När du hänvisar till andra ämnen kanske användarna ännu inte förstår det andra ämnet i samband med den aktuella sidan. Du bör länka till alla nämnda ämnen som har dokumentation, eftersom detta gör det möjligt för läsarna att snabbt hänvisa till underämnen medan de lär sig om ett huvudämne.

12: Klarhet, inte tvetydighet

Tydlighet slår tvetydighet när du skriver produktdokumentation. Du kan använda vanlig engelska för att undvika tvetydigheter, vilket i princip innebär att du undviker jargong och tekniskt språk om det inte är absolut nödvändigt. Om du använder jargong, se till att skriva en förenklad definition omedelbart efter för lekmannaläsare.

"Om du har problem med att förstå informationen i den här dokumentationen kan du be vår kundtjänst om ytterligare information om hur du kan lösa problemet med att förstå informationen."

"Om det innehåll som visas är svårt att förstå kan du be vår kundtjänst om hjälp."

Vilket föredrar du?

13: Skapa mallar för att göra dokument snabbare

När en ny produkt lanseras är det viktigt att påskynda processen för att skapa dokumentation. Du kan göra detta med hjälp av mallar.

Mallar definierar en återanvändbar struktur för sidor, vilket hjälper skribenter att skapa innehåll snabbare och med större konsekvens. Du kan också skapa flera mallar för olika innehållsstilar. Docsie erbjuder en rad förbyggda mallar som du kan använda, tillsammans med stöd för anpassade mallar.

14: Skapa en Tone of Voice och Style Guide för skribenter

Hur mycket fria händer har dina skribenter?

Det är viktigt att styra skribenterna, eftersom det kan leda till inkonsekvens i de slutliga utkasten till produktdokumentation. Det kan du göra med riktlinjer för Tone of Voice (ToV) och stilguider för innehållsskrivning.

• Tone of Voice - Det är inte vad du sa, utan hur du sa det. Vill du att skribenterna ska vara formella och korrekta eller mer avslappnade? Är humor tillåtet eller är ämnena mer allvarliga? Är ditt innehåll mer konversationsinriktat och passionerat, eller vill du bara ha kallhamrade fakta?

• Style Guidelines - Det här dokumentet kan förklara företagets verksamhetsidé och hur skribenterna kan följa en bestämd stil när de skriver och formaterar sidor. Här kan ingå användarpersonas att rikta in sig på, SEO-principer som metabeskrivningar och citerings- eller referenskrav (Chicago, AP Style etc.).

15: Publicera din dokumentation med hjälp av en kraftfull plattform för kunskapsbaser

Om ditt skriftliga innehåll är bränsle, vilket fordon använder du för att få fram budskapet?

En kraftfull plattform för kunskapsbaser är avgörande för att distribuera produktdokumentation av hög kvalitet. Om dokumenten inte är tillgängliga eller om sidorna laddas långsamt går allt arbete som lagts ned på att skapa dokumenten till spillo.

Du behöver kunna importera befintliga dokument, samarbeta om innehåll med interna team, skapa och redigera nya dokument, bädda in dynamiskt innehåll och publicera på en kunskapssajt. Versionskontroll är också avgörande för långsiktiga uppdateringar av dokumentationen, liksom språkhantering och automatisk översättning för lokalisering av globalt innehåll.

Du gissade rätt! Alla dessa funktioner finns tillgängliga i Docsie. Prova dessa funktioner, prova vår Free Forever-plan för att komma igång!