Instruktioner

Det här kapitlet fokuserar på en av de viktigaste användningsområdena för tekniskt skrivande – instruktioner. Som du vet är instruktioner de steg-för-steg-förklaringar av hur man gör något: hur man bygger, använder, reparerar eller underhåller saker.

Se till att kolla in exemplen.

Skrivande av instruktioner

En av de vanligaste och viktigaste användningsområdena för teknisk skrivning är instruktioner – dessa steg-för-steg-förklaringar av hur man gör saker: monterar något, använder något, reparerar något eller utför rutinunderhåll på något. Men för något som verkar vara så enkelt och intuitivt är instruktioner några av de sämst skrivna dokumenten du kan hitta. Precis som jag har du förmodligen haft många upprörande erfarenheter av dåligt skrivna instruktioner. Det som följer i det här kapitlet är kanske inte en idiotsäker, goof-proof-guide för att skriva instruktioner, men det kommer att visa dig vad proffs anser vara de bästa teknikerna.

Enligt slutändan krävs det för att skriva bra instruktioner att:

• Tydlig, enkel skrivning
• En grundlig förståelse för förfarandet i alla dess tekniska detaljer
• Din förmåga att sätta dig i läsarens ställe, den person som försöker använda dina instruktioner
• Din förmåga att visualisera förfarandet i detalj och att fånga den medvetenheten på papper
• Slutligt, din vilja att gå det där lilla extra och testa dina instruktioner på den typ av person som du skrivit dem för.

Hej, vid det här laget har du förmodligen studerat rubriker, listor och särskilda meddelanden – att skriva en uppsättning instruktioner med dessa verktyg verkar förmodligen självklart. Det är bara att dela upp diskussionen i numrerade vertikala listor och slänga in några särskilda notiser på de uppenbara punkterna så är du klar! Inte riktigt, men det är en bra början. Det här kapitlet utforskar några av de egenskaper hos instruktioner som kan göra dem mer komplexa. Du kan i sin tur använda dessa överväganden för att planera dina egna instruktioner.

Vissa förkunskaper

I början av ett projekt för att skriva instruktioner är det viktigt att bestämma strukturen eller egenskaperna hos den speciella procedur som du ska skriva om.

Publik och situation. Definiera tidigt i processen målgruppen och situationen för dina instruktioner. Kom ihåg att definiera en publik innebär att definiera dess nivå av förtrogenhet med ämnet samt andra sådana detaljer. Se diskussionen om målgrupper och steg att använda för att definiera målgrupper.

Det viktigaste, om du går en skrivkurs, är att du måste skriva en beskrivning av din målgrupp och bifoga den till dina instruktioner. På så sätt kan din lärare bedöma dina instruktioner med avseende på om de är lämpliga för den avsedda målgruppen. Kom också ihåg att i en kurs i tekniskt skrivande är det att föredra att skriva för en icke specialiserad publik – en mycket större utmaning för dig som skribent.

Antal uppgifter. Hur många uppgifter finns det i det förfarande som du skriver om? Låt oss använda termen förfarande för att hänvisa till hela den uppsättning aktiviteter som dina instruktioner är avsedda att behandla. En uppgift är en halvt oberoende grupp av åtgärder inom proceduren: att ställa klockan på en mikrovågsugn är till exempel en uppgift i den stora övergripande proceduren för att använda en mikrovågsugn.

En enkel procedur som t.ex. oljebyte i en bil innehåller endast en uppgift; det finns inga halvoberoende grupperingar av aktiviteter. Ett mer komplext förfarande som att använda en mikrovågsugn innehåller många sådana halvoberoende uppgifter: ställa in klockan, ställa in effektnivån, använda timern, rengöra och underhålla mikrovågsugnen, med mera. (Anvisningarna för att använda en kamera är organiserade efter uppgifter.)

Vissa anvisningar har bara en enda uppgift, men har många steg inom den enda uppgiften. Tänk dig till exempel en uppsättning instruktioner för att montera en gungställning för barn. Enligt min egen erfarenhet fanns det mer än 130 steg! Det kan vara lite skrämmande. Ett bra tillvägagångssätt är att gruppera liknande och relaterade steg i faser och börja numrera om stegen vid varje ny fas. En fas är då en grupp av liknande steg inom ett förfarande med en enda uppgift. I exemplet med gungställningen är det en fas att sätta upp ramen, en annan fas är att förankra den i marken och ytterligare en fas är att montera gungan i lådan.

Bästa tillvägagångssättet för diskussionen om steg för steg. Ett annat övervägande, som du kanske inte kan avgöra i ett tidigt skede, är hur du ska fokusera dina instruktioner. För de flesta instruktioner kan du fokusera på uppgifter, eller så kan du fokusera på verktyg (eller egenskaper hos verktyg).

I ett uppgiftsinriktat tillvägagångssätt (även kallat uppgiftsorientering) för instruktioner om hur man använder en telefonsvarartjänst skulle du ha dessa avsnitt:

• Inspelning av din hälsning
• Avspelning av dina meddelanden
• Sparande av dina meddelanden
• Förmedling av dina meddelanden
• Släckning av dina meddelanden, och så vidare

Det här är uppgifter – de typiska sakerna vi skulle vilja göra med maskinen. För ytterligare diskussion, se kapitlet om uppgiftsanalys.

Å andra sidan, i en verktygsmetod för instruktioner om hur man använder en kopieringsmaskin, skulle det finnas dessa osannolika avsnitt:

• kopieringsknappen
• avbrytningsknappen
• förstorings-/förminskningsknappen
• sammanställnings-/staplingsknappen
• kopieringsstorleksknappen, och så vidare

Om du skulle utforma en uppsättning instruktioner på den här planen, skulle du skriva steg för att använda varje knapp eller funktion på kopieringsmaskinen. Instruktioner som använder den här verktygsmetoden är svåra att få att fungera. Ibland stämmer knappens namn inte riktigt överens med den uppgift som den är förknippad med, ibland måste man använda mer än bara den ena knappen för att utföra uppgiften. Ändå kan det finnas tillfällen då tillvägagångssättet verktyg/funktion kan vara att föredra.

Grupperingar av uppgifter. Att lista uppgifter är kanske inte allt du behöver göra. Det kan finnas så många uppgifter att du måste gruppera dem så att läsarna lättare kan hitta enskilda uppgifter. Följande är till exempel vanliga grupperingar av uppgifter i instruktioner:

1. Uppackning och installationsuppgifter
2. Installation och anpassningsuppgifter
3. Grundläggande driftsuppgifter
4. Rutinmässiga underhållsuppgifter
5. Felsökningsuppgifter; och så vidare

Gemensamma avsnitt i instruktioner

Nedan följer en genomgång av de avsnitt som du ofta hittar i instruktioner. Anta inte att var och en av dem måste finnas i de faktiska instruktionerna du skriver, inte heller att de måste vara i den ordning som presenteras här, inte heller att detta är de enda möjliga avsnitten i en uppsättning instruktioner.

När du läser följande om vanliga avsnitt i instruktioner, kolla in exempelinstruktionerna.

Schematisk vy av instruktioner. Kom ihåg att detta är en typisk eller vanlig modell för innehåll och organisation – många andra är möjliga.

Introduktion. Planera inledningen till dina instruktioner noggrant. Se till att den gör något av följande (men inte nödvändigtvis i denna ordning) som gäller för just dina instruktioner:

• Ange de specifika uppgifter eller förfaranden som ska förklaras samt omfattningen av täckningen (vad som inte kommer att täckas).
• Ange vad åhörarna behöver i form av kunskap och bakgrund för att förstå instruktionerna.
• Ge en allmän uppfattning om förfarandet och vad det åstadkommer.
• Ange under vilka förhållanden dessa instruktioner bör (eller inte bör) användas.
• Ge en översikt över innehållet i instruktionerna.

Se avsnittet om introduktioner för ytterligare diskussion.

Allmänna varningar, varningar, faroanvisningar. Instruktioner måste ofta uppmärksamma läsarna på möjligheten att förstöra sin utrustning, sabotera förfarandet och skada sig själva. Dessutom måste instruktioner ofta betona viktiga punkter eller undantag. För dessa situationer använder du särskilda notiser – notis, varning, försiktighet och fara. Lägg märke till hur dessa särskilda meddelanden används i de exempelinstruktioner som anges ovan.

Teknisk bakgrund eller teori. I början av vissa typer av instruktioner (efter inledningen, förstås) kan du behöva en diskussion om bakgrund relaterad till proceduren. För vissa instruktioner är denna bakgrund avgörande – annars blir stegen i proceduren meningslösa. Du kanske till exempel har erfarenhet av de mjukvaruapplets där du kan definiera dina egna färger genom att flytta runt på röda, gröna och blå skjutreglage. För att verkligen förstå vad du gör måste du ha en viss bakgrund om färg. På samma sätt kan du tänka dig att det för vissa instruktioner där man använder kameror kan behövas lite teori också.

Utrustning och förnödenheter. Lägg märke till att de flesta instruktioner innehåller en lista över de saker som du måste samla ihop innan du påbörjar proceduren. Detta inkluderar utrustning, de verktyg som du använder i proceduren (t.ex. blandningsskålar, skedar, brödformar, hammare, borrar och sågar) och förnödenheter, de saker som förbrukas i proceduren (t.ex. trä, färg, olja, mjöl och spik). I instruktioner listas dessa vanligtvis antingen i en enkel vertikal lista eller i en lista med två kolumner. Använd listan med två kolumner om du behöver lägga till vissa specifikationer till några eller alla artiklar – till exempel märkesnamn, storlekar, mängder, typer, modellnummer och så vidare.

Diskussion av stegen. När du kommer till själva skrivandet av stegen finns det flera saker att tänka på: (1) strukturen och formatet för dessa steg, (2) kompletterande information som kan behövas och (3) synvinkel och allmän skrivstil.

Struktur och format. Normalt föreställer vi oss att en uppsättning instruktioner är formaterade som vertikala numrerade listor. Och det är de flesta faktiskt också. Normalt sett formaterar du dina faktiska steg-för-steg-instruktioner på detta sätt. Det finns dock vissa variationer, liksom några andra överväganden:

• Steg med fast ordning är steg som måste utföras i den ordning som presenteras. Om du till exempel byter olja i en bil är tömning av oljan ett steg som måste komma innan du sätter i den nya oljan. Dessa är numrerade listor (vanligtvis vertikala numrerade listor).
• Steg med varierande ordning är steg som kan utföras i praktiskt taget vilken ordning som helst. Goda exempel är de felsökningsguider som säger att du ska kontrollera det här, kontrollera det där när du försöker åtgärda något. Du kan utföra dessa typer av steg i praktiskt taget vilken ordning som helst. För den här typen är punktlista det lämpliga formatet.
• Alternativa steg är steg där två eller flera sätt att utföra samma sak presenteras. Alternativa steg används också när olika villkor kan föreligga. Använd punktlistor med denna typ, med OR infogat mellan alternativen, eller inledningen som indikerar att alternativ är på väg att presenteras.
• Nested steps (inbäddade steg). I vissa fall kan enskilda steg inom en procedur vara ganska komplexa i sig själva och behöver delas upp i delsteg. I det här fallet drar man in ytterligare strecksatser och ordnar delstegen som a, b, c och så vidare.
• ”Steglösa” instruktioner. Slutligen finns det instruktioner som egentligen inte kan använda sig av numrerade vertikala listor och som inte ger läsaren någon direkt vägledning i instruktionsstil. Vissa situationer måste vara så generaliserade eller så varierande att steg inte kan anges.

Se kapitlet om listor för stil och format för dessa möjligheter.

Supplementär diskussion. Ofta räcker det inte att bara tala om för läsarna att de ska göra det ena eller det andra. De behöver ytterligare förklarande information, t.ex. hur saken ska se ut före och efter steget, varför de ska bry sig om att göra det här steget, vilken mekanisk princip som ligger bakom det de gör, till och med en förklaring av steget på mikronivå – en diskussion om de specifika åtgärder som ingår i steget.

Problemet med kompletterande diskussion är dock att den kan dölja det egentliga steget. Man vill att det egentliga steget – de specifika åtgärder som läsaren ska vidta – ska framträda tydligt. Du vill inte att det ska vara begravt i en hög med ord. Det finns minst två tekniker för att undvika detta problem: du kan dela upp instruktionen från tillägget i separata stycken, eller så kan du fetstila instruktionen.

Fetstilning av faktiska användarsteg i instruktioner. Fet text hjälper till att skilja den faktiska åtgärden från den kompletterande informationen.

Skrivstil. Det sätt på vilket du faktiskt skriver instruktioner, mening för mening, kan verka motsägelsefullt mot vad tidigare skrivkurser har lärt dig. Lägg dock märke till hur ”riktiga” instruktioner skrivs – de använder en hel del imperativ skrivstil (kommandostil, eller direkt adress); de använder en hel del ”du”. Det är helt lämpligt. Du vill vara i läsarens ansikte, få hennes eller hans fulla uppmärksamhet. Av den anledningen låter instruktioner som dessa meningar så här: ”Tryck nu på pausknappen på frontpanelen för att tillfälligt stoppa visningen” och ”Du bör vara försiktig så att du inte …”

Ett särskilt problem är användningen av den passiva rösten i instruktioner. Av någon konstig anledning låter vissa instruktioner så här: ”Pausknappen ska tryckas ned för att tillfälligt stoppa displayen.” Vi är inte bara oroliga för pausknappens mentala hälsa, utan vi undrar också vem som ska trycka ner den (talar du till mig?). Eller ta det här exemplet: ”Timerknappen ställs sedan in på 3:00.” Återigen, som den person som följer dessa instruktioner kan du missa detta; du kanske tror att det helt enkelt är en hänvisning till något befintligt tillstånd, eller så undrar du: ”Pratar de med mig?”. Nästan lika illa är det att använda tredje person: ”Användaren ska sedan trycka på pausknappen.” Återigen är det den gamla dubbla tagningen: du ser dig omkring i rummet och undrar: ”Vem är jag?”. (För mer information, se problemet med passiv röst.)

Ett annat av de typiska problemen med skrivstilen i instruktioner är att folk verkar vilja utelämna artiklar: ”Tryck på pausknappen på frontpanelen för att stoppa visningen av information tillfälligt” eller ”Jordperson, ange adressen till närmaste pizzeria”. Varför gör vi detta? Vill vi alla i hemlighet vara robotar? Hur som helst, se till att inkludera alla artiklar (a, an, the) och andra sådana ord som vi normalt använder i instruktioner.

Grafik i instruktioner

Sannolikt mer än i någon annan form av skrivande (utom kanske i serietidningar) är grafik avgörande för instruktioner. Ibland kan ord helt enkelt inte förklara steget. Illustrationer är ofta avgörande för att läsarna ska kunna visualisera vad de ska göra.

I en kurs i tekniskt skrivande kan instruktionerna kräva att du inkluderar illustrationer eller andra typer av grafik – det som normalt skulle användas i instruktionerna. Problemet kan naturligtvis vara att du inte har tillgång till grafik som är lämplig för just dina instruktioner och att du inte känner dig helt säker på din konstnärliga förmåga. Det finns sätt att övervinna dessa problem! Ta en titt på förslagen under grafik. I det kapitlet hittar du inte bara förslag på hur du skapar grafik, utan även krav på deras format.

Format i instruktioner

Huvudrubriker. I dina instruktioner ska du använda rubriker på ett bra sätt. Normalt sett vill du ha rubriker för alla bakgrundsavsnitt som du kan ha, avsnittet om utrustning och förnödenheter, en allmän rubrik för själva instruktionsavsnittet och underrubriker för de enskilda uppgifterna eller faserna inom det avsnittet. Ta en titt på exemplen i början av det här kapitlet. Se rubriker för gemensamma krav.

Listor. På samma sätt använder sig instruktioner vanligtvis mycket av listor, särskilt numrerade vertikala listor för de egentliga steg-för-steg-förklaringarna. Enkla vertikala listor eller listor med två kolumner är vanligtvis bra för avsnittet om utrustning och förnödenheter. Listor i en mening är bra när du ger en översikt över vad som kommer att hända. Se listor för gemensamma krav.

Särskilda meddelanden. I instruktioner måste du varna läsarna för möjligheter där de kan skada sin utrustning, slösa förnödenheter, få hela förfarandet att misslyckas, skada sig själva eller andra – till och med allvarligt eller dödligt. Företag har stämts för avsaknad av dessa särskilda anvisningar, för dåligt skrivna särskilda anvisningar eller för särskilda anvisningar som var felplacerade. Se Särskilda meddelanden för en fullständig diskussion om korrekt användning av dessa särskilda meddelanden samt deras format och placering i instruktionerna.

Indragning av meddelanden i instruktioner. I det första exemplet kan du se hur meddelandet är indraget i förhållande till texten i det föregående steget. I det andra exemplet märker du att det stränga meddelandet är placerat i början före något av stegen.

Nummer, förkortningar och symboler. Instruktioner använder också rikligt med siffror, förkortningar och symboler. Du hittar riktlinjer för dessa områden.

Revision Checklist for Instructions

När du läser om och reviderar dina instruktioner ska du hålla utkik efter problem som följande:

• Se till att du ger riktiga instruktioner – förklaringar om hur man bygger, använder eller reparerar något.
• Skriv en bra inledning – i den ska du ange det exakta tillvägagångssättet som ska förklaras, ange målgruppens krav och ge en översikt av innehållet.
• Se till att du använder de olika typerna av listor när det är lämpligt. Använd särskilt numrerade vertikala listor för sekventiella steg.
• Använd rubriker för att markera alla huvudavsnitt och underrubriker för underavsnitt. (Kom ihåg att det inte behövs någon rubrik ”Inledning” mellan titeln och det första stycket. Kom ihåg att inte använda rubriker på första nivån i den här uppgiften; börja med andra nivån.)
• Använd särskilda notiser vid behov.
• Se till att du använder stil och format för alla rubriker, listor, särskilda notiser och grafik som presenteras i de här kapitlen. Om det är ett problem, kontakta din lärare.
• Använd grafik för att illustrera viktiga åtgärder eller objekt.
• Ge ytterligare kompletterande förklaringar av stegen vid behov.
• Håll dig till att skapa ett avsnitt som listar utrustning och förnödenheter, om det är nödvändigt.

Jag uppskattar dina tankar, reaktioner, kritik angående det här kapitlet: Ditt svar-David McMurrey.