”Kan ni lova att er skribent är expert på vårt område? Vår verksamhet är mycket teknisk och väldigt unik.” Det här är en av de vanligaste frågorna från företag som ska köpa dokumentationstjänster. Många företag tror att deras verksamhetsområde är så specialiserat att bara en expert kan skriva dokumentation om det.
De personer som verkligen är experter jobbar oftast redan för företaget med produktutveckling eller på andra expertbefattningar. De har inte tid att skriva dokumentation, och oftast har de inte lust heller – det är därför de vänder sig till ett företag som erbjuder dokumentationstjänster. Dessutom är dessa experter vanligen väldigt väl bevandrade i sitt ämne, men de är sällan professionella skribenter eller duktiga på teknisk dokumentation. Det här är anledningen till att de kanske inte kan ta fram så professionell och välskriven dokumentation som företaget och dess image kräver.
Tekniska skribenter har å andra sidan detta som sitt yrke och är utbildade i hur man sammanställer och redovisar information. Enligt en definition av TC Europe, som är en europeisk paraplyorganisation för teknisk kommunikation, är tekniska skribenter personer som förmedlar kunskap om en produkt till dess användare. Egentligen är det bara bra att skribenten inte är alltför insatt i ämnet, eftersom läsaren kanske inte heller är det. Därför har skribenten lättare för att identifiera sig med läsaren och kan justera svårighetsnivå och detaljgrad efter läsarens behov. För att kunna förklara de viktigaste begreppen klart och tydligt måste skribenten naturligtvis ha grundkunskaper i ämnet. En logiskt uppbyggd och tydlig text gör det lättare att förstå komplicerat innehåll för en läsare som inte är så hemma i ämnet.
Tekniska skribenter är personer som förmedlar kunskap om en produkt till dess användare.
I stället för djupa kunskaper om ett visst ämnesområde behöver tekniska skribenter vara duktiga på följande för att kunna ta fram bra dokumentation:
Inhämtning av information från olika källor, till exempel kundens befintliga material (tidigare dokumentation, tekniska data, marknadsmaterial) och relevanta webbplatser för branschen, men de måste också kunna intervjua personer som är experter på området. Att våga ställa frågor som kan verka dumma är en viktig del av förmågan att inhämta information.
Det tekniska skrivandets hantverk. Hantverket ser likadant ut oavsett ämnesområde: man måste kunna planera dokumentationen, göra en användar- och uppgiftsanalys (om hur arbetet utförs och av vem), inhämta och sammanställa information, skapa olika versioner av dokumentationen och genomföra tester av den, inhämta feedback och förbättra dokumentation och arbetsmetoder i enlighet med resultaten.
Kvalitetskontroll, vilket kan handla om många saker när man arbetar med dokumentation. Det första kunderna tänker på är normalt att texten ska vara tydlig och grammatiskt korrekt. Att texten ska vara användarvänlig och lätt att ta till sig är andra kvaliteter som kunden förväntar sig. Kvaliteten höjs också om man ser till att terminologin är konsekvent och om man planerar dokumentstrukturen på bästa sätt för ändamålet. Att välja terminologi på ett genomtänkt sätt och använda den konsekvent gör texten lättare att förstå, medan en tydlig struktur och enhetlig stil ökar textens läsbarhet och gör det lättare att hitta det man söker. Skribenten måste också se till att innehållet i dokumentationen tillgodoser användarens behov – skribenten måste förstå vad som verkligen måste finnas med och vad som är irrelevant. Dokumentationen ska inte innehålla all tänkbar information om ämnet i fråga.
Därför är svaret på kundens fråga: ”Nej, vår skribent är inte expert på ert område, men det är faktiskt bara en fördel.” Skribenternas egna expertkunskaper gör att de kan ta fram objektiv och användarvänlig dokumentation som ger företagen möjlighet att nå sina mål.
Behöver ditt företag hjälp att producera tekniskt material på flera språk? Eller behöver ni översätta befintligt material till ett annat språk? Kontakta oss och låt våra experter hjälpa dig hitta de lämpligaste lösningarna för era behov.
Updated