Hur skapar jag en användarmanual?
För att skriva användarmanualer, börja med att dela upp huvuddelen av innehållet i kapitel eller avsnitt som är meningsfulla för produktens användning och sedan starta handboken med en innehållsförteckning och ordlista. Skapa sedan säkerhetsvarningar och skriv en beskrivning av enheten. Inkludera sedan installationsinstruktioner, förklara grundläggande funktioner och skapa en produktöversikt för att gå i slutet av manualen. Du kan också inkludera ett avsnitt om produktvård för att gå igenom information om rengöring, grundläggande underhåll, lagring och felsökning. Läs mer om den perfekta skrivstilen för användarmanualer!
Användarhandboken ska skrivas för publiken - de som köper din produkt eller tjänst och läser bruksanvisningen.
Programvara, datorer, spel och enheter kräver användarmanualer, guider som förklarar hur man använder produkten (och hur man inte). En bruksanvisning är ett formellt skrivstycke med en specifik struktur och bör skrivas av någon som är väl förtrogen med produkten, till exempel en teknisk författare eller produktdesignern. Att skriva en effektiv användarmanual kräver att du vet vem som ska använda produkten och sedan skriver den med dessa användare i åtanke. Håll ditt skrivande tydligt, exakt och enkelt för att säkerställa en problemfri användarupplevelse.
Del 1 av 4: planera din användarmanual
- 1Gör en publikanalys. Användarhandboken ska skrivas för publiken - de som köper din produkt eller tjänst och läser bruksanvisningen. En publikanalys kommer att berätta vem din huvud- eller målgrupp kommer att vara och vägleda ditt skrivande.
- Prata med människor som kommer att använda din enhet. Erbjud testanvändares prototyper av enheten och ett utkast till användarmanualen under kontrollerade förhållanden. Begär dessa testanvändares feedback om saker som inte är uppenbara eller förvirrande i användaranvisningarna och inför ändringar i din användarmanual baserat på denna feedback.
- Du kan aldrig behaga hela publiken; skriv handboken för att passa målgruppen eller den största publiken.
- Tänk på publikens ålder, hälsa (har de sjukdomar, inlärningssvårigheter eller funktionsnedsättningar?) Och utbildningsnivå för att bestämma det bästa sättet att skriva användarhandboken.
- 2Koordinera 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 titta på produkten objektivt för att förklara hur den fungerar. Du kanske därför vill få råd från en författare (helst en med erfarenhet av att skriva instruktioner) och grafisk formgivare för att hjälpa dig att utarbeta användarhandboken. Du kan välja dessa individer från ett externt konsultföretag eller från ditt eget företag eller organisation.
- 3Gör en uppgiftsanalys. En uppgiftsanalys är processen att identifiera och organisera de steg som behövs för att använda enheten. En noggrann uppgiftsanalys kommer att identifiera det material och utrustning (som batterier, mediciner eller andra produkter som tillhandahålls av användaren) som behö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 på varje uppgift. Till exempel, i en bil kan du tuta på hornet, spänna fast dig och slå på eller av strålkastarna. Skapa en uppgiftsanalys för var och en av dessa efter behov.
- 4Se till att din produkt uppfyller kraven på märkning och marknadsföring. Dessa krav säkerställer att produkter produceras med användarsäkerhet i åtanke och begränsar användarens exponering för farliga förhållanden som strålning och elektrocution. Annonser måste tydligt visa vad en produkts syfte och grundläggande driftsriktlinjer är, och du bör använda dessa källor när du skriver din användarmanual.
- För att en produkts användarhandbok ska vara effektiv måste den skrivas tillsammans med etiketter som är fästa direkt på produkten.
- Se till att din enhet är lagligt licensierad för försäljning innan du skriver instruktionsmanual.
Användarhandboken ska fortsätta på ett sätt som användaren tycker är mest fördelaktigt. - 5Bestäm din manuals layout. Det finns flera viktiga sätt att effektivisera din handbok på. Du bör placera en fet rubrik i början av varje avsnitt med varje ord i stort. Till exempel kan "Konfigurera din enhet", "Använda din enhet" och "Felsökning" alla vara djärva sektionsrubriker.
- Ett annat sätt att effektivisera din handbok är att använda två kolumner, en till höger med text och den andra till vänster om texten med punkter, siffror eller små ikoner som varningsskyltar eller röda utropstecken.
- Din handbok kan mestadels vara bilder med lite text under varje bild för att förklara enheten, eller det kan i första hand vara text med bara några medföljande bilder. Du kan också använda ett flödesschema för att ge användaren vägbeskrivningar. Tänk på din produkt och hur varje metod kan vara användbar när du skriver din användarmanual. Undvik dock att blanda olika layouter i en manual. Välj en och håll fast vid den.
Del 2 av 4: inklusive viktig information
- 1Organisera manualen logiskt. Användarhandboken ska fortsätta på ett sätt som användaren tycker är mest fördelaktigt. Dela upp manualen i kapitel eller avsnitt som är meningsfulla för produktens användning och inkludera en innehållsförteckning framåt i manualen 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 när det finns många termer för att förklara att din publik kanske inte känner till. Ordlistor 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 framför manualen, strax efter innehållsförteckningen.
- En lista över 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 ska förklaras men inte kan förklaras vid en annan punkt i handboken eftersom det skulle störa flöde och fokus.
- 2Inkludera nödvändiga varningar. Allmänna varningar eller varningsinformation bör ge information om potentiella hot som felaktig användning av produkten kan medföra, inklusive dödsfall eller allvarlig personskada. Dessa varningar bör placeras längst fram i manualen efter försättsbladet så att användaren ser dem först. Specifika varningar bör också ingå i texten i användarhandboken strax efter eller strax innan ett potentiellt farligt steg föreslås.
- Till exempel kan en allmän varning för en elektrisk enhet vara att undvika att använda den under regn.
- En specifik riktning kan vara att se till att händerna och enheten båda är torra innan du ansluter enheten.
- Inkludera grafik (som en skalle och tvärben) eller text med olika färg (som röd text) för att skilja varningen från resten av anvisningarna i användarhandboken och uppmärksamma användaren på den.
- 3Beskriv enheten. Din beskrivning ska innehålla både en skriftlig förklaring om enhetens syfte och en liten grafik som visar hur enheten ser ut. Grafiken ska ordentligt märka och namnge alla omkopplare, vred och fästbara delar som enheten innehåller.
- 4Inkludera 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 konstrueras eller ställas in av en hemanvändare, ange detta faktum tydligt i en fet rubrik längst upp i installationssektionen. Du bör också inkludera:
- En lista över delar
- Uppackningsinstruktioner
- Varningar relaterade till installation
- Resultat av felaktig installation
- Vem man ska ringa om de får problem med att ställa in
- 5Ge information om drift. Detta avsnitt är den huvudsakliga delen av användarmanualen och ska 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 ansluta den eller tvätta händerna. Gå vidare till logiska, numrerade steg som beskriver hur enheten ska användas, liksom feedback (till exempel "Du hör ett klick...") som användaren kan förvänta sig när enheten används på rätt sätt.
- I slutet av detta avsnitt bör användare hänvisas till felsökningsavsnittet för att lösa problem som inte kan förklaras snabbt.
- Inkludera grafik vid behov. Vissa steg förklaras bäst med både bilder och ord. Tänk på att använda fotografier eller illustrationer i din användarmanual.
- Se till att i detta avsnitt, som i varje avsnitt, inkludera relevanta säkerhetsvarningar om felaktig användning eller användning. Till exempel kan du varna användare av en motorsåg att inte dricka alkohol eller använda motorsågen när de är på vissa mediciner.
- Om du tror att användarna skulle dra nytta av det kan du överväga att inkludera länkar till onlinevideor som visar korrekt användning och användning av enheten. Du kan inkludera 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.
Användarmanualen bör vid behov förklara hur produkten eller enheten ska lagras korrekt. - 6Inkludera en produktöversikt i slutet. Sammanfattningen ska gå i slutet av manualen, strax före indexet, för att ge grundläggande driftssteg. Detta bör vara en förenklad, avskalad version av avsnittet om operativ information och bör inte vara mer än en sida. Sammanfatta hur du använder enheten eller produkten. 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 sammanfattningsarket eller behöver konsultera det ofta kan du skriva ut det på ett laminerat kort eller ett tjockt papper för att göra det lättare för användaren att ha med sig och referera.
- Alternativt kan du inkludera ett sammanfattningsark direkt på produkten så att användare kan referera till det snabbt och enkelt.
Del 3 av 4: beskrivning av produktvård
- 1Förklara hur du rengör enheten. Om din enhet eller produkt behöver rengöras, förklara hur du gör det. Var noga med att räkna upp de rengöringsmaterial som behövs. Informera läsaren om hur ofta de ska rengöra. Precis som i något annat avsnitt i användarhandboken, inkludera sedan numrerade steg-för-steg-instruktioner om hur rengöringen ska fortsätta.
- Om rengöring kräver en del isärtagning av produkten eller borttagning av en viss del eller delar, var noga med att ta med detaljer om hur man tar isär.
- Inkludera en varning om resultatet av att inte rengöra enheten kommer att bli. Du kan till exempel säga "Om du inte rengör kommer resultatet att vara under optimalt."
- 2Berätta för användaren hur man utför grundläggande underhåll. Om produkten eller enheten kan servas av användaren för att rätta till prestandaproblem, inkludera numrerade anvisningar om hur användaren kan göra det. Till exempel, om batterierna måste bytas ut efter var 300: e timmars användning, inkludera anvisningar om hur man kontrollerar om batterierna behöver bytas, hur man tar ut de döda batterierna och hur man sätter i de nya batterierna.
- Om det finns några underhållsuppgifter som bara kan utföras av en certifierad tekniker, dela underhållsdelen av handboken i två avsnitt.
- 3Diskutera lagringsalternativ. Användarmanualen bör vid behov förklara hur produkten eller enheten ska lagras korrekt. Du bör också inkludera information om varför lagring är nödvändig och vad resultatet av felaktig lagring är. Du kan till exempel skriva:
- "Förvara produkten på en sval och torr plats. Felaktig förvaring kan förkorta produktens livslängd på grund av fukt."
- "Utsätt inte produkten för värme eller förvaring vid temperaturer över 49°C. Om du gör det kan det leda till förbränning."
- 4Inkludera 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.
- Till exempel, om det finns flera problem med att datorn visar en blå skärm, lista dem tillsammans under en underrubrik som "Vanliga skärmproblem."
- Du bör också inkludera ett telefonnummer och / eller e-post för kundtjänst i detta avsnitt.
Del 4 av 4: skriva en läsbar manual
- 1Läs andra användarmanualer. Innan du skriver en handbok för din egen produkt, titta på andra effektiva användarmanualer. Var uppmärksam på struktur, ordval och meningsstil. Stora varumärken som Apple, Google och Microsoft producerar starka, effektiva användarmanualer som kan hjälpa dig att producera en mer noggrant skriven användarmanual.
- Läs inte bara några användarmanualer. Läs manualerna för liknande produkter som du säljer. Till exempel, om du säljer babyprodukter, läs babyhandböcker, inte tekniska.
Om det finns flera språkgrupper representerade i din publik, inkludera översättningar av användarhandboken på varje relevant språk. - 2Välj dina standarder. Standardisering av stavning, ordval och frasering 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 användarmanual. konsultera båda för att se om någon kommer att arbeta för din manual.
- Till exempel, istället för att använda både "on / off switch" och "power switch" i din användarmanual, välj den ena eller den andra termen och håll fast vid den.
- 3Använd aktiv röst. Aktiv röst är ett skriftligt perspektiv som förklarar saker ur användarens perspektiv. Det är lättare att förstå än dess alternativa, passiva röst, där motivet är odefinierat.
- Prova Hemingway-appen (www.hemmingwayapp.com) för att identifiera passiva passager i ditt skrivande.
- Undersök dessa två meningar, den första aktiva och den andra passiva, för exempel på var och en:
- Du bör öppna förpackningen långsamt och försiktigt.
- Förpackningen ska öppnas långsamt och försiktigt.
- 4Skriv numrerade instruktioner. Numeriskt beställda instruktioner hjälper läsaren att hålla sig mer fokuserad på processen att använda, ansluta eller bygga produkten i fråga. Istället för att skriva ett långt, vandrande stycke eller en serie omumrerade stycken, skriv din användarmanual med enkla, uttryckliga steg, var och en numrerad tydligt.
- 5Börja varje steg med ett krav. En imperativ är ett handlingsorienterat verb. Genom att starta varje steg med ett verb kommer du att läsa läsaren till 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 krav som "Connect", "Bifoga" eller "Slide". Börja inte dina steg med ett systemsvar, dock.
- Till exempel, om skärmen blir blå och blinkar, börja inte steget med: "Skärmen blinkar och blir blå." Försök: "Håll hemknappen intryckt. Skärmen blinkar och blir blå."
- 6Bestäm vilken typ av ordförråd du ska använda. Om du skriver en yo-yo-användarmanual blir publiken mestadels små barn. Använd enkla ord och ordförråd för att förklara hur jojo fungerar. Om du skriver en användarmanual för ett svepelektronmikroskop kommer din publik att vara välutbildade forskare som kan förstå mycket detaljerad information, så undvik inte att använda specialiserad ordförråd eller nyanserade förklaringar.
- Försök i allmänhet undvika jargong och tekniskt språk.
- För att vara effektiv för det bredaste utbudet av användare, försök att skriva på läsnivå sjätte till sjunde klass.
- 7Se till att dina översättningar är korrekta om du levererar en produkt utomlands. Hyr en översättare för att översätta din användarmanual till det modersmål det land du skickar din produkt till. Alternativt kan du använda en onlineöversättningsapp, men be en modersmål läsa igenom och redigera översättningen för fel.
- Om det finns flera språkgrupper representerade i din publik, inkludera översättningar av användarhandboken på varje relevant språk.
- Översättaren bör vara bekant med produkten, eftersom det kan finnas olika ord för specifika termer på målspråket som inte är ord-för-ord-översättningar.
Tänk på din produkt och hur varje metod kan vara användbar när du skriver din användarmanual. - 8Håll ditt skrivande kort. Använd många korta stycken istället för några långa stycken. Leta efter logiska avbrott i varje avsnitt och lägg användbar information i en eller två menings bitar. Detsamma gäller på meningsnivå. Håll dina meningar korta och enkla, snarare än långa och vandrande.
- Om ett steg börjar bli för långt, dela upp det i mindre steg. Detta kommer inte att leda till att ordräkningen går ner, men radbrytningarna gör det lättare att läsa.
- 9Korrekturläsa manualen. En manual kan förlora trovärdigheten på grund av grammatik och stavfel. Låt en kollega eller teknisk författare redigera och korrekturläsa manualen också. Förutom stavning och grammatik bör en korrekturläsare leta efter:
- Passiv form
- Tvetydigt eller förvirrande språk
- Komplicerad meningsstruktur
- Alltför långa stycken
- 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 handboken för att hjälpa visuella elever.
Läs också: Hur undviker man vanliga stavfel?
Kommentarer (7)
- Jag gillar verkligen illustrationerna och utformningen av instruktionerna, det har gett mig några idéer om hur jag kan städa upp mitt projekt. Tack!
- Det har logiskt sett sammanställt vad jag skulle vilja göra.
- Detta hjälper mig att skriva en användarmanual effektivt.
- Jag läste bara några få avsnitt och tyckte att det var intressant, så jag bokmärke det för när jag slappnar av och kan spendera tid på att smälta det. Jag gillar konceptet.
- Det var detaljerat. Jag tyckte att den "passiva / aktiva" röstsektionen var mycket informativ. Tack för ditt hårda arbete.
- Så användbart för mig. Det visade mig framstegen och det var så tydligt.
- Grymt bra! Jag fick ett försprång på mitt vitbok!
