I den här bloggen förklarar vi varför teknisk dokumentation är viktig och hur både företag och slutkunder har nytta av högkvalitativ teknisk dokumentation. Vi tar också en tjuvtitt på utmaningarna inom och framtiden för tekniska dokumentation.
Vi har intervjuat Karl Bjelkesjö och Mats Hermansson, två erfarna proffs inom teknisk dokumentation. Karl är chef för teknisk kommunikation och WI-affärssystemverktyg på Xylem, och Mats är strategisk chef för teknisk information på SAAB. Karl och Mats delade med sig av sina personliga åsikter och insikter om teknisk dokumentation i den här artikeln. De arbetar också för att förbättra industrin via BOTI (Branschorganisationen för teknisk information), som vi kommer att få veta mer om i den här artikeln.
Teknisk information leder till ökad kundnöjdhet och optimal användning av produkten. Det är det centrala för varför man eftersträvar teknisk dokumentation av högsta kvalitet. Inom vissa branscher är detta reglerat i relation till produktansvaret. Det är ett krav.
Karl:
Teknisk dokumentation ger företag en konkurrensfördel eftersom den både förbättrar användarupplevelsen och försäljningen. Teknisk information måste finnas lätt tillgänglig under hela kundresan. Sammanfattningsvis handlar högkvalitativ teknisk dokumentation om att skapa en bra upplevelse för användaren och även fungera som försäljningsargument under offertprocessen.
Mats:
Det är min åsikt att teknisk dokumentation är till nytta för ett företag på många sätt, och affärsvärde är ett av dem. När du ser bra dokumentation ser du också att det här är ett varumärke, en produkt eller ett företag som du kan lita på. En annan viktig faktor är att du inte behöver ha en stor supportorganisation om du har bra dokumentation. Och i slutändan gör bra dokumentation också företagen mer konkurrenskraftiga.
Så jag tror att det finns många olika sätt som dokumentation kan vara till nytta för företaget.
Mats:
Först och främst skulle jag säga att fördelarna är att den är lätt att använda. Om du kan använda produkten enkelt, effektivt och säkert är det naturligtvis en stor fördel.
Karl:
Fördelarna är att säkerställa att produkten används på bästa sätt och att välja rätt produkt för dina behov.
Karl:
Personligen skulle jag definiera bra teknisk dokumentation som dokumentation som följer en stilguide och hjälper till att uppfylla dokumentationens övergripande mål, som kan skilja sig åt beroende på bransch och ämnesområde osv. Men att följa en stilguide som hjälper till att uppfylla de målen är hur jag definierar bra teknisk dokumentation.
Och vad kriterierna beträffar: Definitivt läsbarhet, som också säkerställer att innehållet är användbart, och översättbarhet. Är innehållet utvecklat för att förenkla kommunikation med globala användare? Flyttbarhet är också viktigt. Hur flexibelt är innehållet så att det kan återanvändas i en värld med en mängd olika kanaler? Kan du dela innehållet med publik i flera kanaler där dina kunder finns? Ännu ett kriterium är återanvändbarhet. För organisationens räkning handlar det om att få ut mesta möjliga från investeringen om det är möjligt att återanvända innehåll som redan utvecklats i framtida initiativ. Så, läsbarhet, användbarhet, översättbarhet, flyttbarhet och återanvändbarhet: kundupplevelse och effektivitet i drift, och möjligheten att kommunicera i flera eller alla kanaler.
Mats:
Jag tycker att den måste vara objektiv och faktabaserad, och den bör inte innehålla någon marknadsföringsinformation. Den ska också vara lättåtkomlig och välstrukturerad, och dessutom lätt att förstå. Ett bra språk är naturligtvis viktigt.
Mats:
Det beror på komplexiteten och behoven av säkerhet när man arbetar med en produkt. Jag menar, det kan vara som IKEA; där de levererar sin tekniska information helt utan ord, som är så lätt att förstå som möjligt.
Jag tror inte det finns några branscher som kan låta bli att nämna teknisk information och teknisk dokumentation.
Karl:
Det finns till exempel programvaruföretag som har API som en integrerad del av produktvärdet, där kunderna kan utveckla sina egna applikationer genom att använda de programmerbara gränssnitten. De företagen måste vara extra uppmärksamma på API-utvecklardokumentationen, där dokumentationen är själva produkten. Så du måste ge dina kunder och utvecklare support för att de ska kunna använda produkten. Därför måste man absolut vara uppmärksam inom API-dokumentation.
Sedan finns det reglerade branscher, maskinindustrin och så vidare. De branscherna måste vara extra uppmärksamma på teknisk dokumentation och översättning, i synnerhet all dokumentation som rör produktansvar. Det finns en juridisk aspekt i de reglerade branscherna.
Det finns till exempel ett maskindirektiv som är en av de huvudsakliga lagarna som styr harmoniseringen av viktiga hälso- och säkerhetskrav på EU-nivå. Det kan förstås också finnas lokala regelverk som kräver ännu större uppmärksamhet på teknisk dokumentation.
Mats:
Det är min erfarenhet att det är mycket viktigt att andra delar av ett företag förstår vad teknisk dokumentation är och varför den är viktig, eftersom det inte alltid är så lätt att få alla att förstå.
Tidigare jobbade jag på ett programvaruföretag där programutvecklarna tyckte att de var i mål när de hade levererat programmet, som andra sedan kunde använda rakt av. Det var en lång resa att få utvecklarna att förstå hur viktigt det är med teknisk dokumentation och att de måste ge support med den.
När det gäller tekniska skribenter kan de ibland komma med svåra eller många frågor, och ibland är de frågorna sådana som en amatör skulle ställa. I sådana fall är det mycket viktigt att experterna ger svar på de frågorna så att de tekniska skribenterna kan använda svaren för att skapa riktigt bra teknisk dokumentation.
En annan faktor är terminologi. Tekniska skribenter sitter ofta i slutet av arbetsflödet på ett företag som är fristående från branschen. Det kan till exempel börja i en bransch med utvecklare, där det kanske är köparna som bestämmer om en specifik term för en produkt eller del av en produkt. Och sedan kanske utvecklarna och köparna använder olika namn för samma del.
Det leder till att artikeln får olika namn i olika system, så en teknisk skribent bör försöka få terminologin konsekvent, vilket kan vara en rejäl utmaning.
Så i bästa fall skulle jag säga att en teknisk skribent bör vara involverad även i inköps- och designprocesserna för att kunna avgöra termer. Det vore mycket bättre för slutanvändarna om de inte hade två eller tre eller fem synonymer för samma ord.
Karl:
När det gäller att framställa dokumentation skulle jag säga att det är viktigt att engagera sig. Det är en lagsport att utveckla föredragna metoder. Du kan hålla evenemang för att lära dig hur en bra uppackning ser ut eller hur du utvecklar metodologier. Att samarbeta med tekniska skribenter som ett team för att se till att dokumentationen blir så bra som möjligt, och sedan ge granskningsfeedback i rimlig tid, är en vision för alla tekniska skribenter.
Teknisk dokumentation är en väsentlig del av produkten, inte produkten eller tjänsten och sedan dokumentationen. Dokumentationen är en del av produkten eller tjänsten. Ur ett kundperspektiv ingår de alla i samma kundupplevelse.
Mats:
Jag tror det finns några olika saker, men språket är en av dem. Om du inte översätter dokumentationen måste du se till att använda ett mycket enkelt språk. Inom flygbranschen där jag jobbar använder vi till exempel Simplified Technical English, som är ett mycket förenklat sätt att skriva engelska. Det gör det möjligt för någon som inte har så mycket utbildning i engelska att förstå anvisningarna. Därför är det enklare att ha en enda ton i all dokumentation, eftersom det också gör den lättare att översätta.
En annan sak du måste vara medveten om är tillgång till internet. Vi tänker ofta att alla i hela världen har tillgång till internet, men det finns platser där det inte finns den åtkomsten, så det måste finnas lösningar för teknisk information som kan användas offline.
Det finns flera olika skrivguider, förenklade språk och strukturer för olika branscher. Därför tror jag att alla kan hitta det som passar för just deras verksamhet.
Mats:
Det finns ett antal utmaningar, och under det kommande året tror jag att några av dem även blir frågor.
Men en som sätter grunden för utmaningen är den tekniska utvecklingen. Det vill säga, man behöver nya plattformar för att leverera teknisk information, och även att yngre människor förväntar sig teknisk information och teknisk dokumentation på andra sätt än tidigare. När jag var ung var det enda sättet att få reda på hur man använde eller reparerade något att läsa handboken som kom med produkten. Men nu använder man Google för det. Du kan få dokumentationen att visas direkt när du har ett problem, och du använder mer eller mindre dokumentationen för att lösa problemet åt dig omedelbart.
Karl:
Jag ser att kraven på hanteringstid förändras. Många företage går över till agil produktutveckling och agila processer i stället för vattenfallsmodellen, där man arbetar oavbrutet i flera månader, kanske åratal, och sedan lanserar produkten på marknaden. Sedan ser vi att produktutvecklingen övergår till att få ut en produkt som alls fungerar på marknaden och få feedback och arbeta med kunderna för att förbättra produkten. Följderna för innehållsutvecklingen är att kraven på hanteringstid ökar. Så det innebär att ett innehållsutvecklingsteam nu måste släppa innehåll oftare, med mindre leveranser som kommer oftare. Det som brukade vara flera månaders utveckling räknas nu i veckor.
Så det är en utmaning. Det kan vara dyrt att släppa innehåll, och det är något som teamen behöver tänka på: hur de kan minska kostnaderna och samtidigt kunna integrera innehåll fortlöpande för att stödja den fortlöpande integreringen av funktioner medan produkten utvecklas.
Den agila omvandlingen går bortom utvecklingen av teknikprodukter. Det finns inte ett team i någon bransch som inte talar om agil omvandling. Till exempel utbildningsinnehåll, teknisk dokumentation, marknadsföringsmaterial, webben, e-handel och så vidare. Alla påverkas av det.
Karl:
En sak som gör utgåvor dyra är layouten: att göra layoutarbetet gång på gång i publikationer. En trend är att gå mot innehåll som en tjänst inom e-handel, något man kanske kan kalla Headless CMS. Genom att tillämpa layouten i framänden av applikationen, antingen det rör sig om ett hjälpcenter eller ett utbildningspaket eller en e-handelsplattform, tillämpar själva plattformen, med klientdelen, layouten, så fokuserar innehållsutvecklarna på att utveckla innehållet.
Så innehåll som en tjänst och Headless CMS är absolut en trend. I stället för att varje skribent arbetar med layouten i sin redigeringsmiljö har layoutarbetet flyttats nedströms i processen.
En annan trend är att använda en enda källa för innehåll: återanvända innehåll över en produkt eller utvecklingsinitiativ för tjänster. Företagen är ute efter att dra nytta av sin investering i innehåll. Använda digitala resurser som utvecklats, återanvända dem om och om igen, antingen det rör sig om innehållshanteringssystem, översättningshanteringssystem eller gemensamma databaser. Jag skulle inte kalla det en trend under 2021, utan snarare att det är en utveckling som pågått under mer än ett årtionde.
Den tredje trenden skulle vara att stödja IoT i informationssammanhang där produkter och tjänster flyttas till molnet. Att gå från papper till digitala lösningar är definitivt industrins framtid.
Slutligen är den fjärde trenden internationalisering, där produkterna kopplas ihop och marknaden blir global. Det finns en chans att nå kunder i alla delar av världen.
Mats:
Det är ett av de mål vi har under de närmaste åren: att se framåt och verkligen se vilka förändringar och utmaningar vi ställs inför. Det finns en massa diskussion om alla nya modeord som artificiell intelligens, förstärkt verklighet, virtuell verklighet och digitala tvillingar.
Så det är verkligen inte lätt att förutse hur allt detta påverkar behovet av teknisk information och hur vi framställer och konsumerar teknisk dokumentation och teknisk information. Jag tror inte det är någon enskild sak. Utan det är ett kluster av många olika nya tekniker och snabbare evolution som vi måste hålla jämna steg med.
Kort sagt är BOTI en mötesplats för företag där vi samarbetar för att få bättre teknisk information i svenska företag. BOTI stöttar bra teknisk information i svenska företag, på alla språk och naturligtvis i översättningar.
En sak som är viktig för oss är att tekniska skribenter eller verksamheten för teknisk information ofta bara är en liten del av ett företag. Det kan vara en teknisk skribent på ett företag med 100 personer, så det är inte så lätt att bygga på den erfarenhet de har och bli bättre om man är ensam och inte har någon annan att bli vägledd av. Så det är därför vi tror det är viktigt att ha organisationen för att hjälpa varandra och också för att hjälpa företag, och naturligtvis för att gå framåt inom teknikinformationsbranschen.
Vi har en omfattande verksamhet: vi har konferensen en gång om året och vi har en mängd webbinarier som är gratis för alla att delta i. Vi har också flera arbetsgrupper där man kan diskutera med folk från olika företag och skapa ett riktigt bra nätverk.
Målet för organisationen är att förmedla hur dokumentation av hög kvalitet skapar värde och hur den kan göra ett företag mer konkurrenskraftigt.
Organisationens huvudspråk är svenska, men alla är välkomna. Till exempel är den årliga konferensen och webbsidan på svenska. Så det är användbart att kunna lite svenska för att få ut så mycket som möjligt av det.
Läs mer om BOTI här.
Det är enkelt. Fyll bara i formuläret med ditt företags information här. När ett företag blir medlem räknas alla i det företaget som medlemmar.