Efni.

• Að stíga
• Hluti 1 af 4: Skipuleggja handbók þína
• Hluti 2 af 4: Fella nauðsynlegar upplýsingar
• Hluti 3 af 4: Lýsing á viðhaldi vörunnar
• Hluti 4 af 4: Skrifaðu læsilega handbók
• Ábendingar

Hugbúnaður, tölvur, leikir og tæki þurfa notendahandbækur; leiðbeiningar sem útskýra hvernig á að nota vöruna (og hvernig ekki). Notendahandbók er formlegt skjal með ákveðinni uppbyggingu og verður að vera skrifað af þeim sem þekkir vöruna að innan, svo sem tæknihöfund eða vöruhönnuðinn. Að skrifa árangursríka notendahandbók krefst þess að þú vitir hver muni nota vöruna og að þú skrifir handbókina með þessa notendur í huga. Hafðu skrif þín skýr, nákvæm og einföld til að tryggja þægilega notendaupplifun.

Að stíga

Hluti 1 af 4: Skipuleggja handbók þína

1. Gerðu notendagreiningu. Notendahandbókin ætti að vera skrifuð fyrir notendurna - þá sem munu kaupa vöru þína eða þjónustu og lesa notendahandbókina. Notendagreining mun segja þér hver aðal eða markhópur þinn verður og mun leiða þig í gegnum texta.
   • Talaðu við fólk sem mun nota tækið þitt. Bjóddu prófnotendum frumgerðir tækisins og drög að notendahandbók við stýrðar aðstæður. Biddu þessa prófanotendur um viðbrögð við hlutum sem eru óljósir eða ruglingslegir í notendahandbókinni og gerðu breytingar á notendahandbókinni á grundvelli þessara endurgjafa.
   • Þú getur aldrei fullnægt öllum áhorfendum þínum; skrifaðu handbókina sniðna að markhópnum eða stærsta áhorfendahópnum.
   • Hugleiddu aldur, heilsu (eru þeir með einhverja sjúkdóma, námsörðugleika eða fötlun?) Og menntunarstig áhorfenda til að ákvarða bestu nálgunina við að skrifa notendahandbókina.
2. Samræma hönnun notendahandbókarinnar. Ef þú varst hluti af teyminu sem hjálpaði til við að hanna og þróa tækið eða vöruna getur verið erfitt að skoða hlutina hlutlaust til að útskýra hvernig hún virkar. Þú ættir því að leita ráða hjá rithöfundi (helst einhverjum sem hefur reynslu af því að skrifa leiðbeiningar) og grafískrar hönnuðar til að hjálpa þér við undirbúning notendahandbókarinnar. Þú gætir valið þetta fólk í gegnum utanaðkomandi ráðgjöf eða frá þínu eigin fyrirtæki eða stofnun.
3. Gerðu verkefnagreiningu. Atvinnugreining er ferlið við að greina og skipuleggja skrefin sem þarf til að nota tækið. Ítarleg vinnugreining skilgreinir efni og búnað (svo sem rafhlöður, lyf eða aðrar vörur sem notendur fá) fyrir hvert skref, sem og aðgerðir, villur og ráð við bilanaleit sem hvert skref gæti þurft.
   • Ef þú ert með vöru sem getur framkvæmt mörg mismunandi verkefni eða undirverk, verður þú að framkvæma verkefnagreiningu fyrir hvert verkefni. Til dæmis: í bíl sem þú getur tútað, festir þig í og ​​kveikt eða slökkt á aðalljósum. Gerðu starfsgreiningu fyrir hvert og eitt þessara, ef nauðsyn krefur.
4. Gakktu úr skugga um að varan þín uppfylli kröfur um merkingar og markaðsleyfi. Þessar kröfur tryggja að vörur séu framleiddar með öryggi notandans í huga og að útsetning notandans við hættulegar aðstæður, svo sem geislun og rafmagn, er takmörkuð. Auglýsingar ættu að koma skýrt fram með tilgang og grundvallar notkunarleiðbeiningar vöru og þú ættir að nota þessar heimildir þegar þú skrifar handbók þína.
   • Til að notendahandbók vöru skili árangri verður hún að vera skrifuð í samræmi við merkimiða sem eru beint á vöruna.
   • Gakktu úr skugga um að tækið þitt sé með leyfi til sölu áður en þú skrifar notendahandbókina.
5. Ákveðið útlit handbókarinnar. Það eru nokkrar mikilvægar leiðir til að hagræða handbókinni. Þú verður að setja feitletrað fyrirsögn í byrjun hvers kafla með hverju orði með stórum stöfum. Til dæmis geta „Setja upp tækið“, „Stjórna tækinu“ og „Úrræðaleit“ geta verið feitletruð fyrirsagnir.
   • Önnur leið til að hagræða leiðarvísinum er að nota tvo dálka, annan til hægri með texta og hinn vinstra megin við textann, með byssukúlum, tölustöfum eða litlum táknum, svo sem viðvörunarmerki eða rauðum upphrópunarmerkjum.
   • Handbókin getur aðallega samanstaðið af myndum með nokkrum texta undir hverri mynd til að útskýra tækið, eða það getur aðallega verið texti með örfáum meðfylgjandi myndum. Þú getur líka notað flæðirit til að leiðbeina notandanum. Hugsaðu um vöruna þína og hvernig hver aðferð getur hjálpað þér við að skrifa handbókina. Hins vegar forðastu að blanda mismunandi skipulagi í einni handbók. Veldu einn og haltu þér við hann.

Hluti 2 af 4: Fella nauðsynlegar upplýsingar

1. Skipuleggðu handbókina rökrétt. Handbókin á að vera þannig uppbyggð að notandinn hafi sem mestan ávinning af henni. Skiptu handbókinni í kafla eða hluta sem eru skynsamlegir fyrir notkun vörunnar og láttu innihaldsyfirlit fylgja framan í handbókinni svo að hver hluti finnist fljótt.
   • Efnisyfirlit er sérstaklega nauðsynlegt fyrir lengri handbækur.
   • Orðalista eða vísitölu er þörf ef það eru mörg hugtök til að útskýra að áhorfendur þínir þekki kannski ekki. Hins vegar er ekki mælt með orðalista; besti kosturinn er að útskýra ruglingsleg hugtök í texta handbókarinnar sjálfs. Ef þú velur að láta fylgja orðalista skaltu setja hann fremst á handbókina, rétt eftir efnisyfirlitinu.
   • Listi yfir töflur eða myndir er aðeins nauðsynlegur ef fleiri en nokkrar töflur eða myndir eru í handbókinni.
   • Viðauka er þörf fyrir hluti sem þarf að útskýra en ekki er hægt að útskýra annars staðar í handbókinni, þar sem það myndi trufla flæði og fókus.
2. Láttu nauðsynlegar viðvaranir fylgja með. Almennar viðvaranir eða varúðarupplýsingar ættu að veita upplýsingar um hugsanlega hættu sem stafar af óviðeigandi notkun vörunnar, þar með talið dauða eða alvarlegum meiðslum. Þessar viðvaranir ættu að vera settar fremst í handbókinni, á eftir forsíðu, svo að notandinn sjái þær fyrst. Sérstakar viðvaranir ættu einnig að vera með í texta handbókarinnar rétt á eftir eða rétt áður en mælt er með hugsanlega hættulegu skrefi.
   • Til dæmis gæti almenn viðvörun fyrir raftæki verið að nota það ekki þegar það rignir.
   • Sérstök leiðbeining gæti verið að ganga úr skugga um að bæði hendurnar og tækið séu þurrt áður en tækinu er stungið í rafmagnsinnstunguna.
   • Gefðu fram myndir (svo sem höfuðkúpu og krossbein) eða texta af öðrum lit (svo sem rauðum texta) til að greina viðvörunina frá hinum leiðbeiningunum í IFU og vekja athygli notenda á henni.
3. Lýstu tækinu. Lýsing þín ætti að innihalda bæði skriflega skýringu á tilgangi tækisins og litla myndræna framsetningu á því hvernig tækið lítur út. Myndin ætti að merkja og nefna alla rofa, hnappa og festanlega hluti sem eru í tækinu.
4. Veittu leiðbeiningar um uppsetningu. Uppsetningarhlutinn ætti að innihalda grunnupplýsingar um hvernig á að undirbúa notkun vörunnar eða tækisins. Ef heimilistækið getur ekki smíðað heimilið eða sett það upp skaltu taka það skýrt fram í feitletruðum fyrirsögn efst í uppsetningarhlutanum. Þú ættir einnig að hafa eftirfarandi með:
   • Hlutalisti
   • Leiðbeiningar um pökkun
   • Viðvaranir um uppsetningu
   • Afleiðingar rangrar uppsetningar
   • Hverja á að hringja í ef erfiðleikar eru við uppsetningu
5. Veita upplýsingar um aðgerðina. Þessi hluti er mikilvægasti hluti notendahandbókarinnar og ætti að veita áþreifanlegar, nákvæmar upplýsingar um notkun tækisins. Byrjaðu á grunnundirbúningi fyrir notkun einingarinnar, svo sem að tengja rafmagnssnúruna eða þvo hendurnar. Haltu áfram með rökrétt, númeruð skref sem lýsa því hvernig tækið er notað, svo og öll viðbrögð (til dæmis „Þú munt heyra smell ...“) sem notandinn getur búist við þegar hann notar tækið á réttan hátt.
   • Í lok þessa kafla ætti að vísa notendum í úrræðaleitarkaflann til að leysa mál sem ekki er hægt að útskýra fljótt.
   • Settu myndir þar sem nauðsyn krefur. Sum skref eru best útskýrð með bæði myndum og orðum. Hugleiddu notkun ljósmynda eða myndskreytinga í handbókinni.
   • Í þessum kafla, eins og í öllum hlutum, ættir þú að setja viðeigandi öryggisviðvaranir við óviðeigandi notkun eða notkun. Þú gætir til dæmis varað notendur við keðjusög við því að drekka áfengi eða nota keðjusaginn meðan þeir eru í ákveðnum lyfjum.
   • Ef þú heldur að notendur muni njóta góðs skaltu íhuga að tengja við myndskeið á netinu sem sýna fram á rétta notkun og notkun tækisins. Þú getur tekið upp þessi myndskeið annaðhvort í byrjun þessa kafla, eða (ef um er að ræða myndskeið sem sýna aðeins eitt skref) í lok hvers skrefs.
6. Láttu fylgja yfirlit yfir vöruna í lokin. Yfirlitið ætti að birtast í lok handbókarinnar, rétt fyrir vísitöluna, til að bjóða upp á grunnskref. Þetta ætti að vera einfölduð, strípuð útgáfa af rekstrarupplýsingunum og ætti ekki að vera fleiri en ein blaðsíða. Taktu saman hvernig nota á tækið eða vöruna. Hafa með grunnviðvaranir, númeruð skref sem útskýra hvernig á að nota vöruna og símanúmer eða netföng sem beina notendum til að hjálpa.
   • Ef þú býst við að notandinn fjarlægi eða vísi oft til yfirlitsblaðsins geturðu prentað það á færanlegt lagskipt kort eða þykkt pappa til að auðvelda notandanum að bera og vísa til.
   • Einnig er hægt að nota samantekt beint á vöruna til að fá notandann fljótt og auðveldan tilvísun.

Hluti 3 af 4: Lýsing á viðhaldi vörunnar

1. Útskýrðu hvernig á að þrífa tækið. Ef tækið þitt eða vara þarfnast hreinsunar skaltu útskýra hvernig á að gera þetta. Skráðu hreinsiefni sem krafist er. Segðu lesandanum hversu oft hann á að þrífa. Láttu síðan eins og í öðrum hlutum handbókarinnar fylgja númeraðar leiðbeiningar skref fyrir skref um hvernig á að þrífa hana.
   • Ef hreinsun krefst þess að vöran sé tekin í sundur, eða tiltekinn hluti eða hlutar fjarlægðir, tilgreindu hvernig taka ætti vöruna í sundur.
   • Veittu viðvörun um árangur af bilun í hreinsun tækisins. Til dæmis gætirðu sagt: „Ef tækið er ekki þrifið, verður árangur minna en ákjósanlegur.“
2. Telja notandann hvernig á að framkvæma grunnviðhald. Ef varan eða tækið er nothæft fyrir notendur til að leiðrétta frammistöðuvandamál skaltu gefa upp númeraðar leiðbeiningar um hvernig á að gera þetta fyrir notandann. Til dæmis, ef skipta þarf um rafhlöður eftir hverja 300 klukkustunda notkun, gefðu leiðbeiningar um það hvernig á að athuga hvort skipta þurfi um rafhlöður, hvernig á að fjarlægja dauðu rafhlöðurnar og hvernig á að setja þær nýju upp.
   • Ef það eru ákveðin viðhaldsverkefni sem aðeins er hægt að framkvæma af löggiltum tæknimanni skaltu skipta viðhaldshluta handbókarinnar í tvo hluta.
3. Rætt um geymsluvalkosti. Ef nauðsyn krefur ætti handbókin að útskýra hvernig á að geyma vöruna eða tækið á réttan hátt. þú ættir einnig að hafa með upplýsingar um hvers vegna geymsla er nauðsynleg og afleiðingar óviðeigandi geymslu. Til dæmis: þú gætir skrifað:
   • Geymdu vöruna á köldum og þurrum stað. Óviðeigandi geymsla getur stytt endingu vöru þinnar vegna rakauppbyggingar. “
   • „Ekki setja vöruna fyrir hita eða geyma hana við hitastig yfir 50 gráður á Celsíus.Ef þú gerir það getur það leitt til brennslu. “
4. Gefðu upplýsingar um bilanaleit. Þú gætir skipulagt þennan hluta sem lista yfir algeng vandamál og lausnir þeirra. Flokkaðu svipuð vandamál undir rökréttan fyrirsögn. Á þennan hátt geta notendur fljótt fundið sérstök vandamál.
   • Til dæmis, ef nokkur vandamál eru við að tölvan birti bláan skjá skaltu flokka þau undir undirfyrirsögn, svo sem „Algeng skjávandamál“.
   • Þú verður einnig að hafa með símanúmer og / eða tölvupóst fyrir þjónustu við viðskiptavini í þessum kafla.

Hluti 4 af 4: Skrifaðu læsilega handbók

1. Lestu aðrar notendahandbækur. Áður en þú skrifar handbók fyrir eigin vöru skaltu skoða aðrar árangursríkar notendahandbækur. Gefðu gaum að uppbyggingu, orðavali og setningagerð. Helstu vörumerki eins og Apple, Google og Microsoft framleiða öflugar og árangursríkar notendahandbækur sem geta hjálpað þér að framleiða ítarlegri skrifaða notendahandbók.
   • Ekki bara lesa allt notendahandbækur. Lestu handbækurnar fyrir svipaðar vörur sem þú selur. Til dæmis, ef þú selur barnavörur, lestu handbækur fyrir börn, ekki tæknilegar.
2. Veldu staðla þína. Að staðla stafsetningu, orðaval og orðalag mun gera notendahandbókina notendavænni. Stílhandbókin í Chicago og stílhandbókin frá Microsoft geta einnig verið gagnlegar stílleiðbeiningar þegar þú skrifar handbók þína. Athugaðu hvort báðir sjái hvort einn sé réttur fyrir handbókina þína.
   • Til dæmis, í stað þess að nota bæði „aflrofa“ og „aflrofa“ í handbókinni, skaltu velja annað af tveimur hugtökum og halda sig við það.
3. Notaðu virka röddina. Virka röddin er leið til að skrifa sem skýrir hlutina frá sjónarhóli notandans. Það er auðveldara að skilja en valið, passíva röddin, þar sem viðfangsefnið er óskilgreint.
   • Prófaðu Hemingway forritið (www.hemmingwayapp.com) til að bera kennsl á aðgerðalausa kafla í skrifum þínum.
   • Rannsakaðu þessar tvær dæmi um setningar - sú fyrri er virk og sú síðari er aðgerðalaus:
     • Þú verður að opna pakkann hægt og vandlega.
     • Opna skal pakkninguna hægt og vandlega.
4. Skrifaðu tölusettar leiðbeiningar. Tölulega pantaðar leiðbeiningar hjálpa lesandanum að einbeita sér betur að því að nota, tengja eða smíða viðkomandi vöru. Í stað þess að skrifa langa, munnlega málsgrein eða röð ótalaðra málsgreina, skrifaðu notendahandbókina þína með einföldum, skýrum skrefum, hver greinilega númeruð.
5. Byrjaðu hvert skref með nauðsyn. Skylda er aðgerðarmiðuð sögn. Með því að byrja hvert skref með sögn, gefur þú lesandanum vísbendingu um þá aðgerð sem þarf til að klára skrefið. Til dæmis, eftir því hvaða vöru þú ert að skrifa um, getur þú byrjað skrefin með skipun eins og „Connect“, „Confirm“ eða „Slide“. Hins vegar skaltu ekki byrja skref þín með svari frá kerfinu.
   • Til dæmis, ef skjárinn verður blár og byrjar að blikka, ekki byrja skrefið með: „Skjárinn blikkar og verður blár.“ Reyndu: „Haltu inni heimatakkanum. Skjárinn blikkar og verður blár. “
6. Ákveðið hvaða orðaforða þú notar. Ef þú ert að skrifa jójó handbók verða áhorfendur aðallega ung börn. Notaðu einföld orð og orðaforða til að útskýra hvernig jójóið virkar. Þegar þú ert að skrifa skanna rafeindasmásjá handbók samanstanda áhorfendur af mjög hæfum vísindamönnum sem geta skilið mjög nákvæmar upplýsingar, svo ekki láta þig hverfa frá því að nota sérhæfðan orðaforða eða blæbrigðaríkar skýringar.
   • Almennt reynir þú að forðast hrognamál og tæknimál.
   • Til að skila árangri fyrir sem breiðasta notendahóp skaltu reyna að skrifa á stigi frá sjötta til sjöunda bekk grunnskóla.
7. Þegar þú sendir vöru til útlanda, vertu viss um að þýðingar þínar séu réttar. Ráðið þýðanda til að þýða notendahandbókina yfir á móðurmál landsins sem þú ert að senda vöruna til. Þú getur líka notað þýðingarforrit á netinu, en beðið móðurmáli um að lesa þýðinguna og athuga hvort villur finnist.
   • Ef margir tungumálahópar eru fulltrúar hjá áhorfendum þínum, vinsamlegast láttu þýða notendahandbókina með á hverju tungumáli sem við á.
   • Þýðandinn verður að þekkja vöruna þar sem það geta verið mismunandi orð á markmálinu fyrir tiltekin hugtök sem eru ekki orð-fyrir-orð-þýðingar.
8. Skrifaðu í stuttum setningum. Í staðinn fyrir nokkrar langar málsgreinar notarðu mikið af stuttum málsgreinum. Leitaðu að rökréttum hléum í hverjum kafla og meltu gagnlegar upplýsingar í klumpum með eins eða tveggja setninga. Sama er að segja á setningarstiginu. Hafðu setningar þínar stuttar og einfaldar, frekar en langar og orðréttar.
   • Ef skref er að verða of langt skaltu brjóta það niður í minni skref. Þetta mun ekki draga úr orðatölu en línuskil gera það auðveldara að lesa.
9. Athugaðu hvort handbókin sé villa. Handbók getur misst trúverðugleika vegna málfræði og stafsetningarvillna. Láttu samstarfsmann eða tæknihöfund einnig breyta og prófasts lesa handbókina. Auk stafsetningar og málfræði ætti prófarkalesari að fylgjast með eftirfarandi:
   • Hlutlaus rödd
   • Óskýrt eða ruglingslegt tungumál
   • Vafin setningagerð
   • Of langir málsgreinar

Ábendingar

• Fólk lærir á mismunandi vegu; Ef mögulegt er og við á skaltu hafa sjónræn hjálpartæki eða tengla á myndskeið á netinu í handbókinni til að koma til móts við sjónræna lesendur.