Disenyo ng Dokumentong Teknikal

Sabihin sa amin kung nasaan ka!

Nilalaman ng Seksiyong Ito

Mensahe ng paghahatid
Mga pabalat, mga pahina ng pamagat at etiketa
Talaan ng mga Nilalaman
Talaan ng mga pigura
Abstrak at buod na ehekutibo
Panimula
Katawan ng teknikal na dokumento
Konklusyon
Mga Karugtong
Mga pinagmulan ng impormasyon
Paglalagay ng numero ng pahina
Mga Prompt ng AI para sa mga Pormal na Teknikal na Dokumento

Ang iyong mga komento tungkol sa kabanatang ito

Maghanap!

Mangyaring i-click dito upang tumulong. David McMurrey Magbayad para sa pagho-host ng website:
Mag-donate ng kahit na maliit na halaga na kaya mo!
Mananatiling libre ang online na teknikal na pagsulat.

Ang mga teknikal na dokumento (kabilang ang mga manwal, mga puting papel, at mga gabay) ay may iba't ibang disenyo depende sa industriya, propesyon, o organisasyon. Ipinapakita sa kabanatang ito ang isang tradisyonal na disenyo. Kung kumukuha ka ng kurso sa teknikal na pagsulat, tiyaking katanggap-tanggap ang disenyo na ipinakita sa kabanatang ito. Gayundin kung sumusulat ka ng teknikal na dokumento sa konteksto ng agham, negosyo, o pamahalaan.

Infograpiko na nilikha ng NotebookLM para sa kabanatang ito

Tandaan: Sa loob ng maraming taon, tinukoy ng online na aklat-aralin sa teknikal na pagsulat ang mga ulat nang pangkalahatan bilang halos anumang bagay na naglalaman ng teknikal na impormasyon. Ngunit dahil ang "ulat" ay tumutukoy sa isang tiyak na uri ng dokumentong teknikal, kailangang gawin ang pagbabago sa pangkalahatang tawag na "techdoc," pinaikling salita para sa dokumentong teknikal.

Ang mga techdoc (pangkalahatang pangalan para sa mga teknikal na dokumento) ay may mga espesipikasyon tulad din ng anumang ibang uri ng proyekto. Ang mga espesipikasyon para sa mga techdoc ay sumasaklaw sa layout, organisasyon at nilalaman, format ng mga pamagat at listahan, disenyo ng mga grapiko, at iba pa. Ang bentahe ng isang kinakailangang istruktura at format para sa mga techdoc ay na ikaw o sinuman ay maaaring asahan na idinisenyo ang mga ito sa isang pamilyar na paraan—alam mo kung ano ang dapat hanapin at saan ito hahanapin. Karaniwan binabasa ang mga techdoc nang nagmamadali—nagmamadali ang mga tao na makuha ang impormasyong kailangan nila, ang mga pangunahing katotohanan, ang mga konklusyon, at iba pang mahahalaga. Ang isang karaniwang format ng techdoc ay tulad ng isang pamilyar na kapitbahayan.

Kapag sinusuri mo ang disenyo ng isang dokumentong teknikal, pansinin kung gaano karaming ulit ang ilang mga seksyon. Ang pag-uulit na ito ay may kinalaman sa paraan ng pagbabasa ng mga tao ng mga dokumentong teknikal. Hindi nila binabasa ang mga dokumentong teknikal nang sunud-sunod: maaaring magsimula sila sa buod, maglaktaw-laktaw, at malamang na hindi nila basahin ang bawat pahina. Ang hamon mo ay idisenyo ang mga dokumentong teknikal upang matiyak na matatagpuan ng mga mambabasa ang iyong mga pangunahing katotohanan at konklusyon, gaano man karami sa dokumento ang kanilang basahin o ano pa man ang pagkakasunud-sunod ng kanilang pagbabasa.

Siguraduhing tingnan ang Halimbawa ng mga dokumentong teknikal..

Ang mga karaniwang bahagi ng tipikal na teknikal na ulat ay tinalakay sa kabanatang ito. Ang mga sumusunod na seksyon ay gagabay sa iyo sa bawat isa sa mga bahaging ito, itinuturo ang mga pangunahing katangian. Habang binabasa at ginagamit mo ang mga gabay na ito, tandaan na mga gabay lamang ang mga ito, hindi mga utos. Iba't ibang kumpanya, propesyon, at organisasyon ang may sarili nilang magkakaibang mga patnubay para sa techdocs—; kakailanganin mong iakma ang iyong gawain sa mga iyon pati na rin sa mga ipinakita rito.

Ang mensaheng pagpapadala ay alinman sa isang sulat na pambungad (o memo) o isang e-mail. Ang pisikal na liham (o memo) ay nakalakip sa labas ng teknikal na dokumento gamit ang klips ng papel o nakabuklod sa loob ng teknikal na dokumento. Ang e-mail ay naglalaman ng ugnay sa teknikal na dokumento o ang teknikal na dokumento ay nakalakip. Ito ay isang komunikasyon mula sa iyo—ang manunulat ng teknikal na dokumento—patungo sa tatanggap, ang taong humiling ng teknikal na dokumento at na maaaring nagbabayad pa sa iyo para sa iyong ekspertong konsultasyon. Sa esensya, sinasabi nito, "Sige, narito ang teknikal na dokumentong napagkasunduan nating tatapusin ko pagsapit ng ganoong petsa. Sa madaling sabi, naglalaman ito ng ito at iyon, ngunit hindi nito saklaw ang ito at iyon. Ipaalam sa akin kung ito ay tumutugon sa iyong mga pangangailangan." Ipinapaliwanag ng mensaheng pagpapadala ang konteksto—ang mga pangyayaring nagbunsod ng teknikal na dokumento. Naglalaman ito ng impormasyon tungkol sa teknikal na dokumento na hindi nararapat ilagay sa mismong teknikal na dokumento.

Mga halimbawa ng liham ng paghahatid at mensahe ng paghahatid.

Sa halimbawa ng liham ng paglilipat, pansinin ang karaniwang pormat ng liham-pangnegosyo. Kung susulat ka ng panloob na dokumentong teknikal, gamitin sa halip ang pormat ng memorandum; sa alinmang kaso, magkapareho ang mga nilalaman at ang organisasyon:

Unang talata. Binabanggit ang pangalan ng dokumentong teknikal, at inilalagay ito sa italiko. Binabanggit din nito ang petsa ng kasunduan para isulat ang dokumentong teknikal.

Gitnang talata. Nakatuon sa layunin ng dokumentong teknikal at nagbibigay ng maikling pangkalahatang-ideya ng mga nilalaman nito.

Pangwakas na talata. Hinahikayat ang mambabasa na makipag-ugnayan kung mayroon silang mga tanong, komento, o alalahanin. Nagtatapos ito sa isang kilos ng mabuting kalooban, na nagpapahayag ng pag-asa na masisiyahan ang mambabasa sa teknikal na dokumento.

Tulad ng sa anumang ibang elemento sa dokumentong teknikal, maaaring kailanganin mong baguhin ang nilalaman ng mensaheng ito (o memo) para sa mga tiyak na sitwasyon. Halimbawa, maaaring gusto mong magdagdag ng isa pang talata na naglilista ng mga tanong na nais mong isaalang-alang ng mga mambabasa habang sinusuri nila ang dokumentong teknikal.

Kung ang iyong teknikal na dokumento ay higit sa sampung pahina, lagyan ito ng binding sa anumang paraan at gumawa ng etiketa para sa pabalat.

Mga takip

Ang mga pabalat ay nagbibigay sa mga dokumentong teknikal ng matibay at propesyonal na anyo pati na rin ng proteksyon. Maaari kang pumili mula sa maraming uri ng pabalat. Isaisip ang mga tip na ito:

• Lubhang hindi katanggap-tanggap ang mga malinaw (o makulay) na plastik na slip case na may plastik na manggas sa kaliwang gilid. Parang galing ito sa kurso ng Ingles para sa mga freshman; dagdag pa, nakakainis silang gamitin—kailangang magsumikap ang mga mambabasa na panatilihing bukas ang mga ito at makipagbuno sa static na kuryenteng nalilikha nila.
• Katanggap-tanggap nang bahagya ang mga takip kung saan nagbubutas ka ng mga pahina, inilalagay ang mga ito, at binabaluktot pababa ang mga brad. Kung gagamit ka ng ganitong uri, mag-iwan ng karagdagang kalahating pulgadang puwang sa kaliwang gilid upang hindi na kailangang pilasin pa ng mga mambabasa ang mga pahina. Siyempre, pinipigilan ng ganitong uri ng takip na humiga nang patag ang mga pahina: kailangan gumamit ng magagamit na mga bagay o ng iba't ibang bahagi ng katawan ang mga mambabasa upang pabigatin ang mga pahina.
• Ang pinakamagandang mga pabalat, sa lahat, ay yaong nagpapahintulot na ang mga dokumentong teknikal ay manatiling nakabukas nang mag-isa (tingnan ang ilustrasyon sa susunod na seksyon). Napakalaking ginhawa kapag ang isang dokumentong teknikal ay nakabukas sa iyong kandungan o sa iyong mesa. Ang ganitong uri ay gumagamit ng plastik na spiral para sa pagkakabuklod at makapal na papel na card-stock para sa mga pabalat. Kumunsulta sa iyong lokal na copy shop tungkol sa mga ganitong uri ng pagkakabuklod; mura ang mga ito at nagpapataas ng propesyonalismo ng iyong gawa. Tingnan ang simuladong halimbawa ng plastik na spiral na pagkakabuklod sa sumusunod.

Karaniwang hindi mas kanais-nais ang mga loose-leaf na notebook o mga ring binder. Masyadong malaki ang mga ito para sa maiikling mga teknikal na dokumento, at kadalasang napupunit ang mga butas ng pahina. Siyempre, pinapadali ng ring binder ang pagpapalit ng mga pahina; kung ganoon ang magiging gamit ng iyong teknikal na dokumento, magandang pagpipilian ito. Sa "mataas na uri" naman ang mga sobra namang marangyang pabalat na may artipisyang balat na itsura at gintong kulay na palamuti. Iwasan ang mga iyon—panatilihin itong payak, walang palamuti, at praktikal.

Pahina ng Pamagat

Sa pinakasimpleng anyo, ang pamagat ng techdoc ay isang kopya ng nasa harapang pabalat—marahil na may ilang karagdagang detalye.

Tingnan ang pahina ng pamagat. Abstrak at Buod para sa mga Ehekutibo.

Mga etiketa

Tiyaking gumawa ng etiketa para sa pabalat ng iyong dokumentong teknikal. Ito ay isang hakbang na nakakaligtaan ng ilang mga manunulat ng dokumentong teknikal. Kung walang etiketa, ang dokumentong teknikal ay walang pagkakakilanlan; hindi ito pinapansin.

Ang pinakamagandang paraan para gumawa ng label ay gamitin ang iyong programa sa pagpoproseso ng salita upang idisenyo ito sa isang karaniwang pahina na may kahon na may grapiko sa paligid ng impormasyon ng label. I-print ito, pagkatapos ay pumunta sa isang kopyahan at ipakopya nang direkta sa pabalat ng dokumentong teknikal.

Hindi masyadong marami ang inilalagay sa label: ang pamagat ng techdoc, ang iyong pangalan, ang pangalan ng iyong organisasyon, isang numero ng pagsubaybay ng techdoc, at isang petsa. Walang mga pamantayang kinakailangan para sa label, bagaman dapat magkaroon ang iyong kumpanya o organisasyon ng sarili nitong mga kinakailangan. (Ipinapakita sa ibaba ang isang halimbawa ng label ng techdoc.)

Liham ng Pagpapadala at pabalat ng dokumentong teknikal (may etiketa sa pabalat).

Karamihan sa mga teknikal na techdocs ay naglalaman ng hindi bababa sa isang abstrak — kung minsan dalawa, kung saan ang mga abstrak ay may magkakaibang papel. Ibinubuod ng mga abstrak ang nilalaman ng isang techdoc, ngunit ang iba't ibang uri ay gumagawa nito sa magkaibang paraan:

• Deskriptibong abstrak. Ang uri na ito ay nagbibigay ng isang pangkalahatang-ideya ng layunin at nilalaman ng dokumentong teknikal. Sa ilang mga disenyo ng dokumentong teknikal, ang deskriptibong abstrak ay inilalagay sa ilalim ng pahina ng pamagat, tulad ng ipinapakita sa sumusunod:
  
  
  Deskriptibong abstrakAyon sa tradisyon, karaniwang inilalagay ito sa pahina ng pamagat (hindi sa pabalat).
• Buod ng Eksekutibo. Isa pang karaniwang uri ay ang executive summary, na nagbubuod din ng mga pangunahing katotohanan at konklusyon na nakapaloob sa dokumentong teknikal. Tingnan ang halimbawang ipinapakita sa sumusunod. Parang ginamit mo ang dilaw na highlighter upang markahan ang mga pangunahing pangungusap sa dokumentong teknikal at saka inilipat ang lahat ng ito sa isang hiwalay na pahina at inedit para maging mas madaling basahin. Kadalasan, ang mga executive summary ay nasa isang-sampu hanggang isang-dalawampung bahagi ng haba ng mga dokumentong teknikal na may sampu hanggang limampung pahina. Para sa mas mahahabang dokumentong teknikal—yaong higit sa limampung pahina—hindi dapat lumampas sa dalawang pahina ang executive summary. Ang punto ng executive summary ay magbigay ng buod ng dokumentong teknikal—isang bagay na maaaring mabilis na basahin.

Kung ang pang-ehekutibong buod, panimula, at mensaheng pangpapadala ay tila paulit-ulit sa iyo, tandaan na hindi naman palaging nagsisimula ang mga mambabasa sa simula ng isang dokumentong teknikal at binabasa ito nang paisa-isa hanggang sa dulo. Lumalaktaw-laktaw sila: maaaring silipin nila ang talaan ng mga nilalaman; karaniwang mabilis nilang binabasa ang pang-ehekutibong buod para sa mahahalagang katotohanan at konklusyon. Maaaring isa o dalawang bahagi lamang mula sa katawan ng dokumentong teknikal ang kanilang basahing mabuti, at pagkatapos ay laktawan ang natitira. Dahil dito, dinisenyo ang mga dokumentong teknikal na may ilang pag-uulit upang matiyak na makikita ng mga mambabasa ang mahalagang impormasyon kahit saan man nila buksan ang dokumento.

Talaan ng Nilalaman (na nauuna), pagkatapos ang Ehekutibong Buod.

Talaan ng Nilalaman

Anuman ang format ng talaan ng nilalaman (TOC) na iyong gamitin, ito ang mga karaniwang pamantayan:

• Simulang numero ng pahina lamang. Bagaman ang ilang awtomatikong tagabuo ng talaan ng nilalaman (TOC) ay nagpapakita ng saklaw ng mga pahina, ang pamantayan ay ang unang numero ng pahina lamang.
• Mga antas ng pamagat na isasama. Tulad ng ipinakita sa Talahanayan ng Nilalaman (TOC) sa itaas, ipakita ang dalawang pinakamataas na antas ng mga pamagat maliban kung maraming mga subpamagat ang teknikal na dokumento. Dapat magbigay ang Talahanayan ng Nilalaman ng isang paraan na, sa isang sulyap, madaling makahanap ng impormasyon.
• Pagkakaespasyo at kapitalisasyon. Pansinin kung paano naka-indent ang mga item ng teksto sa Talaan ng Nilalaman (TOC) sa itaas. Ang mga pamagat ng unang antas ay nasa buong malalaking titik; ang mga pamagat ng ikalawang antas ay naka-kapital ang unang titik ng bawat pangunahing salita; ang mga pamagat ng ikatlong antas ay gumagamit ng istilong kapital ng pangungusap.
• Patayong pagitan. Pansinin na ang mga seksyon sa unang antas ay may karagdagang puwang sa itaas at ibaba, na nagpapadali sa pagbabasa.

Mga tuldok na tagapag-ugnay at mga numero ng pahina na naka-ayos sa kanan. Para sa tradisyonal na Talaan ng Nilalaman (TOC) na gumagamit ng mga tuldok na gabay at mga numero ng pahina na naka-ayos sa kanan:

Pagkahanay sa kanan. Sa halimbawang ito, pansinin na ang mga tuldok na "leader" ay "nag-aakay" patungo sa mga numero ng pahina na nakahanay sa kanan.


Mga tuldok na gabay at mga numero ng pahina na nakahanay sa kanan.

Ang Talahanayan ng Nilalaman (TOC) na ito ay gumagamit ng decimal na istilo ng pag‑numero para sa mga bilang ng kabanata at seksyon, na karaniwan sa mga teknikal na dokumento. Ang iba sa librong ito ay gumagamit ng estilong malalaking numerong Romano para sa mga pangunahing kabanata lamang (tingnan ).

Nahihirapan bang gumawa ng maayos na naka-format na Talaan ng Nilalaman (TOC)? Tingnan Gumawa ng isang talaan ng mga nilalaman na may propesyonal na hitsura.

Mga kuwit at mga numero ng pahina. Kung ang format na may leader-dot ay hindi kinakailangan at mas gusto mong iwasan ito, maaari mong gamitin ang karaniwang tinatanggap na format na ito:

3. MGA PANGUNAHING PRINSIPYO NG KAHUSAYAN SA PAGGAMIT NG ENERHIYA, 5 Mga Estratehiya ng Pasibong Disenyo, Anim Mga Aktibong Sistema ng Enerhiya, pito Integrasyon ng Nababagong Enerhiya, 9 4. MGA PAMANTAYAN AT SERTIPIKASYON, 11 LEED, labing-isa Energy Star, labindalawa Hamon ng Nabubuhay na Gusali, labing-apat

Simpleng teksto ng talaan ng nilalaman na may mga kuwit at numero ng pahina.

Talaan ng mga Larawan at Talahanayan

Ang listahan ng mga pigura ay may maraming parehong pagsasaalang-alang sa disenyo tulad ng talaan ng nilalaman. Ginagamit ng mga mambabasa ang listahan ng mga pigura upang hanapin ang mga ilustrasyon, diagram, talahanayan, at tsart sa iyong teknikal na dokumento.

Nagkakaroon ng mga komplikasyon kapag mayroon kang parehong mga talahanayan at mga pigura. Sa mahigpit na pagsasalita, ang mga pigura ay mga ilustrasyon, mga guhit, mga larawan, mga grap, at mga tsart. Ang mga talahanayan ay mga hilera at kolum ng mga salita at numero; hindi sila itinuturing na mga pigura.

Para sa mas mahahabang teknikal na dokumento na naglalaman ng tig-dosenang pigura at talahanayan, gumawa ng magkahiwalay na mga listahan ng mga pigura at mga talahanayan. Ilagay silang magkasama sa parehong pahina kung magkakasya, tulad ng ipinapakita sa ilustrasyon sa ibaba. Maaari mong pagsamahin ang dalawang listahan sa ilalim ng pamagat na "Listahan ng mga Pigura at mga Talahanayan," at tukuyin ang mga item bilang pigura o talahanayan tulad ng nasa ilustrasyon sa ibaba.

Panimula

Isang mahalagang elemento ng anumang dokumentong teknikal ay ang panimula—siguraduhing malinaw sa iyo ang tunay nitong layunin at mga nilalaman. Sa isang dokumentong teknikal, inihahanda ng panimula ang mambabasa upang basahin ang pangunahing katawan ng dokumentong teknikal. Tingnan mga pagpapakilala para sa isang talakayan tungkol sa pagsulat ng mga pambungad.

Tingnan ang halimbawang ito ng isang panimula:


Listahan ng mga pigura at talahanayan na sinundan ng panimula.

Kung walang mga talahanayan, gawing 'Listahan ng mga Figura.' Sa isang kurso sa teknikal na pagsulat, tanungin ang iyong instruktor kung kinakailangan ang desimal na istilo ng pag-numero para sa mga pamagat.

Katawan ng dokumentong teknikal

Ang katawan ng techdoc ay siyempre ang pangunahing teksto ng techdoc, ang mga seksyon sa pagitan ng panimula at konklusyon. Ipinapakita sa ibaba ang mga halimbawa ng pahina.

Mga pamagat

Maliban sa pinakamaikling mga teknikal na dokumento (dalawang pahina o mas kaunti pa), gumamit ng mga pamagat upang markahan ang iba't ibang mga paksa at subpaksa na tinatalakay. Pinahihintulutan ng mga pamagat ang mga mambabasa na mabilis na i-scan ang iyong teknikal na dokumento at tumalon sa mga bahagi kung saan inilalahad mo ang impormasyong kanilang hinahanap. Tingnan mga pamagat para sa mga alituntunin tungkol sa mga heading.

Mga naka-bullet at naka-number na listahan

Sa katawan ng isang dokumentong teknikal, gumamit din ng mga listahang may bullet, mga naka-bilang na listahan, at mga listahang may dalawang kolum kapag naaangkop. Nakakatulong ang mga listahan sa pamamagitan ng pagbibigay-diin sa mga pangunahing punto, pagpapadali sa pagsunod sa impormasyon, at paghahati-hati sa malalaking pader ng teksto. Tingnan mga listahan para sa mga patnubay tungkol sa mga listahan.

Mga Simbolo, Mga Numero, at Mga Pagdadaglat

Ang mga teknikal na talakayan ay karaniwang naglalaman ng maraming simbolo, numero, at mga daglat. Tandaan na iba ang mga patakaran sa paggamit ng mga numero kaysa sa paggamit ng mga salita sa teknikal na mundo. Ang lumang panuntunan na isulat nang salita ang lahat ng numero na mas mababa sa 10 ay hindi palaging nalalapat sa mga teknikal na dokumento. (Tingnan mga numero laban sa mga salita para sa mga alituntunin.)


Maliban sa katawan ng isang teknikal na dokumento.

Sa isang kurso sa teknikal na pagsulat, tanungin ang iyong instruktor kung kinakailangan ang istilong desimal ng pagpapanumero para sa mga pamagat. Gayundin, maaaring kailanganin ang ibang sistema ng dokumentasyon—hindi ang IEEE, na para sa mga inhinyero.

Mga Grapiko at Mga Pamagat ng Figura

Sa mga dokumentong teknikal, malamang kakailanganin mo ang mga guhit, diagram, talahanayan, at tsart. Hindi lamang nito naipapahayag ang ilang uri ng impormasyon nang mas epektibo, nagbibigay din ito sa iyong dokumentong teknikal ng mas propesyonal at awtoritatibong anyo. Kung hindi ka pa nakapaglagay ng ganitong mga grapiko sa isang dokumento, may ilang medyo madaling paraan para gawin ito—hindi mo kailangang maging isang propesyonal na artistang grapiko. Para sa mga estratehiya sa pagdaragdag ng mga grapiko sa s, tingnan mga grapiko. Para sa mga estratehiya sa pagdaragdag ng mga talahanayan sa s, tingnan mga mesa.

Mga Sanggunian na Magkakaugnay

Maaaring kailanganin mong ituro sa mga mambabasa ang mga malapit na kaugnay na impormasyon sa loob ng iyong mga techdo, o sa iba pang mga pinagkukunan ng impormasyon na may kaugnay na nilalaman. Tinatawag ang mga ito mga sanggunian na tumutukoy sa ibang bahagi. Halimbawa, maaari nilang ituro ang mga mambabasa mula sa talakayan ng isang mekanismo patungo sa isang ilustrasyon nito. Maaari rin nilang ituro ang mga mambabasa sa isang apendiks kung saan ibinibigay ang mga panimulang impormasyon tungkol sa isang paksa (mga panimulang impormasyon na talagang hindi kasya sa teksto). At maaari nilang ituro ang mga mambabasa sa labas ng iyong dokumentong teknikal sa iba pang impormasyon—to mga artikulo, dokumentong teknikal, at mga libro na naglalaman ng impormasyon na may kaugnayan sa iyong dokumento. Kapag lumikha ka ng mga cross-reference, sundin ang mga alituntuning ito na ipinakita sa mga sanggunian sa ibang bahagi.

Mga Konklusyon

Para sa karamihan ng mga dokumentong teknikal, kailangan mong isama ang isang huling seksyon. Kapag pinaplano mo ang huling seksyon ng iyong dokumentong teknikal, isipin ang mga tungkuling maaari nitong gampanan kaugnay ng iba pang bahagi ng dokumento. Ipinapakita ang mga ideya para sa mga huling seksyon sa mga konklusyon.

Mga Apendise

Ang mga apendiks ay yaong mga karagdagang seksyon na sumusunod sa konklusyon. Ano ang inilalagay mo sa mga apendiks? —anumang bagay na hindi komportableng magkasya sa pangunahing bahagi ng teknikal na dokumento ngunit hindi rin maaaring hindi isama sa teknikal na dokumento. Karaniwang ginagamit ang apendiks para sa malalaking talahanayan ng datos, malalaking bahagi ng halimbawang kodigo, fold-out na mga mapa, mga background na masyadong batayan o masyadong advanced para sa katawan ng teknikal na dokumento, o malalaking ilustrasyon na hindi kasya sa katawan ng teknikal na dokumento. Anumang bagay na sa palagay mo ay masyadong malaki para sa pangunahing bahagi ng teknikal na dokumento, o na sa palagay mo ay makagugulo at makakaputol sa daloy ng teknikal na dokumento, ay isang magandang kandidato para sa isang apendiks. Pansinin na bawat isa ay binibigyan ng isang titik (A, B, C, at iba pa).

Mga Pinagmulan ng Impormasyon

Ang pagdodokumento ng iyong mga pinagkukunan ng impormasyon ay tungkol sa pagtatatag, pagpapanatili, at pagpaprotekta ng iyong kredibilidad sa propesyon. Dapat mong banggitin ("idokumento") ang hiniram na impormasyon, anuman ang anyo o porma ng iyong pagpresenta nito. Kung direktang sinipi mo ito, ipinaliwanag mo gamit ang ibang salita (paraphrase), o pinabuod mo ito—ito ay hiniram pa ring impormasyon. Kahit ito ay nagmula sa isang libro, artikulo, diagram, talahanayan, web page, brochure ng produkto, o mula sa isang eksperto na ininterbyu mo nang personal—ito ay hiniram pa ring impormasyon.

Nag-iiba ang mga sistema ng dokumentasyon ayon sa mga propesyonal at larangan. Gumagamit ang mga inhinyero ng sistemang IEEE, na ang mga halimbawa ay ipinapakita sa buong kabanatang ito. Isa pang karaniwang ginagamit na sistema ng dokumentasyon ang ibinibigay ng American Psychological Association (APA). Tingnan dokumentasyon para sa mga detalye.

Paglalagay ng numero ng pahina

Ang istilo ng pagbibilang ng pahina sa tradisyunal na disenyo ng teknikal na dokumento ay naiiba mula sa kontemporaryong disenyo ng teknikal na dokumento, lalo na dahil sa tradisyunal na paggamit ng maliliit na numerong Romano sa panimulang bahagi (lahat ng mga bahagi bago ang introduksyon).

• Ang lahat ng pahina sa dokumentong teknikal (sa loob ngunit hindi kasama ang pabalat sa harap at likod) ay may mga numero; ngunit sa ilang mga pahina, hindi ipinapakita ang mga numero.
• Sa kontemporaryong disenyo, ang lahat ng pahina sa buong dokumento ay gumagamit ng mga arabikong numero; sa tradisyunal na disenyo, ang lahat ng pahina bago ang introduksyon (unang pahina ng katawan ng ) ay gumagamit ng maliliit na numerong Romano.
• Sa mga espesyal na pahina, tulad ng pahina ng pamagat at unang pahina ng panimula, hindi ipinapakita ang mga numero ng pahina.
• Maaaring ilagay ang mga numero ng pahina sa isa sa ilang mga bahagi ng pahina. Karaniwan, ang pinakamahusay at pinakamadaling pagpipilian ay ilagay ang mga numero ng pahina sa gitnang ibaba ng pahina (tandaan na itago ang mga ito sa mga espesyal na pahina).
• Kung inilagay mo ang mga numero ng pahina sa itaas ng pahina, dapat mong itago ang mga ito sa mga pambukas ng kabanata o seksyon kung saan nasa itaas ng pahina ang isang heading o pamagat.

Paalala: Ang mas mahahabang dokumentong teknikal ay madalas gumagamit ng istilo ng pag-numero ng pahina na kilala bilang folio-bawat-kabanata o doble-enumerasyon (halimbawa, ang mga pahina sa Kabanata 2 ay mabibilang bilang 2-1, 2-2, 2-3, at iba pa). Gayundin, gagamitin ng mga talahanayan at pigura ang ganitong istilo ng pag-numero. Pinapadali ng istilong ito ang proseso ng pagdaragdag at pagtanggal ng mga pahina.

Mga Prompt ng Artipisyal na Intelihensiya para sa Dokumentasyong Teknikal

Ang mga talaan ng pagsuri, na karaniwang hindi nababasa, ay maaaring gamitin bilang pinagmulan ng mga prompt para sa AI kung bahagyang babaguhin. Kopyahin ang sumusunod, idikit ito sa isang sistema ng AI tulad ng Gemini ng Google, at tingnan kung ano ang maaaring napalampas mo.

Paalala: Lahat ng sanggunian hinggil sa nilalaman, format, at estilo ng mga liham ng aplikasyon o ng kanilang mga bahagi ay matatagpuan sa online na aklat-aralin sa teknikal na pagsulat.

Mga Prompt ng AI para sa mga Dokumentong Teknikal Kapag gusto mong tasahin ng AI ang isang proyekto sa pagsulat, magpakilala, sabihin sa AI kung sino ka at kung ano ang gusto mo. Bigyan ang AI ng isang sanggunian para sa paggawa ng mga pagtatasa, tulad ng isang online na aklat-aralin. Pagkatapos, ilagay kung ano ang gusto mong suriin ni Gemini sa kanyang pagtatasa. Narito ang isang halimbawa: Kumusta, AI. Ako si David McMurrey, isang estudyante ng kiberseguridad sa Austin Community College (Austin, Texas). Hinihiling ko na suriin mo ang sumusunod na teknikal na dokumento gamit ito online na aklat-aralin at ang mga sumusunod na tanong: Naglalaman ba ang techdoc (ulat) ng mga sumusunod (maayos ang pagkaka-format) sa ganitong pagkakasunod-sunod: mensaheng paghahatid; pahina ng pamagat; talaan ng mga nilalaman; listahan ng mga pigura, talahanayan, o pareho; panimula; mga seksyon ng katawan (mga kabanata); mga apendiks (kung kinakailangan); mga pinagmulan ng impormasyon; likod na pabalat (kung kinakailangan). Para sa mga detalye, tingnan Disenyo ng teknikal na dokumentasyon. Bagaman maaari itong maging matalino at mapaglaro, ipinapahiwatig ba ng pamagat ng dokumentong teknikal nang sapat ang paksa nito? Para sa mga detalye, tingnan Mga pamagat ng dokumentong teknikal. Kung ang talaan ng nilalaman at talaan ng mga pigura (at talahanayan) ay gumagamit ng mga tuldok na humahantong, ang mga numero ng pahina ba ay nakahanay sa kanan? Kung ang talaan ng nilalaman at talaan ng mga pigura (at talahanayan) ay naglalagay ng mga numero ng pahina sa kanang gilid ng pahina, ginagamit ba ang mga tuldok na humahantong? Para sa mga detalye, tingnan Mga Talaan ng Nilalaman at Listahan ng mga Larawan (Mga Talahanayan). Tinatalakay ba ng pambungad nang sapat ang paksa, layunin, at itinakdang mambabasa ng dokumentong teknikal? Nagbibigay ba ito ng listahan ng mga subtopiko na tatalakayin at isang indikasyon ng saklaw (ano ang hindi sakop)? Para sa mga detalye, tingnan Mga Pagpapakilala. Naglalaman ba ang teknikal na dokumentong ito ng sapat na mga detalye, mga partikular, mga halimbawa—anumang kinakailangan upang ipaliwanag ang mga pahayag, ang mga pangkalahatan? Kung isinasaalang-alang ang paksa, layunin, at mambabasa, may mga mahahalagang nilalaman bang nawawala sa dokyumentong teknikal na ito? Mayroon bang mga nilalaman na hindi kinakailangan? Mayroon bang anumang impormasyon sa dokyumentong teknikal na ito na teknikal na mali? Mayroon bang anumang kritikal na teknikal na impormasyon na kulang? Naglalaman ba ang dokumentong teknikal na ito ng anumang halatang hiniram na impormasyon na hindi naidokumento sa anumang paraan? Ang mga citation (mga sanggunian sa mga item sa listahan ng mga pinagkukunan ng impormasyon) ba ay lumalabas sa katawan ng techdoc na naka-format ayon sa estilo ng APA, MLA, o binagong estilo ng IEEE? Ang mga item ba sa listahan ng mga pinagkukunan ng impormasyon ay naka-format ayon sa estilo ng APA, MLA, o binagong estilo ng IEEE? Para sa mga detalye, tingnan Dokumentasyon: mga pinagkunang impormasyong hiniram. Mayroon bang paglalarawang pamagat (caption) at pinagmulan (kung kinakailangan) ang lahat ng talahanayan at mga pigurang hindi pampalamuti? Para sa mga detalye, tingnan Mga pamagat ng talahanayan. Nasa kasing lapit hangga't maaari ba ang lahat ng mga talahanayan at mga pigurang hindi pandekorasyon sa kanilang kaugnay na teksto? Nagaganap ba ang mga maiiksing pagpapaliwanag na pagtukoy sa ibang bahagi bago ang mga talahanayan at mga pigurang hindi dekoratibo? Para sa mga detalye, tingnan Mga paliwanag na sanggunian. May ginagamit bang pamantayang format para sa mga heading at subheading sa katawan ng dokumentong teknikal? Para sa mga detalye, tingnan Mga Pamagat. Nagsisimula ba ang mga pangunahing seksyon (mga kabanata) ng dokumentong teknikal sa isang bagong pahina sa mga naka-print na bersyon? Ginagamit ba ang mga naka-number na patayong listahan para sa mga item ng listahan na nangangailangan ng tiyak na pagkakasunod-sunod? Ginagamit ba ang mga patayong listahang may panandang tuldok para sa mga item ng listahan na walang kinakailangang pagkakasunod-sunod? Ginagamit ba ang mga panimulang pahayag bago ang lahat ng mga listahan? Para sa mga detalye, tingnan Mga patayong listahan. Ang mga direktang sipi ba ay may nakatalagang pinagmulan, at tama ba ang pagkakabantas ng mga atribusyon? Ang lahat ba ng direktang sipi, mga buod, at muling pagpapahayag ay wastong nasusipi ayon sa estilo ng APA, MLA, o binagong istilong IEEE? Para sa mga detalye, tingnan Mga sipi at pagkilala sa pinagmulan. Malaya ba ang teksto ng dokumentong teknikal mula sa mga pagkakamali sa balarila, paggamit, at bantas? Para sa mga detalye, tingnan Mga Karaniwang Problema sa Balarila, Paggamit, at Pagbaybay. Malaya ba ang teksto ng teknikal na dokumento mula sa labis na paggamit ng mga salita at iba pang mga pagkakamali sa estilo ng pangungusap? Para sa mga detalye, tingnan Kalabisan ng mga salita, iba pang mga problema sa istilo ng pangungusap. Maiintindihan ba ng target na mambabasa (tulad ng ipinahiwatig sa mensahe ng paghahatid at sa pambungad) ang teknikal na dokumentong ito? Para sa mga detalye, tingnan Pagsusuri ng madla, at tingnan Pagsasalin ng Teknikal. AI, upang kumpletuhin ang iyong pagsusuri ng aking dokumentong teknikal, magtalaga ng numerikong marka mula 100 hanggang 55).

Kaugnay na Impormasyon

Talaan ng Nilalaman: Isang Mahalagang Kasangkapan sa Organisasyon para sa mga Mambabasa

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