Innehåll

• Att gå
• Del 1 av 4: Planera din bruksanvisning
• Del 2 av 4: Bädda in viktig information
• Del 3 av 4: Beskriv produktunderhåll
• Del 4 av 4: Skriv en läsbar manual
• Tips

Programvara, datorer, spel och enheter kräver användarhandböcker; guider som förklarar hur man använder produkten (och hur man inte). En användarmanual är ett formellt dokument med en specifik struktur och måste skrivas av någon som känner produkten inifrån och ut, till exempel en teknisk författare 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.

Att gå

Del 1 av 4: Planera din bruksanvisning

1. Gör en användaranalys. Användarhandboken ska skrivas för användarna - de som köper din produkt eller tjänst och läser bruksanvisningen. En användaranalys kommer att berätta vem din huvud- eller målgrupp kommer att vara och vägleda dig genom att skriva texten.
   • Prata med personer som kommer att använda din enhet. Erbjud testanvändares prototyper av enheten och utkast till användarmanual under kontrollerade förhållanden. Be dessa testanvändare om feedback på saker som är oklara eller förvirrande i användarhandboken och gör ändringar i din användarhandbok baserat på den här feedbacken.
   • Du kan aldrig tillfredsställa hela din publik; skriv handboken 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 publikens utbildningsnivå för att bestämma det bästa sättet att skriva användarhandboken.
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 ta en objektiv titt på produkten för att förklara hur den fungerar. Du bör därför söka råd från en författare (helst någon med erfarenhet av att skriva instruktioner) och en grafisk designer som hjälper dig att förbereda användarhandboken. Du kan välja dessa personer via ett externt konsultföretag eller från ditt eget företag eller organisation.
3. Gör en uppgiftsanalys. Jobbanalys är processen att identifiera och organisera de steg som krävs för att använda enheten. En noggrann jobbanalys identifierar det material och utrustning (som batterier, läkemedel eller andra användarlevererade produkter) som krävs för varje steg, samt 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 utföra en uppgiftsanalys för varje uppgift. Till exempel: i en bil kan du tuta, fästa dig själv och sätta på eller av strålkastarna. Gör en jobbanalys för var och en av dessa, om det behövs.
4. Se till att din produkt uppfyller kraven för märkning och försäljningstillstånd. Dessa krav säkerställer att produkter tillverkas med användarens säkerhet i åtanke och att användarens exponering för farliga förhållanden, såsom strålning och elektrocution, är begränsad. Annonser ska tydligt ange produktens syfte och grundläggande riktlinjer och du bör använda dessa resurser när du skriver din användarhandbok.
   • För att en produkts användarhandbok ska vara effektiv måste den skrivas i enlighet med etiketterna som är fästa direkt på produkten.
   • Se till att din enhet är officiellt licensierad för försäljning innan du skriver användarhandboken.
5. Bestäm layouten på din manual. Det finns flera viktiga sätt att effektivisera din handbok på. Du måste sätta en fet rubrik i början av varje avsnitt med varje ord med versaler. Till exempel kan "Ställ in din enhet", "Använd din enhet" och "Felsök" alla vara fet rubriker.
   • Ett annat sätt att effektivisera din guide är att använda två kolumner, en till höger med text och den andra till vänster om texten, med kulor, siffror eller små ikoner, som varningsmärken eller röda utropstecken.
   • Handboken kan huvudsakligen bestå av bilder med lite text under varje bild för att förklara enheten, eller det kan huvudsakligen vara text med bara några medföljande 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 handbok. Välj en och håll fast vid den.

Del 2 av 4: Bädda in viktig information

1. Organisera manualen logiskt. Handboken ska vara strukturerad på ett sådant sätt att användaren får mest nytta av den. Dela handboken i kapitel eller avsnitt som är användbara för att använda produkten och inkludera en innehållsförteckning längst fram i handboken så att varje avsnitt kan hittas snabbt.
   • En innehållsförteckning är särskilt nödvändig för längre manualer.
   • En ordlista eller ett index behövs om det finns många termer för att förklara att 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 handboken. Om du väljer att inkludera en ordlista, placera den längst fram i manualen, strax efter innehållsförteckningen.
   • En lista med tabeller eller figurer är endast nödvändig om det finns fler än några tabeller eller figurer i handboken.
   • En bilaga behövs för saker som behöver förklaras men inte kan förklaras någon annanstans i handboken, eftersom det skulle störa flöde och fokus.
2. Inkludera nödvändiga varningar. Allmänna varningar eller försiktighetsinformation bör ge information om potentiella faror som orsakas av felaktig användning av produkten, inklusive dödsfall eller allvarlig personskada. Dessa varningar ska 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 strax 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 när det regnar.
   • En specifik instruktion kan vara att se till att både dina händer och enheten är torra innan du ansluter enheten till eluttaget.
   • Ge bilder (som en skalle och tvärben) eller text i en annan färg (som röd text) för att skilja varningen från resten av riktningarna i bruksanvisningen och uppmärksamma användaren.
3. Beskriv enheten. Din beskrivning ska innehålla både en skriftlig förklaring av syftet med enheten och en liten grafisk bild av hur enheten ser ut. Figuren ska märka och namnge alla omkopplare, knappar och delar som finns i enheten.
4. Ge installationsinstruktioner. Installationsavsnittet bör innehålla grundläggande information om hur du förbereder dig för att använda produkten eller enheten. Om apparaten inte kan byggas eller ställas in av en hemanvändare, ange detta tydligt med en fet rubrik högst upp i installationssektionen. Du bör också inkludera följande:
   • En lista över delar
   • Uppackningsinstruktioner
   • Installationsvarningar
   • Konsekvenser av felaktig installation
   • Vem man ska ringa vid problem under installationen
5. Ge information om operationen. Detta avsnitt är den viktigaste delen av användarhandboken och bör ge konkret, detaljerad information om hur du använder enheten. Börja med grundläggande förberedelser för att använda enheten, som att sätta i nätsladden eller tvätta händerna. Fortsätt med logiska, numrerade steg som beskriver hur du använder enheten, liksom eventuell feedback (till exempel "Du hör ett klick ...") som användaren kan förvänta sig när han använder enheten på rätt sätt.
   • I slutet av detta kapitel bör användarna hänvisas till felsökningskapitlet för att lösa problem som inte kan förklaras snabbt.
   • Placera bilder vid behov. Vissa steg förklaras bäst med både bilder och ord. Tänk på användningen av foton eller illustrationer i din handbok.
   • I detta avsnitt, som i alla avsnitt, bör du inkludera relevanta säkerhetsvarningar om felaktig användning eller användning. Du kan till exempel varna motorsåganvändare att inte dricka alkohol eller använda motorsågen medan de använder vissa mediciner.
   • Om du tror att användare kommer att gynnas, överväg att inkludera länkar till onlinevideor som visar korrekt användning och användning av enheten. Du kan spela in dessa videor antingen i början av det här avsnittet eller (i fallet med videor som endast illustrerar ett steg) i slutet av varje steg.
6. Inkludera en sammanfattning av produkten i slutet. Sammanfattningen ska visas i slutet av manualen, strax före indexet, för att ge grundläggande driftssteg. Detta bör vara en förenklad, avklädd version av den operativa informationen och bör inte vara mer än en sida. Sammanfatta hur enheten eller produkten ska användas. Inkludera grundläggande varningar, numrerade steg som förklarar hur du använder produkten och telefonnummer eller e-postadresser som riktar användarna till hjälp.
   • Om du förväntar dig att användaren tar bort eller hänvisar till sammanfattningsarket ofta kan du skriva ut det på ett avtagbart 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 använda en sammanfattning direkt på produkten för snabb och enkel referens för användaren.

Del 3 av 4: Beskriv produktunderhåll

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 de rengöringsmedel som krävs. Berätta för läsaren hur ofta han ska rengöra. Sedan, som i alla andra delar av handboken, inkludera numrerade steg-för-steg-instruktioner om hur du rengör den.
   • Om rengöring kräver att produkten demonteras eller att en viss del eller delar tas bort, ange hur produkten ska demonteras.
   • Ge en varning om resultatet av att enheten inte rengörs. Du kan till exempel säga "Om enheten inte rengörs blir prestandan mindre än optimal."
2. Räkna användaren hur man utför grundläggande underhåll. Om produkten eller enheten kan repareras av användaren för att rätta till prestandaproblem, ange numrerade instruktioner om hur du gör detta för användaren. Till exempel, om batterierna måste bytas ut efter 300 timmars användning, anvisar du hur du kontrollerar om batterierna behöver bytas ut, hur du tar ut de döda batterierna och hur du installerar de nya.
   • Om det finns vissa underhållsuppgifter som bara kan utföras av en certifierad tekniker, dela underhållsdelen av handboken i två delar.
3. Diskutera lagringsalternativ. Om det behövs bör manualen förklara hur produkten eller enheten ska lagras korrekt. Du bör också inkludera information om varför lagring är nödvändig och konsekvenserna av felaktig lagring. Till exempel: du kan skriva:
   • Förvara produkten på en sval, torr plats. Felaktig lagring kan förkorta produktens livslängd på grund av fuktuppbyggnad. "
   • "Utsätt inte produkten för värme eller förvara den vid temperaturer över 50 grader Celsius.Om du gör det kan det leda till förbränning. "
4. Ge felsökningsinformation. Du kan ordna det här avsnittet som en lista över vanliga problem och deras lösningar. Gruppera liknande problem under en logisk rubrik. På detta 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 och / eller e-post för kundtjänst i detta avsnitt.

Del 4 av 4: Skriv en läsbar manual

1. Läs andra användarhandböcker. Innan du skriver en handbok för din egen produkt, kolla in andra effektiva användarhandböcker. Var uppmärksam på struktur, ordval och meningsstruktur. Stora varumärken som Apple, Google och Microsoft producerar starka, effektiva användarhandböcker som kan hjälpa dig att producera en mer noggrant skriven användarhandbok.
   • Läs inte bara Allt användarhandböcker. Läs manualerna för liknande produkter du säljer. Till exempel, om du säljer babyprodukter, läs babyhandböcker, inte tekniska.
2. Välj dina standarder. Standardisering av stavning, ordval och formulering gör 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 bruksanvisning. kolla båda för att se om en är rätt för din manual.
   • Till exempel, istället för att använda både "strömbrytare" och "strömbrytare" i din handbok, välj en av de två termerna och håll dig till den.
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 motivet är odefinierat.
   • Prova Hemingway-appen (www.hemmingwayapp.com) för att identifiera passiva passager i ditt skrivande.
   • Studera dessa två exempel meningar - den första är aktiv och den andra är passiv:
     • Du måste öppna förpackningen långsamt och försiktigt.
     • Förpackningen ska öppnas långsamt och försiktigt.
4. Skriv numrerade instruktioner. Numeriskt beställda instruktioner hjälper läsaren att fokusera bättre på processen att använda, ansluta eller bygga produkten i fråga. Istället för att skriva ett långt, detaljerat stycke eller en serie av numrerade stycken, skriv din användarhandbok med enkla, uttryckliga steg, var och en tydligt numrerad.
5. Börja varje steg med ett krav. En imperativ är ett handlingsorienterat verb. Genom att starta 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. Beroende på vilken produkt du skriver om kan du till exempel börja dina steg med ett kommando som "Connect", "Confirm" eller "Slide". Men starta inte dina steg med ett svar från systemet.
   • Om skärmen till exempel blir blå och börjar blinka, börja inte steget med: "Skärmen blinkar och blir blå." Försök: "Håll hemknappen nedtryckt. Skärmen blinkar och blir blå. "
6. Bestäm vilken ordförråd du ska använda. Om du skriver en yo-yo-handbok blir publiken mestadels små barn. Använd enkla ord och ordförråd för att förklara hur jojo fungerar. När du skriver en skanningelektronmikroskopmanual består din publik av högkvalificerade forskare som kan förstå mycket detaljerad information, så var inte undan med att använda specialiserat ordförråd eller nyanserade förklaringar.
   • I allmänhet försöker du undvika jargong och tekniskt språk.
   • För att vara effektiv för en så bred användarbas som möjligt, försök att skriva på en nivå från sjätte till sjunde klass i grundskolan.
7. När du skickar en produkt utomlands, se till att dina översättningar är korrekta. Hyr 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ättningsprogram, men be en modersmål att läsa översättningen och kontrollera om det finns fel.
   • Om flera språkgrupper är representerade i din publik ska du inkludera översättningar av användarhandboken på varje relevant språk.
   • Översättaren måste vara bekant med produkten eftersom det kan finnas olika ord på målspråket för specifika termer som inte är ord-för-ord-översättningar.
8. Skriv i korta meningar. I stället för några långa stycken använder du många korta stycken. Leta efter logiska raster i varje avsnitt och smälta användbar information i bitar med en eller två meningar. Detsamma gäller på meningsnivå. Håll dina meningar korta och enkla, snarare än långa och detaljerade.
   • Om ett steg blir för långt, dela upp det i mindre steg. Detta minskar inte antalet ord, men radbrytningarna gör det lättare att läsa.
9. Kontrollera manualen för fel. En manual kan förlora trovärdigheten på grund av grammatik och stavfel. Låt en kollega eller teknisk författare också redigera och korrekturläsa manualen. Förutom stavning och grammatik bör en korrekturläsare vara uppmärksam på följande:
   • Passiv form
   • Oklart eller förvirrande språk
   • Insvept meningsstruktur
   • Alltför långa stycken

Tips

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