Bästa praxis vid lansering av nya produkter¶

En av de viktigaste åtgärderna vid lansering av nya produkter är att förbereda produktreleasen. Vi vill särskilt fokusera på att skriva ny produktdokumentation som stöd vid produktlanseringen. Utan den kommer potentiella användare att sakna relevant information att använda som referens efter att de köpt din nya lösning.

Som en del av en bredare marknadsföringsstrategi bör produktchefer och produktteam fortsätta läsa för att lära sig om 15 bästa metoder att följa vid nästa lansering. När du är klar kommer du att förstå hur du kan göra dessa viktiga dokument så bra som möjligt!

Vilka typer av produktdokumentation bör jag känna till?¶

Innan vi går in på listan med bästa metoder, låt oss klargöra vilka typer av produktdokumentation som finns och målet för varje typ:

• Produktkravsdokumentation – Ett produktkravsdokument eller PRD är en typ av intern produktdokumentation som hjälper företag att uppfylla releasekriterier. Det förklarar vad slutprodukten ska åstadkomma för användaren, utan att specifikt definiera hur eller var. Utvecklingsteam och testteam använder sedan en PRD för att anpassa produkten till verksamhetskraven inför lansering. PRD ä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 behöver skapa användarguider som en förutsättning för en framgångsrik produktlansering. Som namnet antyder är detta dokumentation för att hjälpa slutanvändare att maximera sin produktivitet när de använder en ny produkt. Här bör all viktig användarfunktionalitet förklaras fullständigt så att kunderna får ut största möjliga värde. Dela gärna dessa guider i en extern kunskapsbas för självbetjäning så att kunderna kan hjälpa sig själva!

• Installations- och konfigurationsguider – Om en produkt kräver installation och konfiguration är detta ytterligare en teknisk produktdokumentationstillgång du behöver 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 operativsystem om det gäller mjukvarudokumentation, något att ha i åtanke.

• Marknadsföringsmaterial – Du kanske inte tänker på detta som produktdokumentation, men det är det! Stil och format på marknadsföringsmaterial påverkar hur kunder uppfattar din produkt innan de börjar använda den. Att göra ett gott första intryck är avgörande. Hur beskriver du produktens nya funktioner? Vilken målgrupp riktar den sig till? Hur kommer detta att förbättra någons arbets- eller privatliv? Är detta vad du och företaget vill att kunderna ska tänka?

15 bästa metoder för dokumentation vid lansering av nya produkter¶

Efter denna introduktion till produktdokumentation följer nu listan med bästa metoder:

1: Kom igång!¶

Precis börjat med produktdokumentation? Bra! Tveka inte att komma igång. Många vill att produktdokumentationen ska bli PERFEKT, och i strävan efter perfektion blir de paralyserade av uppgiften. Få ner grundkonceptet för dina tjänster på papper och fokusera sedan på att finjustera för att imponera på dina kunder. Releaseanteckningar är utmärkta för att definiera grunderna, sedan kan du bygga vidare från detta dokument.

2: Keep it Simple, Stupid...¶

Förkortat som KISS, är detta en verklig designprincip som florerade (ordvits avsedd) i amerikanska flottan på 60-talet. Samma regel kan tillämpas på produktdokumentation. Fråga dig själv: "Hur kan du förmedla nödvändig information på ett sätt som alla målgrupper kan förstå?"

För att tillämpa detta på din produktvision rekommenderar vi Flesch-Kincaids läsbarhetstest. Verktyg för innehållsgranskning som Grammarly använder ofta detta system. Det ger dig en poäng motsvarande en amerikansk high school-nivå när innehåll analyseras. Sikta på årskurs 8 eller åldern 13-14 för att maximera begripligheten – vänta, vi kunde ha sagt... hur lätt det är att förstå din text.

3: Förstå målgruppen¶

Du har kommit igång och hållit det enkelt. Nu behöver du veta vem du faktiskt skriver för... Som exempel kommer målgruppen för mjukvaruföretag att vara mycket annorlunda jämfört med en biltillverkare.

Låt oss föreställa oss ett utbildningsprogram som fokuserar på enkla verktyg för att hjälpa unga elever lära sig steg för steg om olika koncept. Din första tanke kanske är "så målgruppen är barn, eller hur?". Inte nödvändigtvis... Målgruppen är den primära beslutsfattaren för mjukvarupaket på en förskola eller skola – som IT-avdelningen och interna intressenter ansvariga för inköp. En sekundär målgrupp skulle vara de unga eleverna, som kan se utbildningsprogrammet och förespråka dess användning i sin skola.

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

Även om alla älskar en bra berättelse vill kunder veta vilket värde din produkt erbjuder. Kommer den att förenkla en uppgift eller ett arbetsflöde? Finns din produkt tillgänglig offline, till skillnad från konkurrenter som bara finns online? Utför din produkt uppgiften snabbare än andra konkurrerande produkter?

Dessa exempel utgör unika säljargument (USP) för ett specifikt erbjudande. Att fokusera på och lyfta fram USP kommer att locka potentiella kunder och hjälpa dem förstå vad du har som andra inte har för att öka marknadsandelen. Du kan definiera USP genom att utföra en konkurrensanalys mot konkurrenter i din bransch.

5: Använd formatering för att kategorisera information¶

Dokumentation bör inte vara ett stort textblock. Detta är svårt att skanna igenom och navigera för slutanvändare. Använd istället rubriker och andra formateringsalternativ för att bryta upp texten.

H1-rubriker är det första folk ser när de klickar på en sida. H2 och H3 fungerar som underrubriker för ämnen som täcks på sidan. Du kan använda punktlistor eller numrerade listor för att gruppera innehåll för enklare läsning, och till och med bli berättigad till Rich Snippets för att förbättra SEO och synlighet i sökresultat. Om du har kunskaper i Markdown erbjuder en online markdown-redigerare som Docsie många formateringsalternativ för att få din produktdokumentation att sticka ut!

6: Håll 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? Hur är det med översättning till andra språk?

För denna bästa praxis måste vi nämna Docsie! Online kunskapsbas-programvara låter dig lagra dokument på en enda centraliserad plats i molnet. Härifrån kan anställda och entreprenörer samarbeta kring innehåll för att påskynda färdigställandet inför lansering. Docsie erbjuder versionskontroll när du behöver uppdatera kunskap och språkhantering för global innehållslokalisering. Om du vill automatisera global innehållsskapande har vi också en finurlig AI-språköversättningsbot som noggrant översätter åt dig i bakgrunden!

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

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

Försök skapa en medföljande videoinstruktion för varje produktdokument. På så sätt kan de som föredrar att läsa skanna igenom texten, medan visuella inlärare kan välja videon. På samma sätt kan GIF-filer och bilder hjälpa användare att se vad du hänvisar till, särskilt inom ett mjukvarugränssnitt. Att tillgodose olika inlärningsstilar hjälper dig att hjälpa fler 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.

• Lärande – Om en person aldrig har sett något förut hjälper lärande innehåll dem att förstå grundprinciperna.

• Mål – Denna typ av innehåll bör hjälpa användare att nå ett mål, som "Hur man exporterar en PDF-fil från Docsie". I slutet har användaren uppnått målet: att exportera en PDF.

• Förståelse – Även kallat forskning, detta är för kunder som redan har kunskap om ett ämne men vill förstå det mer på djupet.

• Information – Personen har en fråga och vill ha ett specifikt svar. Detta kan vara så enkelt som realtidsväder på en specifik plats eller en video om "hur man bygger en trädkoja".

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 främsta hindret för användare är att inte snabbt kunna hitta information. Detta leder till frustration, ökad arbetsbelastning för kundsupportteamet om de inte kan hitta informationen, och en negativ övergripande kundupplevelse. Förresten, Docsie stöder global sökning om du undrade!

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

Dokumentationsförfattare är medvetna om att den första versionen av innehållet kommer att förändras med tiden. Tills allmänheten ser dokumentationen kan dina skribenter bara bolla idéer och feedback med varandra.

När din dokumentation har publicerats anser vi att det är viktigt att ha feedback-insamling på plats. På så sätt kan dina skribenter förvandla eventuella innehållsrelaterade negativa aspekter till positiva genom att lyssna på verkliga kunder och slutanvändare. Du behöver inte leta någon annanstans, du kan dra nytta av feedback-insamling 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 till det? När du refererar till andra ämnen kanske användarna ännu inte förstår det andra ämnet i sammanhanget på den aktuella sidan. Du bör länka till alla nämnda ämnen som har dokumentation, eftersom detta gör att läsare snabbt kan referera till underämnen medan de lär sig om ett huvudämne.

12: Tydlighet, inte tvetydighet¶

Tydlighet slår tvetydighet när man skriver produktdokumentation. Du kan använda enkelt språk för att undvika tvetydighet, vilket i grunden betyder att undvika 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 direkt efter för lekmannaläsare.

"Om du har problem med att förstå informationen i denna dokumentation, vänligen be om ytterligare detaljer om hur du kan övervinna denna förståelsesvårighet från vår kundsupportrepresentant."

"Om innehållet är svårt att förstå kan du be kundsupport om hjälp."

Vilket föredrar du?

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

Med en ny produktlansering är det prioriterat att påskynda dokumentationsskapandet. 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 ett antal förbyggda mallar som du kan använda, tillsammans med stöd för anpassade mallar.

14: Fastställ en tonalitet och stilguide för skribenter¶

Hur mycket frihet har dina skribenter?

Att styra skribenter är viktigt, eftersom frihet kan leda till inkonsekvens i slutliga utkast av produktdokumentation. Du kan göra detta med riktlinjer för tonalitet och innehållsstilar.

• Tonalitet – Det är inte vad du sa... det är hur du sa det. Vill du att skribenter ska vara formella och korrekta, eller mer avslappnade? Är humor tillåten, eller är ämnena mer allvarliga? Är ditt innehåll mer konversationellt och passionerat, eller vill du bara ha kalla fakta?

• Stilriktlinjer – Detta dokument kan förklara företagets uppdrag och hur skribenter kan följa en bestämd stil när de skriver och formaterar sidor. Här kan användartyper att rikta sig till, SEO-principer som metabeskrivningar och krav på citat eller referenser (Chicago, AP Style etc.) ingå.

15: Publicera din dokumentation med en kraftfull kunskapsbas-plattform¶

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

En kraftfull kunskapsbas-plattform är avgörande för att distribuera kvalitativ produktdokumentation. Om dokument blir otillgängliga, eller sidor laddar långsamt, kommer all ansträngning för att skapa dessa dokument att gå förlorad.

Du behöver möjligheten att importera befintliga dokument, samarbeta kring innehåll med interna team, skapa och redigera nya dokument, bädda in dynamiskt rikt innehåll och publicera till en kunskapswebbplats. Versionskontroll är också avgörande för långsiktiga dokumentationsuppdateringar, tillsammans med språkhantering och automatisk översättning för global innehållslokalisering.

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