Att skriva en bruksanvisning

Programvara, datorer, spel och enheter kräver användarmanualer; guider som förklarar hur man använder produkten (och hur man inte gör det). En användarmanual är ett formellt dokument med en specifik struktur och bör skrivas av någon som kan produkten till och med, till exempel en teknisk skribent eller produktdesignern. Att skriva en effektiv användarmanual kräver att du vet vem som kommer att använda produkten och att du skriver manualen med dessa användare i åtanke. Håll ditt skrivande tydligt, exakt och enkelt för att säkerställa en problemfri användarupplevelse.

Steg

Del 1 av 4: Planera din användarhandbok

Bild med titeln Write User Manuals Steg 1
1. Gör en användaranalys. Användarhandboken bör skrivas för användarna - de som kommer att köpa din produkt eller tjänst och läsa användarhandboken. En användaranalys kommer att berätta vem din huvud- eller målgrupp kommer att vara och guidar dig i att skriva texten.
  • Prata med personer som kommer att använda din enhet. Förse testanvändare med prototyper av enheten och ett utkast till användarmanualen under kontrollerade förhållanden. Be dessa testanvändare om feedback om saker som inte är tydliga eller förvirrande i användarguiden och gör ändringar i din användarguide baserat på denna feedback.
  • Du kan aldrig tillfredsställa hela din publik; skriv manualen skräddarsydd för målgruppen eller den största publiken.
  • Tänk på ålder, hälsa (har de några sjukdomar, inlärningssvårigheter eller funktionsnedsättningar?) och allmänhetens utbildningsnivå, för att bestämma den bästa metoden för att skriva användarmanualen.
Bild med titeln Write User Manuals Steg 2
2. Koordinera utformningen av användarmanualen. Om du var en del av teamet som hjälpte till att designa och utveckla enheten eller produkten kan det vara svårt att objektivt titta på produkten för att förklara hur den fungerar. Du bör därför rådfråga en skribent (helst någon med erfarenhet av att skriva instruktioner) och en grafisk designer för att hjälpa dig att förbereda bruksanvisningen. Du kan välja dessa personer genom en extern konsultverksamhet eller från ditt eget företag eller organisation.
Bild med titeln Write User Manuals Steg 3
3. Gör en jobbanalys. En jobbanalys är processen att identifiera och organisera de steg som krävs för att använda enheten. En grundlig jobbanalys identifierar material och utrustning (som batterier, droger eller andra produkter som tillhandahålls av användaren) som krävs för varje steg, såväl som de åtgärder, fel och felsökningsråd som varje steg kan kräva.
  • Om du har en produkt som kan utföra många olika uppgifter eller deluppgifter måste du köra en uppgiftsanalys för varje uppgift. Till exempel: i en bil kan du tuta, spänna fast dig och tända eller släcka strålkastarna. Skapa en jobbanalys för var och en av dessa, om det behövs.
  • Bild med titeln Write User Manuals Steg 4
    4. Se till att din produkt uppfyller kraven för märkning och marknadsföringstillstånd. Dessa krav säkerställer att produkterna tillverkas med användarens säkerhet i åtanke, och att användarens exponering för farliga förhållanden, såsom strålning och elektriska stötar, begränsas. Annonser bör tydligt ange syftet och grundläggande driftriktlinjer för en produkt, och du bör använda dessa resurser när du skriver din användarhandbok.
  • För att en produkts användarmanual ska vara effektiv måste den vara skriven i enlighet med etiketterna som är fästa direkt på produkten.
  • Innan du skriver användarmanualen, se till att din enhet har officiella licenser till försäljning.
  • Bild med titeln Write User Manuals Steg 5
    5. Bestäm layouten på din manual. Det finns flera viktiga sätt att effektivisera din manual. Du måste sätta en fet rubrik i början av varje avsnitt med varje ord med versaler. Till exempel kan "Konfigurera din enhet", "Kontrollera din enhet" och "Felsökning" alla vara feta avsnittsrubriker.
  • Ett annat sätt att effektivisera din manual är att använda två kolumner, en till höger med text och den andra precis till vänster om texten, med punkter, siffror eller små ikoner, som varningsskyltar eller röda utropstecken.
  • Manualen kan huvudsakligen bestå av bilder med viss text under varje bild för att förklara enheten, eller så kan den huvudsakligen vara text med endast ett fåtal tillhörande bilder. Du kan också använda ett flödesschema för att vägleda användaren. Tänk på din produkt och hur varje metod kan hjälpa dig att skriva din manual. Undvik dock att blanda olika layouter i en manual. Välj en och håll dig till den.
  • Del 2 av 4: Inbädda viktig information

    Bild med titeln Write User Manuals Steg 6
    1. Organisera manualen logiskt. Manualen bör vara uppbyggd på ett sådant sätt att användaren får mest nytta av den. Dela upp manualen i kapitel eller avsnitt som är meningsfulla för användning av produkten och inkludera en innehållsförteckning längst fram i manualen så att varje avsnitt kan hittas snabbt.
    • En innehållsförteckning är särskilt nödvändig för längre guider.
    • En ordlista eller index behövs om det finns många termer för att förklara som din publik kanske inte känner till. En ordlista rekommenderas dock inte; det bästa valet är att förklara förvirrande termer i själva handbokens text. Om du väljer att inkludera en ordlista, placera den längst fram i manualen, precis efter innehållsförteckningen.
    • En lista med tabeller eller figurer behövs endast om det finns fler än ett fåtal tabeller eller figurer i manualen.
    • En bilaga behövs för saker som behöver förklaras men inte kan förklaras någon annanstans i manualen, eftersom det skulle störa flöde och fokus.
    Bild med titeln Write User Manuals Steg 7
    2. Inkludera nödvändiga varningar. De allmänna varningarna eller försiktighetsinformationen bör ge information om potentiella faror som kan uppstå från felaktig användning av produkten, inklusive dödsfall eller allvarlig skada. Dessa varningar bör placeras längst fram i manualen, efter förstasidan, så att användaren ser dem först. Specifika varningar bör också inkluderas i texten i manualen precis efter eller strax innan ett potentiellt farligt steg föreslås.
  • Till exempel kan en allmän varning för en elektrisk apparat vara att inte använda den under regn.
  • En specifik ledtråd kan vara att se till att både dina händer och enheten är torra innan du ansluter enheten.
  • Tillhandahåll bilder (som en skalle och korsade ben) eller text i en annan färg (som röd text) för att skilja varningen från resten av instruktionerna i manualen och dra användarnas uppmärksamhet på den.
  • Bild med titeln Write User Manuals Steg 8
    3. Beskriv enheten. Din beskrivning bör innehålla både en skriftlig förklaring av enhetens syfte och en liten grafisk representation av hur enheten ser ut. Illustrationen ska märka och namnge alla strömbrytare, knappar och fästbara delar som finns i enheten.
    Bild med titeln Write User Manuals Steg 9
    4. Tillhandahåll installationsinstruktioner. Installationsavsnittet bör innehålla grundläggande information om hur du förbereder dig för att använda produkten eller enheten. Om enheten inte kan byggas eller ställas in av en hemanvändare, ange detta tydligt i en fet rubrik överst i installationsavsnittet. Du bör även inkludera följande:
  • En reservdelslista
  • Uppackningsinstruktioner
  • Installationsvarningar
  • Konsekvenser av en felaktig installation
  • Vem man ska ringa vid installationssvårigheter
  • Bild med titeln Write User Manuals Steg 10
    5. Ange driftinformation. Det här avsnittet är den viktigaste delen av användarmanualen och bör ge konkret, detaljerad information om hur du använder enheten. Börja med den grundläggande förberedelsen innan du använder apparaten, som att sätta i kontakten eller tvätta händerna. Fortsätt med logiska, numrerade steg som beskriver hur du använder enheten, samt feedback (till exempel "Du hör ett klick...`) som användaren kan förvänta sig vid korrekt användning av enheten.
  • I slutet av detta kapitel bör användare hänvisas till felsökningskapitlet för att lösa problem som inte kan förklaras snabbt.
  • Lägg upp bilder där det behövs. Vissa steg förklaras bäst med både bilder och ord. Tänk på att använda foton eller illustrationer i din manual.
  • I den här delen, som i alla delar, bör du inkludera relevanta säkerhetsvarningar om felaktig användning eller användning. Du kan till exempel varna motorsågsanvändare att inte dricka alkohol eller använda motorsågen när de tar vissa mediciner.
  • Om du tror att det skulle gynna användare, överväg att inkludera länkar till onlinevideor som visar hur enheten används och fungerar korrekt. Du kan inkludera dessa videor antingen i början av det här avsnittet eller (om det är videor som endast visar ett steg) i slutet av varje steg.
  • Bild med titeln Write User Manuals Steg 11
    6. Lägg till en sammanfattning av produkten i slutet. Sammanfattningen bör komma i slutet av handboken, strax före indexet, för att ge de grundläggande stegen i driften. Detta bör vara en förenklad, avskalad version av driftsinformationen och bör inte överstiga en sida. Sammanfatta hur du använder enheten eller produkten. Inkludera grundläggande varningar, numrerade steg som förklarar hur man använder produkten och telefonnummer eller e-postadresser som leder användarna till hjälp.
  • Om du förväntar dig att användaren ska ta bort sammanfattningsbladet eller behöver hänvisa till det ofta, kan du skriva ut det på ett löstagbart laminerat kort eller tjock kartong för att göra det lättare för användaren att bära och hänvisa till.
  • Alternativt kan du lägga en sammanfattning direkt på produkten för snabb och enkel referens för användaren.
  • Del 3 av 4: Beskrivning av produktunderhållet

    Bild med titeln Write User Manuals Steg 12
    1. Förklara hur du rengör enheten. Om din enhet eller produkt behöver rengöras, förklara hur du gör det. Lista nödvändiga rengöringsmedel. Berätta för läsaren hur ofta den ska städa. Inkludera sedan, som i alla andra delar av manualen, numrerade steg-för-steg-instruktioner om hur man rengör.
    • Om rengöring kräver demontering av produkten eller borttagning av en viss del eller delar, vänligen ange hur man demonterar produkten.
    • Ge en varning om resultatet av underlåtenhet att rengöra enheten. Till exempel kan du säga, "Om enheten inte rengörs kommer prestandan att vara mindre än optimal.`
    Bild med titeln Write User Manuals Steg 13
    2. Räkna användaren hur man utför grundläggande underhåll. Om produkten eller enheten kan servas av användaren för att åtgärda prestandaproblem, tillhandahåll numrerade instruktioner om hur man gör detta av användaren. Till exempel: om batterierna behöver bytas efter var 300:e timmes användning, ge instruktioner om hur du kontrollerar om batterierna behöver bytas, hur du tar bort de använda batterierna och hur du sätter i de nya batterierna.
  • Om det finns vissa underhållsuppgifter som endast kan utföras av en certifierad tekniker, dela underhållsdelen av manualen i två delar.
  • Bild med titeln Write User Manuals Steg 14
    3. Diskutera lagringsalternativ. Manualen ska vid behov förklara hur produkten eller enheten ska förvaras korrekt. Du bör också ta med information om varför lagring är nödvändig och vilka konsekvenserna blir av felaktig förvaring. Du kan till exempel skriva:
  • `Förvara produkten på en sval, torr plats. Felaktig förvaring kan förkorta produktens livslängd på grund av fuktuppbyggnad.`
  • `Utsätt inte produkten för värme och förvara den inte i temperaturer över 50 grader Celsius. Om du gör detta kan det leda till antändning.`
  • Bild med titeln Write User Manuals Steg 15
    4. Ange felsökningsinformation. Du kan organisera detta avsnitt som en lista över vanliga problem och deras lösningar. Gruppera liknande problem under en logisk rubrik. På så sätt kan användare snabbt hitta specifika problem.
  • Om det till exempel finns flera problem med att datorn visar en blå skärm, gruppera dem under en underrubrik, till exempel "Vanliga skärmproblem".
  • Du måste också inkludera ett telefonnummer till kundtjänst och/eller e-post i detta avsnitt.
  • Del 4 av 4: Att skriva en läsbar guide

    Bild med titeln Write User Manuals Steg 16
    1. Läs andra bruksanvisningar. Innan du skriver en manual för din egen produkt, titta på andra effektiva användarmanualer. Var uppmärksam på struktur, val av ord och meningsuppbyggnad. Stora varumärken som Apple, Google och Microsoft producerar starka, effektiva användarguider som kan hjälpa dig att ta fram en genomtänkt skriven användarguide.
    • Läs inte bara Allt användarmanualer. Läs manualerna för liknande produkter du säljer. Till exempel: om du säljer babyprodukter, läs babymanualer, inte tekniska.
    Bild med titeln Write User Manuals Steg 17
    2. Välj dina standarder. Att standardisera stavning, ordval och formulering kommer att göra användarhandboken mer användarvänlig. Chicago Manual of Style och Microsoft Manual of Style kan också vara användbara stilguider när du skriver din användarmanual; kontrollera båda för att se om den ena är rätt för din manual.
  • Till exempel, istället för att använda både "på/av-knapp" och "på/av-knapp" i din manual, välj en av de två termerna och håll dig till den.
  • Bild med titeln Write User Manuals Steg 18
    3. Använd den aktiva rösten. Den aktiva rösten är ett sätt att skriva som förklarar saker ur användarens perspektiv. Det är lättare att förstå än alternativet, den passiva rösten, där subjektet är odefinierat.
  • Prova Hemingway-appen (www.hemmingwayapp.com) för att känna igen passiva passager i ditt skrivande.
  • Studera dessa två exempelmeningar - den första är aktiv och den andra passiv:
  • Du måste öppna förpackningen långsamt och försiktigt.
  • Förpackningen måste öppnas långsamt och försiktigt.
  • Bild med titeln Write User Manuals Steg 19
    4. Skriv numrerade instruktioner. Numeriskt ordnade instruktioner hjälper läsaren att bättre fokusera på processen att använda, koppla eller bygga produkten i fråga. Istället för att skriva ett långt, utförligt stycke eller en serie onumrerade stycken, skriv din användarhandbok med enkla, tydliga steg, var och en tydligt numrerad.
    Bild med titeln Write User Manuals Steg 20
    5. Börja varje steg med ett imperativ. Ett imperativ är ett handlingsinriktat verb. Genom att börja varje steg med ett verb ger du läsaren en ledtråd om den åtgärd som krävs för att slutföra steget. Till exempel, beroende på vilken produkt du skriver om, kan du börja dina steg med ett kommando som "Anslut", "Bekräfta" eller "Sklid". Börja dock inte dina steg med ett svar från systemet.
  • Till exempel, om skärmen blir blå och börjar blinka, börja inte steget med "Skärmen blinkar och blir blå.` Försök: `Tryck och håll ned hemknappen. Skärmen blinkar och blir blå.`
  • Bild med titeln Write User Manuals Steg 21
    6. Bestäm vilket ordförråd du ska använda. Om du skriver en bruksanvisning för en jojo kommer din publik främst att bestå av små barn. Använd enkla ord och ordförråd för att förklara hur jojo fungerar. När du skriver en manual för ett svepelektronmikroskop består din publik av välutbildade forskare som kan förstå mycket detaljerad information, så dra dig inte för att använda specialiserade ordförråd eller nyanserade förklaringar.
  • Försök i allmänhet undvika jargong och fackspråk.
  • För att vara effektiv för största möjliga användarbas, försök att skriva på en nivå från sjätte till sjunde klass.
  • Bild med titeln Write User Manuals Steg 22
    7. När du skickar en produkt utomlands, se till att dina översättningar är korrekta. Anlita en översättare för att översätta din användarmanual till modersmålet i det land du skickar din produkt till. Du kan också använda ett onlineöversättningsverktyg, men be en som modersmål läsa översättningen och kontrollera om det finns fel.
  • Om flera språkgrupper är representerade i din publik, vänligen inkludera översättningar av användarmanualen på varje relevant språk.
  • Översättaren bör vara bekant med produkten eftersom det kan finnas andra ord på målspråket för specifika termer som inte är ord-för-ord-översättningar.
  • Bild med titeln Write User Manuals Steg 23
    8. Skriv i korta meningar. Istället för några långa stycken, använd många korta stycken. Leta efter logiska avbrott i varje avsnitt och sammanfatta användbar information i bitar av en eller två meningar. Detsamma gäller på meningsnivå. Håll dina meningar korta och enkla, istället för långa och utförliga.
  • Om ett steg börjar bli för långt, dela upp det i mindre steg. Detta kommer inte att minska antalet ord, men radbrytningarna gör det lättare att läsa.
  • Bild med titeln Write User Manuals Steg 24
    9. Kontrollera manualen för fel. En manual kan förlora i trovärdighet på grund av grammatik och stavfel. Låt en kollega eller teknisk skribent också redigera och korrekturläsa manualen. Förutom stavning och grammatik bör en korrekturläsare vara uppmärksam på följande:
  • Passiv form
  • Otydligt eller förvirrande språk
  • inlindad meningsstruktur
  • För långa stycken
  • Tips

    • Människor lär sig på olika sätt; Om möjligt och lämpligt, inkludera visuella hjälpmedel eller länkar till onlinevideor i manualen för att passa visuellt orienterade läsare.

    Оцените, пожалуйста статью