Hindi mahalaga kung gaano katalinuhan ang isang imbentor, programmer o rationalizer, minsan ang kanyang mga nilikha ay hindi maaaring gamitin para sa kanilang nilalayon na layunin. Ang dahilan para dito ay ang maling pagguhit ng manwal ng pagtuturo o ang kumpletong kawalan nito. Ngunit kahit na ang mga mapanlikha na imbentor minsan ay nagsusulat ng gayong mga tagubilin na, bukod sa makitid na mga dalubhasa, walang makakabasa sa mga papel na ito. Kaya paano mo maayos na gumuhit ng gayong kinakailangang dokumento?
Kailangan iyon
- - isang daang porsyento na kaalaman tungkol sa aparato o produkto ng software kung saan isinusulat ang manwal;
- - kaalaman sa larangan ng lingguwistika;
- - kasanayan sa pagsusulat.
Panuto
Hakbang 1
Ang isang manwal ng gumagamit o, sa madaling salita, isang manu-manong operasyon ay isang dokumento na idinisenyo upang magbigay ng tulong sa paggamit ng isang tiyak na sistema sa mga gumagamit nito. Upang makatipon ng isang manwal ng gumagamit, kailangan mong malaman ang inilarawan na sistema ng daang porsyento, ngunit tingnan ito sa pamamagitan ng mga mata ng isang ignoranteng mag-aaral. Ipagpalagay na ang isang manwal ng gumagamit ay nakasulat para sa isang software utility na wala pang mga analogue. Isipin na ito ang iyong unang pagkakataon sa paggamit ng program na ito. Saan ka magsisimula Ano ang unang dapat malaman? Isaayos ang kaalamang ito sa mga kategorya ng kahalagahan.
Hakbang 2
Sa pamamagitan ng paghahati ng lahat ng impormasyon tungkol sa iyong paglikha sa mga pangkat, nakagawa ka ng isang plano para sa pagsusulat ng isang manwal ng gumagamit. Simulang ilarawan ang trabaho sa iyong programa mula sa simula, iwanan ang huling mahirap na mga detalye, tulad ng mga tampok na muling pagprogram o pagharap sa mga kritikal na error. Sa yugtong ito, dapat ay handa kang magkaroon ng nilalaman ng manwal ng gumagamit - isa sa mga kinakailangang bahagi ng dokumentong ito.
Hakbang 3
Kung ang manwal na iyong nilikha ay inilaan para magamit sa isang malaking kumpanya, dapat mong bigyang pansin ang mga pamantayang korporasyon na pinagtibay doon. Halimbawa, sa maraming mga kumpanya ng Russia, ang mga manwal ng gumagamit ay hindi tinatanggap nang walang naglalarawan na suporta, sa madaling salita, mga larawan na nagpapaliwanag kung ano ang nakasulat. Bilang karagdagan sa nilalaman, ang manwal ng gumagamit ay dapat maglaman ng iba pang mga sapilitan na bahagi: - Anotasyon, iyon ay, isang paliwanag ng mga pangkalahatang layunin ng manu-manong at ang inilarawan na produkto; - isang pagpapakilala, na naglalarawan sa mga dokumento na nauugnay sa manwal ng gumagamit at kung paano upang magamit ang manu-manong; - mga seksyon na nagpapaliwanag ng paggamit ng produkto sa iba't ibang yugto ng paggamit nito, halimbawa, mga unang hakbang, pag-aayos o pagpapanatili - - seksyon ng mga madalas itanong at sagot sa kanila; - glossary o index ng paksa.
Hakbang 4
Karaniwan, ang isang teknikal na manunulat ay kasangkot sa paglikha ng isang manwal ng gumagamit - isang tao na mayroong lahat ng kinakailangang kaalaman kapwa sa wika at sa produktong inilalarawan. Bilang isang teknikal na manunulat na walang pagsasanay, maraming mga patakaran na dapat tandaan. Una, hindi mo dapat abusuhin ang mga espesyal na term na hindi naiintindihan ng isang ordinaryong gumagamit. Pangalawa, ang bawat term na ginamit ay dapat na detalyado at ipaliwanag. Pangatlo, kailangan mong magsulat nang malinaw at maikli hangga't maaari. Sa wakas, ang isang teknikal na manunulat ay dapat na tumingin sa kanilang sariling teksto sa mata ng isang ordinaryong gumagamit upang makita ang mga pagkukulang ng kanilang sariling teksto.
Hakbang 5
Mahusay na subukan ang natapos na teksto ng manwal ng gumagamit sa pagsasanay sa pamamagitan ng pag-alok nito sa isang tao na walang kinalaman sa inilarawan na produkto. Sa pamamagitan ng magkasamang pagsisikap, posible na matanggal ang lahat ng mga pagkukulang at bitag ng dokumento.
