Vad är teknisk dokumentation?

Teknisk dokumentation, eller produktinformation som det också kallas, är benämningen på all den information som behövs för att kunna använda och sköta en produkt eller ett system. Med informationen kan en användare lära sig produktens alla funktioner för att nyttja den till fullo. Även olika yrkesroller behöver teknisk dokumentation för att kunna ta hand om produkten, t.ex. en servicetekniker som ska utföra en reparation.

Teknisk dokumentation handlar inte heller bara om produkten i sig utan även om system och andra produkter som relaterar till den. Några exempel på sådan information är vilka komponenter som produkten innehåller, vilka tillbehör och reservdelar som den är kompatibel med och vilka verktyg som behövs för att underhålla den.

Exempel på teknisk dokumentation:

• Användarmanualer för att kunna nyttja alla funktioner
• Serviceinformation
• Underhållsinformation
• Reservdelskataloger för att lätt förstå vilken reservdel som behövs, samt på ett enkelt sätt kunna beställa den
• Felsökningsguider
• Produktbeskrivningar

Varför ska man förbättra sin tekniska dokumentation?

Teknisk dokumentation finns till för att produkter och system ska kunna användas så smidigt, ofta och länge som möjligt. Ju lättare informationen är att ta till sig, desto mer bidrar den till det.

Att få ut mesta möjliga av sin produkt, att snabbt kunna laga den om den går sönder – eller att underhålla produkten för att förebygga att det alls händer – ökar såväl kundnöjdhet som produktivitet. Det i sin tur ökar lönsamheten. Dessutom möjliggör det nya intäktsströmmar, för med en mer pålitlig produkt kan företag sälja dess funktion istället för varan i sig.

Det som är avgörande är alltså hur lätt den tekniska dokumentationen är att ta till sig.

Dessutom finns det goda skäl att se över hur informationen skapas och underhålls för att minska kostnader och öka effektiviteten. Med moderna dokumentationsverktyg, en genomtänkt informationsstruktur och gemensamma processer kan t.ex. översättningskostnader ofta reduceras kraftigt och ledtider kortas.

• Slipp att uppdatera hela manualen så fort produkten förändras eller att ”vänta in” flera förändringar innan den uppdateras, då det räcker att ändra det område som ändringen rör
• Slipp att ladda upp pdf:er på nytt eftersom uppdateringar görs automatiskt
• Slipp tryckkostnader för fysiska manualer
• Slipp nya tryckkostnader när produkter förändras och resursslöseriet i att behöva slänga föråldrade manualer
• Sluta betala för onödiga översättningskostnader

Det finns två övergripande villkor för att teknisk dokumentation ska vara lätt att ta till sig:

• Informationen som behövs ska vara lätt att få fram
• Informationen som behövs ska vara lätt att använda

Traditionellt har teknisk dokumentation utgjorts av tryckta manualer som på senare tid i många fall har gjorts om till pdf:er att ladda ned från en hemsida. Problemet med dessa format är att det krävs mycket tid och ansträngning för att hitta just den information som behövs i stunden. Manualen eller pdf:en innehåller all information men i verkligheten är det aldrig all information vi frågar efter, utan den specifika information som hjälper oss att hantera situationen vi befinner oss i just nu. Dessutom kanske situationen vi befinner oss i när vi behöver informationen kräver att vi håller i oss eller har uppsyn över trafik eller maskiner i drift. Det ställer krav på varifrån vi får informationen: Istället för att bläddra i en manual eller scrolla på en dator, kan det hjälpa om den tekniska dokumentationen finns i en app på mobilen eller integreras i produktens gränssnitt.

Hur den dokumentationen förmedlas spelar också roll. Att läsa en lång text i liten textstorlek och med komplicerade termer är sällan det lättaste sättet att lära sig en ny funktion eller laga något som gått sönder. Förutom att språk, ton och ordval påverkar hur lättbegriplig en text är, kan bilder, animationer, AR-lager i mobilkameran eller en röst göra det betydligt lättare att ta till sig informationen. Teknisk dokumentation kan till och med göras interaktiv, så att vi guidas fram till lösningen genom ja- och nej-frågor.

Teknisk dokumentation blir alltså bättre när vi gör det lättare att använda den information som behövs nu.

För att förbättra den tekniska dokumentationen behöver den digitaliseras. Först då kan varje ämne eller område som informationen rör göras till en egen modul, så att vi slipper få all information när vi ju egentligen bara behöver information om någonting specifikt.

När man skall digitalisera sin tekniska dokumentation är det oftast bäst att göra det i mindre, men kontinuerliga steg. Då kan man löpande utvärdera och skapa en förankring och förståelse inom den egna organisationen för kommande steg. Några exempel på steg är:

• Digitalisera den tekniska dokumentationen för en eller flera produkter.
• Göra den tekniska dokumentationen tillgänglig i en eller flera kanaler, t.ex. i en webbportal, en mobilapp eller i produktens gränssnitt.
• Förmedla den tekniska dokumentationen på fler sätt, t.ex. i skrift, tal, bild och animation eller genom vägledande ja- och nej-frågor.
• Koppla ihop den tekniska dokumentationen med andra system såsom reservdelslhantering och e-handel.

Ofta krävs beslut ifrån många håll inom organisationen för att komma igång med att digitalisera sin produktinformation. Här är några argument för att digitalisera sin tekniska dokumentation, som våra kunder använde inför sina digitaliseringsprojekt:

• Tech-doc-organisationen kommer lättare kunna möta det ökande behovet av information som drivs utav snabbare produktutveckling, fler lanseringar och produktuppgraderingar samtidigt som produkterna i sig blir mer avancerade genom ny teknologi som färre känner till och kan hantera utan stöd.
• Teknisk dokumentation behöver göras alltmer användbar i takt med att produkter blir mer avancerade. Annars sjunker kundnöjdheten samtidigt som service och reparationer kommer ta längre tid att utföra och vara beroende av några få personer med spetskompetens inom nya system och teknologier.
• Att gå från fysiska manualer till att digitalisera informationen innebär stora besparingar då vi slipper printkostnader. Dessutom minskar produktens ”totala” vikt och ett moment i förpackningslinjen.
• För att möta nya hållbarhetskrav som ställs både av kunderna och av organisationen, är det inte längre försvarbart med fysiska manualer. Ibland kan det finnas krav på att viss information ska finnas i fysisk form men i de fallen kan merparten fortfarande digitaliseras.
• Med digitaliserad teknisk dokumentation kan vi göra verklighet av de affärsmöjligheter på eftermarknaden som ställer höga krav på pålitlig drift, såsom att sälja en produkts funktion istället för produkten i sig: Med relevant, korrekt och lättanvänd information kommer operatörer kunna hantera produkterna på rätt sätt och servicetekniker snabbare åtgärda ev. driftstopp, vilket gör det lättare att uppskatta lönsamheten i en sådan affär.

Tekniska skribenter, illustratörer och projektledare är roller som kommer att behövas inom tech-doc-organisationen även framöver. För att kunna skapa digital produktinformation, vilket görs i modernare verktyg, behövs även kunskaper i att skriva topic-baserat och hantera metadata. Därtill behövs ett antal nya kompetenser såsom informationsstrateger, informationsarkitekter och mjukvaruutvecklare för att kunna digitalisera informationen. Då blir det även aktuellt för 3D-illustratörer, animatörer och andra ”informationsproducerande” roller att arbeta med teknisk dokumentation, eftersom digitaliseringen gör det möjligt att förmedla samma information på flera sätt.