En af de mest almindelige og vigtige anvendelser af teknisk skrivning er at give instruktioner, dvs. trinvise forklaringer på, hvordan man samler, betjener, reparerer eller udfører rutinemæssig vedligeholdelse på noget. Selv om de kan virke intuitive og enkle at skrive, er vejledninger nogle af de dårligst skrevne dokumenter, du kan finde. De fleste af os har sikkert haft mange irriterende oplevelser med dårligt skrevne instruktioner. Dette kapitel vil vise dig, hvad fagfolk anser for at være de bedste teknikker til at udarbejde instruktioner.
Et effektivt sæt instruktioner kræver følgende:
- Klar, præcis og enkel skrift
- En grundig forståelse af proceduren i alle dens tekniske detaljer
- Evnen til at sætte sig i læserens sted, den person, der forsøger at bruge din instruktion
- Evnen til at visualisere proceduren i detaljer og til at fange denne bevidsthed på papiret
- Villighed til at afprøve din instruktion på den type person, som du har skrevet den til.
I begyndelsen af et projekt om at skrive et sæt instruktioner er det vigtigt at bestemme strukturen eller karakteristika for den særlige procedure, som du skal skrive om. Her er nogle trin, du kan følge:
Gør en omhyggelig analyse af målgruppen og opgaven
Først i processen skal du definere målgruppen og situationen for din vejledning. Husk, at definitionen af en målgruppe betyder, at du definerer det niveau af fortrolighed, som dine læsere har med emnet.
Festlæg antallet af opgaver
Hvor mange opgaver er der i den procedure, som du skriver om? Lad os bruge udtrykket procedure til at henvise til hele det sæt af aktiviteter, som dine instruktioner skal omhandle. En opgave er en semi-uafhængig gruppe af handlinger inden for proceduren: f.eks. er indstilling af uret på en mikrobølgeovn én opgave i den store overordnede procedure for betjening af en mikrobølgeovn.
En simpel procedure som f.eks. olieskift i en bil indeholder kun én opgave; der er ingen semi-uafhængige grupperinger af aktiviteter. En mere kompleks procedure som f.eks. at bruge en mikrobølgeovn indeholder flere semi-uafhængige opgaver: indstilling af uret; indstilling af effektniveauet; brug af timeren; rengøring og vedligeholdelse af mikrobølgeovnen, blandt andre.
Somme instruktioner har kun en enkelt opgave, men har mange trin inden for denne enkelt opgave. Forestil dig f.eks. et sæt instruktioner til samling af et gyngesæt til børn. I min egen erfaring var der mere end 130 trin! Det kan være en smule skræmmende. En god fremgangsmåde er at gruppere lignende og beslægtede trin i faser og begynde at omnummerere trinene ved hver ny fase. En fase er således en gruppe af lignende trin inden for en procedure med en enkelt opgave. I gyngesæt-eksemplet ville opstilling af rammen være en fase; forankring af tingesten i jorden ville være en anden; samling af kasse-gyngen ville være endnu en anden.
3. Bestem den bedste tilgang til trin-for-trin-diskussionen
For de fleste instruktioner kan du fokusere på opgaver, eller du kan fokusere på værktøjer (eller funktioner ved værktøjer). I en opgavetilgang (også kendt som opgaveorientering) til instruktioner om brug af en telefonsvarertjeneste ville du have disse afsnit:
- Indspilning af din hilsen
- Afspilning af dine beskeder
- Sparring af dine beskeder
- Forsendelse af dine beskeder
- Sletning af dine beskeder og så videre
Dette er opgaver – de typiske ting, vi ønsker at gøre med maskinen.
På den anden side ville der i en værktøjstilgang til instruktioner om brugen af en fotokopimaskine sandsynligvis være afsnit om, hvordan man bruger specifikke funktioner:
- Knap til kopiering
- Knap til annullering
- Knap til forstørrelse/reduktion
- Knap til samkøring/hæftning
- Knap til kopieringsstørrelse og så videre
Hvis man udtænkte et sæt instruktioner efter denne plan, ville man skrive trin til brug af hver enkelt knap eller funktion i fotokopimaskinen. Instruktioner, der anvender denne værktøjstilgang, er svære at få til at fungere. Nogle gange passer navnet på knappen ikke helt til den opgave, den er forbundet med; nogle gange skal man bruge mere end blot den ene knap for at udføre opgaven. Alligevel kan der være tidspunkter, hvor værktøjs-/funktion-tilgangen kan være at foretrække.
4. Design grupperinger af opgaver
Listen over opgaver er måske ikke alt, hvad du har brug for at gøre. Der kan være så mange opgaver, at du skal gruppere dem, så læserne lettere kan finde de enkelte opgaver. Følgende er f.eks. almindelige opgavegrupperinger i instruktioner:
- Opgaver vedrørende udpakning og opsætning
- Opgaver vedrørende installation og tilpasning
- Grundlæggende driftsopgaver
- Rutinemæssige vedligeholdelsesopgaver
- Opgaver vedrørende fejlfinding.
Fælles afsnit i instruktioner
Det følgende er en gennemgang af de afsnit, som du almindeligvis finder i instruktioner. Du skal ikke gå ud fra, at hver enkelt af dem skal være med i de faktiske instruktioner, du skriver, eller at de skal være i den rækkefølge, der er præsenteret her, eller at det er de eneste mulige afsnit i et sæt instruktioner.
For alternative formater kan du tjekke eksempelinstruktionerne.
Indledning: Planlæg indledningen til din instruktion omhyggeligt. Den kan omfatte noget af følgende (men ikke nødvendigvis i denne rækkefølge):
- Angiv de specifikke opgaver eller den procedure, der skal forklares, samt omfanget (hvad der vil blive dækket og ikke dækket)
- Angiv, hvad målgruppen har brug for af viden og baggrund for at forstå vejledningen
- Giv en generel idé om proceduren, og hvad den opnår
- Angiv, under hvilke omstændigheder denne vejledning bør (eller ikke bør) anvendes
- Giv en oversigt over indholdet af vejledningen.
Allmene advarsler, advarsler, faresignaler: Instruktioner skal ofte gøre læseren opmærksom på muligheden for at ødelægge sit udstyr, for at ødelægge proceduren og for at skade sig selv. Desuden skal vejledninger ofte fremhæve vigtige punkter eller undtagelser. I disse situationer bruger du specielle meddelelser – note, advarsel, forsigtighed, forsigtighed og fare. Læg mærke til, hvordan disse særlige bemærkninger bruges i de ovenfor anførte eksempelinstruktioner.
Teknisk baggrund eller teori: I begyndelsen af visse typer instruktioner (efter indledningen) kan du have brug for en diskussion af baggrund i forbindelse med proceduren. For visse instruktioner er denne baggrund afgørende – ellers giver trinene i proceduren ingen mening. Du har f.eks. måske erfaring med de softwareapplets, hvor du kan definere dine egne farver ved at flytte rundt på de røde, grønne og blå skydebjælker. For virkelig at forstå, hvad du gør, er du nødt til at have en vis baggrund om farver. På samme måde kan du forestille dig, at der i forbindelse med visse instruktioner med kameraer også kan være behov for noget teori.
Udstyr og forsyninger: Læg mærke til, at de fleste instruktioner indeholder en liste over de ting, som du skal samle, før du begynder proceduren. Dette omfatter udstyr, de redskaber, du bruger i proceduren (f.eks. røreskåle, skeer, brødpander, hammere, boremaskiner og save), og forsyninger, de ting, der forbruges i proceduren (f.eks. træ, maling, olie, mel og søm). I instruktioner er disse typisk anført enten i en simpel lodret liste eller i en liste med to kolonner. Brug listen med to kolonner, hvis du har brug for at tilføje nogle specifikationer til nogle eller alle emnerne – f.eks. mærkenavne, størrelser, mængder, typer, modelnumre osv.
Diskussion af trinene: Når du kommer til den egentlige skrivning af trinene, er der flere ting, du skal være opmærksom på: (1) strukturen og formatet af disse trin, (2) supplerende oplysninger, der kan være nødvendige, og (3) synspunktet og den generelle skrivestil.
Struktur og format: Normalt forestiller vi os et sæt instruktioner som værende formateret som lodrette nummererede lister. Og det er de fleste faktisk også. Normalt formaterer man sine egentlige trin-for-trin-vejledninger på denne måde. Der er dog nogle variationer samt nogle andre overvejelser:
- Trin med fast rækkefølge er trin, der skal udføres i den præsenterede rækkefølge. Hvis du f.eks. skifter olie i en bil, er aftapning af olien et trin, der skal komme før påfyldning af ny olie. Der er tale om nummererede lister (normalt lodret nummererede lister).
- Trin med variabel rækkefølge er trin, der kan udføres i praktisk talt hvilken som helst rækkefølge. Gode eksempler er de fejlfindingsvejledninger, der fortæller dig, at du skal tjekke dette, tjekke det, hvor du forsøger at reparere noget. Du kan udføre disse typer trin i praktisk talt enhver rækkefølge. Med denne type er punktlister det passende format.
- Alternative trin er trin, hvor der præsenteres to eller flere måder at udføre den samme ting på. Alternative trin anvendes også, når der kan være forskellige betingelser. Brug punktlister med denne type, med OR indsat mellem alternativerne, eller indledningen, der angiver, at alternativerne er ved at blive præsenteret.
- Skjulte trin kan bruges i tilfælde, hvor de enkelte trin i en procedure er ret komplekse i sig selv og skal opdeles i undertrin. I dette tilfælde indrykker man yderligere og ordner undertrinnene som a, b, c osv.
- “Trinløse” instruktioner. kan bruges, når man virkelig ikke kan bruge nummererede lodrette lister eller give en direkte instruktionslignende vejledning af læseren. Nogle situationer må være så generaliserede eller så variable, at trin ikke kan angives.
Supplerende diskussion: Ofte er det ikke nok blot at fortælle læserne, at de skal gøre dette eller hint. De har brug for yderligere forklarende information såsom hvordan tingen skal se ud før og efter trinnet; hvorfor de bør interessere sig for at udføre dette trin; hvilket mekanisk princip der ligger bag det, de gør; endnu mere mikro-niveau forklaring af trinnet – diskussion af de specifikke handlinger, der udgør trinnet.
Problemet med supplerende diskussion er imidlertid, at den kan skjule det egentlige trin. Man ønsker, at det egentlige trin – de specifikke handlinger, som læseren skal foretage – skal fremstå tydeligt. Du ønsker ikke, at det hele skal være begravet i en bunke ord. Der er mindst to teknikker til at undgå dette problem: Du kan dele instruktionen fra supplementet op i separate afsnit, eller du kan sætte instruktionen med fed skrift.
Skriftstil
Placering af de vigtigste brugertrin med fed skrift kan være en meget nyttig måde at signalere klart og tydeligt, hvad læseren skal gøre. Ofte er kommandoverbet skrevet med fed skrift; nogle gange fremhæver fed skrifttype den nøglekomponent, der omtales.
Brug af passiv stemme i instruktioner kan være problematisk. Af en eller anden mærkelig grund lyder nogle instruktioner sådan her: “Pause-knappen skal trykkes ned for at stoppe skærmen midlertidigt.” Ikke alene er vi bekymrede for pauseknappens mentale helbred, men vi undrer os også over, hvem der skal trykke på den (ninjaer?). Det ville være mere nyttigt at angive, hvornår læseren skal “trykke på pauseknappen”. Overvej dette eksempel: “Timer-knappen indstilles derefter til 3:00.” Igen kan man spørge: “er indstillet af hvem? Ninjas?” Den person, der følger disse instruktioner, vil måske tro, at det blot er en henvisning til en eksisterende tilstand, eller hun vil måske undre sig: “Taler de til mig?” Brug af tredje person kan også føre til akavethed: “Brugeren skal derefter trykke på pauseknappen.” Instruktioner bør typisk skrives ved hjælp af kommando-verbumformer og ved brug af “du” for at gøre det helt klart, hvad læseren skal gøre.
Illustration af dine instruktioner
Måske mere end i nogen anden form for teknisk skrivning er grafik afgørende for instruktioner. Nogle gange kan ord simpelthen ikke forklare et trin. Illustrationer er ofte afgørende for læsernes evne til at visualisere, hvad det er meningen, at de skal gøre. Sørg for, at grafikken repræsenterer billedet fra læserens perspektiv.
Formatering af dine instruktioner
Da folk sjældent har lyst til at læse instruktioner, men ofte er nødt til det, skal du formatere dine instruktioner, så de er læsbare for modvillige læsere. Prøv at få din læser til at få lyst til at læse dem, eller i det mindste til ikke at være modstandsdygtig over for tanken om at konsultere dem. Et format med høj læsbarhed vil gøre det muligt for læsere, der selv har fundet ud af nogle af instruktionerne, at springe til det afsnit, hvor de er gået i stå. Brug det, du har lært om overskrifter, lister, visuelt materiale og passiv plads, til at skabe effektive og læsbare instruktioner:
Overskrifter: Normalt vil du have overskrifter for ethvert baggrundsafsnit, du måtte have, afsnittet om udstyr og forsyninger, en generel overskrift for selve instruktionsafsnittet og underoverskrifter for de enkelte opgaver eller faser inden for dette afsnit.
Lister: På samme måde gør instruktioner typisk udstrakt brug af lister, især nummererede lodrette lister til de egentlige trinvise forklaringer. Enkle lodrette lister eller lister med to kolonner er normalt gode til afsnittet om udstyr og forsyninger. Lister i sætninger er gode, når du giver et overblik over de kommende ting.
Særlige meddelelser: Du kan være nødt til at advare læserne om muligheder, hvor de kan beskadige deres udstyr, spilde forsyninger, få hele proceduren til at mislykkes, skade sig selv eller andre – endda alvorligt eller dødeligt. Virksomheder er blevet sagsøgt for mangel på disse særlige meddelelser, for dårligt skrevne særlige meddelelser eller for særlige meddelelser, der var uhensigtsmæssige. Se særlige meddelelser for en fuldstændig diskussion af den korrekte brug af disse særlige meddelelser samt deres format og placering i vejledningen.
Når du genlæser og reviderer dine instruktioner, skal du kontrollere, at de gør følgende:
- Gennemsigtigt beskriver den præcise procedure, der skal forklares
- Giver et overblik over indholdet
- Angiver krav til målgruppen
- Anvender forskellige typer af lister, hvor det er hensigtsmæssigt; Brug især nummererede lister til sekventielle trin
- Brug overskrifter og underoverskrifter til at opdele hovedafsnit og underafsnit i en logisk, sammenhængende rækkefølge
- Brug særlige meddelelser, hvis det er relevant
- Brug grafik til at illustrere vigtige handlinger og genstande
- Giv yderligere supplerende forklaringer på trinene, hvis det er nødvendigt
- Opret et afsnit med en liste over udstyr og forsyninger, hvis det er nødvendigt.