Nilalaman

• Upang humakbang
• Bahagi 1 ng 4: Pagpaplano ng manwal ng iyong may-ari
• Bahagi 2 ng 4: I-embed ang mahalagang impormasyon
• Bahagi 3 ng 4: Paglalarawan ng pagpapanatili ng produkto
• Bahagi 4 ng 4: Sumulat ng isang nababasa na manwal
• Mga Tip

Ang software, computer, laro at aparato ay nangangailangan ng mga manwal ng gumagamit; mga gabay na nagpapaliwanag kung paano gamitin ang produkto (at kung paano hindi). Ang isang manwal ng gumagamit ay isang pormal na dokumento na may isang tukoy na istraktura at dapat isulat ng isang taong nakakaalam ng produkto sa loob, tulad ng isang teknikal na manunulat o taga-disenyo ng produkto. Ang pagsulat ng isang mabisang manwal ng gumagamit ay nangangailangan na malaman mo kung sino ang gagamit ng produkto at isulat mo ang manu-manong naisip ang mga gumagamit na ito. Panatilihing malinaw, tumpak at simple ang iyong pagsulat upang matiyak ang isang walang problema na karanasan ng gumagamit.

Upang humakbang

Bahagi 1 ng 4: Pagpaplano ng manwal ng iyong may-ari

1. Gumawa ng isang pagtatasa ng gumagamit. Ang manwal ng gumagamit ay dapat na nakasulat para sa mga gumagamit - mga bibilhin ang iyong produkto o serbisyo at basahin ang manwal ng gumagamit. Sasabihin sa iyo ng isang pagtatasa ng gumagamit kung sino ang iyong pangunahing o target na madla at gagabayan ka sa pagsulat ng teksto.
   • Makipag-usap sa mga taong gagamit ng iyong aparato. Mag-alok ng mga gumagamit ng pagsubok ng mga prototype ng aparato at mag-draft ng manwal ng gumagamit sa ilalim ng kinokontrol na mga kundisyon. Tanungin ang mga gumagamit ng pagsubok na ito para sa puna sa mga bagay na hindi malinaw o nakalilito sa gabay ng gumagamit at gumawa ng mga pagbabago sa iyong gabay sa gumagamit batay sa feedback na ito.
   • Hindi mo masiyahan ang iyong buong madla; isulat ang manu-manong pinasadya sa target na madla o ang pinakamalaking madla.
   • Isaalang-alang ang edad, kalusugan (mayroon ba silang anumang mga karamdaman, mga kapansanan sa pag-aaral o mga kapansanan?) At ang antas ng edukasyon ng madla upang matukoy ang pinakamahusay na diskarte sa pagsulat ng manwal ng gumagamit.
2. Coordinate ang disenyo ng manwal ng gumagamit. Kung ikaw ay bahagi ng koponan na tumulong sa disenyo at pagbuo ng aparato o produkto, maaaring maging mahirap na tingnan ang produkto upang ipaliwanag kung paano ito gumagana. Samakatuwid dapat kang humingi ng payo ng isang manunulat (mas mabuti ang isang taong may karanasan sa mga tagubilin sa pagsusulat) at isang graphic designer upang matulungan kang ihanda ang manwal ng gumagamit. Maaari mong piliin ang mga taong ito sa pamamagitan ng isang panlabas na pagkonsulta o mula sa iyong sariling kumpanya o samahan.
3. Gumawa ng pagtatasa ng gawain. Ang pagtatasa ng trabaho ay ang proseso ng pagkilala at pag-aayos ng mga hakbang na kinakailangan upang magamit ang aparato. Kinikilala ng isang masusing pagsusuri sa trabaho ang mga materyales at kagamitan (tulad ng mga baterya, gamot, o iba pang mga produkto na ibinibigay ng gumagamit) na kinakailangan para sa bawat hakbang, pati na rin ang mga aksyon, pagkakamali, at payo sa pag-troubleshoot na maaaring kailanganin ng bawat hakbang.
   • Kung mayroon kang isang produkto na maaaring gumanap ng maraming iba't ibang mga gawain o subtask, dapat kang magsagawa ng isang pagtatasa ng gawain para sa bawat gawain. Halimbawa: sa isang kotse maaari kang magbusina, i-strap ang iyong sarili at i-on o i-off ang iyong mga headlight. Gumawa ng pagtatasa sa trabaho para sa bawat isa sa mga ito, kung kinakailangan.
4. Tiyaking natutugunan ng iyong produkto ang mga kinakailangan para sa pag-label at pahintulot sa marketing. Tinitiyak ng mga kinakailangang ito na ang mga produkto ay gawa ng kaligtasan ng gumagamit at ang pagkakalantad ng gumagamit sa mga mapanganib na kundisyon, tulad ng radiation at electrocution, ay limitado. Dapat malinaw na sabihin ng mga ad ang layunin at pangunahing mga alituntunin sa pagpapatakbo ng isang produkto, at dapat mong gamitin ang mga mapagkukunang ito kapag sumusulat sa manwal ng iyong may-ari.
   • Upang maging epektibo ang manwal ng gumagamit ng isang produkto, dapat itong isulat alinsunod sa mga label na nakakabit nang direkta sa produkto.
   • Siguraduhin na ang iyong aparato ay opisyal na may lisensya para sa pagbebenta bago isulat ang manwal ng gumagamit.
5. Magpasya sa layout ng iyong manwal. Mayroong maraming mahahalagang paraan upang mai-streamline ang iyong manwal. Dapat kang maglagay ng isang naka-bold na heading sa simula ng bawat seksyon sa bawat salita sa mga malalaking titik. Halimbawa, "I-set up ang iyong aparato," "Patakbuhin ang iyong aparato," at "I-troubleshoot" ay maaaring lahat ay naka-bold na mga heading ng seksyon.
   • Ang isa pang paraan upang i-streamline ang iyong gabay ay ang paggamit ng dalawang mga haligi, ang isa sa kanan gamit ang teksto at ang iba pa ay sa kaliwa lamang ng teksto, na may mga bala, numero, o maliliit na icon, tulad ng mga marka ng babala o mga pulang tandang tandang
   • Ang manwal ay maaaring binubuo pangunahin ng mga imahe na may ilang teksto sa ilalim ng bawat imahe upang ipaliwanag ang aparato, o maaari itong pangunahin na teksto na may lamang ng ilang mga kasamang imahe. Maaari mo ring gamitin ang isang flowchart upang gabayan ang gumagamit. Isipin ang tungkol sa iyong produkto at kung paano ka matutulungan ng bawat pamamaraan na isulat ang iyong manwal. Gayunpaman, iwasan ang paghahalo ng iba't ibang mga layout sa loob ng isang manwal. Pumili ng isa at manatili dito.

Bahagi 2 ng 4: I-embed ang mahalagang impormasyon

1. Isaayos ang manwal nang lohikal. Ang manwal ay dapat na nakabalangkas sa paraang makukuha ng gumagamit ang pinaka-pakinabang mula rito. Hatiin ang manwal sa mga kabanata o seksyon na may katuturan para sa paggamit ng produkto at isama ang isang talaan ng nilalaman sa harap ng manu-manong upang ang bawat seksyon ay matagpuan nang mabilis.
   • Ang isang talaan ng mga nilalaman ay lalong kinakailangan para sa mas mahabang mga manwal.
   • Kinakailangan ang isang glossary o index kung maraming mga termino upang ipaliwanag na maaaring hindi pamilyar sa iyong tagapakinig. Gayunpaman, hindi inirerekumenda ang isang glossary; ang pinakamahusay na pagpipilian ay upang ipaliwanag ang nakalilito na mga termino sa teksto ng manwal mismo. Kung pipiliin mong isama ang isang glossary, ilagay ito sa harap ng manwal, pagkatapos lamang ng talaan ng mga nilalaman.
   • Ang isang listahan ng mga talahanayan o numero ay kinakailangan lamang kung mayroong higit sa ilang mga talahanayan o numero sa manwal.
   • Kailangan ng isang apendiks para sa mga bagay na kailangang ipaliwanag ngunit hindi maipaliwanag sa ibang lugar sa manwal, dahil makagambala sa daloy at pagtuon.
2. Isama ang mga kinakailangang babala. Ang pangkalahatang mga babala o pag-iingat na impormasyon ay dapat magbigay ng impormasyon tungkol sa mga potensyal na peligro na sanhi ng hindi tamang paggamit ng produkto, kabilang ang pagkamatay o malubhang pinsala. Ang mga babalang ito ay dapat na ilagay sa harap ng manwal, pagkatapos ng front page, upang makita muna ng gumagamit ang mga ito. Ang mga tiyak na babala ay dapat ding isama sa teksto ng manwal pagkatapos lamang o bago iminungkahi ang isang potensyal na mapanganib na hakbang.
   • Halimbawa, ang isang pangkalahatang babala para sa isang de-koryenteng kasangkapan ay maaaring hindi gamitin ito kapag umuulan.
   • Ang isang tukoy na tagubilin ay maaaring tiyakin na ang iyong parehong mga kamay at ang aparato ay tuyo bago isaksak ang aparato sa outlet ng kuryente.
   • Magbigay ng mga imahe (tulad ng isang bungo at mga crossbone) o teksto ng ibang kulay (tulad ng pulang teksto) upang makilala ang babala mula sa natitirang mga direksyon sa IFU at iguhit ang pansin ng mga gumagamit dito.
3. Ilarawan ang aparato. Dapat isama sa iyong paglalarawan ang parehong nakasulat na paliwanag sa layunin ng aparato at isang maliit na graphic na representasyon ng kung ano ang hitsura ng aparato. Dapat lagyan ng label ang pangalan at pangalanan ang lahat ng mga switch, pindutan, at mga nakalakip na bahagi na nilalaman ng aparato.
4. Magbigay ng mga tagubilin sa pag-install. Ang seksyon ng pag-install ay dapat maglaman ng pangunahing impormasyon sa kung paano maghanda na gamitin ang produkto o aparato. Kung ang appliance ay hindi maitatayo o mai-set up ng isang gumagamit sa bahay, malinaw na sabihin ito sa isang naka-bold na heading sa tuktok ng seksyon ng pag-install. Dapat mo ring isama ang sumusunod:
   • Isang listahan ng mga bahagi
   • Mga Tagubilin sa Pag-unpack
   • Mga babala sa pag-install
   • Mga kahihinatnan ng maling pag-install
   • Sino ang tatawag sa kaso ng mga paghihirap sa panahon ng pag-install
5. Magbigay ng impormasyon tungkol sa operasyon. Ang seksyon na ito ay ang pinakamahalagang bahagi ng manwal ng gumagamit at dapat magbigay ng kongkreto, detalyadong impormasyon sa kung paano gamitin ang aparato. Magsimula sa pangunahing paghahanda sa paggamit ng yunit, tulad ng pag-plug sa kurdon ng kuryente o paghuhugas ng iyong mga kamay. Magpatuloy sa lohikal, may bilang na mga hakbang na naglalarawan kung paano gamitin ang aparato, pati na rin ang anumang feedback (halimbawa, "Makakarinig ka ng isang pag-click ...") na maaasahan ng gumagamit kapag ginamit nang maayos ang aparato.
   • Sa pagtatapos ng kabanatang ito, ang mga gumagamit ay dapat na mag-refer sa kabanata ng pag-troubleshoot upang malutas ang mga isyu na hindi maipaliwanag nang mabilis.
   • Ilagay ang mga imahe kung saan kinakailangan. Ang ilang mga hakbang ay pinakamahusay na ipinaliwanag sa parehong mga larawan at salita. Isaalang-alang ang paggamit ng mga larawan o guhit sa iyong manwal.
   • Sa seksyong ito, tulad ng sa anumang seksyon, dapat mong isama ang mga nauugnay na babala sa kaligtasan tungkol sa hindi tamang paggamit o pagpapatakbo. Halimbawa, maaari mong babalaan ang mga gumagamit ng chainaw na huwag uminom ng alak o gumamit ng chainsaw habang nasa ilang mga gamot.
   • Kung sa palagay mo ay makikinabang ang mga gumagamit, isaalang-alang ang pagsasama ng mga link sa mga online na video na nagpapakita ng wastong paggamit at pagpapatakbo ng aparato. Maaari mong i-record ang mga video na ito alinman sa simula ng seksyong ito, o (sa kaso ng mga video na naglalarawan ng isang hakbang lamang) sa pagtatapos ng bawat hakbang.
6. Magsama ng isang buod ng produkto sa dulo. Ang buod ay dapat lumitaw sa pagtatapos ng manwal, bago ang index, upang magbigay ng pangunahing mga hakbang sa pagpapatakbo. Ito ay dapat na isang pinasimple, naalis na bersyon ng impormasyon sa pagpapatakbo, at dapat ay hindi hihigit sa isang pahina. Ibuod kung paano gagamitin ang aparato o produkto. Magsama ng mga pangunahing alerto, may bilang na hakbang na nagpapaliwanag kung paano gamitin ang produkto, at mga numero ng telepono o mga email address na nagdidirekta sa mga gumagamit na tumulong.
   • Kung inaasahan mong ang gumagamit ay mag-alis o mag-refer sa sheet ng buod nang madalas, maaari mo itong mai-print sa isang naaalis na nakalamina na card o makapal na karton upang gawing mas madali para sa gumagamit na magdala at mag-refer.
   • Bilang kahalili, maaari kang maglapat ng isang buod nang direkta sa produkto para sa mabilis at madaling sanggunian ng gumagamit.

Bahagi 3 ng 4: Paglalarawan ng pagpapanatili ng produkto

1. Ipaliwanag kung paano linisin ang aparato. Kung ang iyong aparato o produkto ay nangangailangan ng paglilinis, ipaliwanag kung paano ito gawin. Ilista ang mga kinakailangang ahente ng paglilinis. Sabihin sa mambabasa kung gaano kadalas maglinis. Pagkatapos, tulad ng sa anumang ibang bahagi ng manwal, isama ang mga may bilang na mga sunud-sunod na tagubilin sa kung paano ito linisin.
   • Kung kinakailangan ng paglilinis na disassembled ang produkto, o isang partikular na bahagi o bahagi na aalisin, ipahiwatig kung paano dapat disassembled ang produkto.
   • Magbigay ng isang babala tungkol sa mga resulta ng pagkabigo na linisin ang aparato. Halimbawa, maaari mong sabihin na, "Kung ang aparato ay hindi nalinis, ang pagganap ay mas mababa kaysa sa pinakamainam."
2. Bilangin ang gumagamit kung paano magsagawa ng pangunahing pagpapanatili. Kung ang produkto o aparato ay mapagkakalooban ng gumagamit upang iwasto ang mga problema sa pagganap, magbigay ng mga may bilang na tagubilin sa kung paano ito gawin para sa gumagamit. Halimbawa, kung ang mga baterya ay kailangang mapalitan pagkatapos ng bawat 300 oras na paggamit, magbigay ng mga tagubilin sa kung paano suriin kung kailangang mapalitan ang mga baterya, kung paano alisin ang mga patay na baterya, at kung paano i-install ang mga bago.
   • Kung may ilang mga gawain sa pagpapanatili na magagawa lamang ng isang sertipikadong tekniko, hatiin ang bahagi ng pagpapanatili ng manwal sa dalawang bahagi.
3. Talakayin ang mga pagpipilian sa pag-iimbak. Kung kinakailangan, dapat ipaliwanag ng manwal kung paano maayos na maiimbak ang produkto o aparato. dapat mo ring isama ang impormasyon tungkol sa kung bakit kinakailangan ang pag-iimbak at ang mga kahihinatnan ng hindi tamang pag-iimbak. Halimbawa: maaari kang sumulat:
   • Itabi ang produkto sa isang cool, tuyong lugar. Ang hindi wastong pag-iimbak ay maaaring magpapaikli sa buhay ng iyong produkto dahil sa pagbuo ng kahalumigmigan. "
   • "Huwag ilantad ang produkto sa pag-init o iimbak ito sa temperatura na higit sa 50 degree Celsius.Kung gagawin mo ito, maaari itong humantong sa pagkasunog. "
4. Magbigay ng impormasyon sa pag-troubleshoot. Maaari mong ayusin ang seksyong ito bilang isang listahan ng mga karaniwang problema at kanilang mga solusyon. Pangkatin ang mga katulad na problema sa ilalim ng isang lohikal na heading. Sa ganitong paraan, ang mga gumagamit ay maaaring mabilis na makahanap ng mga tiyak na problema.
   • Halimbawa, kung maraming mga problema sa pagpapakita ng computer ng isang asul na screen, pangkatin sila sa ilalim ng isang subheading, tulad ng "Mga karaniwang problema sa screen".
   • Dapat mo ring isama ang isang numero ng telepono at / o email para sa serbisyo sa customer sa seksyong ito.

Bahagi 4 ng 4: Sumulat ng isang nababasa na manwal

1. Basahin ang iba pang mga gabay ng gumagamit. Bago sumulat ng isang manu-manong para sa iyong sariling produkto, suriin ang iba pang mga mabisang gabay sa gumagamit. Bigyang pansin ang istraktura, pagpili ng salita at istraktura ng pangungusap. Ang mga pangunahing tatak tulad ng Apple, Google at Microsoft ay gumagawa ng malakas, mabisang gabay ng gumagamit na makakatulong sa iyo na makabuo ng isang mas maingat na nakasulat na gabay sa gumagamit.
   • Wag lang magbasa lahat mga manwal ng gumagamit. Basahin ang mga manwal para sa mga katulad na produktong ibinebenta mo. Halimbawa, kung nagbebenta ka ng mga produktong sanggol, basahin ang mga manwal ng sanggol, hindi ang mga teknikal.
2. Piliin ang iyong mga pamantayan. Ang pamantayan sa pagbaybay, pagpili ng salita at pagbigkas ng salita ay gagawing mas user-friendly ang manual ng gumagamit. Ang Manwal ng Estilo ng Chicago at Manwal ng Estilo ng Microsoft ay maaari ding maging kapaki-pakinabang na mga gabay sa estilo kapag nagsusulat ng manwal ng iyong may-ari; suriin ang pareho upang makita kung ang isa tama para sa iyong manwal.
   • Halimbawa, sa halip na gamitin ang parehong "power switch" at "power button" sa iyong manu-manong, pumili ng isa sa dalawang mga termino at dumikit ito.
3. Gamitin ang aktibong boses. Ang aktibong boses ay isang paraan ng pagsulat na nagpapaliwanag ng mga bagay ayon sa pananaw ng gumagamit. Ito ay mas madaling maunawaan kaysa sa kahalili, ang passive na boses, kung saan ang paksa ay hindi natukoy.
   • Subukan ang Hemingway App (www.hemmingwayapp.com) upang makilala ang mga passive na daanan sa iyong pagsulat.
   • Pag-aralan ang dalawang halimbawang pangungusap na ito - ang una ay aktibo at ang pangalawa ay pasibo:
     • Kailangan mong buksan ang package nang mabagal at maingat.
     • Ang pakete ay dapat buksan nang mabagal at maingat.
4. Sumulat ng may bilang na mga tagubilin. Ang mga tagubilin na naayos ng bilang ayon sa bilang ay makakatulong sa mambabasa na higit na ituon ang pansin sa proseso ng paggamit, pagkonekta o pagbuo ng pinag-uusapang produkto. Sa halip na magsulat ng isang mahaba, pandiwang talata, o isang serye ng hindi nabilang na mga talata, isulat ang iyong gabay sa gumagamit na may simple, malinaw na mga hakbang, na malinaw na may bilang ang bawat isa.
5. Simulan ang bawat hakbang sa isang pautos. Ang isang pautos ay isang pandiwa na nakatuon sa pagkilos. Sa pamamagitan ng pagsisimula ng bawat hakbang sa isang pandiwa, bibigyan mo ang mambabasa ng isang pahiwatig tungkol sa kinakailangang aksyon upang makumpleto ang hakbang. Halimbawa, nakasalalay sa produktong sinusulat mo, maaari mong simulan ang iyong mga hakbang sa isang utos tulad ng "Connect", "Confirm" o "Slide". Gayunpaman, huwag simulan ang iyong mga hakbang sa isang tugon mula sa system.
   • Halimbawa, kung ang screen ay nagiging asul at nagsimulang kumurap, huwag simulan ang hakbang sa: "Ang screen ay magpikit at magiging asul." Subukan: "Pindutin nang matagal ang home key. Ang screen ay magpikit at magiging asul. "
6. Tukuyin kung aling bokabularyo ang iyong gagamitin. Kung nagsusulat ka ng isang manwal na yo-yo, ang iyong madla ay halos maliliit na bata. Gumamit ng mga simpleng salita at bokabularyo upang ipaliwanag kung paano gumagana ang yo-yo. Kapag nagsusulat ka ng manu-manong pag-scan ng electron microscope, ang iyong tagapakinig ay binubuo ng mga dalubhasang dalubhasang siyentipiko na nakakaunawa ng napakadetalyadong impormasyon, kaya huwag kang mahiya mula sa paggamit ng dalubhasang bokabularyo o mga nuanced na paliwanag.
   • Sa pangkalahatan, sinubukan mong iwasan ang jargon at teknikal na wika.
   • Upang maging epektibo para sa pinakamalawak na posibleng basehan ng gumagamit, subukang magsulat sa isang antas mula ikaanim hanggang pitong baitang ng pangunahing paaralan.
7. Kapag nagpapadala ng isang produkto sa ibang bansa, tiyaking tumpak ang iyong mga pagsasalin. Kumuha ng isang tagasalin upang isalin ang iyong manu-manong gumagamit sa katutubong wika ng bansa kung saan mo ipinapadala ang iyong produkto. Maaari mo ring gamitin ang isang online na programa sa pagsasalin, ngunit hilingin sa isang katutubong nagsasalita na basahin ang pagsasalin at suriin ang mga error.
   • Kung maraming pangkat ng wika ang kinakatawan sa iyong madla, mangyaring isama ang mga pagsasalin ng manwal ng gumagamit sa bawat nauugnay na wika.
   • Ang tagasalin ay dapat maging pamilyar sa produkto dahil maaaring may iba't ibang mga salita sa target na wika para sa mga tiyak na term na hindi salin-salitang-salin.
8. Isulat sa maikling pangungusap. Sa halip na ilang mahabang talata, gumamit ka ng maraming maikling talata. Maghanap ng mga lohikal na pahinga sa bawat seksyon at digest ang kapaki-pakinabang na impormasyon sa isa o dalawang-pangungusap na mga tipak. Ang pareho ay totoo sa antas ng pangungusap. Panatilihing maikli at simple ang iyong mga pangungusap, sa halip na mahaba at verbose.
   • Kung ang isang hakbang ay masyadong mahaba, paghiwalayin ito sa mas maliit na mga hakbang. Hindi nito babawasan ang bilang ng salita, ngunit ang mga line break ay magpapadali sa pagbabasa.
9. Suriin ang manu-manong para sa mga error. Ang isang manwal ay maaaring mawala ang kredibilidad dahil sa mga error sa grammar at spelling. Mag-edit ng isang kasamahan o teknikal na manunulat at i-proofread din ang manu-manong. Bilang karagdagan sa spelling at grammar, ang isang proofreader ay dapat magbayad ng pansin sa mga sumusunod:
   • Boses na pasibo
   • Hindi malinaw o nakalilito na wika
   • Balot ng istraktura ng pangungusap
   • Masyadong mahaba ang mga talata

Mga Tip

• Natututo ang mga tao sa iba't ibang paraan; Kung posible at naaangkop, isama ang mga visual aid o mga link sa mga online na video sa manwal upang mapaunlakan ang mga mambabasa na nakatuon sa paningin.