Vad är teknisk dokumentation?
Teknisk dokumentation är en fackmässig typ av tjänst- eller produktinformation. Den ger detaljerade beskrivningar och instruktioner till tekniska lösningar som antingen håller på att utvecklas eller redan används. Bra teknisk dokumentation är målgruppsanpassad, tydlig och pedagogisk. Användaren av de tekniska tjänsterna får hjälp att förstå dem för att kunna arbeta på rätt sätt. Dokumentationen kan vara i text, bild, ljud eller, vilket blir allt vanligare, video. Det kan handla om fristående dokumentation eller instruktioner som är integrerade i produkten eller tjänsten. Konkreta exempel på teknisk dokumentation kan vara driftinstruktioner för radiokommunikation, policyer för informationssäkerhet - eller beskrivningar av arbetsprocesser i ditt företag.
Vilka olika typer av teknisk dokumentation finns det?
Teknisk dokumentation kan vara allt från en mindre quick guide i mobilen, till flera pärmar med dokumentation för ett stort infrastrukturprojekt. En uppdelning är att göra åtskillnad på extern och intern dokumentation. Extern dokumentation är vad de flesta kanske tänker på när de hör begreppet teknisk information. Här innefattas olika slags manualer som når slutanvändaren av en tjänst eller produkt. Intern dokumentation avser att stödja företagets eller organisationens verksamhet, till exempel kravdokumentation, rutin- och processbeskrivningar eller systemdokumentation. Teknisk dokumentation kan också vara utredningar och analyser som utförs innan till exempel ett nytt verktyg börjar användas i en organisation.
Varför är teknisk dokumentation viktigt?
Säkerheten ökar
En viktig anledning till att dokumentation sker överhuvudtaget är att öka tryggheten och säkerheten. Med välgjorda instruktioner är sannolikheten större att en tjänst används korrekt. Man kan till exempel föreställa sig ett företags IT-system. Om IT-miljön är väldokumenterad ökar säkerheten och risken minskar för allvarliga avbrott. Dessutom förkortas tiden det tar att återställa produktionen. Policyer, process- och rutinbeskrivningar kring IT-säkerhet minskar dessutom risken för till exempel intrång.
Effektivare organisation med kunskapsöverföring
Varje gång personal försvinner från ett företag försvinner också viktig kunskap. Men med god dokumentation stannar kunskapen inom företaget och introduktionen av nya medarbetare blir så mycket enklare. Om de får tillgång till process- och rutinbeskrivningar, samt instruktioner för de verktyg de behöver för sitt arbete, kommer de snabbare igång. Introduktionen blir lättare och roligare både för verksamheten och för den nyanställda. Dokumenterade processer säkerställer också att alla i organisationen arbetar på liknande sätt, vilket medför en hög och jämn kvalitet på verksamheten, även vid personalförändringar.
Ditt företag blir mer konkurrenskraftigt
God kommunikation är en förutsättning för ett företags framgång. Men för att få till en god kommunikation krävs att det också finns en lika god och tillgänglig dokumentation att utgå från. Dessutom ser både kunder och anställda att du tar dem och din verksamhet på allvar, om de alltid har tillgång till den information de behöver för att att fatta beslut eller utföra arbetsuppgifter. Anpassad, tydlig och organiserad dokumentation och information som användarna förstår och kan använda ökar kunskapskapitalet, skapar effektiva processer och gör företaget mer konkurrenskraftigt.
Kostnader minskar
En stor anledning till att många företag skapar teknisk dokumentation är för att avlasta kundsupporten. Med välgjorda guider, instruktionsfilmer eller till exempel chatbots får användarna av en produkt eller tjänst den hjälp de behöver innan ärendet når supporten. Medarbetare inom kundtjänst kan också lösa de ärenden som kommer in snabbare och därmed arbeta effektivare.
Anna Fedoriw är teknisk skribent på Dokumentera. Hon tycker att det är roligt att förklara saker på ett lättförståeligt sätt och säger så här om varför hon tycker att det är viktigt med teknisk dokumentation:
“Man måste förstå för att kunna använda grejer ordentligt. Annars är det onödigt att överhuvudtaget utveckla något. Min erfarenhet av framförallt programvaruutvecklare är att de gör något som de tycker är fantastiskt och underbart och vackert och kommer att lösa världens alla problem. Och så tror de att det räcker! Det kanske är en jättebra grej som inte blir använd, för ingen begriper hur. Det är onödigt och tråkigt. Då måste man förklara. Jag finner en utmaning i att uttrycka något med så få ord som möjligt och hitta essensen. Det handlar om att överföra kunskap och förståelse.”
Hur underlättar teknisk dokumentation vid distansarbete?
Att alla anställda kan använda de tekniska verktygen är en given förutsättning för att lyckas med distansarbete. Men att få alla i personalstyrkan att behärska Zoom eller Teams är långt ifrån tillräckligt. Effektivt distansarbete kräver sina speciella arbetsprocesser och dessa kan skilja sig åt från arbete på ett fysiskt kontor. När medarbetarna sitter på olika platser kan det till exempel krävas tydligare kommunikation och en ökad disciplin för att få alla medarbetare att dra åt samma håll. Dessutom krävs kanske nya ramverk för hur beslut skrivs ner och förmedlas. Här blir god teknisk dokumentation en nyckel till effektivitet och framgång.
Hur arbetar man med teknisk dokumentation?
Den yrkesgrupp som arbetar med teknisk dokumentation kallas för teknisk dokumentatör, teknisk kommunikatör, teknikinformatör eller teknisk skribent. I den här texten används benämningen teknisk skribent. Givetvis kan arbetsuppgifter och metoder skilja sig åt beroende på vilken organisation den tekniska skribenten är verksam i. Det finns dock en hel del gemensamma nämnare oavsett vilket uppdrag eller verksamhet det gäller.
I korthet är den tekniska skribentens uppgift att samla in underlag, analysera och skriva teknisk dokumentation. Vanliga frågor den tekniska skribenten måste ställa sig är “Vad?”, “Till vem?” och “Vilket är det bästa kommunikationssättet?”. Syftet är att göra tekniken så lättanvänd och tillgänglig som möjligt för dess målgrupp. Till sin hjälp har den tekniska skribenten till exempel olika stilguider eller terminologilistor.
Rollen som teknisk skribent handlar dock om mycket mer än att bara skriva. För att ett dokumentationsprojekt ska bli framgångsrikt krävs också god planering, struktur och uppföljning. Den tekniska skribenten blir på så sätt också projektledare. När det gäller till exempel dokumentation av verksamhetsprocesser får ditt företag också ett tydligt nuläge kring hur verksamheten bedrivs och fungerar. Detta är ovärderligt inför en utveckling och effektivisering. Här kan den tekniska skribenten komma nära rollen som verksamhetsutvecklare.
Slutligen behöver den tekniska skribenten också behärska en mängd olika specialiserade verktyg för att producera och publicera dokumentation. Ordbehandlingsprogram är givetvis viktiga, men också publiceringssystem, grafiska verktyg i 2D och 3D,verktyg för att hantera terminologi, översättningsverktyg med mera med mera.
Per Grahn-Möller är senior teknisk skribent på Dokumentera. Han beskriver arbetsprocessen med att ta fram teknisk dokumentation så här:
“Det första som behöver göras är att skapa en bild av vilka behoven av dokumentationen är. Vilka ska använda dokumentationen? Det avgör språk, medium med mera. Därefter tittar man på realiseringen och gör en tidsplan. När man väl börjar skapa dokumentationen gäller det att hitta en logisk ordning för hur saker och ting ska beskrivas. När det gäller att välja medium är det användarens behov som får styra. För en servicetekniker som ska laga maskiner kanske det passar bättre med en videosnutt att titta på i mobilen än flera sidor skriven dokumentation. Är det dokumentation som ska skickas någonstans kanske den behöver en försättssida och innehållsförteckning. Även när det gäller tonfall och språk utgår vi alltid från användaren. För oss som konsulter är det också viktigt att arbeta på ett så strukturerat sätt som möjligt. På så sätt kan vi dra fördel av tidigare uppdrag och arbete.”
Vilka har behov av teknisk dokumentation?
I stort sett alla branscher har behov av någon slags teknisk dokumentation. Däremot kan omfattningen skilja sig åt. Läkemedelsföretag eller bolag inom medicinteknik har till exempel väldigt stora behov av instruktioner för sina produkter, på grund av att det finns formella krav på dem gällande dokumentation. För utvecklare av IT-system på en bank är det är istället flödesbeskrivningar på olika nivåer som kan behövas.
Dokumentera har lång erfarenhet av att arbeta med kunder från ett flertal branscher, till exempel:
- Bank och finans
- Telekom
- IT/Tech/mjukvara
- Infrastruktur
- Energi
- Myndigheter
Våra konsulter har ofta en egen bakgrund hos företag inom dessa branscher och har därför god kunskap om olika verksamheter och vilka problem som kan förekomma när det gäller att skapa och underhålla teknisk dokumentation.
Det som särskiljer oss som dokumentationskonsulter är att vi följer vår egen beprövade arbetsmodell som grundar sig i mångårig erfarenhet inom dokumentations- och informationsarbete inom stora och komplexa projekt och verksamheter. Vår arbetsmodell tillåter oss att snabbt komma in i uppdragen, att förstå er verksamhet, era utmaningar och era behov. Då kan vi anpassa tjänsten på bästa sätt för just er.