Technical Writing Essentials

Descriptive technical writing bruger en kombination af visuelle elementer og tekst til både at “vise” og “fortælle” læseren om de oplysninger, der formidles. Ligesom mere kreative beskrivelser trækker tekniske beskrivelser nogle gange på de “fem sanser” og metaforiske sammenligninger (analogier) for at give læseren mulighed for fuldt ud at begribe, hvad der bliver beskrevet. Oftere er de dog afhængige af konkrete, målelige beskrivelser. Tekniske beskrivelser kan antage mange former, afhængigt af formål og målgruppe. Beskrivelser kan være alt fra en kort sætning til et afsnit, et helt afsnit af en rapport eller en hel manual. Dårligt skrevne tekniske beskrivelser kan skabe forvirring, spilde tid og endda resultere i en katastrofe! Tekniske produktbeskrivelser er ofte lovpligtige for at sikre sikkerhed og overholdelse af reglerne. Opmærksomhed på detaljer er afgørende.

Produktspecifikationer kræver detaljerede beskrivelser af designfunktioner; instruktioner kræver ofte specifikke beskrivende detaljer for at “vise” læseren, hvad han/hun skal gøre. Nogle generelle kategorier af tekniske beskrivelser omfatter følgende:

• Mekaniske beskrivelser: giver et detaljeret overblik over de fysiske aspekter af et værktøj, en maskine eller en anden mekanisk anordning, der har bevægelige dele og er designet til at udføre en bestemt funktion. Der kan være tale om produktbeskrivelser til salg eller fremstilling, dokumentation af konstruktionsspecifikationer, infografikker osv. Dette kapitel fokuserer i detaljer på denne type beskrivelser.
• Procesbeskrivelser: beskriver detaljeret en række begivenheder (naturlige/biologiske/økologiske, mekaniske, sociale eller psykologiske fænomener), der sker i en bestemt rækkefølge med henblik på at opnå et bestemt resultat. De kan kategoriseres i ikke-undervisningsmæssige processer (f.eks. en procesanalyse af, hvordan en forbrændingsmotor fungerer, eller naturlige processer som fotosyntese) og undervisningsmæssige processer (f.eks. anbefalede/krævede procedurer og eksplicitte trinvise instruktioner, der skal følges). (Se afsnit 7.7 for detaljerede oplysninger om at skrive instruktioner).
• Definitioner: tydeliggør den specifikke betydning, ofte i forbindelse med en specifik kontekst, eller udtrykker den væsentlige karakter af de begreber, der defineres. De kan være af forskellig længde, fra en simpel afklarende sætning til et længere dokument på flere sider. Definitioner vil ofte omfatte detaljerede beskrivelser og visuelle illustrationer til at illustrere idéer. Klik på linket nedenfor for at se en PowerPoint-præsentation af en elev om, hvordan man skriver effektive definitioner til tekniske formål. Denne præsentation er medtaget med udtrykkelig tilladelse fra eleven.

Definitioner i teknisk skrivning – Eksempel på elevpræsentation (.pdf)

Mekanismebeskrivelser bør give en klar forståelse af den genstand, der beskrives, herunder

• Generelt udseende og fysiske egenskaber
• Overordnet funktion/formål
• Komponentdele
• Hvordan delene interagerer for at skabe en fungerende helhed.

Læseren skal være i stand til klart at forestille sig og dermed forstå karakteren af den genstand, der beskrives, hvad den gør, og hvordan den fungerer.

For at opnå denne klarhed for læseren skal forfatteren vælge væsentlige detaljer og organisere oplysningerne logisk. Vælg detaljer, der kan beskrives præcist og målbart, f.eks.

Afhængigt af læserens behov kan beskrivelsen spænde fra en generel oversigt, der kun kræver nogle få sætninger, til en håndbog i flere kapitler, der beskriver alle aspekter af mekanismens dele og funktioner i detaljer med henblik på at løse tekniske problemer og gennemføre reparationer. Et sjovt eksempel på sidstnævnte er Star Trek: The Next Generation: Technical Manual (forsiden er afbildet i figur 7.4.1), som indeholder detaljerede beskrivelser af alt udstyr og teknologi, der anvendes om bord på den fiktive U.S.S. Enterprise-D.

Hvor du begynder at udarbejde din beskrivelse, skal du overveje dit formål og din målgruppe: Hvorfor har din målgruppe brug for denne beskrivelse? Hvad vil de bruge den til? Skal du beskrive forskellige typer solcellepaneler for den almindelige forbruger for at hjælpe dem med at vælge den type, der passer bedst til deres behov? Giver du skitser til teknikere og installatører?

Når du har dit formål og din målgruppe klart i fokus, skal du udarbejde en beskrivelse, der indeholder følgende elementer:

1. Definition: Hvad er det, og hvad er dets hovedformål?
2. Oversigt: Beskriv mekanismens overordnede udseende (“det store billede”).
3. Komponenter: Beskriv mekanismens overordnede udseende (“det store billede”).
4. Komponenter: Beskriv de vigtigste komponentdele i mærkede afsnit; overvej rækkefølgen af oplysningerne nøje her. Skab en logisk forbindelse mellem hver enkelt komponent, der beskrives.
5. Forklaring: Hvordan arbejder delene sammen for at opfylde dens funktion? Hvilke nøgleprincipper styrer dens funktion? Overvej, hvor mange detaljer der er nødvendige her for din tiltænkte målgruppe.
6. Billedmateriale: Indhold grafik, der tydeligt illustrerer mekanismen og/eller dens dele. Vis anordningen som helhed; overvej at vise specifikke detaljer i udvidede visninger, udskæringer eller mærket diagrammer. Du kan endda indlejre eller linke til videoer, der viser apparatet i aktion.
7. Konklusion: Afhængigt af formålet kan du gennemgå produktets historie, tilgængelighed, fremstilling, omkostninger, advarsler osv: Kilder, du har brugt i din beskrivelse, eller yderligere tilgængelige informationskilder (hvis relevant).

Du kan overveje at bruge en skabelon, som f.eks. skabelonen for teknisk beskrivelse nedenfor, idet du skal huske på, at selv om skabeloner kan være nyttige vejledninger, giver de ikke megen fleksibilitet og fungerer måske ikke i alle situationer.

Eksempel på beskrivelser

Undersøg beskrivelsen af “Up Goer Five” i figur 7.4.2 (klik på billedet for at se en større version). Hvem kan den tiltænkte målgruppe være?

Sammenlign beskrivelsen i figur 7.4.2 med oplysningerne på NASA’s websted om Mars Curiosity Rover.

Opmærksomheden henledes på forskellene i beskrivelsernes detaljeringsgrad, ordforråd og overordnede formål. Hvis du brugte oplysningerne på NASA’s websted til at udfylde skabelonen for tekniske beskrivelser, ville du måske ende med noget, der ligner følgende skema. Objectives

Du finder måske, at nogle af disse elementer ikke er nødvendige; igen, overvej, hvad din målgruppe allerede ved. Find en balance mellem at sige det indlysende unødvendigt og at antage fejlagtigt, at dine læsere har viden, som de ikke har.

Ved finpudsning af detaljerne i din beskrivelse og dens bestanddele skal du overveje følgende:

• Organisation: Brug et logisk princip til at organisere din beskrivelse
  • Top til bund (eller fundament opad)
  • Venstre til højre (eller højre til venstre)
  • Indvendigt til udvendigt (eller udvendigt til indvendigt)
  • Mest vigtige til mindst vigtige funktioner
  • Central komponent til perifere dele
  • Materialeegenskaber osv.
• Sprog: Brug specifikke, præcise, konkrete udtryk – undgå vage eller alt for generelle udtryk
  • Brug korrekt terminologi – definér begreberne efter behov for din målgruppe
  • Brug analogi til at beskrive en ukendt ting i form af en velkendt ting
  • Brug objektivt sprog – ingen “ad speak” eller subjektive udtryk
  • Brug nutidsform, aktive verber til at beskrive, hvordan apparatet ser ud, og hvad det gør
  • Brug ord, der skaber levende og specifikke billeder i læserens hoved.

Vælg en almindelig, dagligdags genstand (f.eks. en af genstandene i figur 7.4.3) og udarbejd en teknisk beskrivelse for et publikum, der ikke er bekendt med genstanden. Start med at forestille dig en målgruppe og et formål, og prøv derefter at udfylde skabelonen for teknisk beskrivelse med detaljerede oplysninger. Ved hjælp af oplysningerne i din skabelon udarbejder du en kort beskrivelse på 1-2 afsnit og tilføjer visuelt materiale med korrekte billedtekster.