En steg-för-steg-guide om hur man skapar och hanterar produktdokumentation | Produktledning #31

Vad är produktdokumentation?

Produktdokumentation är en samling av text, bilder och videor som beskriver produkten, dess funktioner, hur den ska användas och andra relevanta detaljer. Huvudsyftet med att skapa dokumentation är att hjälpa användare att förstå hur man använder produkten, särskilt dess avancerade funktioner.

Dokumentation är viktig, särskilt om du skapar en digital produkt som inte bara ska tjäna slutanvändare utan också integrera med andra produkter – till exempel, möjliggöra att exportera data till en annan applikation, eller använda en lokaliserings- eller kontaktdatabas.

Till exempel kan dokumentationen för ett projektledningsverktyg inkludera information om hur man skapar ett nytt projekt, hur man lägger till teammedlemmar i ett projekt och ger dem behörighet att ändra endast vissa uppgifter, hur man tilldelar uppgifter till flera personer samtidigt, och hur man spårar deras framsteg.

Element av produktdokumentation

Produktdokumentation kan inkludera:

• Användarmanual – ett dokument som ger information om produktens funktioner, installation, inställningar och felsökning.
• Användarguide – ett dokument som förklarar hur man utför olika uppgifter med produkten, såsom hur man använder ett fotoredigeringsprogram eller hur man spelar ett datorspel.
• Kunskapsbas – en samling av artiklar eller webbsidor som svarar på vanliga frågor eller ger ytterligare information om en produkt. Ett exempel skulle vara “Hjälpcenter” eller “Support”-avsnittet på webbplatsen. Det används också ofta som en informationskälla för en chatbot som hjälper kunder.
• FAQ – en lista med vanliga frågor och svar om produkten. Till exempel, en webbplats eller PDF-fil som inkluderar svar på frågor som: “Hur återställer jag mitt lösenord?”, “Hur kontaktar jag kundsupport?” eller “Vilka är systemkraven för produkten?”.
• Handledningar – videor, vanligtvis publicerade på företagets webbplats eller YouTube, som visar hur man använder produkten eller utför vissa uppgifter.
• Diagram och infografik – grafiska representationer av strukturen, funktionen eller processen för en produkt. Till exempel, ett diagram som visar vilka alternativ som ska väljas när man konfigurerar ett API.

Hur skapar man produktdokumentation?

Förstå målgruppen

Det första steget i att skapa produktdokumentation är att förstå den publik som detta specifika dokument kommer att riktas till. Svara på följande frågor:

• Vem kommer att använda detta dokument? – Kommer det att vara en ny användare eller en mer avancerad användare?
• Vid vilken tidpunkt kommer användaren att ta fram detta dokument? Söker de allmän eller extra information om verktygets kapabiliteter, eller en lösning på ett specifikt problem?
• Vilken enhet kommer de att använda det på? Om det är en mobil enhet, är videorna tillräckligt tydliga?
• Vilka är deras behov och förväntningar? Föredrar användaren att titta på en dynamisk video eller titta på ett diagram?

När du har förstått din publik och deras behov kan du börja skapa din dokumentation. Till exempel, om din målgrupp är nybörjare, bör dokumentationen vara tillgänglig i varje steg, skriven på ett enkelt, lättförståeligt språk och inkludera detaljerade instruktioner.

Kom ihåg att välorganiserad dokumentation inte bara hjälper användare att förstå produkten utan också sparar tid som de annars skulle ha spenderat på att söka efter svar på sina frågor. Detta minskar churn, det vill säga den procentandel av kunder som slutar prenumerera på en tjänst.

Tydlig kommunikation

Att skapa effektiv produktdokumentation handlar inte bara om att välja rätt kommunikationsform (t.ex. videor, bilder, kunskapsbas), utan också om att skriva och kommunicera tydligt och koncist. De grundläggande principerna för effektiv kommunikation i produktdokumentation är följande:

• Använd enkelt språk – undvik tekniskt språk och komplicerade termer. Till exempel, istället för att säga “initiera ett projekt”, kan du säga “starta ett projekt”.
• Var specifik – ge exempel för att hjälpa användare att förstå hur man använder produkten. Till exempel, istället för att säga “möjliggör att lägga till teammedlemmar i ett projekt”, säg “lägg till en teammedlem i ett projekt genom att klicka på den gröna knappen längst ner på projektledningssidan” och lägg till en skärmdump med en visuell ledtråd.
• Undvik passiv röst – aktiv röst är lättare att förstå och läsa. Till exempel, istället för att säga “projektet kan startas av chefen”, säg “chefen kan starta projektet.”

Det finns många andra principer att följa, men den viktigaste är att komma ihåg att effektiv produktdokumentation bör vara förståelig för användarna och hjälpa dem att använda produkten effektivt.

Använda visuella element i produktdokumentation

Visuella element, såsom bilder, gifs, korta videor, diagram och infografik, kan avsevärt förbättra förståelsen av produktdokumentationen. Till exempel kan en skärmdump som visar var knappen “Lägg till teammedlem” finns på sidan vara mycket hjälpsam för nybörjare. När du skapar dokumentation, använd också tydliga rubriker och ett enkelt typsnitt för att organisera texten.

Uppdatera och underhålla produktdokumentation

Produktdokumentation är inte ett statiskt dokument. Det måste uppdateras regelbundet för att återspegla förändringar i produkten. Regelbundna uppdateringar är avgörande för att dokumentationen ska tjäna sitt syfte. Till exempel, om du introducerar en ny funktion i din projektledningsprogramvara, bör du uppdatera dess produktdokumentation för att ta upp det.

Publicera och distribuera produktdokumentation

Att publicera och distribuera produktdokumentation är lika viktigt som att skapa den. Du måste se till att din dokumentation är lättillgänglig för användarna, oavsett var de befinner sig eller vilken enhet de använder. Till exempel kan du ladda upp din produktdokumentation till din webbplats, eller skicka den direkt till användarna via e-post.

Toppsystem för dokumenthantering för produktchefer

Produktchefer har många verktyg tillgängliga som kan hjälpa dem att skapa och hantera produktdokumentation. Populära lösningar inkluderar:

• Google Docs är en molnbaserad tjänst för att skapa och redigera dokument. Det är ett populärt verktyg för produktchefer eftersom du kan komma åt det på vilken enhet som helst och det kan användas av flera teammedlemmar.

• Firmbee är ett omfattande projekt- och teamhanteringsverktyg som gör det möjligt för användare att slutföra uppgifter från var som helst i världen i realtid. Produktchefer kan enkelt organisera sitt arbete och sina kollegors, spåra framsteg, kontrollera budgetar och genomföra rekryteringsprocesser.

• Notion är en uppgifts- och projektledningsapplikation som kan användas för att spåra uppgifter, anteckningar och filer. Notion är ett populärt alternativ för produktchefer eftersom det är flexibelt och kan anpassas.

• Zendesk Guide är en kundservicelösning som kan användas för att skapa och dela artiklar i kunskapsbasen. Zendesk Guide är ett populärt val för produktchefer eftersom det gör det möjligt för dem att ge support och hjälpa kunder att lösa sina problem.

Sammanfattning

Att skapa och hantera produktdokumentation är en ofta underskattad uppgift. Många utvecklare av digitala produkter tror att en väl utformad produkt är självklar. Men produktdokumentation bör vara mer än bara en användarguide.

Den bör också vara ett verktyg som kan hjälpa till att öka kundernas medvetenhet om produkten och analysera deras intresse för nya funktioner, samt antalet visningar av specifika artiklar eller förklaringar. Sådan analys hjälper företag att bättre hantera sina produkter och förbättra användarupplevelsen. Så det är värt tiden och ansträngningen att skapa effektiv produktdokumentation som kan tjäna både dig och dina användare.

Om du gillar vårt innehåll, gå med i vår aktiva community av busy bees på Facebook, Twitter, LinkedIn, Instagram, YouTube, Pinterest, TikTok.