Instruktioner

Fokus for dette kapitel er en af de vigtigste af alle anvendelser af teknisk skrivning – instruktioner. Som du ved, er instruktioner de trinvise forklaringer på, hvordan man gør noget: hvordan man bygger, betjener, reparerer eller vedligeholder ting.

Sørg for at tjekke eksemplerne.

Skrivning af instruktioner

En af de mest almindelige og en af de vigtigste anvendelser af teknisk skrivning er instruktioner – de trinvise forklaringer på, hvordan man gør noget: samler noget, betjener noget, reparerer noget eller udfører rutinemæssig vedligeholdelse på noget. Men for noget, der tilsyneladende er så let og intuitivt, er vejledninger nogle af de dårligst skrevne dokumenter, man kan finde. Ligesom jeg har du sikkert haft mange irriterende oplevelser med dårligt skrevne vejledninger. Det, der følger i dette kapitel, er måske ikke en idiotsikker, goof-proof guide til at skrive instruktioner, men det vil vise dig, hvad fagfolk anser for de bedste teknikker.

Endeligt kræver det, at man skriver gode instruktioner:

• Klar, enkel skrivning
• En grundig forståelse af proceduren i alle dens tekniske detaljer
• Din evne til at sætte dig i læserens sted, den person, der forsøger at bruge din instruktion
• Din evne til at visualisere proceduren i stor detalje og til at fange denne bevidsthed på papiret
• Endeligt din vilje til at gå den ekstra distance og teste din instruktion på den type person, du har skrevet den til.

Snart har du sikkert studeret overskrifter, lister og særlige meddelelser – at skrive et sæt instruktioner med disse værktøjer virker sikkert indlysende. Du skal bare dele diskussionen op i nummererede lodrette lister og smide nogle særlige bemærkninger ind på de indlysende punkter, og så er du færdig! Nå, ikke helt, men det er en god start. I dette kapitel udforskes nogle af de funktioner i instruktioner, som kan gøre dem mere komplekse. Du kan til gengæld bruge disse overvejelser til at planlægge dine egne instruktioner.

Nogle indledende overvejelser

I begyndelsen af et projekt om at skrive instruktioner er det vigtigt at fastlægge strukturen eller karakteristika for den særlige procedure, du skal skrive om.

Adgangspunkt og situation. Tidligt i processen skal du definere målgruppen og situationen for din vejledning. Husk, at det at definere en målgruppe betyder at definere dens niveau af fortrolighed med emnet samt andre sådanne detaljer. Se diskussionen om målgrupper og de trin, der skal bruges til at definere målgrupper.

Det vigtigste er, at du, hvis du deltager i et skrivekursus, skal skrive en beskrivelse af din målgruppe og vedhæfte den til dine instruktioner. Dette vil gøre det muligt for din underviser at vurdere dine instruktioner med hensyn til, om de er rigtige for den tilsigtede målgruppe. Og husk også, at i et kursus i teknisk skrivning er det at foretrække at skrive til et ikke-specialiseret publikum – det er en langt større udfordring for dig som skribent.

Antal opgaver. Hvor mange opgaver er der i den procedure, 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 en 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 semiuafhængige grupperinger af aktiviteter. En mere kompleks procedure som f.eks. brugen af en mikrobølgeovn indeholder masser af sådanne semi-uafhængige opgaver: indstilling af uret; indstilling af effektniveauet; brug af timeren; rengøring og vedligeholdelse af mikrobølgeovnen, blandt andre. (Vejledningen til brug af et kamera er organiseret efter opgaver.)

Nogle instruktioner har kun en enkelt opgave, men har mange trin inden for den enkelte 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 eksemplet med gyngesættet ville opstilling af rammen være en fase, forankring i jorden ville være en anden, og samling af gyngekassen ville være endnu en anden.

Bedste tilgang til trin-for-trin-diskussionen. En anden overvejelse, som du måske ikke kan bestemme tidligt i forløbet, er, hvordan du skal fokusere dine instruktioner. For de fleste instruktioner kan du fokusere på opgaver, eller du kan fokusere på værktøjer (eller funktioner i værktøjer).

I en opgavetilgang (også kendt som opgaveorientering) til instruktioner om brug af en telefonsvarertjeneste ville du have disse afsnit:

• optagelse af din hilsen
• afspilning af dine beskeder
• sparing af dine beskeder
• videresendelse af dine beskeder
• sletning af dine beskeder og så videre

Dette er opgaver – de typiske ting, som vi ønsker at gøre med maskinen. For yderligere diskussion, se kapitlet om opgaveanalyse.

På den anden side ville der i en værktøjstilgang til instruktioner om brugen af en fotokopimaskine være disse usandsynlige afsnit:

• knap til kopiering
• knap til annullering
• knap til forstørrelse/reduktion
• knap til sammenklipning/hæftning
• knap til kopieringsstørrelse og så videre

Hvis du designede et sæt instruktioner efter denne plan, ville du 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-/funktionstilgangen kan være at foretrække.

Grupperinger af opgaver. Det er måske ikke alt, hvad du har brug for at gøre, at opstille en liste over opgaver. Der kan være så mange opgaver, at du er nødt til at gruppere dem, så læserne lettere kan finde de enkelte opgaver. Følgende er f.eks. almindelige grupperinger af opgaver i instruktioner:

1. Udpakning og opsætningsopgaver
2. Installations- og tilpasningsopgaver
3. Grundlæggende driftsopgaver
4. Rutinevedligeholdelsesopgaver
5. Fejlfindingsopgaver; og så videre

Fælles afsnit i instruktioner

Det følgende er en gennemgang af de afsnit, som du ofte 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 præsenteres her, eller at det er de eneste mulige afsnit i et sæt instruktioner.

Mens du læser det følgende om almindelige afsnit i instruktioner, skal du se på eksempelinstruktionerne.

Skematisk visning af instruktioner. Husk, at dette er en typisk eller almindelig model for indhold og organisering – mange andre er mulige.

Indledning. Planlæg indledningen til din vejledning omhyggeligt. Sørg for, at den gør nogen af følgende ting (men ikke nødvendigvis i denne rækkefølge), der gælder for netop din instruktion:

• Angiv de specifikke opgaver eller procedurer, der skal forklares, samt omfanget af dækningen (hvad der ikke vil blive dækket).
• Angiv, hvad publikum har brug for af viden og baggrund for at forstå instruktionen.
• Giv en generel idé om proceduren og om, hvad den medfører.
• Angiv de forhold, hvor disse instruktioner bør (eller ikke bør) anvendes.
• Giv en oversigt over indholdet af instruktionerne.

Se afsnittet om introduktioner for yderligere diskussion.

Allmene advarsler, forsigtigheds- og farehenvisninger. 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 gøre sig selv fortræd. 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 specielle meddelelser bruges i de ovenfor anførte eksempelinstruktioner.

Teknisk baggrund eller teori. I begyndelsen af visse typer instruktioner (efter indledningen, naturligvis) kan du have brug for en diskussion af baggrunden 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. Bemærk, at de fleste instruktioner indeholder en liste over de ting, 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 af 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 huske 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:

• Strin 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. I nogle tilfælde kan de enkelte trin i en procedure være ret komplekse i sig selv og skal derfor opdeles i undertrin. I dette tilfælde indrykker man yderligere og sekvenserer undertrinnene som a, b, c osv.
• “Trinløse” instruktioner. Og endelig findes der instruktioner, som virkelig ikke kan bruge nummereret lodret liste, og som kun i ringe grad, hvis overhovedet ikke direkte instruktionsagtigt, leder læseren. Nogle situationer må være så generaliserede eller så variable, at der ikke kan angives trin.

Se kapitlet om lister for stil og format for disse muligheder.

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 oplysninger som f.eks. 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; endda en forklaring af trinnet på mere mikroplan – en 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 skille sig ud. 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.

Fedskrift af de faktiske brugertrin i instruktioner. Fed tekst hjælper med at skelne den faktiske handling fra de supplerende oplysninger.

Skriftstil. Den måde, du rent faktisk skriver instruktioner, sætning for sætning, kan synes at være i modstrid med det, du har lært i tidligere skriveundervisning. Læg dog mærke til, hvordan “virkelige” instruktioner er skrevet – de bruger en masse imperativ (kommando eller direkte henvendelse) skrivemåde; de bruger en masse “du”. Det er helt passende. Du ønsker at komme ind i læserens ansigt, at få hendes eller hans fulde opmærksomhed. Derfor lyder sætninger i instruktionsstil som disse: “Tryk nu på knappen Pause på frontpanelet for at standse skærmen midlertidigt” og “Du skal være forsigtig med at …”

Et særligt problem er brugen af passiv stemme i instruktioner. Af en eller anden underlig grund lyder nogle instruktioner sådan her: “Pause-knappen skal trykkes ned for at stoppe displayet midlertidigt.” Ikke alene er vi bekymrede for pauseknappens mentale helbred, men vi undrer os også over, hvem der skal trykke på den (taler du til mig?). Eller tænk på dette eksempel: “Timer-knappen er derefter indstillet til 3:00.” Igen vil du som den person, der følger disse instruktioner, måske overse dette; du vil måske tro, at det blot er en henvisning til en eksisterende tilstand, eller du vil måske undre dig: “Taler de til mig?” Næsten lige så slemt er det at bruge den tredje person: “Brugeren skal derefter trykke på knappen Pause”. Igen er det den gamle dobbelttolkning: Du kigger rundt i rummet og tænker: “Hvem mig?” (For flere detaljer, se problemet med passiv-stemme.)

Et andet af de typiske problemer med skrivestilen i vejledninger er, at folk tilsyneladende ønsker at udelade artikler: “Tryk på pauseknappen på frontpanelet for at stoppe visningen af oplysninger midlertidigt” eller “Jordperson, angiv venligst adressen på den nærmeste pizzarestaurant”. Hvorfor gør vi det? Ønsker vi alle i hemmelighed at være robotter? Sørg i hvert fald for at medtage alle artikler (a, an, the) og andre ord, som vi normalt bruger i instruktioner.

Grafik i instruktioner

Sandsynligvis mere end i nogen anden form for skrift (bortset måske fra tegneserier) 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.

I et kursus i teknisk skrivning kan instruktionerne kræve, at du medtager illustrationer eller andre former for grafik – alt det, der normalt ville blive brugt i instruktionerne. Problemet kan naturligvis være, at du ikke har adgang til grafik, der passer til dine særlige instruktioner, og at du ikke føler dig helt sikker på dine kunstneriske evner. Der er måder at overvinde disse problemer på! Tag et kig på forslagene under grafik. I dette kapitel kan du ikke kun se forslag til at skabe grafik, men også krav til deres format.

Format i instruktioner

Overskrifter. I dine instruktioner skal du gøre god brug af 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. Tag et kig på eksemplerne i begyndelsen af dette kapitel. Se overskrifter for almindelige krav.

Lister. På samme måde gør instruktioner typisk stor 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 ting, der skal ske. Se lister for almindelige krav.

Særlige meddelelser. I instruktioner skal du gøre læserne opmærksomme på 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.

Indrykning af meddelelser i vejledninger. I det første eksempel kan du se, hvordan meddelelsen er indrykket i forhold til teksten i det foregående trin. I det andet eksempel kan du se, at den alvorlige meddelelse er placeret i begyndelsen før alle trin.

Numre, forkortelser og symboler. Vejledninger bruger også masser af tal, forkortelser og symboler. Du kan finde retningslinjer for disse områder.

Revisionscheckliste for instruktioner

Når du genlæser og reviderer dine instruktioner, skal du holde øje med problemer som f.eks. følgende:

• Sørg for at give rigtige instruktioner – forklaringer på, hvordan man bygger, betjener eller reparerer noget.
• Skriv en god indledning – i den skal du angive den præcise procedure, der skal forklares, angive målgruppens krav og give en oversigt over indholdet.
• Sørg for, at du bruger de forskellige typer lister, hvor det er hensigtsmæssigt. Brug især nummererede lodrette lister til sekventielle trin.
• Brug overskrifter til at afmærke alle hovedafsnit og underoverskrifter til underafsnit. (Husk, at det ikke er nødvendigt med en overskrift “Indledning” mellem titlen og det første afsnit. Husk ikke at bruge overskrifter på første niveau i denne opgave; start med andet niveau.)
• Brug evt. særlige bemærkninger.
• Sørg for at bruge den stil og det format for alle overskrifter, lister, særlige bemærkninger og grafik, som er præsenteret i disse kapitler. Hvis det er et problem, skal du kontakte din instruktør.
• Brug grafik til at illustrere alle vigtige handlinger eller objekter.
• Giv om nødvendigt yderligere supplerende forklaringer på trinene.
• Husk at oprette et afsnit med en liste over udstyr og forsyninger, hvis det er nødvendigt.

Jeg vil sætte pris på dine tanker, reaktioner, kritik vedrørende dette kapitel: dit svar-David McMurrey.