En av de vanligaste och viktigaste användningsområdena för teknisk skrift är att tillhandahålla instruktioner, dvs. steg-för-steg-förklaringar om hur man monterar, använder, reparerar eller utför rutinunderhåll på något. Även om de kan verka intuitiva och enkla att skriva är instruktioner några av de sämst skrivna dokumenten du kan hitta. De flesta av oss har förmodligen haft många upprörande erfarenheter av dåligt skrivna instruktioner. Det här kapitlet kommer att visa dig vad yrkesverksamma anser vara de bästa teknikerna för att ge instruktioner.
En effektiv instruktion kräver följande:
- Klar, exakt och enkel skrivning
- En grundlig förståelse för förfarandet i alla dess tekniska detaljer
- Förmågan att sätta sig in i läsarens situation, den person som försöker använda dina instruktioner
- Förmågan att visualisera förfarandet i detalj och att fånga den medvetenheten på papper
- Villighet att testa dina instruktioner på den typ av person som du skrivit dem för.
I början av ett projekt för att skriva en uppsättning instruktioner är det viktigt att bestämma strukturen eller egenskaperna hos den specifika procedur du ska skriva om. Här är några steg att följa:
Gör en noggrann analys av målgrupp och uppgift
För tidigt i processen ska du definiera målgruppen och situationen för dina instruktioner. Kom ihåg att definiera en målgrupp innebär att definiera hur bekanta dina läsare är med ämnet.
Bestäm antalet 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 att byta olja på en bil innehåller bara en uppgift; det finns inga halvt oberoende grupperingar av aktiviteter. En mer komplex procedur som att använda en mikrovågsugn innehåller flera delvis oberoende uppgifter: ställa in klockan, ställa in effektnivån, använda timern, rengöra och underhålla mikrovågsugnen, bland annat.
Vissa instruktioner 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 att förankra den i marken och ytterligare en att montera lådgungan.
3. Bestäm det bästa tillvägagångssättet för steg-för-steg-diskussionen
För de flesta instruktioner kan du fokusera på arbetsuppgifter, eller du kan fokusera på verktyg (eller verktygsegenskaper). 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örflyttning av dina meddelanden
- Släckning av dina meddelanden, och så vidare
Detta är uppgifter – de typiska saker som vi vill göra med maskinen.
Å andra sidan, i en verktygsmetod för instruktioner om hur man använder en kopieringsmaskin, skulle det sannolikt finnas avsnitt om hur man använder specifika funktioner:
- Kopiera-knappen
- Avbryt-knappen
- Förstorings-/förminskningsknappen
- Samla ihop/häfta-knappen
- Knappen för kopieringsstorlek, och så vidare
Om du utformade en uppsättning instruktioner på den här planen skulle du skriva steg för hur man använder 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 du använda mer än bara en knapp för att utföra uppgiften. Ändå kan det finnas tillfällen då metoden med verktyg/funktioner kan vara att föredra.
4. Utforma grupperingar av uppgifter
Listan över 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. Till exempel är följande vanliga uppgiftsgrupperingar i instruktioner:
- Uppacknings- och konfigurationsuppgifter
- Installations- och anpassningsuppgifter
- Grundläggande driftsuppgifter
- Rutinmässiga underhållsuppgifter
- Felsökningsuppgifter.
Gemensamma avsnitt i instruktioner
Nedan följer en genomgång av de avsnitt som du vanligtvis hittar i instruktioner. Anta inte att var och en av dem måste finnas med i de faktiska instruktioner du skriver, inte heller att de måste vara i den ordning som presenteras här eller att detta är de enda möjliga avsnitten i en instruktion.
För alternativa format, kolla in exempelinstruktionerna.
Inledning: Planera inledningen till dina instruktioner noggrant. Den kan innehålla något av följande (men inte nödvändigtvis i denna ordning):
- Ange de specifika uppgifter eller det förfarande som ska förklaras samt omfattningen (vad som kommer att täckas och 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 som åstadkoms med det
- Ange under vilka förhållanden som instruktionerna bör (eller inte bör) användas
- Ge en översikt över innehållet i instruktionerna.
Allmän varning, försiktighet, faroanvisningar: Instruktioner måste ofta göra läsarna uppmärksamma 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) kan du behöva en diskussion om bakgrunden i samband med proceduren. För vissa instruktioner är denna bakgrund kritisk – 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 föreställa dig att det för vissa instruktioner där man använder kameror också kan behövas lite teori.
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 sett föreställer vi oss att en uppsättning instruktioner är formaterade som vertikala numrerade listor. Och det är de flesta faktiskt. 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. Bra 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 anger att alternativ är på väg att presenteras.
- Nested steps kan användas i fall då enskilda steg inom en procedur är ganska komplexa i sig själva och behöver delas upp i understeg. I det här fallet drar man in ytterligare ett steg och ordnar delstegen som a, b, c och så vidare.
- ”Steglösa” instruktioner kan användas när man verkligen inte kan använda sig av numrerade vertikala listor eller ge läsaren en direkt vägledning i stil med en instruktion. Vissa situationer måste vara så generaliserade eller så varierande att steg inte kan anges.
Kompletterande diskussion: Ofta räcker det inte med att bara tala om för läsaren att göra så här eller så här. 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, eller 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. Du vill att det faktiska 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.
Skrivstil
Att placera de viktigaste användarstegen i fetstil kan vara ett mycket användbart sätt att tydligt signalera vad läsaren behöver göra. Ofta är kommandoverbetet fetstilat; ibland lyfter fetstilat fram den nyckelkomponent som diskuteras.
Användning av den passiva rösten i instruktioner kan vara problematisk. Av någon märklig anledning låter vissa instruktioner så här: ”Pausknappen ska tryckas ned för att tillfälligt stoppa visningen”. Vi är inte bara oroliga för pausknappens mentala hälsa, utan vi undrar också vem som ska trycka ner den (ninjor?). Det skulle vara mer hjälpsamt att ange när läsaren måste ”trycka på pausknappen”. Tänk på det här exemplet: ”Timerknappen ställs sedan in på 3:00.” Återigen kan man fråga sig: ”ställs in av vem? Ninjas?” Den person som följer dessa instruktioner kanske tror att det helt enkelt är en hänvisning till något befintligt tillstånd, eller så undrar han eller hon: ”Talar de till mig?”. Att använda tredje person kan också leda till obehagligheter: ”Användaren ska sedan trycka på pausknappen.” Instruktioner bör vanligtvis skrivas med hjälp av kommandobetonformer och genom att använda ”du” för att göra det helt klart vad läsaren ska göra.
Illustration av dina instruktioner
Kanske mer än i någon annan form av teknisk skrift ä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. Se till att grafiken representerar bilden ur läsarens perspektiv.
Formatera dina instruktioner
Då människor sällan vill läsa instruktioner, men ofta måste göra det, ska du formatera dina instruktioner så att de blir ovilligt läsbara. Försök att få din läsare att vilja läsa dem, eller åtminstone inte motstå tanken på att konsultera dem. Ett format med hög läsbarhet gör det möjligt för läsare som har listat ut en del av instruktionerna på egen hand att hoppa över till det avsnitt där de har fastnat. Använd det du lärt dig om rubriker, listor, bilder och passivt utrymme för att skapa effektiva och läsbara instruktioner:
Rubriker: 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.
Listor: På samma sätt använder sig instruktioner vanligtvis i stor utsträckning av listor, särskilt numrerade vertikala listor för de faktiska 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 med en mening är bra när du ger en översikt över vad som kommer att hända.
Särskilda meddelanden: Du kan behöva 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 meddelanden, för dåligt skrivna särskilda meddelanden eller för särskilda meddelanden 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.
När du läser om och reviderar dina instruktioner, kontrollera att de gör följande:
- Den exakta proceduren som ska förklaras beskrivs tydligt
- Ge en översikt över innehållet
- Ange målgruppens krav
- Använd olika typer av listor när det är lämpligt; Använd särskilt numrerade listor för sekventiella steg
- Använd rubriker och underrubriker för att dela in huvudavsnitten och underavsnitten i en logisk, sammanhängande ordning
- Använd särskilda meddelanden när det är lämpligt
- Använd grafik för att illustrera viktiga åtgärder och objekt
- Ge ytterligare kompletterande förklaringar av stegen när det är nödvändigt
- Skapa ett avsnitt med en förteckning över utrustning och förnödenheter om det behövs.