Teknisk Dokumentation & Manualer

Hvad dækker Teknisk Dokumentation & Manualer? Teknisk dokumentation er evnen til at gøre et komplekst produkt forståeligt nok til, at andre kan bruge det korrekt og sikkert. Det kan være en maskine, et softwareprodukt, et teknisk system eller en kombination af hardware og software.

En person med færdigheden kan omsætte viden fra ingeniører, udviklere og produktspecialister til information for den faktiske bruger. Det kræver mere end godt sprog. Personen skal forstå produktet, brugerens opgave og konsekvensen af uklare eller forkerte instruktioner.

Arbejdet kan omfatte brugermanualer, installationsvejledninger, servicevejledninger, onlinehjælp, administratorvejledninger, fejlfinding, release notes og tekniske vidensartikler.

En teknisk skribent starter normalt med at undersøge målgruppen og brugssituationen. En servicetekniker har andre behov end en førstegangsbruger. En systemadministrator har brug for andre detaljer end medarbejderen, der bruger systemet til daglig.

Derefter indsamler personen teknisk viden. Det sker eksempelvis gennem interviews med udviklere og ingeniører, produktdemonstrationer, tegninger, specifikationer, testmiljøer og eksisterende dokumentation. Dygtige tekniske skribenter accepterer ikke nødvendigvis fagpersonens første forklaring. De undersøger, indtil processen kan forklares entydigt.

Færdigheden viser sig tydeligt i procedurer. En god instruktion fortæller brugeren, hvad der skal gøres, i hvilken rækkefølge og under hvilke betingelser. Microsofts Writing Style Guide anbefaler blandt andet handlingsorienterede trin, tydelige overskrifter og en klar placering af handlinger i brugergrænsefladen.

Teknisk dokumentation handler også om informationsarkitektur. Store manualer skal opdeles, så brugeren kan finde den relevante information uden at læse alt. Emner kan eksempelvis opdeles i konceptforklaringer, konkrete opgaver, referenceinformation og fejlfinding.

Ved store produktporteføljer arbejder tekniske skribenter ofte med struktureret indhold. Tekstkomponenter kan genbruges på tværs af produkter, varianter og sprog. DITA er en etableret OASIS-standard til denne form for emnebaseret og struktureret teknisk indhold.

Terminologi er en anden del af færdigheden. Det samme komponentnavn eller systembegreb bør ikke skifte navn gennem manualen. Konsekvent terminologi gør dokumentationen lettere at forstå og lettere at oversætte.

Dokumentationen skal samtidig følge produktets ændringer. En dygtig teknisk skribent arbejder derfor med versionsstyring, review, godkendelser og ansvar for opdateringer. Dokumentationen er et produkt, der skal vedligeholdes sammen med maskinen eller softwaren.

For fysiske produkter kan dokumentation også have betydning for sikkerhed og compliance. IEC/IEEE 82079-1 beskriver principper og krav til information for brug af produkter. For maskiner beskriver ISO 20607 krav til de sikkerhedsrelevante dele af instruktionshåndbogen.

Teknisk skribentering er derfor ikke det samme som almindelig copywriting. Marketingtekst skal blandt andet skabe interesse. En teknisk manual skal først og fremmest være korrekt, entydig og anvendelig.

Hvornår er færdigheden Teknisk Dokumentation & Manualer vigtig? Færdigheden er vigtig, når brugeren ikke sikkert eller effektivt kan forstå et produkt ved blot at se på det.

I industrivirksomheder kan opgaven være dokumentation af installation, drift, vedligeholdelse og fejlfinding på maskiner. Her arbejder den tekniske skribent ofte tæt sammen med konstruktører, sikkerhedsspecialister og serviceorganisationen.

Ved software bruges færdigheden til blandt andet brugerhjælp, opsætning, administration, integrationer og fejlfinding. Skribenten arbejder typisk sammen med udviklere, produktchefer, UX-designere og support.

Færdigheden bliver særlig vigtig, når et produkt har mange funktioner eller brugergrupper. Dokumentationen skal kunne fortælle forskellige brugere præcis det, de har brug for, uden at drukne dem i resten.

Internationalisering gør også kompetencen vigtig. Hvis en virksomhed oversætter dokumentationen til mange markeder, bliver konsekvent terminologi og genanvendelige tekstmoduler værdifulde. Dårligt struktureret kildetekst skaber let fejl og ekstra arbejde i oversættelsen.

Teknisk dokumentation gør også en forskel i supportarbejdet. Gentagne spørgsmål fra kunder kan vise, at en funktion, procedure eller fejlmeddelelse mangler en forståelig forklaring. Teknisk dokumentation kan dermed koble produktudvikling, support og brugernes erfaringer.

På regulerede eller sikkerhedskritiske områder er korrektheden endnu vigtigere. En fejl i en reklametekst kan være irriterende. En fejl i en sikkerhedsinstruktion eller vedligeholdelsesprocedure kan få alvorlige konsekvenser.

En almindelig copywriter kan være relevant til simple forklaringer af et teknisk produkt. Ved komplekse maskiner, softwareplatforme eller sikkerhedskritisk brug bør man se efter reel erfaring med teknisk kommunikation og det relevante fagområde.

Hvordan trænes færdigheden Teknisk Dokumentation & Manualer? Teknisk skrivning læres bedst gennem en kombination af metode, teknisk forståelse og gentagen praktisk dokumentation.

Et godt udgangspunkt er tekom Competence Framework. tekom er den europæiske fagorganisation for teknisk kommunikation. Kompetencemodellen beskriver arbejdet fra analyse og planlægning til indholdsstrategi, indholdsproduktion, publicering og evaluering.

tekom tilbyder også certificering som Technical Communicator. TCTrainNet har uddannelsesforløb, der forbereder til tekom-certificeringen. Det er en mere målrettet vej for personer, der vil gøre teknisk kommunikation til deres fag.

IEC/IEEE 82079-1 er et centralt standardværk for personer, der arbejder med instruktioner og information til brugere af produkter. Personer, der skriver maskinmanualer, bør desuden kende ISO 20607 og relevante produkt- og sikkerhedskrav.

Til softwaredokumentation er Microsoft Writing Style Guide et nyttigt praktisk referenceværk. Det viser blandt andet, hvordan procedurer, tekniske begreber og brugerrettet softwaretekst kan struktureres klart.

Personer, der arbejder med større dokumentationsmiljøer, kan også lære structured authoring. DITA er relevant, når indhold skal opdeles i genbrugelige emner og publiceres i forskellige sammenhænge.

Den vigtigste træning er dog praktisk. Tag et produkt, du ikke selv har udviklet. Interview fagpersonen. Udfør proceduren selv. Skriv instruktionen. Lad en ny bruger følge den uden mundtlig hjælp. Ret de steder, hvor brugeren går i stå.

Det træner en afgørende disciplin: at opdage den viden, eksperten tager for givet. En erfaren ingeniør kan springe flere mentale trin over i sin forklaring. Den tekniske skribents arbejde er at finde de manglende trin uden at gøre teksten unødigt tung.

Review med fagpersoner er også vigtigt. Skribenten bør lære at få tekniske udsagn verificeret og samtidig fastholde et sprog, som målgruppen kan forstå.

Et kort kursus kan lære principper og metoder. Det gør ikke alene nogen til en stærk teknisk skribent. Sikker dokumentation kræver erfaring med produkter, brugere, reviews, ændringer og de fejl, der først bliver synlige, når andre forsøger at følge teksten.

Sådan genkender du én, der har færdigheden Teknisk Dokumentation & Manualer Bed personen vise rigtig teknisk dokumentation. En flot brochure siger meget lidt om evnen til at skrive en installationsvejledning eller fejlfindingsprocedure.

Se efter, om informationen er organiseret efter brugerens opgaver. Gode manualer er ikke blot lange beskrivelser af produktets funktioner. Brugeren skal hurtigt kunne finde ud af, hvordan en bestemt opgave udføres.

Bed kandidaten forklare, hvordan dokumentationen blev til. En erfaren teknisk skribent kan normalt beskrive målgruppeanalyse, research, interviews med fageksperter, review, test og vedligeholdelse.

Giv personen et ukendt teknisk produkt og spørg, hvordan arbejdet ville begynde. Et stærkt svar starter sjældent med at skrive. Personen vil først forstå brugere, produkt, opgaver, risici, eksisterende materiale og de eksperter, som skal levere eller validere informationen.

Spørg, hvordan personen ved, at en procedure faktisk virker. Et godt svar handler om at verificere teknikken og om muligt teste instruktionen mod produktet eller med relevante brugere.

Spørg også, hvad personen gør, hvis to ingeniører giver forskellige forklaringer. Teknisk dokumentation kræver evnen til at opdage uoverensstemmelser og få dem afklaret. Skribenten skal ikke gætte sig frem til den tekniske sandhed.

Ved maskinmanualer bør kandidaten kunne forklare forholdet mellem dokumentation, sikkerhed og produktets risici. Kendskab til IEC/IEEE 82079-1, ISO 20607 eller relevante branchespecifikke standarder er et stærkere signal end generel erfaring med tekst.

Ved software bør du se efter erfaring med procedurer, fejlfinding, releaseændringer og tæt samarbejde med udvikling og produktteams. Kendskab til struktureret dokumentation eller docs-as-code kan være relevant afhængigt af virksomhedens setup.

Værktøjserfaring er nyttig, men bør ikke stå alene. En person kan lære et bestemt dokumentationssystem. Det sværere er at forstå komplekst stof, finde den nødvendige information og forklare den præcist til den rigtige bruger.

Den stærkeste prøve er ofte en lille realistisk dokumentationsopgave. Vurder ikke kun sproget. Se efter korrekte forudsætninger, logisk rækkefølge, konsekvent terminologi, tydelige handlinger og spørgsmål til oplysninger, der mangler.