Bliv bedre til at skrive teknisk dokumentation

Hos World Translation synes vi, at brugsanvisninger og anden produktdokumentation er yderst interessante og vigtige dokumenter. Det er jo brugsanvisningen, som skal hjælpe dine kunder til at forstå og bruge dine produkter. Så hvad kan være vigtigere end det?

  • Skal du selv skrive en manual, men ved du bare ikke, hvordan du skal gribe projektet an?
  • Har I brugervejledninger i virksomheden, som godt kunne trænge til en opgradering?
  • Vil du gerne vide, hvilket format er bedst til din Quick Guide, eller om din manual leveres som beskrevet i maskindirektivet?
  • Ved du, hvad du skal tage hensyn til, når din produktdokumentation skal oversættes, så dit produkt kan eksporteres?

Vi har samlet 8 gode vaner som blandt andet besvarer disse spørgsmål. Vi håber, at vanerne kan hjælpe dig med at blive endnu skarpere til at skrive teknisk dokumentation.

1: Kommunikér dig til et godt image

Teknisk dokumentationer et overordnet begreb for alle typer før- og efter -salgsdokumentation.

Teknisk dokumentation er skriftlig kommunikation om virksomhedens produkt mellem en virksomhed og dens interessenter – typisk slutbrugerne.
Brugsanvisninger, vejledninger, manualer og datablade er typiske eksempler på teknisk dokumentation, og hver enkelt af disse kommunikationsværktøjer har sit eget kendetegn. Ofte laver virksomheder brugsanvisninger, der beskriver, hvordan et produkt virker, frem for at fortælle modtagerne, hvordan
de skal bruge produktet.

God dokumentation: er med til at give tilfredse kunder og medvirker til at give
et godt indtryk af maskinfabrikanten som professionel leverandør.
Dårlig dokumentation: kan misforstås af modtageren, og kan derved resultere
i, at produktet og virksomheden vrages til fordel for en anden og kan i værste fald give anledning til
søgsmål.

Husk disse fire emner, når du udarbejder din tekniske dokumentation, så du ikke får dårlige oplevelser:

2: Kend dit DTP-program

DTP er en forkortelse for Desk Top Publishing. Som navnet siger, handler det om at udgive publikationer på et skrivebord, underforstået skrivebordet (engelsk:
desktop) på en computer. Tekstbehandlingsprogrammer kan klare løbende tekst, men er ikke særligt gode til placering af billeder. Billedbehandlingsprogrammer er gode til håndtering af billeder, men er normalt dårlige til at håndtere tekster i eller omkring billeder. Brug det rigtige DTP-program til dine dokumentationsopgaver. På den måde kan du spare meget tid og undgå mange ærgrelser.

Både Adobe FrameMaker og InDesign kan håndtere såkaldte “bøger”. Det betyder, at et dokument kan opbygges i mindre, selvstændige kapitler, som så til sidst samles i en bog. Det gør bl.a. opdatering nemmere, i og med at man kan opdatere de enkelte kapitler og ikke behøver at opdatere hele dokumentet.

Almindelige tekster:

Til mindre, simple opgaver anvendes et standard tekstbehandlingsprogram som Microsoft Word eller tilsvarende. Tekstbehandlingsprogrammer kan også bruges til opbygning af teknisk dokumentation, men det forudsætter, at brugeren har en detaljeret viden om programmets muligheder. Hvis I har store mængder dokumentation eller har behov for jævnlig opdatering, anbefales det at bruge et “ægte” DTP-program, som f.eks.Adobe InDesign eller Adobe FrameMaker.

Mindre/mellemstore opgaver:

Adobe InDesign er et specialudviklet DTP-program, som især er velegnet til dokumentationsopgaver med mange grafiske elementer, såsom salgsbrochurer, marketingmateriale, Quick Guides m.v.

Mellemstore/store opgaver:

DTP-programmet Adobe FrameMaker udmærker sig især ved at kunne arbejde med store mængder tekst og illustrationer.

Andre programmer, som f.eks. CorelDraw, Microsoft Publisher eller CAD-tegneprogrammer, bør bruges med omtanke, når det drejer sig om dokumentationsopgaver. Hvis jeres dokumentation er opbygget i et af disse programmer, kan det medføre ekstraomkostninger ved opdatering, og mange oversættelsesprogrammer har svært ved at arbejde sammen med dem.

3: 80/20-reglen

80/20-reglen, også kaldet Paretos lov, kan bruges både som et personligt værktøj og som værktøj i virksomheder. 80/20-reglen hævder, at den mindste del af alle årsager, alle input og indsatser fører til den største del af alle resultater.Med andre ord vil det sige, at 80 % af dine arbejdsresultater stammer fra 20 % af den tid, du arbejder*.80/20-reglen kan også med fordel bruges til at beskrive, hvordan typiske dokumentationsprojekter hænger sammen. Som tommelfingerregel bruges
80 % af tiden i dokumentationsprojekter på planlægning. Kun ca. 20 % bruges på fremstilling af selve dokumentationen. Planlægning er fundamentet for hele projektet. Det er yderst vigtigt, men det er desværre ikke så synligt og målbart som skrivearbejdet.

Informationssøgning:
∙ Vælg dine informationskilder med omhu. Spørg kunder, eksperter, udviklere m.m.
∙ Lav en tjekliste over de informationer, du har brug for.
∙ Sørg for at få fat i informationerne i tide.

Målgruppe:
∙ Vurder, hvem der er modtager af dokumentationen. Din dokumentation skal være i øjenhøjde med målgruppen.
∙ Lav evt. en beskrivelse af firmaets retningslinjer (ofte kaldet “Style Guide” , som er en samling af standarder vedrørende tekstforfatning og design af virksomhedens dokumenter).

Layout:
∙ Gør din dokumentation nem at bruge; bl.a. med et overskueligt sidelayout og en god indholdsfortegnelse.
∙ Sørg for, at dit dokument har samme kvalitet som firmaets øvrige dokumentation.
∙ Brug evt. illustrationer til at tydeliggøre instruktionerne.

Sprogbrug:
∙ Husk, at det er instruktioner, du skriver – ikke breve eller historier.
∙ Undgå slang og indforstået sprog.
∙ Brug samme betegnelse for de samme ting i hele dokumentet.

Hvad koster dårlig dokumentation?
Mange har sikkert oplevet, hvor svært det kan være at forstå den instruktion, der følger med et produkt. Glæden ved at få noget nyt og spændende overskygges fuldstændigt af problemerne med at få det til at virke. Nogle giver op. Andre prøver sig frem. De ihærdige kontakter den butik eller virksomhed, hvor de har købt produktet. Uanset hvad har denne type problemer en negativ indflydelse på et produkts omdømme. Dårlige produkter bliver ikke anbefalet til venner og bekendte. Dårlig omtale smitter af på producenten. I en global verden, hvor mange virksomheder har betydelig eksport, kan følgerne være katastrofale. I yderste konsekvens kan det betyde liv eller død for virksomheden.

DET BETALER SIG AT INVESTERE I GOD DOKUMENTATION OG OVERSÆTTELSE

4: Brug af standarder ved udarbejdelse af dokumentation

Maskindirektivet
Udarbejdelse af dokumentation sker som regel på baggrund af et regelsæt. I denne artikel tages udgangspunkt i udarbejdelse af dokumentation i henhold til Maskindirektivet 2006/42. Maskindirektivet stiller en række krav til den sikkerhedsmæssige indretning af maskiner. For at markedsføre sin maskine i EU og EØS skal disse krav til maskinsikkerhed overholdes. En maskine må således ikke markedsføres, hvis den ikke er sikkerhedsmæssigt korrekt indrettet. Udover at stille krav til sikkerhed stiller Maskindirektivet også krav til den medfølgende dokumentation. Brugsanvisningen skal altid leveres på brugerlandets sprog – det gælder for EU- og EØS-lande. Dette er et ufravigeligt krav. Kun vedligeholdelsesvejledningen kan leveres på et andet sprog, og kun hvor vedligeholdelsesvejledningen anvendes af fabrikantens eget personale. Der stilles også krav til indholdet i brugsanvisningen, som er gengivet i Maskindirektivets bilag 1.7.4.2. Indholdskravet gælder alle brugsanvisninger. Afhængigt af maskintype stiller Maskindirektivet yderligere krav. F.eks. skal en maskine til fødevarer have en rengøringsvejledning.

Standarder
Maskindirektivet er loven, når det handler om indretning af maskiner. Som vejledninger til Maskindirektivet udarbejdes standarder. Man kan betragte dem som tolkninger af Maskindirektivet. En standard kan både omfatte et enkelt sikkerhedsaspekt, såsom nødstop eller rækkeafstande, og dække en specifik maskintype, f.eks. en koteletskæremaskine. Man er som sådan ikke tvunget til at bruge standarder – ens egne løsninger kan anvendes. Det samlede sikkerhedsniveau skal dog opretholdes. Det betyder, at egne løsninger skal være minimum lige så sikre som dem, der er angivet i standarden. Det samme gælder indholdskrav til dokumentation.
Udover krav til den sikkerhedsmæssige indretning af maskinen stiller standarder også supplerende krav til dokumentation og brugsanvisning. Man skal således både kende de grundlæggende krav fra Maskindirektivet,
samt de supplerende krav fra de anvendte standarder. Hvis en maskine er udstyret med wirenødstop, skal brugsanvisningen fortælle brugeren, at der skal foretages en inspektion af hele wirenødstoppets længde, inden maskinen genstartes.Opgaven for dokumentationsmedarbejderen er at finde ud af hvilket direktiv, der er relevant, samt hvilke standarder, der evt. er anvendt. Informationer om direktiver og standarder indsamles som regel fra konstruktionsafdelingen. Vi anbefaler at starte med at afklare direktiver og standarder allerede i konstruktionsfasen. Afklaringen skal sikre, at maskinen indrettes og dokumenteres korrekt. Det vil altid være en fordel at have en basisbrugsanvisning, der overholder Maskindirektivets krav. Derefter er opgaven at indbygge krav fra de anvendte standarder, således at dokumentationen overholder samtlige relevante krav. Den gode brugsanvisning overholder ikke blot de formelle krav fra direktiver og standarder. Den beskytter også fabrikanten mod, at maskinen giver anledning til ulykker.
Forfatter: World Translations samarbejdspartner Thomas Thillemann Petersen, afdelingsleder hos Maskinsikkerhed ApS.

5: Når produktet leveres

Alle, der arbejder med teknisk dokumentation, ved, hvor vigtigt det er, at dokumentationen opbygges så brugervenligt som muligt. Men det er ikke gjort med det. Det er mindst lige så vigtigt at have et system til dokumentstyring.
Et dokumentstyringssystem behøver ikke at være dyrt, kompliceret og ressourcekrævende. Ofte er et Excel-regneark nok. Det vigtigste er, at det giver et godt overblik over
virksomhedens dokumenter, og at det er nemt at vedligeholde.
Systemet skal kunne håndtere dokumentationen i hele produktets levetid; fra det øjeblik, hvor produktet leveres, i den periode, hvor produktet anvendes, og der kommer feedback fra brugere og andre interessenter, til den dag, hvor produktet ikke længere er i drift. Det er vigtigt for både sælger og kunde, at:
∙ det er den rigtige dokumentation, der leveres med produktet
∙ dokumentationen er sporbar, således at der altid henvises til samme type og version
∙ der er afsat interne ressourcer til at håndtere kundeforespørgsler. Uanset hvor god den tekniske dokumentation er, kan den ikke fortælle alt.
Nedenstående figur illustrerer en typisk livscyklus for teknisk dokumentation:
Tips & tricks
∙ Gå i gang med at fremstille den tekniske dokumentation i god tid før levering af produktet. Dokumentation, som laves i sidste øjeblik, risikerer nemt at blive mangelfuld eller at indeholde fejl.
∙ Opret et system til dokumentstyring.
∙ Forbered evt. dokumentationen til oversættelse.

6: Outsourcing – vejen frem

Outsourcing er processen, når en virksomhed vælger at købe ydelser – den tidligere selv har leveret – hos en underleverandør. Der er en stigende frem- gang inden for outsourcing, da det efterhånden er en nødvendighed for mange virksomheder for at forblive konkurrencedygtige. Teknisk dokumentation kan være en torn i øjet på mange produktionsvirksomheder. Det tager tid og ekspertise at skrive den, og hvem gider egentlig at læse den? Men fejl og mangler i dokumentation kan koste en virksomhed dyrt, når noget går galt, og konsekvenserne kan være alvorlige. For at reducere arbejdsbyrden, nedbringe lønomkostninger og sikre de rigtige kompetencer inden for teknisk dokumentation, kan du outsource dokumentationsopgaverne til et specialiseret bureau.
HVAD ER FORDELEN VED AT OUTSOURCE?
Brug dine ressourcer på den bedst mulige måde:
Lad dine medarbejdere koncentrere sig om deres kernekompetencer, og lad bureauets eksperter klare dokumentationsopgaverne.
Ingen faste lønomkostninger:
En konsulent skal naturligvis også have betaling for sit arbejde, men kun i den periode, hvor projektet kører. Der er ingen faste udgifter til kontorplads, forsikring, feriepenge m.m.
Få en stærk samarbejdspartner:
Med gensidig tillid kan der opnås et fantastisk samarbejde ift. vidensdeling mellem jeres specialister og
dokumentationseksperten.
Selvfølgelig betyder outsourcing, at du skal introducere konsulenten til dit produkt, dine arbejdsprocesser
og meget mere. Men når den del af arbejdet er gjort, kan konsulenten overtage dokumentationsarbejdet.
Vi kan sagtnes hjælpe dig med at oversætte din tekniske dokumentation til andre sprog. Læs mere om vores oversættelser.

7: Vejen mod globalisering

En del virksomheder tænker på eksport som en langsigtet mulighed, men rigtig mange virksomheder begynder lidt tilfældigt. Der er nemlig mange ting, der skal overvejes, inden man starter eksport. Når det gælder den tekniske dokumentation, er det vigtigt, at den er tilpasset det nye marked. Måske skal layout ændres, sproget ændres, eller der skal laves en helt ny type dokumentation. Når det drejer sig om eksport af maskiner, skal dokumentation overholde forskrifterne på de lokale markeder i Europa, bl.a. EU’s Maskindirektiv. Her er bl.a. beskrevet, hvilke dokumenter, der skal medleveres, og i hvilken form dokumenterne skal leveres. Der findes tilsvarende standarder for andre brancher. Her følger et par eksempler, der kan hjælpe dig til at undgå faldgruber i din tekniske dokumentation:
Eksempel 1)
En dansk producent af saltspredere anbefaler, at der anvendes salt i maskinerne i Danmark. I Norge, hvor frosten på vejene er hårdere, og frostperioden er længere, har salt ingen effekt. Tværtimod, vil saltet ofte kun smelte det øverste lag is på vejoverfladen, hvorved der opstår vand på vejene, som gør vejene glattere. Det betyder, at teksten i den norske manual skal tilpasses, så der bliver brugt det rigtige materiale i saltsprederene – så indholdet passer til de norske omstændigheder.
Eksempel 2)
I Danmark associerer vi ofte farven blå med fred, ro, harmoni, tillid og selvtillid. I andre lande er det anderledes. I Colombia associeres denne farve med sæbe. I Mellemøsten ses den som en beskyttende farve. I Kina forbinder man blå med udødelighed, og for jøderne er farven lig med hellighed. Forkert farvebrug kan resultere i et væld af kulturelle misforståelser, som i sidste ende kan skade virksomhedens eksport. Der er altså god grund til at overveje brugen af blå, og andre farver, i din tekniske dokumentation.
Eksempel 3)
Forkert formatering kan være en fejlkilde i forbindelse med oversættelse. Når man oversætter med CAT-værktøjer, bliver teksten delt op i mindre enheder. Opdelingen sker på basis af tegnsætning, formatering og koder. Hvis en sætning bliver delt op i flere enheder pga. forkert formatering, f. eks. fejlplaceret hårdt linjeskift, kan der ske fejl i oversættelsen, da sætningerne kan misforstås, eller få en anden betydning. Vær derfor omhyggelig med din tegnsætning og formatering, når du skriver din tekniske dokumentation. Du kan spare dig mange ærgrelser på eksportmarkedet, hvis du tænker på de mulige faldgruber på forhånd og aktivt gør noget ved dem, når du udarbejder din tekniske dokumentation. Det betyder måske, at du skal yde en ekstra indsats ved at undersøge farvebetydninger, eller de lokale omstændigheder, før du kan komme i gang
med eksporten. Til gengæld undgår du dårlige oplevelser i form af produktafvisning, hvis manualens indhold er fejlagtig, eller en arbejdsulykke ved betjeningen af maskinen i udlandet, hvis oversættelsen indeholder fejl pga. forkert formatering.

8: Med verden som arbejdsplads

Scenarie 1:
Du har solgt din maskine til udlandet. Endelig er der gang i eksporten. Men så kræver køberen, at dine manualer skal være på landets sprog, og siger, at de kun vil modtage din maskine, når alle oplysninger er på deres sprog. Hvad gør du så?
Scenarie 2:
Du vil gerne sælge dine produkter online. Din hjemmeside er på dansk og engelsk, men du får simpelthen ikke solgt noget til udlandet. Skulle det ikke være nok med en engelsk hjemmeside?
Professionel oversættelse er løsningen til disse problemer
Når du sælger din maskine indenfor den Europæiske Union, så gælder EU’s Maskindirektiv. Det foreskriver blandt andet, at den tekniske dokumentation, som følger med maskinen, skal være på landets officielle sprog. Køberen har ret til at afvise maskinen, hvis dokumentationen ikke foreligger på det pågældende sprog.
Du skal dog ikke kun oversætte dit materiale, fordi det er et lovkrav. Et studie fra Common Sense Advisory* har vist, at folk foretrækker onlineshopping på deres eget sprog. Hele 52,4 % af forbrugerne køber først produkter online, når hjemmesiden er oversat.
De er endda villige til at betale flere penge, når oplysningerne er på deres eget sprog. Oversættelsen af hjemmesiden kan altså bidrage til et øget salg af dine produkter.

Hent de 8 råd som en PDF:

Vane 5