Mga Manwal

A mghuhukom, na aming tinutukoy dito, ay isang kombinasyon ng mga sumusunod:

• konseptong impormasyon
• mga tagubilin impormasyon
• impormasyon ng sanggunian

lahat ay nakatuon sa isang tiyak na paksa para sa mga pangangailangan ng isang tiyak na audience. Kung ikaw ay kumuha ng kurso sa teknikal na pagsulat gamit ang aklat na ito, ang iyong proyekto sa handbook dapat isama sa anumang paraan ang bawat isa sa mga tatlong elemento. Bukod pa rito, ang mga elementong ito ay dapat na isang natural, lohikal na "pagsasaayon" para sa iyong proyekto sa handbook.

Tiyaking tingnan ang mga halimbawa.

NotebookLM na nilikhang infographic ng kabanatang ito.

Mga Pangunahing Kaalaman sa Manwal

Mga Konsepto. Ang konseptwal na impormasyon ay nagpapaliwanag kung paano gumagana ang mga bagay, kung paano ito pinagsama-sama. Para sa mas kumplikadong mga tagubilin, kailangan mong malaman ang ilang mga konsepto, teorya, background, at prinsipyo upang maisagawa ang mga tagubilin. Isaalang-alang ang halimbawa ng software function na nagbibigay-daan sa iyo upang baguhin o lumikha ng iyong sariling kulay. Ang paggamit ng kagaya ng Photoshop, Illustration, CorelDraw o Paint Shop Pro para dito—ang aktwal na mga button at slider—ay madali. Ngunit ang pag-unawa sa kung paano ang hue, intensity, brightness, saturation, density, contrast, RGB—ay mahirap. Kailangan mong malaman ang teorya ng kulay sa computer upang makalikha ng kailangan mong kulay.

Isaalang-alang ang isa pang halimbawa: simpleng mga utos sa sistema ng file ng Linux —ls, cd, cp, mv, pwd. Upang magamit ang mga utos na ito, kailangan mong maunawaan kung ano ang mga file at direktoryo, at marahil kung ano ang isang operating system pati na rin ang mga wildcard. Talagang hindi mo maiintindihan kung paano gamitin ang mga utos na ito —sundin ang mga tagubilin gamit ang mga ito —maliban kung nauunawaan mo ang mga pangunahing konseptong ito.

Mga Tagubilin. Kung naiintindihan mo ang mga pangunahing konsepto, makakapagpatuloy ka sa mga hakbang-hakbang na pamamaraan nang may kaalaman. Ang mga tagubilin ay mga pamilyar na bagay na may bilang na listahan na maingat na nagtuturo sa iyo ng isang proseso. Ang mga tagubilin ay nasa lahat ng dako, sa mga packaging ng produkto, sa mga gabay ng gumagamit na kasama ng mga appliances at kompyuter.

Sanggunian. Ang huling kategorya ng impormasyon ay tungkol sa impormasyon na maaari mong tingnan, o mabilis na reperensiya. Kung sinundan mo ang halimbawa ng sistema ng file sa itaas, kailangan mong pag-aralan at matutunan ang mga konsepto ng mga file, direktoryo, at wildcards muna. Pagkatapos ay maaari mong sundan at unawain ang mga tagubilin sa pagpapalit ng mga direktoryo, pagkopya, pagbura, o paglipat ng mga file. Ngunit pagkatapos ng ilang panahon, hindi mo na kailangan ang mga tagubilin, ngunit paminsan-minsan mayroon kang mga espesyal na pangangailangan na hindi nasasaklaw sa seksyon ng tagubilin o hindi mo matandaan ang mga tiyak na pamamaraan na nasasaklaw sa seksyon ng tagubilin. Ngayon ang oras na kailangan mo ng pangunahing impormasyon sa reperensiya: pupunta ka lang sa seksyon na iyon at mabilis itong titingnan.

At pagkatapos ng mas mahabang panahon, hindi mo na kailangan ang seksyong konsepto o ang seksyong tagubilin: sanay na sanay ka na sa mga prosesong iyon, alam mo na ang mga ito nang tila. Pero paminsan-minsan nakakalimutan mo ang ilang maliit na detalye o may espesyal na gawain kang hindi pa nagagawa —doon ka pupunta sa seksyong reperensya. Siguro ay maaari mo nang alisin ang mga seksyong konsepto at tagubilin at itapon ang mga ito. Ang kailangan mo lang ay ang seksyong reperensya.

Format at Estilo ng Manwal

Sa isang kurso sa teknikal na pagsulat na gumagamit ng aklat na ito, maaari kang inaasahang gamitin ang mga tiyak na alituntunin para sa paggamit ng mga pamagat, listahan, abiso, graphics, talahanayan, dokumentasyon, at mga panimula:

Manwal na prototype. Mula sa link sa ibaba, makakakuha ka ng dummy na bersyon ng handbook. Nasa maayos na format ang lahat ng kinakailangang pahina. Kasama sa dokumentong Word na ito ang mga estilo ng talata at karakter na magpapadali sa iyong trabaho at magdadagdag ng ilang propesyonal na kasanayan sa iyong kaalaman.

Manwal na prototype

Nilalaman ng prototype. Ang prototype para sa talahanayan ng nilalaman ay partikular na kapaki-pakinabang: nagbibigay ito sa iyo ng Word styles para makagawa ng propesyonal na hitsura ng TOC. Mahirap makuha ang tamang left- at right-alignments at leader dots:

Prototipo ng Talahanayan ng Nilalaman

Mga Halimbawa ng Manwal

Narito ang ilang mga link sa mga halimbawa ng handbook. Mag-ingat na may ilang problema sa mga halimbawa, karamihan sa mga ito ay aking pinuna. Ang ilan sa mga ito ay nasa hangganan ng mga handbook. Ang nagpapagawa sa isang handbook para sa akin ay ang pagkakaroon ng talakayang konseptwal, mga tagubilin, at impormasyong sanggunian.

Tiyaking tingnan ang mga halimbawa.

Mga AI Prompt para sa mga Manwal

Ang mga checklist, na karaniwang hindi nababasa, ay maaaring gamitin bilang pinagmulan para sa mga AI prompt na may kaunting pagbabago. Kopyahin ang sumusunod, i-paste ito sa isang AI system tulad ng Google Gemini, at tingnan kung ano ang maaaring iyong nalampasan.

Tandaan: Lahat ng mga sanggunian sa nilalaman, format, estilo ng techdocs o mga bahagi nito ay matatagpuan sa online na aklat tungkol sa teknikal na pagsulat.

malapit na!

Pahalagahan ko ang iyong mga saloobin, reaksyon, at kritisismo tungkol sa kabanatang ito: ang iyong tugon—David McMurrey.