Så länge vi har verktyg och programvara behöver vi kommunicera effektivt för att förmedla användning, skapande, funktionalitet och arkitektur av våra produkter. VARFÖR? Helt enkelt eftersom tekniska kommunikationsfärdigheter är nödvändiga för att fånga information och hjälpa användarna att förstå produkten eller tekniken vi säljer.
Medan kommunikation i verkliga livet sker genom ord eller uttryck, sker teknisk kommunikation genom teknisk dokumentation i den digitala världen!
Teknisk produktdokumentation skapas med det enda syftet att hjälpa slutanvändaren att förstå hur produkten eller tekniken de använder fungerar. Det är en detaljerad beskrivning av produktens alla delar – en bruksanvisning för nya medarbetare, användare och alla andra som behöver veta hur den fungerar!
Men trots att det låter enkelt kan teknisk dokumentation vara förvirrande! De flesta tekniska dokument innehåller flera faser, från "Hur du använder: Om du är ny och har begränsad erfarenhet" till "Felsökning: Vid eventuella buggar eller fel".
Om du är osäker på var du ska börja, här är en omfattande guide som hjälper dig att förstå vad, varför och hur gällande teknisk dokumentation, samtidigt som processen förenklas!
Låt oss börja!¶
Du har kommit rätt om du är ny inom produktdokumentation och aldrig behövt utveckla en produktdokumentationsspecifikation.
Även om du kanske har lärt dig grunderna i att skapa en produktdokumentationsspecifikation kräver genomförandet eftertanke och ett metodiskt tillvägagångssätt. Här är en guide om vad du behöver veta och hur du utvecklar en flexibel och korrekt produktdokumentationsspecifikation.
Vi kommer att definiera produktkrav och diskutera dess syfte, samt ge flera exempel på produktstandarder. Du kommer att lära dig vad som ska ingå i din produktdokumentation, hur du skriver den – från att etablera en produktbeskrivning till att modifiera den baserat på kundernas återkoppling och begränsad användartestning – och hur du får dina produkter på väg mot produktion eller mjukvaruutvecklingsprocessen.
Vad är syftet med produktdokumentationsspecifikationer?¶
För att utveckla en produktdokumentationsspecifikation måste du först ha en god förståelse för vad produkten är. En produktdokumentationsspecifikation är en ritning för produktdokumentationen du utvecklar, som beskriver hur den kommer att se ut för dina kunder, samt dess specifika krav och funktionalitet, som sökfunktioner, språkändringsmöjligheter med mera. Den kan även innehålla persona eller konsument för vilken produkten skapas, men detta gäller främst produkter som är avsedda för vissa åldersgrupper.
Denna produktdokumentationsspecifikation bör vara extremt tydlig, lättillgänglig och innehålla all information som ditt design- och produktteam behöver. Inkludera så många detaljer som möjligt för att säkerställa att ditt team för tekniskt skrivande förstår vad de ska skriva och att ditt designteam förstår layouten för din produktdokumentation. En tabell eller ett diagram över skriftliga specifikationer visar var mer information kan hittas. Kom ihåg att detta bara är produktdokumentationsspecifikationen – du kan lämna detaljerna kring produktens olika aspekter till ditt team att skriva i själva produktdokumentationen.
Vilken information bör en produktdokumentationsspecifikation innehålla?¶
Varje produktspecifikation bygger på tekniska krav, ingenjörsspecifikationer och annan produktspecifik information. Följande bör dock ingå i din produktdokumentation som minimum:
Sammanfattning: Detta är en övergripande beskrivning av produkten. Den börjar med en översikt av produktkonceptet och avslutas med en koncis beskrivning av produkten och dess övergripande detaljer. Den förtydligar också varför produkten utvecklades och dess allmänna syfte. Produktbeskrivningen beskriver den färdiga produktens utseende och funktioner.
Funktionsspecifikationer: Detta är skriftliga aspekter som definierar din produkts utseende och funktioner. Det bör också beskriva hur människor kommer att interagera med den. Det är mycket viktigt att vara så detaljerad som möjligt i dessa förklaringar och inte utelämna något.
Användningsfall: Produkten bör ange användningsfallet för varje funktion och hur det gynnar slutanvändaren. Detta kan betraktas som material på marknadsföringsnivå. Men om användaren har en manual som också beskriver användningsfallet för varje funktion hjälper det dem att förstå hur den ska användas.
Användarpersonas: Detta avsnitt beskriver målgruppen för vilken produkten har utvecklats. Det beskriver måldemografin och de problem som produkten kommer att lösa. Att känna till produktens målgrupp säkerställer att ditt arbete förblir kundcentrerat. Om din produkt har vissa risker som inte är lämpliga för barn är det klokt att ange detta i din produktdokumentation.
Bilder/video: Varje avsnitt bör ha nödvändiga bilder eller videor av dina produkter i samband med skriftlig information om hur produkterna används. Detta förbättrar din produktdokumentation och produktens användningsfall.
Hur man planerar, skriver och levererar effektiv teknisk dokumentation¶
Teknisk dokumentation kan bli mycket sofistikerad och komplex! Det viktigaste är att se till att ditt innehåll förblir aktuellt, korrekt och intressant för din publik genom att följa dessa enkla steg:
Var tydlig med vad du vill att läsaren ska göra när de är klara:¶
Teknisk dokumentation fokuserar helt på läsarens nästa åtgärd. Uttryck ditt syfte för varje steg och fas av din produktdokumentation så att användaren förstår vad de kommer att kunna göra efter läsningen. Om du är tydlig med dokumentets slutanvändarguider blir det lättare att skriva din del. Ju mer omfattande din dokumentation är, desto lättare blir det för dina läsare att navigera genom informationen. Docsie har många verktyg som hjälper till med detta, till exempel vår söknavigering som låter användarna söka genom dokumentationen och hitta information snabbt!
Skapa en översikt för dokumentationen:¶
Utan en strukturerad plan kan det vara svårt att bygga produktdokumentation som flyter bra och effektivt uppnår huvudmålet med dina dokumentationskriterier. Därför rekommenderas starkt att börja med ett skelett som din dokumentation kan bygga på. Använd rubriker, kategorier, underkategorier och teman för att organisera och gruppera ditt material ordentligt. Docsie har många bra verktyg som låter dig skapa dokumentation snabbt och effektivt, med fokus på att skapa dynamisk produktdokumentation.
Vi har sökfunktioner, en välorganiserad struktur för din dokumentation och många andra kraftfulla funktioner.
Definiera din målgrupp:¶
Det är viktigt att förstå vilken publik som använder dina produkter för att avgöra om din dokumentation riktar sig till utvecklare, anställda eller användare. Detta för att säkerställa att konsumenterna förstår sammanhang, mål och funktioner hos produkten eller tekniken, vilket hjälper dig att anpassa materialet till din publik. Om din publik kommer från ett annat land än där ditt huvudkontor ligger, är översatt dokumentation ytterligare en faktor att ta hänsyn till.
Inkludera ritningar och bildtexter i ditt innehåll:¶
Illustrationer eller diagram i teknisk dokumentation måste inkludera olika mått som förklarar dimensioner eller aspekter av dina produkter. Om du demonstrerar funktioner i en digital SaaS-produkt fungerar skärmbilder utmärkt, så länge du visar vad de gör och hur de fungerar.
Dessutom hjälper bilder till att bryta monotonin av ord och skapa intresse för dokumentet. Bildtexter kan hjälpa till att sätta produktdiagram och ritningar med tydliga anvisningar i perspektiv.
Omläs, redigera och skriv om:¶
Gå igenom din tekniska dokumentation flera gånger för att säkerställa att du inte har missat något! Du kan också få ditt arbete redigerat av en kollega eller chef för att verifiera att allt är med. En gransknings- och ändringsmekanism skulle säkerställa att det publicerade materialet är korrekt.
Docsie har fantastiska verktyg som kan hjälpa dig att skapa din produktdokumentation. Om du vill lära dig mer om Docsie, klicka här.