Att skapa retoriskt effektiva bruksanvisningar

Bruksanvisningar

Många människor förknippar bruksanvisningar med apparater, datortillbehör och produkter som kräver montering (t.ex. möbler). Eftersom vi inte finner oss själva använda dem regelbundet eller vi kommer att förvänta oss dem endast i vissa sammanhang är det lätt att glömma hur viktiga de är. Kvaliteten hos en väl utformad bruksanvisning kan gå obemärkt förbi. Men när vi stöter på frustration när vi sätter ihop en bokhylla eller en leksak, eller när vi försöker ta reda på hur man ändrar eller aktiverar en viss inställning i en apparat, blir betydelsen av en väl utformad bruksanvisning tydlig.

Förståelse av bruksanvisningarnas retoriska situation

Bruksanvisningar, liksom andra typer av texter, präglas av en retorisk situation. De val som tekniska skribenter gör när det gäller innehåll och form beror på syftet med instruktionsmanualen, den avsedda målgruppen och det sammanhang i vilket manualen används. När du skriver din egen bruksanvisning bör du överväga följande idéer och frågor om den retoriska situationen.

Syfte

I allmänhet är syftet med en bruksanvisning att göra användaren bekant med produkten och/eller att vägleda användaren genom en serie steg som leder till att en uppgift slutförs. Varje bruksanvisning kommer dock också att ha ett mer specifikt resultat. Genom att identifiera vad det specifika resultatet är kan du fatta effektivare retoriska beslut om innehåll och utformning. Fråga dig själv:

Vad är det specifika avsedda utfallet/utfallen av instruktionerna? (t.ex. baka en tårta från grunden, installera en luftkonditionering etc.)
Inom att hjälpa användarna att nå det/de viktigaste önskade resultatet/resultaten, finns det andra syften som manualen tjänar? (t.ex. erbjuda råd om felsökning, lära användarna hur de ska utföra ytterligare, enkla uppgifter som är nödvändiga för att nå huvudmålet)

Publik

Att skapa en profil av din publik (dvs. den primära avsedda användaren av dokumentet) är en integrerad del för att kunna göra genomtänkta val om omfattning, innehåll och utformning. Tänk på dessa frågor om målgruppen innan du skriver:

Vad är målgruppens förtrogenhet eller expertis när det gäller ämnet för bruksanvisningen?
Vad är målgruppens allmänna bekvämlighetsnivå när det gäller att lära sig nya färdigheter i samband med programvaran, apparna, recepten etc.?
Vad är målgruppens ”typiska” tillvägagångssätt för att lära sig? Hur kommer din instruktionsbok att ta hänsyn till målgruppens inlärningsstil, mål och uppgiftsrelaterade behov?

Kontext

Tänk på kontexten som den tidsmässiga, sociala, tekniska och kulturella situation som omger skapandet och användningen av instruktionsboken. Följande frågor hjälper dig att identifiera kontexten:

Hur mycket tid kommer du att ha till förfogande för att färdigställa instruktionsboken?
Har användaren tidsbegränsningar?
Vilka tekniska begränsningar måste du ta hänsyn till när du skapar instruktionsboken? Tänk på dina kunskaper om teknik och din nivå av tillgång.
Hur kommer din publik att få tillgång till handboken? (t.ex. kan publiken få tillgång till handboken online via företagets webbplats)
Vilka ytterligare verktyg eller material antar du att publiken redan har? Kommer de att ha tillgång till den teknik eller de material som behövs för att följa instruktionerna? (För att lyckas bygga en bokhylla behöver användaren t.ex. en hammare, en skruvmejsel och en öppen arbetsyta)
Från vilket kulturellt perspektiv skriver du bruksanvisningen? Kommer publiken att dela samma kulturella sammanhang? (t.ex. kan ett tyskt recept som kräver vaniljsocker, en ingrediens som inte är lätt tillgänglig i USA, behöva modifieras för amerikanska användare)

Använda kunskap om retorisk situation för att göra effektiva retoriska val

Trots att de flesta bruksanvisningar förlitar sig på vissa standardkonventioner, bör varje bruksanvisning skräddarsys för att uppnå ett specifikt syfte för en viss publik inom ett givet sammanhang. I följande avsnitt presenteras några vanliga egenskaper hos instruktionsböcker, samtidigt som man tar hänsyn till den retoriska situationen och hur den kan kräva avvikelser från vissa konventioner.

Skala

Den retoriska situationen hjälper till att avgöra hur mycket detaljer som ska ingå i en instruktionsbok. Till exempel är omfattningen av en bruksanvisning för att sätta ihop ett skrivbord lätt att bestämma eftersom den bara har ett resultat: att sätta ihop skrivbordet. En bruksanvisning för en DSLR-kamera (Digital Single Lens Reflex) kan dock vara skriven för både amatörer och mer erfarna kameraanvändare och kan behöva innehålla instruktioner för att utföra grundläggande uppgifter (t.ex. installera batteriet och minneskortet) samt mer avancerade uppgifter (t.ex, justera inställningar för specifika fotograferingsmiljöer).

Innehåll

En del standardavsnitt i bruksanvisningar innehåller en framsida, en introduktion, en serie steg, en slutsats och en baksida, även om vissa bruksanvisningar kanske inte använder alla dessa avsnitt eller märker dem på detta sätt. Omfattande fram- och baksidestexter finns till exempel ofta i längre och mer komplexa handböcker. De flesta instruktioner innehåller dock en inledning som ger den information som behövs för att genomföra stegen på ett säkert och effektivt sätt. Inledningen kan innehålla en förklaring av vem som ska utföra uppgiften (kanske behöver användaren behärska en viss färdighet), vilka material som behövs, eventuella försiktighetsåtgärder som användaren bör vidta (säkerhetstips eller andra varningar) och i vissa fall en uppskattning av hur lång tid processen kommer att ta (ett vanligt inslag i recept). I vissa fall är det nödvändigt att inkludera en förklaring till varför användaren bör följa instruktionerna. Exempelvis kan instruktioner för oljebyte i en bil förklara varför uppgiften är nödvändig för att fordonet ska fungera korrekt.

Efter detta inledande material följer sekvensen av steg-för-steg-instruktioner. Se följande avsnitt om ”Språk” för hur man utarbetar tydliga och effektiva steg. Slutligen kan en bruksanvisning innehålla en ”guide för felsökning” eller ett avsnitt för ”tips” för att hjälpa användarna att ta itu med vanliga problem som de kan stöta på när de följer instruktionerna eller efter att ha slutfört processen.

Språk

Frågorna om ”målgrupp” och ”sammanhang” ovan kan hjälpa dig att vägleda dig i att göra effektiva språkval. Följande underavsnitt innehåller förklaringar av vanliga språkliga drag i bruksanvisningar tillsammans med tips för att skriva tydligt och kortfattat i den här genren.

Imperativstämning

Instruktioner, liksom kommandon, använder sig ofta av imperativstämningen. För att skriva på detta sätt ska du vända dig direkt till publiken med aktiv röst och specifika verb. Vilken av följande instruktioner är tydligast?

”Tryck på den röda knappen för att börja spela spelet”
”När du trycker på den röda knappen börjar spelet”
”Operatören ska trycka på knappen”

En användare skulle förmodligen kunna förstå vilken som helst av dessa meningar, men den första förklarar tydligast vilken åtgärd användaren ska utföra. Den andra, passiva konstruktionen anger inte vem som ska trycka på knappen. Det tredje exemplet hänvisar till ett vagt subjekt, ”operatören”, vilket kan förvirra användaren.

Vordsval

När man skriver instruktioner är en noggrann övervägning av ordvalet viktig eftersom användarens säkerhet i vissa fall är i fara. Sträva därför efter klarhet och koncisitet. För att fatta effektiva beslut om ordval bör du ta hänsyn till din primära målgrupps kunskapsnivå och kulturella bakgrund. Du kan finna det nödvändigt att

definiera komplexa termer.
Spela ut akronymer första gången de introduceras (t.ex, digital single-lens reflexkamera, DSLR).
undvik att använda liknelser, metaforer, slang eller ersättningar som kan förvirra användarna.
använd klarspråk, för i vissa fall kan allvarliga rättsliga konsekvenser uppstå när en instruktion är otydlig. Mer om klarspråk finns i http://www.plainlanguage.gov/index.cfm
Inkludera översättningar av instruktionerna till flera språk.
Använd korta och informativa rubriker och underrubriker

Konsistens och parallellitet

Parallellitet, eller parallellitet, innebär att man använder samma grammatiska struktur för att presentera information eller idéer. Parallellism används ofta för att förbättra läsbarheten och skapa konsekvens.

Denna numeriska instruktionslista innehåller ett steg som bryter parallellstrukturen. Vilket av dessa steg verkar skilja sig från de andra?

Lägg av skruven för att öppna batterifacket.
Insätt batterierna genom att följa bilden på batterifacket.
Nu kan du stänga facket och skruva igen det.

Steg tre bryter listans parallella struktur eftersom det inte inleds med ett direktiv verb.

Använder följande rubriker parallell struktur? Varför eller varför inte?

”Installera batterier”
”Stänga av/på enheten”
”Hur du laddar enheten”

Design

Dokumentens utformning avser det sätt på vilket informationen organiseras och presenteras. Eftersom visuellt material kräver mindre tid för att bearbetas kommer användarna vanligtvis att lägga märke till – och reagera på – designens kvalitet före innehållets kvalitet. Även om du väljer att inte inkludera bilder eller grafik måste du ta hänsyn till designen. Detta innebär bland annat att du måste välja layout, ordningsföljd, teckenstorlek, typsnitt, rubriker, färg och vitt utrymme. Designelementen ska leda användaren smidigt genom manualen. Detta innebär att dokumentet ska kunna skannas; ett skannbart dokument gör det möjligt för användarna att navigera genom innehållet för att hitta specifik information. Liksom för alla andra dokument bör beslut om utformning ta hänsyn till målgrupp, syfte och övergripande användarvänlighet.

Konsistens/upprepning

Att använda ett utformningselement på ett enhetligt sätt i hela dokumentet vägleder användarna genom att ge dem en känsla av vad de kan förvänta sig (t.ex. samma typsnitt och storlek för alla rubriker, samma layout från sida till sida).

Kontrast

Användning av ett designelement för att framhäva specifik information eller funktioner i manualen (t.ex. att ett ord skrivs med stor bokstav för att framhäva det; att placera en ruta eller en ram runt en punkt; att ändra färger för att framhäva det). Kontrast är främst effektiv när ett dokument använder sig av konsistens överlag. Om det finns en brist på konsekvens är det svårare att skapa kontrast.

Allinje

Organisering av objekt på en sida med horisontell och/eller vertikal justering skapar hierarki och struktur och kan användas för att hjälpa till att uppnå balans, kontrast eller konsistens. I det här dokumentet används till exempel vertikal justering för att skapa en hierarki mellan namnet på ett designelement, som är vänsterjusterat, och dess beskrivning, som är indragen.

Balans

Fördelning av objekt jämnt över ett givet utrymme. För att uppnå detta bör man ta hänsyn till varje objekts vikt – det vill säga ögats benägenhet att dras till ett objekt. Eftersom en bild t.ex. väger mer än text bör man vid beslut om bildplacering ta hänsyn till hur man balanserar dess vikt mot andra objekt för att undvika visuell förvirring.

Vitutrymme

Användning av vitutrymme för att skapa ett professionellt, balanserat dokument. I stället för att ange färgen på utrymmet hänvisar detta designelement till en avsaknad av bilder och text. Vitt utrymme hjälper till att skilja mellan enskilda objekt och grupper av objekt (dvs. avsnitt i manualen) och gör det lättare att skanna dokument.

Gruppering/närhet

Placera relaterade bilder eller innehåll nära varandra. Till exempel att gruppera ihop bilder av allt material som behövs för att utföra en viss uppgift.

Färg

Välja färger för att skapa kontrast och betoning, för att vägleda läsaren i olika utrymmen och för att utforma ett visuellt tilltalande dokument. Du bör ta hänsyn till dokumentet som helhet för att skapa ett konsekvent färgschema. Om du till exempel vill använda blått i ditt dokument ska du se till att det används konsekvent och att det kompletterar andra dokumentfärger. Detta är särskilt viktigt när du integrerar färggrafik och/eller bilder.

Bilder

Välja lämpliga bilder för det givna sammanhanget och syftet med handboken. Du bör överväga om bilderna är avsedda att stå för sig själva eller att komplettera skriftliga instruktioner. Tänk på typer av bilder, t.ex. ritningar, foton och grafiska illustrationer, och om det behövs ytterligare utropstecken eller anteckningar för att framhäva specifika delar av bilden. Bilderna bör väljas så att de kompletterar andra designelement i manualen.

Slutsats

En bra instruktionsmanual börjar med ett noggrant övervägande av den retoriska situationen – syfte, målgrupp och sammanhang. Denna information är nyckeln till att göra både lämpliga och effektiva val av innehåll, språk och utformning. I en idealisk tidslinje har tekniska skribenter möjlighet att genomföra användbarhetstester, som är utformade för att bedöma hur väl ett dokument uppfyller sitt syfte. När din instruktionsmanual har testats kommer du att införliva den feedback du fått för att slutföra dess utformning och innehåll.

Övningsuppgift 1 – Bekanta dig med instruktionsmanualer

Följande webbplats innehåller flera exempel på instruktionsmanualer med öppen källkod. Följ den här länken, bläddra igenom listan och välj en manual att titta närmare på. Skumma igenom manualen för att bekanta dig med dess innehåll och utformning. Ta sedan upp följande i ett PM till din lärare eller klasskamrater.

Identifiera den retoriska situationen

Vem är målgruppen? Hur vet du vem publiken är? Vad kan du anta om målgruppen utifrån innehållet och designvalen i handboken?
Vad är syftet med dokumentet? Hur vet du att detta är det primära syftet (dvs. vilka val av innehåll och utformning signalerar syftet)?
Vilket sammanhang ligger till grund för det skriftliga innehållet och utformningen av denna handbok?

Undersök kompositionsval

Beskriv handbokens övergripande omfattning och organisation. Hur detaljerad är manualen? Vad täcker den? Hur är informationen organiserad?
Tillämpas alla ”standardfunktioner” för innehållet i denna handbok? Varför eller varför inte? Finns det ytterligare funktioner? Vilka är de och vad är deras syfte?
Lokalisera och beskriv exempel på effektiva språkval. Förklara varför du tycker att de är effektiva.
Lokalisera och beskriva exempel på effektiv design. Förklara varför du tycker att de är effektiva.
Om du var författaren till den här handboken, vad skulle du ha gjort annorlunda och varför?

Övningsuppgift 2 – Planering av en bruksanvisning

Föreställ dig att du skriver en bruksanvisning för en process eller produkt som du är bekant med och ta upp följande uppmaningar.