Steg 1 för att Få Allmänna Kunskaper om Användarhandbok Mall

Innan faktiskt använda Bruksanvisning Mall och den andra verktyg som jag utvecklat för Philip, jag ville se till att vi har samma utgångspunkt. Jag gav honom lite allmän information om användarinstruktioner och med några bra exempel på befintliga bruksanvisningar.

Jag har listat denna information nedan.,

vad är definitionen av en bruksanvisning?

en användarmanual är ett tekniskt kommunikationsdokument som är avsett att ge hjälp till personer om hur man använder en produkt. En bra användarmanual hjälper användare om hur man använder en produkt på ett säkert, hälsosamt och effektivt sätt.,

andra namn, eller andra former av en bruksanvisning, kan vara:

  • Användarhandbok
  • teknisk dokumentation
  • bruksanvisning
  • Driftsmanual
  • träningsmanual
  • Snabbstartsguide
  • installationsmanual
  • underhållsmanual
  • programvarumanual

förutom det primära målet för en användarhandbok (ul>), kan du använda den här bruksanvisningen.för att hjälpa en användare) kan sekundära mål skapa en bättre användarupplevelse och uppfylla juridiska krav.

en bruksanvisning består av textuell visuell information (illustrationer, skärmdumpar, tabeller etc.,) för att hjälpa användaren att slutföra specifika uppgifter.

användaren spelar den centrala rollen när man utarbetar en bruksanvisning. En väl utarbetad bruksanvisning ger endast den information som är relevant för den avsedda användaren av produkten.

användarhandboken ska innehålla både procedurinformation (steg-för-steg-instruktioner) och konceptuell information (information som användaren behöver för att förstå procedurinformation).

en bra bruksanvisning är kortfattad och använder jargong-fritt språk. En bra bruksanvisning ska svara på hur och vilka frågor., De bör innehålla information om vad som händer om en uppgift inte görs korrekt.

i vissa fall är en produkt avsedd att användas av olika typer av användare. Typiska användartyper är slutanvändare, installatör, underhållstekniker och operatör. Varje användartyp behöver ett annat tillvägagångssätt när det gäller språk som ska användas, tonfall och begreppsinformation.

vilken information ska finnas i en bruksanvisning?

olika typer av produkter behöver en bruksanvisning. En produkt kan vara ett system, verktyg, enhet, ett instrument, en mjukvara eller en app.,installationsanvisningar

  • beskrivning av hur du använder/använder produkten
  • felsökningssektionen och instruktioner om hur du löser problem
  • underhållsinformation
  • reparationsinformation
  • Information om bortskaffande av produkten och förpackningen

  • tekniska specifikationer
  • Innehållsförteckning
  • Index
  • ordlista
  • garantiinformation
  • garantiinformation
  • kontaktuppgifter

    • använda en användarmanual Mall

    det viktigaste verktyget som jag utvecklat för att hjälpa Philip utarbeta sin bruksanvisning är en användarmanual mall., Mallen innehåller all information och mer från listan ovan. Den uppfyller kraven för sin produkt.

    den manuella mallen kan användas för att skapa din manual för ditt system, verktyg, enhet, instrument eller för att skapa en installationsmanual, programvaruhandbok, driftsmanual, underhållsmanual eller träningsmanual.

    baserat på den första mallen för Philip har vi utvecklat mallar för följande produktgrupper:

    • medicintekniska produkter
    • leksaker
    • maskiner
    • Elektronik

    vilka format har en bruksanvisning?,

    användarmanualer kan tillhandahållas i antingen ett pappersformat eller som ett elektroniskt dokument (PDF eller placeras online eller på enheten i HTML). Den manuella mallen är ett MS Word-dokument som kan skrivas ut eller placeras online.

    användarmanualer kan skapas med hjälp av olika verktyg. Varje verktyg har sina egna fördelar och nackdelar., innehåll möjligt

    Indesign hög grad av designfrihet innehållsförändringar kan kräva många extra DTP-timmar CMS (teknisk författande & publiceringslösningar) återanvändning av innehåll
    allt i en lösning
    Omni-platform publikationer
    innehåller standard användarmanual mallar hög inlärningskurva

    användarmanual exempel

    När du utarbetar en bruksanvisning med hjälp av den manuella mallen kan det vara praktiskt att ha några bra exempel., Genom följande länkar kan du ladda ner ett användarmanual prov för dokumentation:

    • IKEA installationsanvisningar
    • Jura bruksanvisning

    steg 2 identifiera användaren/användarna av din bruksanvisning Mall

    Ok, så nu Philip har några grundläggande kunskaper om bruksanvisningar. Låt oss dyka in i detaljer och handlingar.

    När du vill skriva en manual som hjälper din användare att lösa problem måste du först definiera vem din användare är. Detta kan göras genom att skapa en användarprofil, även kallad en persona.,

    med en persona gör du några rimliga antaganden om användarens egenskaper. Detta är inte bara användbart för att skapa dina användarinstruktioner, men det är en viktig del i början av utvecklingen av någon produkt! Som utbildad industriell designingenjör startade vi alla våra designuppdrag.

    När jag kollade ISOVOX-webbplatsen hittade jag inte ens en tydlig beskrivning av deras avsedda användare. Därför bad jag Philip att definiera sina användare och svara på frågor som:

    • vem är användaren av din produkt?,
    • används produkten professionellt eller huvudsakligen privat?
    • vilka andra tekniska erfarenheter har de? Vad beskriver användaren?

    Jag har skapat en mall som innehåller frågorna. Jag bad Philip att fylla i mallen.

    Du kan använda mallen själv för att avgöra vem din användare är. Observera att den andra fliken också innehåller Philips svar, så du har ett exempel på hur arket kan användas.

    åtgärd: använd mallen för att beskriva dina användare.

    Jag är ett stort fan av att visualisera saker., Så om du vill ta definiera din användare ett steg längre, jag föreslår att du visualisera din användare i form av en persona. När du skapar en persona ger du din användare ett namn, ålder et cetera, så det blir en riktig person som representerar din användare.

    Jag gjorde detta för Philip., Detta är resultatet:

    åtgärd: skapa en visualisering av din användare

    Om du vill veta mer om att definiera din publik och skapa personas:

    steg 3 Skapa ämnen för användarens problem

    börja med att identifiera de problem som din användare kan stöta på under produktens livscykel och att han / hon vill lösa. Typiska problem kan vara: installation av produkten, användning av produkten, användning av produkten på ett säkert sätt, underhåll av produkten och bortskaffande av produkten.,

    Om problemet är för komplicerat kan du bryta ner det i bitar.

    Jag bad Philip att identifiera de problem och lösningar som hans användare kan stöta på under produktens livscykel. För att göra det skapade jag en annan mall för Philip. I den vänstra kolumnen på fliken livscykel nämns stegen i en produkts livscykel. Dessa härrör från den internationella standarden för användarinstruktioner, IEC / IEEE 82079. Våra användarmanual mallar är kompatibla med denna standard.

    På fliken livscykel ser du hur Philip justerade livscykeln till sin egen produkt.,

    åtgärd: använd den här mallen och instruktionerna på den första fliken för att identifiera de problem som din användare kan ha under produktens livscykel och presentera sina lösningar.,

    Om du vill veta mer om hur du definierar användarens problem och skapar ämnen:

    • ämnesbaserad författande
    • Minimalism
    • informationskartläggning
    • Chunking

    steg 4 definiera strukturen för den manuella mallen

    Philip har nu identifierat de problem som en användare har kan ha med sin produkt under sin livscykel och han har nu tänkt på lösningen för att lösa problemet. Med andra ord: Philip har definierat ämnena för sin bruksanvisning., Varje ämne kan bara handla om ett specifikt ämne, har ett identifierbart syfte och måste kunna stå ensam.

    ett ämne bör ge svaret på endast en användares fråga. En användare vill lösa ett problem i taget. När en användare har löst problemet kommer han/hon att gå och lösa nästa problem.

    ett ämne kommer att bli ett avsnitt i användarhandboken. Det kan vara ett kapitel eller ett (under)stycke. Så snart en användare letar efter ett svar på sitt problem, kommer han att använda innehållsförteckningen för att ta reda på hur man navigerar till det svaret.,

    Jag bad Philip att strukturera ämnena och definiera deras plats i användarhandboken genom att tilldela ett visst ämne till ett visst kapitel eller (under)stycke. Resultatet kan ses på fliken ToC.

    åtgärd: för att definiera strukturen i din bruksanvisning:

    1. kopiera innehållet från fliken livscykel till fliken ToC.
    2. på fliken ToC, ersätt Produktnamn med ditt eget Produktnamn.
    3. Lägg till en kolumn till vänster. Benämn det ”avsnitt”.
    4. om tillämpligt, organisera dina avsnitt logiskt.
    5. Bestäm vilka ämnen som ska bli kapitel genom att lägga till kapitelnummer., Börja numreringen FÖRBEREDELSE PRODUKT FÖR ANVÄNDNING med nummer 4. Vi kommer att lägga till några fler kapitel i nästa steg.
    6. Bestäm vilka ämnen som kommer att bli stycken genom att lägga till sektionsnumren.
    7. Bestäm vilka ämnen som kommer att bli underavsnitt genom att lägga till underavsnittsnummer.

    Du har nu skapat innehållsförteckningen (ToC). ToC är konturerna av din bruksanvisning. Senare kommer vi att lägga till några fler ämnen/sektioner, som introduktion, säkerhetsinformation etc., så oroa dig inte om att lägga till det nu.,

    Steg 5 skapa meningsfulla rubriker

    varje ämne i användarhandboken får sin egen rubrik. Rubrikerna är de (under)titlar som föregår den faktiska texten. De visas i ToC, så att användaren kan navigera till nödvändig information.

    så, Philip har just skapat (sub-)titlarna för hans ämnen.

    eftersom Toc-posterna spelar en så viktig roll för att hjälpa din användare att hitta sin väg och för att hjälpa dem att hoppa över vad som inte är viktigt behöver de lite mer uppmärksamhet.

    i grund och botten bör du försöka arbeta med tre nivåer av rubriker: rubriker på första, andra och tredje nivån.,

    rubriken på första nivån beskriver vad hela kapitlet eller avsnittet handlar om (t.ex. INSTALLATION av produkten). I rubrikerna på andra nivån bör man använda formuleringens ”hur vad” – stil (t.ex. hur man monterar produkten och hur man gör den elektriska installationen). En tredje nivå rubrik använder substantivfraser (t.ex. Förpackningens innehåll och verktyg som ska användas).

    Jag bad Philip att omdirigera sina rubriker och att notera följande allmänna riktlinjer:

    • använd strukturen som visas ovan för första, andra och tredje nivårubriken.,
    • kontrollera att rubrikerna är självförklarande. Rubriken gör pannkakor är mycket mer användarorienterad än att använda MagicCook5000.
    • se till att rubriken täcker hela ämnet. Om avsnittet omfattar underhåll och reparation av en produkt, skulle rubriken Underhåll vara ofullständig.
    • om möjligt, försök att utelämna artiklar i början av rubrikerna

    åtgärd: Skriv nya rubriker för dina ToC-poster.

    Philips ToC med meningsfulla rubriker finns på fliken ToC w. meningsfulla rubriker.,

    steg 6 bestäm det lagliga innehållet

    beroende på vilken marknad din produkt placeras i eller tas i bruk, och beroende på vilken produktgrupp din produkt tillhör gäller specifik lagstiftning för din produkt.

    i allmänhet kräver lagstiftningen att din produkt är ”säker” och ger därför allmänna säkerhetskrav som din produkt ska uppfylla.

    dessa krav innehåller också krav på innehållet i din bruksanvisning och säkerhetsanvisningar.,

    för att kunna sälja din produkt på en viss marknad bör du se till att din bruksanvisning uppfyller dessa krav.

    dessa två artiklar nedan kommer att berätta hur du kan ta reda på exakt vilken lagstiftning som gäller för din produkt för den europeiska och amerikanska marknaden och vad kraven är för din bruksanvisning. Pro Tips: när det redan finns en försäkran om överensstämmelse kan du hitta de tillämpliga direktiven där.,

    • hur man skapar kompatibla Handböcker för EU
    • hur man skapar kompatibla Handböcker för USA

    Philip behövde inte utföra dessa steg, eftersom mallen han använde redan innehöll det rättsliga innehållet i enlighet med de relevanta direktiven.

    för sin produkt betyder det att följande information krävs för bruksanvisningen för sin produkt:

    EU (relevanta CE-märkningsdirektiv: LVD, EMC, RoHS, WEEE, REACH):

    • användarhandboken ska översättas till språket eller språken i det land där produkten säljs.,
    • bruksanvisningen ska beskriva den avsedda användningen av produkten.
    • användarhandboken ska beskriva den rimligen förutsedda oavsiktliga användningen av produkten.
    • i förekommande fall bör bristande efterlevnad i bostadsområden nämnas.
    • typ, sats eller serienummer eller annat element som gör det möjligt att identifiera produkten ska anges på produkten. Om produkten är för liten kan den placeras i bruksanvisningen.
    • namn, registrerat handelsnamn eller registrerat varumärke och postadress ska anges på produkten., Om produkten är för liten kan den placeras i bruksanvisningen.
    • en riskanalys bör göras för att fastställa de kvarstående riskerna i samband med användningen av produkten. Säkerhetsinformation ska tillhandahållas för att informera användaren om vilka åtgärder som ska vidtas.
    • WEEE-information ska inkluderas
    • Information om förpackningsavfall ska inkluderas.

    förutom denna lagstiftning finns det också en internationell standard för bruksanvisningar, IEC/IEEE 82079-1:2019. Denna standard har harmoniserats i EU., Överensstämmelse med harmoniserade standarder ger en presumtion om överensstämmelse med motsvarande lagstiftning!

    den manuella mallen överensstämmer med denna standard.

    Jag har också skapat en checklista för IEC 82079 som kan användas för att dubbelkolla att din bruksanvisning överensstämmer med denna standard.

    för att skapa en internationellt kompatibel bruksanvisning bör du alltid se till att handboken uppfyller kraven i EU, USA och 80279.,

    åtgärd: för att fastställa de rättsliga kraven i din bruksanvisning:

    1. följ steg 1-2 från EU: s efterlevnad och / eller steg 1-6 från USA: s efterlevnadsartiklar för att bestämma den rättsliga ramen för dina instruktioner.
    2. studera checklistan IEC 82079 för att säkerställa att handboken överensstämmer med 82079-standarden.

    i den här videon förklarar jag hur du kan skapa en manual som överensstämmer med 82079-standarden:

    till butiken

    Steg 7 Ladda ner och förbered Användarmanual Mall

    Nu kan Philip starta själva skapandet av sin bruksanvisning.,

    Jag bad honom att justera innehållsförteckningen i mallen enligt sin egen innehållsförteckning. Utan att ta bort och obligatoriska element förstås…

    kommer du ihåg från steg 4 att jag bad om att starta numreringen av avsnitten med kapitel 4? När du har hämtat användarhandboken Mall doc själv ser du att några standardkapitel har lagts till, liksom några bilagor.,

    åtgärd: för att justera användarmanual Mall:

    om du vill arbeta med den fria mallen:

    1. ladda ner gratis användarmanual Mall Word 2013 eller 2007
    2. ändra avsnitt rubriker enligt din egen ToC. Obs! Justera inte innehållsförteckningen. Innehållsförteckningen kan uppdateras automatiskt när du har justerat sektionsrubrikerna.
    3. Lägg till det obligatoriska innehållet enligt steg 6 i din manual.
    4. om tillämpligt, ändra avsnitt 1-3 och bilagorna efter dina egna behov.,

    eller använd en av våra betalda mallar som innehåller allt obligatoriskt innehåll, som Philip gjorde:

    • medicintekniska produkter EU
    • medicintekniska produkter usa
    • maskiner EU
    • maskiner USA
    • Elektronik EU
    • leksaker EU

    steg 8 skapa innehållet för din användarmanual Mall

    skriv den avsedda användningen

    syftet med din produkt, eller bättre: den avsedda användningen, är hjärtat i en bruksanvisning och utgör grunden för att säkerställa en säker och hälsosam användning av produkten.,

    hur den avsedda användningen beskrivs bestämmer också ditt ansvar och påverkar det ytterligare innehållet i användarhandboken.

    enligt flest lagar ska du inkludera en beskrivning av den avsedda användningen i bruksanvisningen.

    den internationella standarden för användarinstruktioner, IEC 82079-1, ger följande definition för den avsedda användningen:

    ett uttömmande utbud av funktioner eller planerade applikationer definierade och utformade av leverantören av produkten

    genom att beskriva den avsedda användningen bestämmer du produktens säkra kuvert., Och när du har bestämt den avsedda användningen kan du fokusera på att endast tillhandahålla dessa säkerhets-och användarinstruktioner för hur du använder produkten inom det givna kuvertet.

    dessutom, till den avsedda användningen, kräver många fler standarder, direktiv och förordningar också att du ska inkludera en beskrivning av det rimligen förutsebara missbruket.

    till exempel kan det rimligen förutsebara missbruk av ett aggressivt rengöringsmedel vara användningen av det i en livsmedelsbearbetningsmiljö.

    om man ägnar för lite uppmärksamhet åt att beskriva det rimligen förutsebara missbruket kommer det att påverka ett företags ansvar.,

    produktansvar lagar / föreskrifter håller en tillverkare ansvarig för en defekt produkt. Om en produkts defektivitet behöver bestämmas, kommer alla omständigheter att beaktas. Detta inkluderar den rimligen förutsebara användningen av produkten.

    beskrivningen av den avsedda användningen avgör vilka instruktioner som ges i resten av handboken. Till exempel, om ett kylsystem endast används för kylning av vissa mediciner, behöver endast dessa procedurer beskrivas.,
    om det rimligen kan förutses att kylsystemet kan användas som ett system för att kyla organ, bör detta beskrivas i instruktionerna. Genom att göra det kommer du som tillverkare att begränsa ditt ansvar och du kan fokusera på att bara beskriva hur du använder systemet för att kyla läkemedel.

    åtgärd: skriv den avsedda användningen och det rimligen förutsebara missbruket av din produkt.


    Figur 1. Rimligen förutsebar missbruk?,

    skriv säkerhetsvarningarna baserat på riskanalysen

    även om den avsedda användningen nu har definierats tydligt betyder det inte att användningen av en produkt är helt utan några risker.

    för att identifiera de faror som följer med användningen av en produkt kan du göra en riskanalys. En riskanalys kan också vara obligatorisk för vissa produktgrupper, t.ex. lågspänningsutrustning, leksaker, maskiner och utrustning för användning i explosiv atmosfär.

    standarder, som ISO 12100, har utvecklats om hur man utför en riskanalys., ISO 12100 ger också en metod för att vidta begränsningsåtgärder: Trestegsmetoden. Enligt denna metod finns följande hierarki av riskreducerande åtgärder:

    1. i sig säkra konstruktionsåtgärder
    2. skydd och kompletterande skyddsåtgärder
    3. Information för användning

    detta innebär att användarhandboken bör varna för eventuella kvarstående risker i samband med användningen av produkten. Detta görs med säkerhetsvarningar.,

    Köp nu

    en bra säkerhetsvarning beskriver arten av en farlig situation, konsekvenserna av att inte undvika en farlig situation och metoden / metoderna för att undvika den.

    för att indikera graden av fara som kan uppstå av användaren, bör signalorden ”fara”, ”varning” och ”försiktighet” användas.

    ta en titt på följande säkerhetsmeddelanden:

    varning! Roterande delar. Risk för allvarliga skador. Håll händerna fria. Lockout/Tagout före service.

    då vill du varna användaren där en farlig situation kan uppstå. ANSI Z535.,6 standard beskriver följande platser i användarhandboken där detta kan vara:

    • grupperade i ett separat kapitel.
    • i den första delen av det specifika avsnittet:
    • inbäddad i ett förfarande:

    1. Gör det här.
    2. Gör det. VARNING! Detta är inbäddade säkerhetsmeddelanden. Allmän text allmän text allmän text.
    3. Gör det här.,

    • i förordet kan eventuella kompletterande direktiv placeras, till exempel Läs alla instruktioner före användning eller behåll dessa instruktioner för framtida referens kan placeras i införandet av en bruksanvisning.

    i EU kan det, beroende på typ av produkt, vara tillåtet att endast tillhandahålla säkerhetsinformation i tryckt form och resten av informationen online.

    För att hjälpa Philip att skapa och placera ett säkerhetsmeddelande har jag skapat en annan mall.

    åtgärd: utför en riskanalys och skapa dina säkerhetsmeddelanden med den här mallen.,

    skapa allt annat innehåll

    nu bad jag Philip att skapa allt annat innehåll, till exempel procedurer, tekniska specifikationer och juridisk information.

    Jag gav följande tips:

    • Uteslut onödigt material för att undvika överbelastning av information (till exempel säljfrämjande åtgärder, omfattande upprepning etc.).
    • se till att villkoren är bekanta för användaren, tekniska funktioner och villkor är väl förklaras och använda termer konsekvent.
    • beskriv alla förutsättningar som bör uppfyllas innan de faktiska instruktionerna börjar., Detta kan också beskriva specialverktyg eller utrymme för underhåll och reparation.
    • ge begreppsinformation när information är nödvändig för adekvat förståelse och utförande av uppgifter.
    • skriv alltid ämne baserat.
    • använd en fetstil för alla produktelement.
    • använd en stilguide som hjälper dig att skriva och formatera dokumentation på ett tydligare sätt.
    • ange när du vill lägga till en bild för bättre förståelse senare.
    • se till att ord och fraser inte är för komplicerade eller över-sofistikerade.,
    • Använd enkla / standardiserade och korta fraser: ett mening-ett kommando.
    • lägg inte för mycket information i en mening.
    • använd kommandona direct active voice och assertive.
    • använd ord som substantiv och verb konsekvent för att undvika tvetydighet.
    • för att skriva bättre instruktioner, Använd principerna om Minimalism i teknisk kommunikation och förenklad Teknisk engelska.

    åtgärd: skapa allt annat innehåll för din bruksanvisning.

    För de flesta produktgrupper finns det betalda mallar som kan göra arbetet enklare., Dessa mallar innehåller alla juridiska texter, obligatorisk information om bortskaffande, upphovsrättsliga uttalanden och överensstämmer med IEC 82079-standarden på användarinstruktioner.

    placera säkerhetsvarningarna i rätt läge

    När du använder mallen för att skapa säkerhetsmeddelanden, bad jag Philip att ange om ett säkerhetsmeddelande är ett kompletterande direktiv, eller bör placeras som en grupperad, avsnitt eller inbäddade säkerhetsmeddelande.

    nu har all text skapats, säkerhetsmeddelandena kan placeras på rätt plats.,

    åtgärd: placera alla säkerhetsmeddelanden på rätt plats i användarhandboken.

    steg 9 Lägg till navigering i din användarmanual Mall

    en bruksanvisning bör ge hjälp till personer genom att ge information om hur du använder en produkt. Att hitta rätt information som löser användarens problem bör ta så lite tid som möjligt.

    utformningen av meningsfulla rubriker är ett av de verktyg som hjälper användarna att hitta information., Det finns dock flera andra verktyg som hjälper användaren att hitta den information han / hon vill ha, till exempel:

    • innehållsförteckning
    • sidnumrering
    • Index

    Jag bad Philip att uppdatera innehållsförteckningen och lägga till sidnumrering och ett index.

    åtgärd: Lägg till eller uppdatera innehållsförteckningen, sidnumreringen och indexet.

    steg 10 Läs igenom din bruksanvisning

    Philip har nu skapat utkastet till version av sin bruksanvisning med hjälp av den manuella mallen. Vi kallar denna version textinnehåll design.,
    eftersom Philip har en affärspartner och en utvecklare med djupgående teknisk produktkunskap bad jag Philip att låta dem granska arbetet hittills.
    både hans affärspartner och utvecklaren gav feedback. Philip använde denna feedback för att optimera användarhandboken.
    åtgärd: skicka utkastsversionen av användarhandboken till alla inom ditt team som kanske kan ge feedback. Be dem att kombinera all feedback i ett dokument innan de skickar tillbaka det till dig. Detta stimulerar diskussionen om dina gruppmedlemmar och förhindrar oenighet i ett senare skede.,

    steg 11 skapa bilderna

    När användarhandboken har granskats och optimerats är texterna mer eller mindre bestämda. Detta innebär att alla bilder nu kan skapas och läggas till innehållet.

    anledningen till att vänta tills texterna är klara är att skapa eller redigera bilder kan vara tidskrävande. Som bilder bör stödja, ersätta eller utöka text, du vill vänta med att skapa dem tills texterna är slutliga.

    bilder i bruksanvisningar kan innehålla illustrationer, foton, skärmdumpar, tabeller, diagram och scheman.,

    det finns många bra verktyg som kan hjälpa dig att skapa dina bilder, till exempel:

    • Snagit eller Adobe Photoshop för redigering av skärmdumpar eller foton
    • Solidworks Composer eller Google Sketchup för att skapa linjeritningar
    • Lucidchart eller Microsoft Visio för diagram och scheman

    Jag rådde Philip att inte använda foton som ett billigt alternativ för illustrationer. Ofta är bilder inte lika informativa eftersom de innehåller för mycket information. Dessutom kan bilder göra en bruksanvisning ser rörigt.,

    av den anledningen använde Philip Google Sketchup för att skapa sina illustrationer.

    åtgärd: skapa bilderna för din bruksanvisning.

    om du vill veta mer om att skapa bilder:

    • använda text, bilder eller video
    • skapa IKEA-ish-handböcker

    steg 12 slutkontroll av den manuella mallen

    innan vi börjar göra det ser bra ut och översätter innehållet vill vi vara säkra på att innehållet är klart.

    För att göra det bad jag Philip att använda en checklista.,

    åtgärd: l se till att din bruksanvisning uppfyller alla relevanta krav från IEC 82079-1:2012 genom att använda denna checklista.

    steg 13 designa din användarmanual Mall

    en väl utformad manual bidrar till en bättre varumärke och användarupplevelse.

    Du kan justera den manuella mallen i MS Word genom att lägga till en företagslogotyp och justera teckensnittet, färgerna och så vidare, men det kan ha begränsningar.

    När du vet hur man arbetar med Adobe Indesign, eller är villiga att lära sig att arbeta med det, kommer detta att erbjuda dig mycket större designmöjligheter.,

    Jag skapade den här mallen i Indesign och bad Philip att justera den för att matcha sin varumärkesidentitet.

    åtgärd: justera mallen för Användarmanual så att den passar din varumärkesidentitet, eller ladda ner mallen för användarmanual för InDesign och justera den.

    steg 14 DTP fungerar

    DTP står för Desktop Publishing och Wikipedia beskriver det som ”skapandet av dokument med hjälp av sidlayoutfärdigheter på en persondator främst för utskrift”.

    Philip har nu både innehållet i sin bruksanvisning (Word-fil) och den manuella mallen (InDesign-fil)., Innehållet måste sättas in i InDesign-mallen. Detta kallas Desktop Publishing.

    åtgärd: placera innehållet från din Word-fil i Indesign-mallen. Om du bestämde dig för att inte använda InDesign-mallen men fastnade i Word-filen kan du hoppa över det här steget.

    steg 15 Översätt och publicera dina bruksanvisningar

    beroende på vilken marknad du ska sälja din produkt kan du behöva översätta användarhandboken.

    några allmänna tips:

    • leta efter en översättare med liknande erfarenhet., Detta kan vara en översättare som har erfarenhet av att översätta tekniskt innehåll, med liknande produkter eller med att översätta bruksanvisningar.
    • Om du behöver översätta till flera språk kan arbetet med en översättningsbyrå spara mycket tid.
    • fråga översättaren eller byrån om deras kvalitetsförfaranden och vem som ska revidera texten efter översättning.
    • som du vet din produkt bäst och vem din publik är, kan det vara en bra idé att ge översättaren eller byrån En ordlista eller en lista med den terminologi som du vill använda.,
    • leta efter en översättare som kan arbeta direkt i ditt ord eller InDesign-fil eller hitta en byrå som kan göra DTP fungerar också. Alternativt kan du göra det själv, förstås.

    eftersom Philip kommer att sälja sin produkt i både USA och EU bestämde han sig för att arbeta med en byrå.

    åtgärd: hitta en översättare eller byrå som passar dina behov och få din bruksanvisning översatt.

    i allmänhet bör en bruksanvisning vara tillgänglig i ett format som är lättillgängligt för användaren. Som kan skrivas ut, eller användas online eller på enheten.,

    som användare vill ha information just nu behöver han/hon det och tänker därför inte i kanaler, det bästa sättet skulle vara att ge instruktionerna omni-platform.

    i Europeiska unionen är det för vissa produktgrupper fortfarande begränsat till att tillhandahålla bruksanvisningen som skrivs ut med produkten.
    Från och med April 2016 kan instruktionerna från många produktgrupper dock levereras i ett annat format i stället för i tryck. Det finns dock ett undantag.

    säkerhetsinformation ska fortfarande levereras i pappersform tillsammans med produkten., Dessutom bör en pappersanvändarhandbok göras tillgänglig för konsumenten på begäran av en konsument.

    Philip bestämde sig för följande:

    • han tillhandahåller en tryckt fullständig handbok med produkten, inklusive säkerhetsinstruktionerna.
    • han skapade en separat snabbstartsguide som också ska tillhandahållas med produkten.
    • han placerade en pdf-version av den fullständiga handboken online.
    • han kommer att skapa ett online-hjälpavsnitt på sin webbplats med HTML-versionen av användarhandboken. Här kan han lägga till videor också., Och genom att optimera HTML-versionen för sökmotorer gör han det lättare för sin användare att hitta information för sin användare

    slutsats

    det är allt som finns för det. Så skapade Philip en kompatibel bruksanvisning med hjälp av mallen för användarmanualer och de andra tillgängliga verktygen som jag tillhandahöll.

    den bästa delen av allt detta är att du kan få samma resultat som Philip gjorde genom att följa denna steg-för-steg-process om hur du skapar en bruksanvisning.