Tala:
- Ang kabanatang ito, pati na rin ang natitirang bahagi ng aklat sa Teknikal na Pagsulat, ay nakatuon sa mga kasanayan sa teknikal na pagsulat. Ang teknikal na nilalaman dito ay hindi ginagarantiyahan na magiging matagumpay, tumpak o napapanahon.
- Ang kabanatang ito ay naisalin gamit ang Open AI ChatGPT. Mangyaring iulat ang mga problema sa wika sa admin@mcmassociates.io.
- Pindutin dito upang tulungan si David McMurrey na magbayad para sa web hosting: Mag-donate ng kahit anong halaga! Mananatiling libre ang Online Technical Writing.
Ang pokus ng kabanatang ito ay isa sa pinakamahalaga sa lahat ng gamit ng teknikal na pagsulat—ang mga tagubilin. Tulad ng alam mo, ang tagubilin ay mga hakbang-hakbang na paliwanag kung paano gawin ang isang bagay: paano bumuo, mag-operate, mag-ayos, o magpanatili ng mga bagay.
Siguraduhing tingnan ang mga halimbawa.
Nagsusulat ng isang set ng tagubilin para sa trabaho o para sa klase sa teknikal na pagsulat? Subukan ang gabay sa pagpaplano ng tagubilin.
Pagsusulat ng Mga Tagubilin
Isa sa mga pinaka-karaniwan at pinaka-mahalagang gamit ng teknikal na pagsulat ay ang mga tagubilin—ang mga hakbang-hakbang na paliwanag kung paano gawin ang mga bagay: mag-assemble ng isang bagay, mag-operate ng isang bagay, mag-ayos ng isang bagay, o magsagawa ng routine na pagpapanatili ng isang bagay. Ngunit para sa isang bagay na tila madaling intindihin, ang mga tagubilin ay ilan sa mga pinakamasamang dokumentong nakasulat. Tulad ko, malamang naranasan mo na ang maraming nakakainis na karanasan sa masamang pagkakasulat ng mga tagubilin. Ang susunod sa kabanatang ito ay maaaring hindi fool-proof o goof-proof na gabay, ngunit ipapakita nito ang mga pinakamahuhusay na teknik na tinatanggap ng mga propesyonal.
Sa huli, ang mahusay na pagsusulat ng tagubilin ay nangangailangan ng:
- Maliwanag, simpleng pagsusulat
- Masusing pag-unawa sa proseso sa lahat ng teknikal na detalye nito
- Ang kakayahan mong ilagay ang iyong sarili sa posisyon ng mambabasa, ang taong sumusubok gamitin ang iyong mga tagubilin
- Ang kakayahan mong i-visualize ang proseso nang detalyado at i-capture ang kamalayan na iyon sa papel
- Sa wakas, ang kahandaang magpunta ng dagdag na hakbang at subukan ang iyong mga tagubilin sa uri ng taong isinulat mo para sa kanila.
Sa puntong ito, malamang na na-aral mo na ang mga headings, listahan, at mga espesyal na abiso—ang pagsusulat ng isang set ng tagubilin gamit ang mga ito ay tila halata. Hatiin lamang ang talakayan sa numbered vertical lists at maglagay ng ilang espesyal na abiso sa mga malinaw na punto at tapos na! Hindi pa man ganap, ngunit magandang simula ito. Tinutuklas ng kabanatang ito ang ilang katangian ng mga tagubilin na maaaring gawing mas kumplikado ang mga ito. Maaari mong gamitin ang mga konsiderasyong ito upang planuhin ang iyong sariling mga tagubilin.
NotebookLM-generated infographic ng kabanatang ito
Ilang Paunang Hakbang
Sa simula ng isang proyekto sa pagsusulat ng mga tagubilin, mahalagang tukuyin ang estruktura o katangian ng partikular na proseso na isusulat mo.
Tagapakinig at sitwasyon. Maaga sa proseso, tukuyin ang tagapakinig at sitwasyon ng iyong mga tagubilin. Tandaan na ang pagtukoy ng tagapakinig ay nangangahulugang pagtukoy sa antas ng pamilyaridad nito sa paksa pati na rin ang iba pang detalye. Tingnan ang talakayan ng mga tagapakinig at mga hakbang sa pagtukoy ng tagapakinig.
Pinakamahalaga, kung ikaw ay nasa isang kurso sa pagsusulat, kakailanganin mong gumawa ng paglalarawan ng iyong tagapakinig at i-attach iyon sa iyong mga tagubilin. Papayagan nito ang iyong instructor na suriin ang iyong mga tagubilin ayon sa pagiging angkop nito para sa tinukoy na tagapakinig. At tandaan din na sa isang kurso sa teknikal na pagsusulat mas mainam na magsulat para sa mga hindi espesyalistang tagapakinig—mas malaking hamon ito sa iyo bilang manunulat.
Bilang ng mga gawain. Ilan ang mga gawain sa proseso na isinusulat mo? Gamitin natin ang term na proseso para tukuyin ang kabuuang hanay ng mga aktibidad na tinatalakay ng iyong mga tagubilin. Ang gawain ay isang semi-independenteng grupo ng mga aksyon sa loob ng proseso: halimbawa, ang pagsasaayos ng orasan sa isang microwave oven ay isang gawain sa kabuuang proseso ng paggamit ng microwave oven.
Ang simpleng proseso tulad ng pagpapalit ng langis sa isang kotse ay naglalaman lamang ng isang gawain; walang semi-independenteng pagpangkat ng mga aktibidad. Ang mas kumplikadong proseso tulad ng paggamit ng microwave oven ay may maraming ganitong semi-independenteng gawain: pagsasaayos ng orasan; pagtatakda ng antas ng kuryente; paggamit ng timer; paglilinis at pagpapanatili ng microwave, at iba pa. (Ang mga tagubilin sa paggamit ng kamera ay nakaayos ayon sa mga gawain.)
Ang ilang tagubilin ay may iisang gawain lamang, ngunit may maraming hakbang sa loob ng iisang gawain. Halimbawa, isipin ang isang set ng tagubilin para sa pag-assemble ng swing set ng bata. Sa aking karanasan, may higit sa 130 hakbang! Medyo nakakatakot iyon. Isang magandang paraan ay pag-grupo ng magkakatulad at magkaugnay na hakbang sa mga phase, at magsimulang muli ang pagbibilang sa bawat bagong phase. Ang phase ay isang grupo ng magkakatulad na hakbang sa loob ng iisang gawain. Sa halimbawa ng swing set, ang pagtatayo ng frame ay isang phase; ang pag-angkla sa lupa ay isa pa; ang pag-assemble ng box swing ay isa pa.
Gamitin ang task orientation. Ituon ang pansin sa mga gawain na nais gawin ng iyong mambabasa; gamitin ang how to o –ing na parirala sa mga headings.
Pinakamainam na paraan sa hakbang-hakbang na talakayan. Isa pang konsiderasyon, na maaaring hindi mo matukoy nang maaga, ay kung paano ituon ang iyong mga tagubilin. Sa karamihan ng mga tagubilin, maaari kang magtuon sa mga gawain, o sa mga kagamitan (o katangian ng mga kagamitan).
Sa isang task approach (kilala rin bilang task orientation) sa mga tagubilin sa paggamit ng phone-answering service, magkakaroon ka ng mga seksyong ito:
- pagre-record ng iyong pagbati
- pag-playback ng iyong mga mensahe
- pagsave ng iyong mga mensahe
- pag-forward ng iyong mga mensahe
- pag-delete ng iyong mga mensahe, at iba pa
Ito ay mga gawain—ang tipikal na mga bagay na nais nating gawin gamit ang makina. Para sa karagdagang talakayan, tingnan ang kabanata sa task analysis.
Sa kabilang banda, sa isang tools approach sa mga tagubilin sa paggamit ng photocopier, magkakaroon ng mga hindi karaniwang seksyon:
- copy button
- cancel button
- enlarge/reduce button
- collate/staple button
- copy-size button, at iba pa
Kung gagawa ka ng set ng tagubilin sa ganitong plano, magsusulat ka ng mga hakbang para sa paggamit ng bawat button o katangian ng photocopier. Mahirap gamitin ang tools approach na ito sa tagubilin. Minsan, ang pangalan ng button ay hindi tugma sa gawain na kaugnay nito; minsan, kailangan mong gamitin ang higit sa isang button para matapos ang gawain. Gayunpaman, may mga pagkakataon na mas mainam ang tools/feature approach.
Pagpangkat ng mga gawain. Ang paglista ng mga gawain ay maaaring hindi sapat. Maaaring napakaraming gawain kaya kailangan mo silang pangkatin upang mas madaling mahanap ng mga mambabasa ang bawat isa. Halimbawa, ang mga sumusunod ay karaniwang pagpangkat ng gawain sa mga tagubilin:
- mga gawain sa unpacking at setup
- mga gawain sa pag-install at pag-customize
- mga pangunahing operating tasks
- mga routine maintenance tasks
- mga troubleshooting tasks; at iba pa
Karaniwang Seksyon sa Mga Tagubilin
Ang sumusunod ay isang review ng mga seksyon na karaniwan mong makikita sa mga tagubilin. Huwag ipagpalagay na bawat isa sa kanila ay dapat nasa aktwal na tagubilin na isusulat mo, o na kailangang nasa pagkakasunud-sunod na ipinakita dito, o na ito lamang ang mga posibleng seksyon sa isang set ng tagubilin.
Habang binabasa ang sumusunod tungkol sa karaniwang mga seksyon sa tagubilin, tingnan ang mga halimbawa ng tagubilin.
Schematic view ng mga tagubilin. Tandaan na ito ay isang tipikal o karaniwang modelo para sa nilalaman at organisasyon—marami pang iba ang posible.
Panimula. Planuhin nang maayos ang panimula ng iyong mga tagubilin. Siguraduhing gawin nito ang alinman sa mga sumusunod (ngunit hindi kinakailangang sa pagkakasunud-sunod) na naaangkop sa iyong partikular na tagubilin:
- Tukuyin ang partikular na mga gawain o proseso na ipapaliwanag pati na rin ang saklaw ng coverage (kung ano ang hindi sakop).
- Tukuyin kung ano ang kailangan ng tagapakinig sa kaalaman at background upang maunawaan ang mga tagubilin.
- Magbigay ng pangkalahatang ideya ng proseso at kung ano ang nakakamit nito.
- Tukuyin ang mga kondisyon kung kailan dapat (o hindi dapat) gamitin ang mga tagubilin.
- Magbigay ng pangkalahatang overview ng nilalaman ng mga tagubilin.
Tingnan ang seksyon sa introductions para sa karagdagang talakayan.
Pangunahing babala, pag-iingat, mga abiso ng panganib. Kadalasan, kailangang alertuhin ng mga tagubilin ang mambabasa sa posibilidad na masira ang kanilang kagamitan, magkamali sa proseso, at masaktan ang sarili. Kadalasan, kailangan ding bigyang-diin ng mga tagubilin ang mahahalagang punto o exceptions. Para sa mga sitwasyong ito, gamitin ang special notices—note, warning, caution, at danger notices. Pansinin kung paano ginagamit ang mga special notices sa mga halimbawa ng tagubilin sa itaas.
Teknikal na kaalaman o teorya. Sa simula ng ilang uri ng tagubilin (pagkatapos ng panimula), maaaring kailanganin ang talakayan tungkol sa background ng proseso. Para sa ilang tagubilin, kritikal ang background na ito—kung wala ito, hindi maiintindihan ang mga hakbang sa proseso. Halimbawa, maaaring nagkaroon ka ng karanasan sa mga software applets kung saan tinutukoy mo ang sarili mong kulay sa pamamagitan ng pag-adjust ng red, green, at blue slider bars. Upang talagang maunawaan ang ginagawa mo, kailangan ng background tungkol sa kulay. Gayundin, maaari mong isipin na, para sa ilang tagubilin sa paggamit ng mga camera, maaaring kailangan din ng ilang teorya.
Kagamitan at suplay. Pansinin na karamihan sa mga tagubilin ay naglalaman ng listahan ng mga bagay na kailangan mong tipunin bago simulan ang proseso. Kabilang dito ang kagamitan, ang mga tools na ginagamit sa proseso (tulad ng mixing bowls, spoons, bread pans, hammers, drills, at saws) at suplay, ang mga bagay na nauubos sa proseso (tulad ng kahoy, pintura, langis, harina, at pako). Sa tagubilin, kadalasan ay nakalista ito sa simpleng vertical list o sa two-column list. Gamitin ang two-column list kung kailangan mong magdagdag ng ilang specifications sa ilan o lahat ng items—halimbawa, brand names, laki, dami, uri, model numbers, at iba pa.
Talakayan ng mga hakbang. Kapag nagsusulat ng aktwal na hakbang, may ilang bagay na dapat tandaan: (1) ang estruktura at format ng mga hakbang, (2) karagdagang impormasyon na maaaring kailanganin, at (3) ang pananaw at pangkalahatang estilo ng pagsusulat.
Estruktura at format. Karaniwan, iniisip natin ang set ng tagubilin bilang vertical numbered lists. At karamihan nga ay ganito. Karaniwan, ganito mo i-format ang hakbang-hakbang na tagubilin. May ilang variations, gayundin ang ilang konsiderasyon:
- Fixed-order steps ay mga hakbang na kailangang isagawa sa pagkakasunud-sunod na ipinakita. Halimbawa, kung nagpapalit ka ng langis sa kotse, ang pag-drain ng lumang langis ay hakbang na dapat na mauuna bago ilagay ang bagong langis. Ito ay mga numbered lists (karaniwan, vertical numbered lists).
- Variable-order steps ay mga hakbang na maaaring gawin sa halos anumang pagkakasunud-sunod. Magandang halimbawa ay mga troubleshooting guides na nagsasabi sa iyo na i-check ito, i-check iyon habang sinusubukan mong ayusin ang isang bagay. Maaari mong gawin ang ganitong hakbang sa halos anumang order. Sa ganitong uri, ang bulleted list ang tamang format.
- Alternate steps ay ang mga kung saan dalawang o higit pang paraan upang matapos ang parehong gawain ay ipinapakita. Ginagamit din ang alternate steps kapag maaaring may iba't ibang kondisyon. Gamitin ang bulleted lists sa ganitong uri, may OR sa pagitan ng mga alternatibo, o ang lead-in na nagsasaad na ipapakita ang alternatibo.
- Nested steps. Sa ilang kaso, ang mga indibidwal na hakbang sa loob ng proseso ay maaaring maging kumplikado at kailangang hatiin sa substeps. Sa ganitong kaso, mag-indent nang higit pa at i-sequence ang substeps bilang a, b, c, at iba pa.
- "Stepless" instructions. At sa huli, may mga tagubilin na talagang hindi maaaring gumamit ng numbered vertical list at halos walang diretso o instructional na gabay sa mambabasa. Ang ilang sitwasyon ay kailangang maging generalized o variable kaya hindi maipahayag ang hakbang.
Tingnan ang kabanata sa lists para sa estilo at format ng mga posibilidad na ito.
Karagdagang talakayan. Madalas, hindi sapat na sabihan lamang ang mambabasa na gawin ito o gawin iyon. Kailangan nila ng karagdagang paliwanag tulad ng kung paano dapat magmukha ang bagay bago at pagkatapos ng hakbang; bakit mahalaga ang hakbang na ito; ano ang mekanikal na prinsipyo sa likod ng ginagawa nila; o mas detalyadong micro-level na paliwanag ng hakbang—talakayan ng mga partikular na aksyon na bumubuo sa hakbang.
Ang problema sa karagdagang talakayan, gayunpaman, ay maaari nitong itago ang aktwal na hakbang. Gusto mo na ang aktwal na hakbang—ang partikular na aksyon na gagawin ng mambabasa—ay malinaw. Ayaw mo na ito ay matabunan ng isang bunton ng mga salita. May hindi bababa sa dalawang teknik upang maiwasan ang problemang ito: maaari mong hiwalayin ang tagubilin mula sa karagdagang paliwanag sa magkahiwalay na talata; o maaari mong gawing bold ang tagubilin.
Pag-bold ng aktwal na hakbang ng gumagamit sa mga tagubilin. Nakakatulong ang bold na teksto upang maiba ang aktwal na aksyon mula sa karagdagang impormasyon.
Iwasan ang telegraphic writing—huwag tanggalin ang mga artikulo (the, a, an). Totoo, ganito magsulat ang mga robot, ngunit hindi natin kailangan.)
Estilo ng pagsusulat. Ang paraan ng pagsusulat ng tagubilin, pangungusap kada pangungusap, ay maaaring tila salungat sa itinuro sa iyo ng mga naunang klase sa pagsusulat. Gayunpaman, pansinin kung paano isinusulat ang mga "real-world" na tagubilin—marami silang gumagamit ng imperative (command, o direct-address) na pagsusulat; madalas ding ginagamit ang "you." Ito ay ganap na angkop. Gusto mong kunin ang atensyon ng iyong mambabasa nang buong buo. Dahil dito, ang mga pangungusap sa tagubilin ay maaaring tunog ganito: "Ngayon, pindutin ang Pause button sa front panel upang pansamantalang itigil ang display" at "Dapat kang maging maingat na huwag ..."
Isang partikular na problema ay ang paggamit ng passive voice sa tagubilin. Sa ilang kakaibang dahilan, ang ilang tagubilin ay tunog ganito: "The Pause button should be depressed in order to stop the display temporarily." Hindi lamang natin iniisip ang mental na kalusugan ng Pause button, ngunit iniisip din natin kung sino ang dapat pumindot dito (sinasabi ba ito sa akin?). O isipin ang halimbawa: "The Timer button is then set to 3:00." Muli, bilang taong sumusunod sa tagubiling ito, maaaring hindi mo ito pansinin; maaaring isipin mo na ito ay simpleng reference sa kasalukuyang estado, o maiisip mo, "Sinasabi ba ito sa akin?" Halos kasing problema rin ang paggamit ng third person: "The user should then press the Pause button." Muli, ito ang lumang double-take: tumingin ka sa paligid at iniisip mo, "Ako ba?" (Para sa karagdagang detalye, tingnan ang passive-voice problem.)
Isa pa sa mga tipikal na problema sa estilo ng pagsusulat sa tagubilin ay ang tila kagustuhang tanggalin ang mga artikulo: "Press Pause button on front panel to stop display of information temporarily" o "Earthperson, please provide address of nearest pizza restaurant." Bakit natin ito ginagawa? Lahat ba tayo ay lihim na gustong maging robot? Sa anumang kaso, siguraduhing isama ang lahat ng artikulo (a, an, the) at iba pang salitang karaniwang ginagamit sa tagubilin.
Graphics sa Mga Tagubilin
Marahil higit pa sa anumang ibang anyo ng pagsusulat (maliban siguro sa comic books), napakahalaga ng graphics sa tagubilin. Minsan, hindi kayang ipaliwanag ng salita ang hakbang. Mahalaga ang ilustrasyon sa kakayahan ng mambabasa na i-visualize kung ano ang dapat nilang gawin.
Sa isang kurso sa teknikal na pagsulat, maaaring kailanganin mong isama ang ilustrasyon o iba pang uri ng graphics—anumang karaniwang ginagamit sa tagubilin. Ang problema, siyempre, ay maaaring wala kang access sa angkop na graphics para sa partikular mong tagubilin, at maaaring hindi ka tiwala sa iyong kakayahan sa sining. May mga paraan para malampasan ang mga problemang ito! Tingnan ang mga mungkahi sa graphics. Sa kabanatang iyon, makikita mo hindi lamang mga mungkahi sa paggawa ng graphics, kundi pati rin ang mga kinakailangan sa format nito.
Format sa Mga Tagubilin
Headings. Sa iyong mga tagubilin, gamitin nang maayos ang headings. Karaniwan, gusto mong may headings para sa anumang background section, section ng kagamitan at suplay, pangkalahatang heading para sa aktwal na tagubilin, at subheadings para sa indibidwal na gawain o phase sa loob ng section. Tingnan ang mga halimbawa sa simula ng kabanatang ito. Tingnan ang headings para sa karaniwang requirements.
Lists. Katulad nito, karaniwang gumagamit nang mabigat ng listahan ang tagubilin, lalo na ang numbered vertical lists para sa aktwal na hakbang-hakbang na paliwanag. Ang simpleng vertical lists o two-column lists ay mabuti para sa section ng kagamitan at suplay. Ang in-sentence lists ay mabuti kung nagbibigay ng overview ng mga darating na bagay. Tingnan ang lists para sa karaniwang requirements.
Special notices. Sa tagubilin, dapat alertuhin ang mambabasa sa mga posibilidad kung saan maaaring masira ang kagamitan, masayang ang suplay, mabigo ang buong proseso, masaktan ang sarili o iba—kahit na seryoso o nakamamatay. May mga kompanya na na-sue dahil sa kakulangan ng special notices, sa maling pagkakagawa ng special notices, o sa special notices na nasa maling lugar. Tingnan ang special notices para sa kumpletong talakayan ng wastong paggamit ng special notices pati na rin ang format at paglalagay nito sa tagubilin.
Bilang, abbreviations, at simbolo. Gumagamit din ang tagubilin ng maraming bilang, abbreviations, at simbolo. Para sa mga gabay sa mga ito.
Indentation ng notices sa tagubilin. Sa unang halimbawa, pansinin kung paano naka-indent ang notice sa teksto ng naunang hakbang. Sa pangalawang halimbawa, pansinin na ang malubhang notice ay inilagay sa simula bago ang anumang hakbang.
AI Prompts para sa Mga Tagubilin
Maaaring gamitin ang mga checklists, na karaniwang hindi nababasa, bilang source para sa AI prompts na may ilang modification. Kopyahin ang sumusunod, i-paste sa AI system tulad ng Google's Gemini, at tingnan kung ano ang maaaring hindi mo napansin.
Tandaan: Lahat ng sanggunian sa nilalaman, format, estilo ng application letters o kanilang bahagi ay matatagpuan sa online technical-writing textbook.
Kapag gusto mong gamitin ang AI para suriin ang isang writing project, ipakilala ang iyong sarili, sabihin sa AI kung sino ka at ano ang gusto mo. Bigyan ang AI ng reference point para sa pagsusuri tulad ng online textbook. Pagkatapos, i-post ang gusto mong suriin ng AI.
I-modify ang panimula upang tumugma sa iyong pagkakakilanlan.
|
AI Prompts Instructions Hello, AI. Humihiling ako na suriin mo ang mga tagubilin na isinulat ng isang U.S. college sophomore. Sa ibaba ay isang buod ng mga kabanata ng textbook tungkol sa tagubilin at notices bilang basehan ng iyong pagsusuri. (Identifying information masked):
|
Apreciado ko ang inyong mga opinyon, reaksyon, at kritisismo tungkol sa kabanatang ito: ang iyong sagot—David McMurrey.
