“Kan du garantere, at jeres technical writer er ekspert inden for vores område?” Vores branche er meget teknisk og adskiller sig en del fra de andre brancher.” Firmaer, der leverer dokumentationsydelser, hører ofte den slags spørgsmål fra kunder. Virksomheder er ofte af den opfattelse, at deres felt er så specielt, at kun en ekspert inden for området kan skrive dokumentation om deres emne.
Men disse eksperter er normalt allerede ansat i virksomheden, hvor de arbejder med produktudvikling eller sidder i en anden ekspertfunktion. De har ikke tid til at skrive dokumentation og ønsker det heller ikke – det er derfor, de kontakter et firma, der kan levere dokumentationsydelser. Disse eksperter kender ofte deres felt rigtig godt, men de er sjældent professionelle technical writers eller dygtige til teknisk dokumentation, og derfor kan de sandsynligvis ikke producere dokumentation, der er så flydende og velskrevet, som f.eks. en virksomheds image kræver.
Technical writers er derimod professionelle tekniske forfattere, der er trænet i at strukturere oplysninger. Ifølge en definition fra TC Europe, den europæiske paraplyorganisation for teknisk kommunikation, er en technical writer en mægler mellem et produkt og dets brugere. Det er kun godt, at en technical writer ikke kender emnet alt for godt, eftersom læseren af dokumentationen muligvis heller ikke føler sig hjemme på området. På den måde kan en technical writer bedre identificere sig med læseren og tilpasse sværhedsgrad og detaljeniveau, så det opfylder læserens behov. For at kunne forklare de vigtigste ting tydeligt skal en technical writer naturligvis have en grundlæggende forståelse af emnet. En klart formuleret og sammenhængende tekst hjælper en læser, der ikke kender emnet, med at forstå teksten.
En technical writer er en mægler mellem et produkt og dets brugere.
I stedet for at have en stor viden inden for et vist felt skal en technical writer have følgende vigtige færdigheder for at kunne producere god dokumentation:
Indsamling af information fra forskellige kilder, såsom eksisterende materiale fra kunden (gammel dokumentation, tekniske data, marketingmateriale) og branchewebsteder samt fra interviews med eksperter inden for området. Mod til at stille spørgsmål, der muligvis lyder dumme, er en væsentlig del af færdighederne i forbindelse med indsamling af information.
Udarbejdelse af teknisk dokumentation i praksis. De forskellige elementer i udarbejdelsen af teknisk dokumentation er de samme uanset område: planlægning af dokumentationen, bruger- og opgaveanalyse, indsamling og strukturering af information, udarbejdelse af dokumentationen og testning af dokumentationen, feedback og forbedring af dokumentationen og arbejdsmetoderne på baggrund af feedback.
Kvalitetskontrol, hvilket dækker over flere ting inden for dokumentation. Først og fremmest vil kunder gerne have, at deres tekst er klart formuleret og grammatisk korrekt. Brugervenlighed er også en vigtig faktor, der påvirker kvaliteten af dokumentationen. Den kan f.eks. forbedres ved at sikre, at terminologien er konsekvent og ved at sørge for en god strukturering af dokumentationen. Et velovervejet valg af terminologi og konsekvent brug heraf gør teksten mere forståelig, mens en tydelig struktur og sammenhængende stil gør teksten mere læsbar og gør det lettere at finde informationer i dokumentationen. En technical writer skal også sikre, at oplysningerne i dokumentationen dækker brugerens behov, og skal således kunne vurdere, hvilke oplysninger, der er vigtige for brugeren. Dokumentationen skal ikke indeholde alle mulige informationer om et emne.
Derfor er svaret på kundens spørgsmål: "Nej, vores technical writer er ikke ekspert inden for jeres område, og det er faktisk en god ting!" En technical writers egen ekspertise giver vedkommende mulighed for at producere objektiv og brugervenlig dokumentation, hvilket giver virksomheder mulighed for a fremme deres mål.
Har din virksomhed brug for hjælp til produktion af flersproget teknisk materiale? Har du brug for at få oversat din virksomheds eksisterende materiale til et andet sprog? Kontakt os, så hjælper vores eksperter dig med at vælge den bedste løsning til dine behov.
Updated