Kakailanganin mong

• - 100% na kaalaman sa device o software na produkto kung saan isinusulat ang manual;
• - kaalaman sa larangan ng lingguwistika;
• - kasanayan sa pagsulat.

Mga tagubilin

Pamamahala gumagamit o, sa madaling salita, ang manwal ng pagtuturo ay isang dokumentong nilayon upang magbigay ng tulong sa paggamit ng ilang sistema nito gumagamit m. Upang ipunin ang manwal gumagamit kailangan mong malaman ang sistemang inilarawan sa isang daang porsyento, ngunit tingnan ito sa pamamagitan ng mga mata ng isang taong walang alam. Ipagpalagay natin ang pamumuno gumagamit para sa isang partikular na software utility na wala pang mga analogue. Isipin na nakatagpo mo ang program na ito sa unang pagkakataon. Saan ka dapat magsimula? Ano ang kailangan mong malaman muna? Ayusin ang kaalamang ito sa mga kategorya ng kahalagahan.

Sa pamamagitan ng paghahati sa lahat ng impormasyong nauugnay sa iyong paglikha sa mga pangkat, nakagawa ka ng plano para sa pagsulat ng isang manwal gumagamit. Simulan ang paglalarawan ng gawain sa iyong programa mula sa mga pangunahing kaalaman, na iiwan ang pinakakumplikadong mga detalye tungkol sa, halimbawa, muling pagprograma ng mga tampok o pagtatrabaho sa mga kritikal na error. Sa puntong ito dapat mong ihanda ang mga nilalaman ng gabay. gumagamit– isa sa mga mandatoryong bahagi ng dokumentong ito.

Kung ang manwal na iyong nililikha ay nilayon na gamitin sa malaking kumpanya, pagkatapos ay dapat mong bigyang pansin ang mga pamantayan ng korporasyon na pinagtibay doon. Halimbawa, maraming mga kumpanyang Ruso ang hindi tumatanggap ng mga manwal ng gumagamit nang walang ilustrasyon na suporta, sa madaling salita, mga larawan na nagpapaliwanag kung ano ang nakasulat. Sa manwal gumagamit Bilang karagdagan sa nilalaman, dapat mayroong iba pang mga ipinag-uutos na bahagi: - Abstract, iyon ay, paliwanag karaniwang gawain manual at ang produktong inilarawan; - panimula, na nagpapaliwanag ng impormasyong nauugnay sa manwal gumagamit mga dokumento at paraan ng paggamit ng manwal; - mga seksyon na nagpapaliwanag ng paggamit ng produkto sa iba't ibang yugto paggamit nito, halimbawa, mga unang hakbang, pagkukumpuni o pag-iwas; - seksyon ng mga madalas itanong at sagot sa mga ito; - glossary o.

Karaniwan sa pamamagitan ng paglikha ng isang manwal gumagamit ang teknikal na manunulat ay isang taong may lahat ng kinakailangang kaalaman sa parehong wika at produktong inilalarawan. Kapag nakikibahagi sa mga aktibidad ng isang teknikal na manunulat nang walang tamang pagsasanay, kailangan mong tandaan ang ilang mga patakaran. Una, hindi dapat gumamit ng labis na mga espesyal na termino na hindi naiintindihan ng karaniwang tao. gumagamit. Pangalawa, ang bawat terminong ginamit ay dapat ilarawan at ipaliwanag nang detalyado. Pangatlo, kailangan mong sumulat nang malinaw at maigsi hangga't maaari. Sa wakas, ang isang teknikal na manunulat ay dapat na tingnan ang kanyang sariling pagsulat sa pamamagitan ng mga mata ng isang ordinaryong tao. gumagamit upang makita ang mga pagkukulang ng iyong sariling teksto.

Ang isang espesyal na lugar sa mga tagubilin ay inookupahan ng mga manual na inilaan para sa mga empleyado ng kumpanya - inilalarawan nila kung paano dapat kumilos nang tama ang isang empleyado sa lugar ng trabaho, kung anong mga tungkulin ang dapat gawin, kung anong oras ang darating sa trabaho at kung anong oras ang aalis. Paano magsulat ng mga tagubilin upang sila ay maunawaan at sa parehong oras, mapadali ang katuparan ng isang tao sa mga patakaran na tinukoy dito?

Pangkalahatang tuntunin

Ang mga tagubilin ay dapat na iguguhit nang lohikal nang tama, iyon ay, sumusunod ito sa pagkakasunud-sunod ng mga aksyon na dapat gawin ng isang tao upang makamit isang tiyak na resulta. Kasabay nito, ang dokumentong ito ay hindi dapat masyadong mahaba, dahil magiging mahirap para sa isang tao na basahin at maunawaan ito mula simula hanggang wakas. kahit na, unang beses. Ang lahat ng mga parirala at salita ay dapat na simple, maliban sa mga teknolohikal na tagubilin, kung saan imposibleng gawin nang walang paggamit ng mga espesyal na teknikal, medikal o iba pang makitid na profile na mga termino.

Kapag gumuhit ng mga tagubilin, hindi natin dapat kalimutan na ang bawat bagong talata sa dokumentong ito ay isang tawag sa pagkilos, at ang paggamit ng mga pandiwa sa imperative mood ay ipinag-uutos. Ang mga tagubilin ay hindi dapat maglaman ng "pandekorasyon" na mga salita o tanong. Dapat ay walang mga paglihis dito. Kung maaari, ang mga simple at naiintindihan na mga aksyon ay dapat ipahiwatig, at ang bawat kasunod na hakbang ng pagtuturo ay dapat na nakasalalay sa resulta na nakuha bilang isang resulta ng nakaraang hakbang. Ang mga tagubilin ay madalas na gumagamit ng lahat ng mga uri ng mga diagram, salamat sa kung saan ang isang tao ay maaaring malaman ito nang mas mabilis kaysa sa pamamagitan ng pagbabasa ng isang tekstuwal na presentasyon. Siyempre, bago ka magsulat Deskripsyon ng trabaho, hindi mo kailangang mag-isip tungkol sa paglikha ng ilang uri ng diagram, dahil ang dokumentong ito ay palaging ipinakita sa isang purong tekstong bersyon.

Deskripsyon ng trabaho

Kapag nagsusulat ng isang paglalarawan ng trabaho para sa bawat opisyal, ang pamamahala ng kumpanya ay dapat magpasya kung kailangan niya ng naturang dokumento sa negosyo o hindi. Sa katotohanan ay Kodigo sa Paggawa ay hindi nag-oobliga sa mga tagapamahala na gumawa ng gayong mga tagubilin, kahit na ang Ministri ng Paggawa ay madalas na nagpipilit sa pagguhit ng mga paglalarawan ng trabaho. Ang mga patakaran para sa pagguhit ng isang paglalarawan ng trabaho ay kapareho ng pangkalahatang tuntunin pagguhit ng mga naturang dokumento, ngunit mayroong ilang mga kakaiba dito.

Bago ka magsulat ng tama ng mga tagubilin para sa isang opisyal, kailangan mong malinaw na maunawaan ang hanay ng mga responsibilidad, karapatan at gawain ng empleyadong ito. Dahil ang paglalarawan ng trabaho ay dapat isaalang-alang ang parehong mga karapatan at obligasyon ng empleyado at ang mga karapatan ng employer, kadalasang ginagamit nito ang mga sumusunod na punto:

• Pangkalahatang mga probisyon (tukuyin functional na layunin dokumento, atbp.).
• Mga responsibilidad sa trabaho (paglalarawan ng mga tiyak na tungkulin ng empleyado na dapat niyang gampanan nang may tiyak na regularidad).
• Mga karapatan ng empleyado (isang listahan ng mga karapatan na ibinibigay sa isang empleyado para sa matagumpay na pagganap ng kanyang mga tungkulin sa trabaho).
• Mga koneksyon sa trabaho (ipinahiwatig ang mga posisyon kung saan nakikipag-ugnayan ang empleyado sa proseso ng pagsasagawa ng kanyang mga tungkulin sa trabaho).
• Responsibilidad ng empleyado para sa hindi pagkumpleto ng kanyang trabaho sa oras.
• Pagsusuri ng pagganap ng empleyado.

Panghuling probisyon (ang pamamaraan para sa paggawa ng mga pagbabago sa dokumento, ang petsa kung saan ang paglalarawan ng trabaho ay nagsimula).

Mga teknolohikal na tagubilin

Ang mga teknolohikal na tagubilin ay nakasulat na isinasaalang-alang ang teknolohikal na pagkakasunud-sunod ng mga operasyon o aksyon. Lahat ng teksto ay nakasulat sa simpleng wika, ngunit nagpapahiwatig ng mga parameter ng bagay kung saan kailangang isagawa ang mga aksyon. Bago ka magsulat ng mga teknolohikal na tagubilin, kailangan mong malaman kung anong kagamitan ang ginamit sa paggawa ng isang partikular na item. Ang mga tagubilin ay naglalaman ng impormasyon tungkol sa kondisyon ng temperatura, presyon at kapangyarihan, pati na rin ang iba pang mga parameter na kinakailangan para sa tamang execution mga operasyon.

Bilang isang patakaran, upang paikliin ang teksto, ang mga code ng titik ay ginagamit sa mga teknolohikal na tagubilin upang magtalaga ng mga tool at device. Ang teksto ng mga teknolohikal na tagubilin ay dapat na hatiin hindi lamang sa mga talata, ngunit sa mga maikling talata hangga't maaari. Maaari kang gumawa ng mga highlight ng font na makakatulong na ituon ang atensyon ng mambabasa mga kritikal na aksyon inilarawan sa mga tagubilin. Ipahayag ang iyong mga saloobin nang tumpak at lohikal, at ang taong nag-aaral ng mga teknolohikal na tagubilin na iyong isinulat ay magpapasalamat sa iyo.

User manual

Ang manu-manong pagtuturo ay pinagsama-sama para sa bawat pangkat ng mga produkto, kaya dapat itong may talaan ng mga nilalaman at mga pagtutukoy bagay (mga gamit sa bahay) o ang komposisyon ng produkto, kung ito ay mga bagay na tela. Bago ka magsulat ng mga tagubilin sa pagpapatakbo para sa isang device na nangangailangan ng pagpupulong, dapat mong ipahiwatig kung paano ito i-assemble at kung anong mga tool ang dapat gamitin para dito. Ang diagram ng pagpupulong ay dapat iharap sa mga tagubilin sa mga guhit, kung saan ang bawat bahagi ay may sariling serial number.

Kung may mga pindutan sa aparato, kinakailangan upang ipahiwatig kung aling pindutan ang inilaan para sa kung ano. Ang mga patakaran para sa pagtatakda ng mga partikular na parameter ng device, kung ibinigay ng tagagawa, ay ipinahiwatig sa mga tagubilin. Inilalarawan ng sumusunod ang mga kondisyon kung saan maaaring patakbuhin ang device, kasama ang power na kinakailangan para sa normal na operasyon. Ipaalam sa user kung anong mga aksyon ang hindi niya dapat gawin para hindi makapinsala sa performance ng device.

Tukuyin ang mga panuntunan sa pag-aalaga sa device. Kung ang mga tagubilin ay pinagsama-sama para sa mga kagamitan sa sambahayan, dapat itong magpahiwatig ng mga posibleng problema at mga paraan upang maalis ang mga ito. Sa dulo ng mga tagubilin, ang mga pag-iingat ay nakasulat.

Ang isang hanay ng mga tagubilin ay dapat makatulong sa mambabasa na makumpleto ang isang gawain nang mabilis, mahusay, at matagumpay. Mahalagang ibigay ang bawat detalye. Ang mga pagkukulang o pagkakamali ay maaaring mabigo sa mambabasa. Gamitin ang aming mga alituntunin upang magsulat ng isang hanay ng mga tagubilin.

Mga hakbang

Bahagi 1

Paghahanda sa pagsulat ng mga tagubilin

Magsaliksik sa iyong target na madla. Ito ang unang bagay na dapat gawin kapag nagsusulat ng mga tagubilin. Para kanino ka sumusulat? Ang mga taong ito ba ay dalubhasa o baguhan? Ang pag-alam sa iyong madla ay nakakatulong sa iyong pumili ng mga tamang salita, gamitin ang kinakailangang antas ng detalye, at gumamit ng mga diskarte para sa pagbubuo ng impormasyon.

• Halimbawa, kung ipinapaliwanag mo kung paano maghurno ng cake sa isang propesyonal na chef, hindi mo kailangang ipaliwanag kung paano paghaluin ang mga sangkap, kung bakit mahalagang dalhin ang mga itlog sa temperatura ng silid, o ang pagkakaiba sa pagitan ng regular at pancake na harina. Kung ipinapaliwanag mo ito sa isang taong hindi marunong magluto, ang pagkakaroon ng mga kahulugan at pagpapaliwanag na ito ay maaaring makaapekto sa lasa ng natapos na cake.
• Sa halip, magkamali sa panig ng pag-iingat at iwasang tratuhin ang iyong audience bilang mga eksperto. Kung gayon ang iyong mga tagubilin ay magiging malinaw at madaling sundin.

1. Tukuyin ang lahat ng kinakailangang kasangkapan. Bago ka magsimula, dapat mong malinaw na ilista kung ano ang kinakailangan upang matagumpay na makumpleto ang pagtuturo. Ito ay maaaring isang listahan ng mga sangkap o kinakailangang kagamitan.

   Kumpletuhin ang gawain. Ang pinakamahusay na paraan magsulat kapaki-pakinabang na mga tagubilin– dumaan sa proseso ng pagkumpleto ng gawain sa iyong sarili. Sa ganitong paraan isusulat mo ang lahat ng mga detalye. Kung itatayo mo ang proseso mula sa memorya, maaaring hindi mo matandaan ang lahat ng mga detalye. Pagkatapos ay humanap ng taong kukumpleto sa gawain batay sa iyong mga tala. Ipakomento sa kanila ang anumang kakaiba o nakalilitong mga aksyon na binanggit sa teksto.

   • Mag-ingat at huwag makaligtaan ang anumang bagay. Kung namimiss mo mahahalagang hakbang, kung gayon hindi magagawa ng mambabasa ang gawain. Tiyakin din na ang lahat ng mga hakbang ay nasa tamang pagkakasunod-sunod.
   • Halimbawa, kung sasabihin mong “Ihalo ang mga sangkap gamit ang isang panghalo. Ilagay sa oven na preheated sa 350 degrees," maaaring isipin ng mambabasa na naglalagay ka ng mixing bowl sa oven.

2. Gumamit ng mga salitang aksyon. Ang mga tagubilin ay dapat punan ng mga salitang aksyon at paglalarawan. Magsimula sa mga pandiwa ng aksyon. Kasabay nito, ang mambabasa ay tumatanggap ng isang malinaw na tawag sa pagkilos. Ang bawat hakbang ay dapat tunog tulad ng isang command, gamitin imperative mood.

   • Sa mga kahulugan o paliwanag, subukang gumamit ng maigsi na mga konstruksyon.
   • Halimbawa, sabihin ang "Magdagdag ng dalawang itlog" sa halip na "Magdagdag ng dalawang itlog sa batter ng cake."

3. Idagdag lamang ang kinakailangang impormasyon. Kapag nagdagdag ka Karagdagang impormasyon, siguraduhing gagamitin mo lang ang kailangan mo. Tanungin ang iyong sarili: "Kailangan bang malaman ng mambabasa ang kahulugang ito upang maunawaan ang mga tagubilin?" o "Kailangan ba ng mambabasa ang payong ito upang matagumpay na masunod ang mga tagubilin?"

   • Iwasang magdagdag hindi kinakailangang impormasyon. Maaaring malito ng mga hindi kinakailangang kahulugan, hakbang, o impormasyon ang iyong mga mambabasa at magpapahirap sa pagsunod sa mga tagubilin.

4. Gumamit ng mga apela. Ang teksto ng mga tagubilin ay dapat isulat bilang isang pakikipag-usap sa mambabasa. Upang gawin ito, gamitin ang salitang "ikaw". Sa pamamagitan nito, personal mong gagabayan ang mambabasa sa lahat ng mga punto.

   Maging tiyak. Ang mga tagubilin ay dapat na lubos na tiyak. Isulat lamang ang kailangan mong malaman. Ipahiwatig kung aling paraan upang iikot ang susi, kung gaano karaming mga paa ang gagamitin kapag naglalakad, o kung ano ang hitsura ng natapos na cake.

   • Magbigay ng eksaktong mga halaga. Kung kailangan ng isang tao na putulin ang 7.8 cm mula sa isang board, sabihin ito.
   • Halimbawa, kapag nag-compile recipe sa pagluluto Huwag maghintay hanggang sa ika-apat na hakbang upang sabihin, "Bago paghaluin ang mga sangkap, salain ang harina at dalhin ang mga itlog sa temperatura ng silid."

5. Ayusin ang mga aksyon nang sunud-sunod at gumamit ng mga pang-abay ng oras. Makakatulong ito na ikonekta ang mga hakbang nang sama-sama, at gayundin ang iyong mga iniisip ay magiging mas magkakaugnay. Ang mga tagubilin ay karaniwang binubuo ng mga sunud-sunod na aksyon at pambungad na salita. Tinutulungan nito ang mambabasa na maunawaan ang mga tagubilin nang sunud-sunod.

   • Ilang pambungad na salita: una, susunod, pagkatapos, sa wakas, pagkatapos, bago.

Bahagi 3

Istraktura ng pagtuturo

1. Isulat ang panimulang bahagi. Bago ka magsimula detalyadong mga tagubilin, kinakailangan na maikli na ipakilala ang mambabasa sa sitwasyon. Ipinapaliwanag ng panimula kung ano ang magagawa ng mambabasa pagkatapos basahin ang mga tagubilin. Nagbibigay din ito ng pangkalahatang-ideya ng lahat ng aktibidad. Dapat itong maikli at malinaw.

   Ayusin ang iyong mga tagubilin ayon sa pangangailangan. Ang mga tagubilin ay binubuo ng magkakasunod na magkakaugnay na pagkilos. Bago ka umupo upang isulat ang mga tagubilin, dapat kang magpasya kung aling mga hakbang ang kinakailangan. Iyon ay, kailangan mong pumili ng isang bagay kung wala ito ay hindi mo maaaring simulan ang pagkumpleto ng gawain.

   Hatiin ang mga tagubilin sa magkakahiwalay na gawain. Karamihan sa mga tagubilin ay nangangailangan sa iyo na kumpletuhin ang ilang mga gawain upang matagumpay na makumpleto ang buong proseso. Ang pagsasaayos ng mga tagubilin sa magkakahiwalay na mga talata para sa bawat hakbang ay gagawing madaling basahin at maunawaan.

   Lagyan ng label nang malinaw ang bawat gawain. Upang matulungan ang mambabasa na maunawaan ang mga tagubilin, lagyan ng label ang bawat seksyon ng malinaw na salita. Dapat isama sa pamagat ng gawain kung tungkol saan ang partikular na gawain o bahagi nito. Dapat maunawaan ng mambabasa ang gawaing kanyang gagawin bago niya ito simulan.

2. Ilagay ang bawat hakbang sa isang pangungusap. Ang mga pangungusap na ito ay dapat na maikli; ang bawat panukala ay dapat magsama lamang ng isang hakbang. Tinitiyak nito na hatiin mo ang gawain mga indibidwal na aksyon, sa halip na hatiin ang bawat yugto sa ilang mga aksyon.

   • Kung ang isang hakbang ay may kasamang kaugnay na aksyon na dapat kumpletuhin sa loob ng parehong hakbang, ipaliwanag ang aksyon nang sunud-sunod sa parehong pangungusap. Halimbawa, "Bago ibuhos ang cake sa kawali, balutin ang ibabaw ng kawali ng non-stick na likido" o "Pahiran ang ibabaw ng kawali ng non-stick na likido. Pagkatapos ay ibuhos ang cake sa molde.

Bawat isa sa atin ngayon ay regular na nahaharap sa pangangailangang pag-aralan ang iba't ibang mga tagubilin para sa paggamit ng isang partikular na produkto.

Sinasamahan nila kami kahit saan. Bumibili kami mga kasangkapan sa sambahayan at pag-aralan ang manual ng pagtuturo, bumili ng mga tabletas para sa sakit ng ulo sa parmasya at agad na tingnan ang mga nakalakip na tagubilin para sa medikal na paggamit.

Paano ang tungkol sa mga tabletas at kagamitan! Pumunta sa isang simpleng supermarket at kumuha ng isang pakete ng pasta. Ano ang makikita mo sa likurang bahagi? Hindi ba ito isang uri ng instruction manual?!

Dito na magsisimula ang saya...

Ang likas na katangian ng paglalahad ng impormasyon ay lubhang nag-iiba. Minsan tila ang isang lihim na mensahe mula sa mga espesyal na serbisyo ay nahulog sa aming mga kamay, na hindi posible na maunawaan, o kabaliktaran - ang mga matatanda ay ipinaliwanag halos sa kanilang mga daliri kung magkano ang dalawa at dalawa.

Ang kaginhawahan at kadalian ng paggamit ng isang produkto ay palaging makabuluhang "mga levers" ng pag-impluwensya sa desisyon ng target na madla na bumili.

Halimbawa, kapag naghahanap ng bagong tablet sa Internet, kung maaari, tiyak na ida-download at titingnan namin ang mga tagubilin sa pagpapatakbo nito.

Nagawa mo bang tabunan ito ng hindi maintindihan na mga termino? Pagkatapos ay tumanggap ng "bilang gantimpala" ng pagtanggi na bumili at ang kagalakan ng iyong mga kakumpitensya, na nagbigay sa mga kliyente ng sapat, malinaw at malinaw na mga tagubilin, na nagpapakita na madaling "makipagkaibigan" sa aming tablet.

Ang pagsulat ng de-kalidad na manwal ng produkto ay isang sining. Iangat natin ang kurtina at tingnan ang "sa likod ng mga eksena" ng paglikha nito.

Kaya, ano ang dapat mong bigyang pansin kapag lumilikha ng isang manu-manong pagtuturo na "gumagana" para sa mga benta?

Detalye

Ang katiyakan at antas ng detalye ay ang mga parameter na tinutukoy ayon sa antas ng kahandaan ng target na madla. Dito napili ang pinakamainam na balanse, na nakatuon sa potensyal na mamimili.

Halimbawa:

Pagkatapos i-click ang ____, lalabas ang isang welcome window.

Pagkatapos pindutin ang ____ sa ____ na sulok ng keyboard, may lalabas na welcome window sa screen na may nakasulat na "____".

Kadalasan mayroong mga tagubilin na naglalaman ng mas detalyadong impormasyon. Ngunit mag-ingat! Hindi mo dapat dalhin ang detalye sa punto ng kahangalan at kalabisan, kung hindi man ay nanganganib kang magalit at mawala ang kliyente:

Pagkatapos mong pindutin ang ____ key gamit ang iyong daliri sa kanang sulok sa itaas ng keyboard, may lalabas na welcome window sa screen na may madilim na asul na “____” na text na matatagpuan sa gitna.

Pag-istruktura

Paulit-ulit nating napag-usapan ang kahalagahan ng pagbubuo ng impormasyon sa mga teksto. Ang pagtatanghal na ito ay nagpapadali para sa madla na maunawaan ang materyal. Ang manu-manong pagtuturo ay walang pagbubukod.

Ihambing:

1. Ipasok ang disc sa drive.
2. Sa lalabas na window, i-click ang ____.
3. Pumili ng item sa menu ____.

Ipasok ang disc sa drive, pagkatapos ay sa window na lilitaw, i-click ang ____, at pagkatapos ay piliin ang ____ menu item.

Sa unang opsyon makikita natin ang sunud-sunod na pag-istruktura ng impormasyon. Malinaw, madali at naiintindihan. Iba ang hitsura at pakiramdam ng pangalawang opsyon - ito ay mas "mabigat".

Positibo at kawastuhan

Sa tingin mo ba hindi ito mahalaga? Ikaw ay mali! Para sa isang positibong resulta, kailangan mong mag-isip nang positibo at magsalita nang positibo sa pamamagitan ng teksto sa target na madla (nawa'y patawarin tayo ng mga masigasig na kalaban ng tautolohiya).

Walang may gusto sa kabastusan at kalungkutan. Samakatuwid, maselan at napakawastong i-set up ang mga potensyal na mamimili LAMANG para sa positibo.

Narito ang hitsura nito sa pagsasanay:

Alisin ang monitor mula sa kahon at maingat na alisin ito mula sa packaging nito. Kumapit sa lahat ng panig upang mapanatili ang integridad nito.

Alisin ang monitor mula sa kahon at alisin ang packaging. Subukang huwag ihulog o masira ito sa proseso.

HINDI sa tatlong C: mga pagdadaglat, kasingkahulugan at pagdududa

Kapag gumuhit ng mga tagubilin para sa paggamit ng isang produkto, ipinapayong iwasan ang anumang "kawalang-katiyakan ng intonasyon". Huwag mag-atubiling i-cross out ang iba't ibang "marahil, marahil, marahil."

Ang mga pagdadaglat ay pinahihintulutan lamang kung ang buong salita ay ibinigay sa pinakadulo simula ng manwal, sa tabi kung saan ang "condensed form" nito ay ipinahiwatig:

Ang kumpanya ng transportasyon (TC) ay may pananagutan ____.

Ang multifunction device (MFP) ay gumagana ____.

operating system(OS) magsisimula ____.

Ang paggamit ng mga kasingkahulugan at jargons ay hindi katanggap-tanggap. Hindi na kailangang "ipagmalaki" ang iyong karunungan at lituhin ang mga gumagamit na may iba't ibang terminolohiya.

Kung pinag-uusapan natin, halimbawa, tungkol sa cellphone, kung gayon hindi ka dapat gumamit ng mga salita gaya ng “mobile phone”, “mobile”, “telephone device”, “ cellular na telepono" atbp.

Mayroon bang madalas na pag-uulit? Pero hindi ikaw piraso ng sining lumikha, ngunit isang manwal ng pagtuturo. Dapat itong maunawaan ng kliyente, at hindi suriin ang iyong estilo at bokabularyo.

Mabuhay ang imperative mood!

Gamitin ang imperative na mood - hikayatin ang mga user na kumilos (tumawag, payuhan, babala, ipagbawal).

Ihambing:

Upang i-on ang telepono kailangan mong pindutin ang ____.

Ang ____ button ay responsable para sa pag-on ng telepono.

Pindutin ang ____ upang i-on ang iyong telepono.

I-on ang telepono gamit ang ____ button.

Finishing touch

Ang pinakamasamang bagay ay kung ang isang tao, dahil sa "nakalilitong mga tagubilin," ay hindi maintindihan kung paano gamitin ang produkto at tumanggi na bilhin ito. kaya naman…

Pagkatapos handa na mga tagubilin naayos sa "screen sheet" ng monitor sa pamamagitan ng pagpindot sa "save" na buton, magandang ideya na tingnan kung ito ay malinaw sa iyong target na madla.

Hindi kami nakikibahagi sa pagsulat ng mga "verbal canvases" na may simpleng paglalarawan hilera mga kinakailangang aksyon, ngunit bumuo kami ng malinaw, lohikal at visual na mga alituntunin.

Mga gabay sa gumagamit na humihikayat sa mga gumagamit na bumili.

Ano ang isang tagubilin?

Ang pagtuturo ay isang ligal na kilos na inilabas o inaprubahan para sa layunin ng pagtatatag ng mga tuntunin na namamahala sa organisasyon, siyentipiko, teknikal, teknolohikal, pananalapi at iba pang mga espesyal na aspeto ng mga aktibidad ng mga institusyon, organisasyon, negosyo (kanilang mga dibisyon at serbisyo), mga opisyal at mamamayan. Ang pangunahing layunin ng dokumentasyong pagtuturo ay magturo ng pagkakasunod-sunod ng mga aksyon o magbigay ng tulong bilang sanggunian sa pagsasanay.

Ang mga tagubilin ay inilabas din para sa layunin ng pagpapaliwanag at pagtukoy sa pamamaraan para sa paglalapat ng mga gawaing pambatasan at mga dokumentong pang-administratibo (halimbawa, mga utos). Ang mga tagubilin para sa pagpuno at pagpapanatili ng mga dokumento ng accounting ay patuloy na ibinibigay.

Ang isang paglalarawan ng trabaho ay iginuhit para sa bawat empleyado ng isang institusyon (organisasyon). Ang paglalarawan ng trabaho ay may isang pinag-isang anyo at parehong istraktura ng teksto para sa lahat ng mga posisyon: pangkalahatang mga probisyon, mga tungkulin, mga responsibilidad sa trabaho, mga karapatan, mga responsibilidad, mga opisyal na relasyon.

Ang dokumentasyon ng pagtuturo ay maaari ding isang paglalarawan ng operating system ng computer, mga tagubilin para sa pagsasagawa ng trabaho o espesyal na gawain, o isang manwal ng software.

Ano ang mga pangunahing prinsipyo para sa paglikha ng dokumentasyong pagtuturo?

Ang mga mabubuting tagubilin ay tumpak ang pagkakasabi, malinaw, kumpleto, pare-pareho at epektibo. Ang bawat isa sa mga katangiang ito ay isang gabay para sa may-akda ng mga tagubilin.

Unang prinsipyo: iwasan ang kawalan ng katiyakan. Kung mas tiyak ang mga tagubilin, mas mabuti. Mas mabuting sabihing, "kumaliwa ka sa malaking puno ng oak kung saan may bahay na may berdeng baldosa na bubong na may karatula na 'for sale'," kaysa sabihin na lang, "Kumaliwa sa malaking puno." Kapag malinaw na naglalarawan, iwasan ang mga salitang maraming kahulugan o walang kahulugan. Ang katumpakan ay isang mahalagang aspeto ng kalinawan.

Ang pangalawang prinsipyo: maging malinaw. Ang mga tagubilin ay dapat ihanda para sa mga partikular na tatanggap. I-target ang iyong mensahe sa iyong nilalayong madla. Kung naghahanda ka ng dokumentasyon para sa isang computer system, kailangan mong isaalang-alang ang antas ng kamalayan ng iyong madla tungkol sa system. Maaaring katanggap-tanggap ang paggamit ng mga jargon at acronym sa ilang silid-aralan ngunit hindi katanggap-tanggap sa iba. Bilang karagdagan, ang mga tagubilin ay maaaring gawing mas malinaw sa pamamagitan ng paggamit ng mga maiikling pangungusap, karaniwang salita, at magagandang pang-ugnay.

Ikatlong Prinsipyo: Magbigay ng kumpletong impormasyon. Maaaring malinaw at nauunawaan ang mga tagubilin, ngunit mabibigo pa rin kung hindi kumpleto ang mga ito. Kung napalampas mo ang anumang mahalagang hakbang kapag inilalarawan ang pamamaraan, maaaring humantong ito sa imposibilidad ng pagkumpleto ng gawain. Bilang karagdagan sa pagtukoy sa lahat ng pangunahing aksyon o elemento ng iyong mga tagubilin, isaalang-alang ang posibilidad na maaaring lumitaw ang iba't ibang problema o tanong. Bilang isang paraan ng pagsuri sa iyong mga tagubilin para sa pagkakumpleto, tanungin ang iyong sarili ng mga sumusunod na tanong: Sino? Ano? Kailan? saan? Paano? Bakit?

Ikaapat na prinsipyo: maging pare-pareho. Ang mga tagubiling ibinigay ay magiging mas madaling ipatupad kung sila ay pare-pareho at pare-pareho. Tukuyin ang pagkakaiba sa pagitan ng mga antas ng istruktura sa loob ng iyong mga tagubilin at gawin itong halata sa tatanggap. Halimbawa, sa mga nakasulat na tagubilin, ituturing na pareho ang bawat pangunahing hakbang, pare-pareho din ang bawat hakbang sa susunod na antas, atbp. Mas mainam na simulan ang bawat pangunahing hakbang sa isang bagong pahina, gamitin ang parehong font at mga format, at magsimula sa isang maikling buod.

Ikalimang prinsipyo: maging epektibo. Ang kahusayan ay nangangahulugan ng pagpapanatiling pinakamababa sa teksto ng pagtuturo habang pinapanatili ang apat na naunang mga prinsipyo. Ang kahusayan ay hindi madaling makamit dahil malinaw, hindi malabo, naiintindihan, pare-pareho ang mga tagubilin ay malamang na mahaba. Gayunpaman, dapat kang maghanap ng mga paraan upang mabawasan ang iyong mga tagubilin. Halimbawa, ang pagsisimula sa bawat isa sa pitong aksyon sa pariralang "Ang iyong susunod na hakbang sa pagkumpleto ng gawain..." ay hindi epektibo. Sa halip, gumamit ng pariralang tulad nito nang isang beses at pagkatapos, pagkatapos ng tutuldok, ilista ang lahat ng pitong aksyon.

Madalas na nakakamit ang kahusayan sa pamamagitan ng paggamit ng mga maikling buod upang ilarawan ang nilalaman ng mga tagubilin, halimbawa: “Ang pag-install ng software na ito ay may kasamang tatlong pangunahing hakbang at tumatagal ng walong minuto. Gayunpaman, bago i-install dapat mong malaman ang iyong serial number at ang dami ng RAM sa iyong computer.” Ang mga maikling buod (mga buod ng mga iminungkahing aksyon) ay nakakatulong na maiwasan ang kawalan ng kakayahang dumaan sa bahagi ng landas na inilarawan sa mga tagubilin hanggang sa sandaling maging malinaw sa iyo na wala kang sapat na kagamitan o impormasyon upang makumpleto ang gawain.

Saan ako dapat magsimulang maghanda ng mga tagubilin?

Kapag gumagawa ng mga dokumento ng gabay, bilang karagdagan sa paglalapat ng mga pangunahing prinsipyo, dapat mo ring isaalang-alang kung paano maaaring gamitin ng iyong audience ang impormasyon. Ang isang piloto ng eroplano ay kumukunsulta sa isang listahan ng mga kinakailangang aksyon at kundisyon sa bawat oras bago lumipad. Ang isang computer technician ay bumaling sa mga tagubilin upang matandaan ang key combination para sa isang bihirang ginagamit na command. Ang bagong empleyado ay sumusunod sa mga tagubiling inihanda ng kanyang hinalinhan upang makayanan ang isang mahirap na gawain. Sinusuri ng isang aplikante para sa isang posisyon ang mga paglalarawan ng trabaho upang masukat ang antas ng kanyang interes sa posisyon.

Ang bawat isa sa mga dokumentong ito ay may malinaw na layunin at mga tampok na nauugnay sa nilalayon nitong paggamit. Kapag naghahanda ng mga tagubilin, makakatulong sa iyo ang sumusunod na listahan ng mga tanong na dapat mong mahanapan ng mga sagot bago ka magsimulang magsulat ng dokumentasyon:

Para saan ang dokumentasyong ito?

Nagsusulat ba ako ng dokumentasyon para sa isang indibidwal na gumagamit o para sa isang pangkat ng mga gumagamit?

Magre-refer ba ang user sa dokumentasyong ito nang higit sa isang beses?

Gaano katagal gagamitin ang bersyong ito ng dokumentasyon? (Ano ang kanyang buhay?)

Kailangan ba ng glossary?

Sinuri ko ba ang dokumentasyon upang matiyak na ito ay naiintindihan ng isang hindi sanay na gumagamit?

Ang istilo ng pagsulat ba ay pinakaangkop mababang antas mga potensyal na gumagamit?

Dapat bang may kasamang index?

Anong visual reinforcement o visual aid ang maaaring makatulong?

Paano dapat iguhit ang opisyal na mga tagubilin sa panloob na kumpanya?

Ang mga tagubilin ay ibinibigay sa isang pangkalahatang form. Ito ay inaprubahan ng isang espesyal na gawaing pang-administratibo o direkta ng pinuno, bilang ebidensya ng kaukulang selyo ng pag-apruba. Ang selyo ng pag-apruba ay may dalawang pagpipilian sa disenyo:

INAPRUBAHAN ng Pangulo ng Olympus Joint Stock Company, lagda V.L. Plotnikov 03/30/02

APRUBADONG Utos ng Ministro ng Kalusugan ng Russia 11/15/99 No. 287

Ang mga tagubilin ay maaaring markahan bilang isang annex sa administratibong dokumento. Kapag ang isang pagtuturo ay naaprubahan ng isang administratibong dokumento (halimbawa, isang order), ito ay nagtatakda ng deadline para sa pagpapakilala ng pagtuturo, naglilista ng mga kinakailangang hakbang sa organisasyon, at nagpapahiwatig ng mga responsableng tao.