Är er dokumentation skapad i sista minuten?

Ett bra dokument servar läsaren 

e viktigaste aspekterna har med säkerheten att göra. Hur man ska installera, använda och serva produkten utan att skada sig själv eller miljön.  Hur man undviker att skada produkten. Säkerhetsaspekter beskrivs i tre steg. Vilken är risken, vad innebär den och hur kan den undvikas”, listar Jukka Toimela.

”Dokumenten måste vara kortfattade, tydliga och så illustrerade som möjligt, presentera delarna i rätt ordning och uppvisa en tydlig struktur. De måste betjäna mekaniker, användare, underhållspersonal och alla andra användargrupper”, säger Jukka Toimela. Bilden till höger visar HyperSTE-verktyget som kontrollerar innehållets tydlighet. 

Redaktören måste tydligt ha användarna av dokumentet i åtanke. Det måste svara snabbt på användarens troliga frågor. Däremot kommer de djuplodande frågorna från en ingenjörskollega inte att besvaras, såvida kollegan inte är en förväntad läsare. 

”Man kan inte överdriva betydelsen av bilder. Lyckade illustrationer är en väsentlig del av ett högkvalitativt dokument”, betonar Jukka Toimela. 

”Bra att veta”-instruktioner informerar läsaren om bra metoder och praxis. Kom ihåg att lägga till dessa. Kommentarer och tips om hur man får enheten att fungera korrekt. En användarmanual beskriver hur funktioner och egenskaper kan utnyttjas fullt ut, och så vidare. 

Kontrollerade versioner 

Strukturen för ett bra dokument, dvs. dess innehållsförteckning, är i ordning. 

”Grundprincipen för ett strukturerat dokument är enkel: det är uppdelat i moduler, vars versioner och översättningar till andra språk hanteras separat”, sammanfattar Jukka Toimela. Bilden till vänster visar HyperDoc-systemet för innehållshantering. 

Varje modul svarar på en enstaka fråga eller beskriver en enstaka uppgift. Till exempel, hur motorn startas. En ändring som berör en uppgift påverkar bara en modul. Ändringen och den korrekta informationen visas automatiskt i varje publikation som använder den modulen. Ändringen av uppgiften påverkar bara en modul. En typisk modul är 1–1,5 sidor lång. 

Underhållet blir betydligt enklare. En ändring som berör en uppgift påverkar bara en modul. Ändringen och den korrekta informationen silar automatiskt ned till alla, kanske dussintals, publikationer där modulen används. 

Ett strukturerat dokumentationssystem skapar automatiskt layouterna för olika språkversioner. En bild och tillhörande text visas på samma sida, även om textlängden varierar mellan olika språkversioner. Den här funktionen sparar in mycket hantverk. 

Besparingar i översättningskostnader 

”I en del företag ger designer sina bidrag till dokumenten med skiftande engelskakunskaper och terminologi. Översättarna ställs inför en nästan omöjlig uppgift. Språkversionerna blir dyra och inte så mycket till kvalitet”, berättar Jukka Toimela. 

Lösningen även på detta problem är dokumentationspersonal med effektiva metoder och verktyg. 

En modul som visas i flera publikationer av ett strukturerat system behöver bara översättas en gång. Hanteringen av översättning av produktversioner blir också effektivare. 

Engelska och kinesiska översättningar skapas för version A av produkten. När produktversion B och C släpps, uppdateras den engelska språkmodulen med ändringarna. Den kinesiska språkversionen behöver dock inte uppdateras om bara produktversion A levereras till Kina. 

Materialen lagras i ett översättningsminne. Översättningsminnet visar vilka meningar som redan har översatts, vilka som endast har mindre ändringar som ska göras, och vilka som behöver översättas fullt ut. En specifik mening behöver bara översättas en gång.