Pakiclick dito upang tumulong David McMurrey bayaran para sa web hosting:
Magdonate ng kahit anong maliit na halaga na kaya mo!
Mananatiling libre ang Online Technical Writing.
Ang mga teknikal na dokumento (kasama ang mga handbook, puting papel at mga gabay) ay may iba't ibang disenyo depende sa industriya, propesyon, o organisasyon. Ipinapakita ng 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. Ganito rin ang katotohanan kung ikaw ay sumusulat ng isang teknikal na dokumento sa konteksto ng agham, negosyo, o gobyerno.
Infographic na ginawa ng NotebookLM para sa kabanatang ito
Tandaan: Sa loob ng maraming taon, ang online na aklat tungkol sa teknikal na pagsusulat ay karaniwang tinutukoy ang mga ulat bilang halos anumang naglalaman ng teknikal na impormasyon. Ngunit dahil ang "ulat" ay tumutukoy sa isang tiyak na uri ng teknikal na dokumento, kailangan na itong palitan ng pangkaraniwang "techdoc," na pananggalan para sa teknikal na dokumento.
Ang mga Techdocs (pangkalahatang pangalan para sa mga teknikal na dokumento) ay may mga espesipikasyon katulad ng anumang uri ng proyekto. Ang mga espesipikasyon para sa techdocs ay kinabibilangan ng layout, organisasyon at nilalaman, pormat ng mga pamagat at listahan, disenyo ng mga graphics, at iba pa. Ang bentahe ng isang kinakailangang estruktura at pormat para sa techdocs ay na maaari mong asahan na ang mga ito ay idinisenyo sa isang pamilyar na paraan—alam mo kung ano ang hahanapin at kung saan ito hahanapin. Karaniwang binabasa ang mga techdocs nang mabilisan—ang mga tao ay nagmamadali upang makuha ang impormasyong kailangan nila, ang mga pangunahing katotohanan, ang mga konklusyon, at iba pang mahahalaga. Ang isang pamantayang pormat ng techdoc ay parang pamilyar na kapitbahayan.
Kapag sinusuri mo ang disenyo ng isang techdoc, pansinin kung gaano ka-ulit-ulit ang ilan sa mga seksyon. Ang pag-uulit na ito ay may kinalaman sa kung paano nagbabasa ang mga tao ng mga techdoc. Hindi sila nagbabasa ng techdoc nang diretso: maaaring magsimula sila sa executive summary, laktawan ang ilang bahagi, at malamang na hindi mabasa ang bawat pahina. Ang hamon mo ay disenyo ng mga techdoc upang ang mga mambabasa ay makatagpo sa iyong mga pangunahing katotohanan at konklusyon, anuman kung gaano karaming bahagi ng techdoc ang kanilang binasa o sa kung anong pagkakasunud-sunod nila ito binasa.
Siguraduhing makita ang halimbawa ng techdocs.
Tinalakay sa kabanatang ito ang mga karaniwang bahagi ng tipikal na teknikal na ulat. Ang mga sumusunod na seksyon ay nagbibigay ng gabay sa bawat isa sa mga bahaging ito, na itinuturo ang mga pangunahing katangian. Habang binabasa at ginagamit mo ang mga patnubay na ito, tandaan na ito ay mga patnubay, hindi mga utos. Iba't ibang kumpanya, propesyon, at organisasyon ang may kanya-kanyang iba't ibang patnubay para sa techdocs— kailangan mong iakma ang iyong kasanayan sa mga iyon pati na rin sa mga ipinakita rito.
Mensaheng Tanggapin
Ang mensahe ng pagpapadala ay maaaring isang liham (o memo) o isang e-mail. Ang pisikal na liham (o memo) ay maaaring nakalakip sa labas ng techdoc gamit ang paper clip o nakabuklod sa loob ng techdoc. Ang e-mail ay naglalaman ng link sa techdoc o ang techdoc na nakalakip. Ito ay isang komunikasyon mula sa iyo—ang manunulat ng techdoc—patungo sa tatanggap, ang taong humiling ng techdoc at maaaring nagbabayad sa iyo para sa iyong ekspertong konsultasyon. Sa madaling salita, sinasabi nito na "Okay, narito ang techdoc na napagkasunduan naming tapusin ko ng ganito at ganyan na petsa. Sa madaling salita, naglalaman ito ng ganito at ganyan, ngunit hindi ito sumasaklaw sa ganito o ganyan. Ipaalam sa akin kung natutugunan nito ang iyong mga pangangailangan." Ang mensahe ng pagpapadala ay naglalarawan ng konteksto—ang mga kaganapang nagdala sa techdoc. Naglalaman ito ng impormasyon tungkol sa techdoc na hindi nararapat na nakapaloob sa techdoc.
Mga halimbawa ng liham ng pagpapasa at mensahe ng pagpapasa.
Sa halimbawa ng liham na pagpapadala, mapapansin ang karaniwang format ng liham pang-negosyo. Kung magsusulat ka ng isang panloob na techdoc, gamitin ang format ng memorandum sa halip; sa alinmang kaso, magkapareho ang nilalaman at organisasyon:
Unang talata. Binanggit ang pangalan ng techdoc, ilalagay ito sa _kursibo_. Binanggit din ang petsa ng kasunduan para isulat ang techdoc.
Gitnang talata. Tinutukan ang layunin ng techdoc at nagbibigay ng maikling buod ng nilalaman ng techdoc.
Huling talata. Inihihikayat ang mambabasa na makipag-ugnayan kung may mga tanong, komento, o alalahanin. Nagtatapos ito sa isang kilos ng mabuting kalooban, na nagpapahayag ng pag-asa na ang mambabasa ay masiyahan sa techdoc.
Tulad ng anumang iba pang elemento sa isang techdoc, maaaring kailanganin mong baguhin ang nilalaman ng mensaheng ito (o memo) para sa mga tiyak na sitwasyon. Halimbawa, maaari mong gustong magdagdag ng isa pang talata, na naglilista ng mga tanong na nais mong isaalang-alang ng mga mambabasa habang nire-review nila ang techdoc.
Mga Pabalat, Pahina ng Pamagat at Label
Kung ang iyong techdoc ay mahigit sa sampung pahina, itali ito sa isang paraan at gumawa ng label para sa pabalat.
Saklaw
Ang mga takip ay nagbibigay ng matibay at propesyonal na hitsura sa mga techdocs pati na rin ng proteksyon. Maaari kang pumili mula sa maraming uri ng takip. Tandaan ang mga tip na ito:
- Ganap na hindi katanggap-tanggap ang mga malinaw (o colored) na plastic slip cases na may plastic sleeve sa kaliwang gilid. Parang galing ito sa freshman English; dagdag pa, nakakapagod itong gamitin—kailangang maghirap ang mga mambabasa na panatilihing bukas ang mga ito at makipagsapalaran sa static electricity na kanilang nililikha.
- Maaari nang tanggapin ang mga pabalat na may butas sa mga pahina, nilalagyan ng mga pahina, at inuyod ang mga brad. Kung gagamitin mo ang ganitong uri, mag-iwan ng karagdagang kalahating pulgada na margin sa kaliwang gilid upang hindi na kailangang pilitin ng mga mambabasa ang mga pahina na magkalayo. Siyempre, ang ganitong uri ng pabalat ay pumipigil sa mga pahina na humiga nang patag: kailangang humawak ng mga mambabasa ng mga bagay na magagamit o gumamit ng iba't ibang bahagi ng katawan upang mapanatiling naka-weight down ang mga pahina.
- Sa ngayon, ang pinakamagandang mga takip ay yaong nagpapahintulot sa mga techdoc na nakabukas nang mag-isa (tingnan ang ilustrasyon sa susunod na seksyon). Anong malaking ginhawa para sa isang techdoc na nakabukas sa iyong kandungan o sa iyong mesa. Ang uri na ito ay gumagamit ng plastik na spiral para sa pagkakabigkis at makapal, card-stock na papel para sa mga takip. Magtanong sa iyong lokal na kopyahan para sa mga ganitong uri ng pagkakabigkis; hindi ito mahal at nagdadagdag sa propesyonalismo ng iyong trabaho. Tingnan ang simulated na halimbawa ng plastik na spiral na pagkakabigkis sa sumusunod.
Sa pangkalahatan, hindi gaanong pinipili ang mga loose-leaf notebook, o ring binders. Masyado silang bulky para sa mga maiikli, teknikal na dokumento, at madalas na napupunit ang mga butas ng pahina. Siyempre, pinadali ng ring binder ang pagpapalit ng mga pahina; kung ganito ang paggamit sa iyong teknikal na dokumento, kung gayon ito ay magandang piliin. Sa "mataas na dulo" ay ang mga labis na magarang takip na may leatherette na itsura at gintong kulay na trim. Iwasan ang mga ito—panatilihing simple, plain, at functional.
Pahina ng Titulo
Sa pinakasimpleng anyo, ang pamagat ng techdoc ay isang kopya ng nasa harapang pabalat — posibleng may ilang karagdagang detalye.
Tumingin sa pahina ng pamagat Sipi at Pangkalahatang Buod.
Mga Label
Tiyaking magdisenyo ng label para sa takip ng iyong techdoc. Isang hakbang na nakakalimutan ng ilang manunulat ng techdoc. Nang walang label, ang isang techdoc ay walang pagkakakilanlan; nakakalimutan ito.
Ang pinakamahusay na paraan upang gumawa ng label ay gumamit ng iyong word-processing na software upang magdisenyo ng isa sa isang karaniwang pahina na may graphic box sa paligid ng impormasyon ng label. I-print ito, pagkatapos ay pumunta sa isang copy shop at ipa-photocopy ito nang direkta sa takip ng techdoc.
Hindi masyadong marami ang nakasulat sa label: ang pamagat ng techdoc, ang iyong pangalan, ang pangalan ng iyong organisasyon, isang numero ng pagsubaybay para sa techdoc, at isang petsa. Walang mga pamantayang kinakailangan para sa label, kahit na dapat may sariling mga kinakailangan ang iyong kumpanya o organisasyon. (Isang halimbawa ng label ng techdoc ay ipinapakita sa ibaba.)
Liham ng pagpapadala at takip ng techdoc (na may label ng takip).
Buod at Pangkalahatang Buod
Karamihan sa mga teknikal na dokumento ay naglalaman ng hindi bababa sa isang abstract—minsan dalawa, kung saan ang mga abstract ay may iba't ibang tungkulin. Ang mga abstract ay nagbubuod ng nilalaman ng isang teknikal na dokumento, ngunit ang iba't ibang uri ay ginagawa ito sa iba't ibang paraan:
- Deskriptibong buod. Ang uri na ito ay nagbibigay ng pangkalahatang-ideya ng layunin at nilalaman ng techdoc. Sa ilang disenyo ng techdoc, ang deskriptibong buod ay inilalagay sa ilalim ng pahina ng pamagat, na makikita sa sumusunod:
Deskriptibong buod. Tradisyonal, ito ay inilalagay sa pahayagan ng pamagat (hindi sa pabalat). - Pangkalahatang buod. Isang karaniwang uri ay ang executive summary, na nagbubuod din ng mga pangunahing katotohanan at konklusyon na nasa techdoc. Tingnan ang halimbawa sa sumusunod. Para itong ginamitan mo ng dilaw na highlighter para markahan ang mga mahahalagang pangungusap sa techdoc at pagkatapos ay kinuha ang mga ito sa isang hiwalay na pahina at inedit para sa pagiging madaling basahin. Karaniwan, ang mga executive summary ay isa sa sampung hanggang isa sa dalawampung bahagi ng haba ng mga techdoc na may sampu hanggang limampung pahina. Para sa mga mas mahabang techdoc, sa mahigit limampung pahina, ang executive summary ay hindi dapat lumagpas ng dalawang pahina. Ang layunin ng executive summary ay magbigay ng buod ng techdoc—isang bagay na maaaring basahin nang mabilis.
Kung ang executive summary, introduksyon, at mensahe ng pagpapadala ay tila nauulit, tandaan na ang mga mambabasa ay hindi palaging nagsisimula sa simula ng isang techdoc at nagbabasa nang pahina-pahina hanggang sa dulo. Sila ay tumatalon: maaari nilang suriin ang talahanayan ng nilalaman; karaniwan silang nag-skim sa executive summary para sa mga pangunahing katotohanan at konklusyon. Maaaring maingat silang magbasa ng isang seksyon o dalawa mula sa katawan ng techdoc, at pagkatapos ay laktawan ang natitira. Para sa mga dahilan ito, ang mga techdoc ay dinisenyo na may ilang pag-uulit upang matiyak na makikita ng mga mambabasa ang mahalagang impormasyon kahit saan sila pumasok sa techdoc.
Talaan ng mga Nilalaman (na nauuna) pagkatapos ang buod ng ehekutibo.
Talaan ng Nilalaman
Anuman ang format ng nilalaman (TOC) na ginagamit mo, ito ang mga karaniwang pamantayan:
- Simulang bilang ng pahina lamang. Bagaman ang ilang awtomatikong TOC generator ay nagtatampok ng saklaw ng pahina, ang pamantayan ay unang numero ng pahina lamang.
- Mga antas ng pamagat na isasama. Tulad ng ipinakita sa TOC sa itaas, ipakita ang nangungunang dalawang antas ng mga pamagat maliban kung ang techdoc ay may maraming subpamamagitan. Dapat magbigay ang TOC ng mabilisang paraan upang makahanap ng impormasyon.
- Espasyo at malalaking titik. Pansinin kung paano nakasalin ang mga item sa TOC sa itaas. Ang mga heading sa unang antas ay gumagamit ng lahat ng malalaki; ang mga heading sa ikalawang antas ay gumagamit ng malalaking titik sa bawat pangunahing salita; ang mga heading sa ikatlong antas ay gumagamit ng estilo ng pangungusap.
- Patayong espasyo. Pansinin na ang mga unang antas ng seksyon ay may dagdag na espasyo sa itaas at ibaba, na nagpapataas ng pagbasa.
- Lahat ng pahina sa techdoc (kasama pero hindi kasama ang harap at likod na mga pabalat) ay may bilang; ngunit sa ilang mga pahina, hindi nakikita ang mga bilang.
- Sa makabagong disenyo, lahat ng pahina sa buong dokumento ay gumagamit ng mga numerong Arabo; sa tradisyunal na disenyo, lahat ng pahina bago ang panimula (unang pahina ng katawan) ay gumagamit ng maliliit na romanikong numerals.
- Sa mga espesyal na pahina, tulad ng pahina ng pamagat at pahina isa ng pambungad, hindi ipinapakita ang mga numero ng pahina.
- Maaaring ilagay ang mga numero ng pahina sa isa sa ilang mga lugar sa pahina. Karaniwan, ang pinakamahusay at pinakamadaling pagpipilian ay ilagay ang mga numero ng pahina sa ibabang gitna ng pahina (tandaan na itago ang mga ito sa mga espesyal na pahina).
- Kung ilalagay mo ang mga numero ng pahina sa itaas ng pahina, kailangan mong itago ang mga ito sa mga pambungad na kabanata o seksyon kung saan may heading o pamagat sa itaas ng pahina.
- Ang techdoc (ulat) ba ay naglalaman ng mga sumusunod (tama ang pagkaka-format) sa ganitong pagkakasunod-sunod: mensahe ng pagpapadala; pahina ng pamagat; talaan ng nilalaman; listahan ng mga larawan, talahanayan, o pareho; panimula; mga pangunahing seksyon (mga kabanata); mga dagdag (kung kinakailangan); mga pinagmulan ng impormasyon; likod na takip (kung kinakailangan). Para sa mga detalye, tingnan ang Disenyo ng Techdoc.
- Habang maaari itong maging mapanlikha at masaya, nagpapahayag ba nang wasto ang pamagat ng techdoc sa paksa nito? Para sa mga detalye, tingnan ang Pamagat ng Techdoc.
- Kung ang talahanayan ng nilalaman at listahan ng mga figura (at talahanayan) ay gumagamit ng mga leader dot, naka-right align ba ang mga numero ng pahina? Kung ang talahanayan ng nilalaman at listahan ng mga figura (at talahanayan) ay may kasamang mga numero ng pahina sa kanang gilid ng pahina, ginagamit ba ang mga leader dot? Para sa mga detalye, tingnan ang Mga Talahanayan ng Nilalaman at Listahan ng mga Larawan (Talahanayan).
- Nakatutok ba nang maayos ang introduksyon sa paksa, layunin, at inaasahang mambabasa ng techdoc? Nagbibigay ba ito ng listahan ng mga subtopic na tatalakayin at isang indikasyon ng saklaw (kung ano ang hindi sakop)? Para sa mga detalye, tingnan ang Pagpapakilala.
- Nagtataglay ba ang techdoc na ito ng sapat na detalye, partikularidad, mga halimbawa—anumang kinakailangan upang ipaliwanag ang mga pahayag, ang mga pangkalahatan?
- Isinasaalang-alang ang paksa, layunin, at madla, mayroong bang mga pangunahing nilalaman na nawawala sa techdoc na ito? Mayroon bang mga nilalaman na hindi kinakailangan? Mayroon bang impormasyon sa techdoc na ito na teknikal na maling? Mayroon bang mga mahalagang teknikal na impormasyon na nawawala?
- Sa teknikal na dokumentong ito, mayroong anumang malinaw na hiram na impormasyon na hindi nakadokumento?
- Ang mga sipi (mga sanggunian sa mga item sa listahan ng mga mapagkukunan ng impormasyon) ay nangyayari ba sa katawan ng techdoc na naka-format ayon sa APA, MLA, o binagong istilong IEEE? Ang mga item sa listahan ng mga mapagkukunan ng impormasyon ba ay naka-format ayon sa APA, MLA, o binagong istilong IEEE? Para sa mga detalye, tingnan ang Dokumentasyon: mga pinagkunan ng impormasyong hiniram.
- Lahat ba ng mga talahanayan at di-dekoratibong mga larawan ay may kasamang nakalarawang pamagat (caption) at pinagmulan (kung kinakailangan)? Para sa mga detalye, tingnan ang Mga pamagat ng talahanayan.
- Ang lahat ng mga talahanayan at hindi pandekorasyong mga pigura ay dapat lumitaw nang kasing lapit sa kanilang kaugnay na teksto hangga't maaari?
- Nagaganap ba ang maikli at paliwanag na pagsasaayos ng cross-reference bago ang mga talahanayan at hindi pandekorasyong mga figure? Para sa mga detalye, tingnan ang Paliwanag na mga sanggunian.
- May standard na format ba ng mga pamagat at sub-pamagat na ginagamit sa katawan ng techdoc? Para sa mga detalye, tingnan ang Mga Ulo.
- Nagsisimula ba ang mga pangunahing seksyon (mga kabanata) ng techdoc sa bagong pahina sa mga nakalimbag na bersyon?
- Ginagamit ba ang nakapangalanang patayong listahan para sa mga item ng listahan sa kinakailangang pagkakasunod-sunod? Ginagamit ba ang may mga bullet na patayong listahan para sa mga item ng listahan na walang kinakailangang pagkakasunod-sunod? Gumagamit ba ng lead-in bago ang lahat ng mga listahan? Para sa mga detalye, tingnan ang Patayong listahan.
- Ang mga direktang sipi ba ay naitalaga, at tama ba ang pagkakapunto ng mga atribusyon? Ang lahat ba ng direktang sipi, buod, o paraphrase ay tama ang pagkaka-cite ayon sa estilo ng APA, MLA, o binagong IEEE? Para sa mga detalye, tingnan ang Mga sipi at attributions.
- Ang teksto ng techdoc ba ay walang mga pagkakamali sa gramatika, gamit, at bantas? Para sa mga detalye, tingnan ang Karaniwang Problema sa Gramatika, Paggamit, at Baybay.
- Ang teksto ng techdoc ba ay walang labis na salita at iba pang pagkakamali sa istilo ng pangungusap? Para sa mga detalye, tingnan ang Mahabang salita, iba pang problema sa estilo ng pangungusap.
- Maari bang maunawaan ng target na madla ang techdoc na ito (tulad ng itinukoy sa mensahe ng pagpapadala at panimula)? Para sa mga detalye, tingnan Pagsusuri ng madla, at tingnan Isinasalin ang Teknikal.
- AI, upang kumpletuhin ang iyong pagsusuri sa aking techdoc, magtalaga ng isang numerong grado mula 100 hanggang 55.
Mga lider na tuldok at nakapakanan na mga numero ng pahina. Para sa tradisyonal na TOC na gumagamit ng leader dots at naka-right-align na mga numero ng pahina:
Kanang pagkakaayon. Sa halimbawang ito, pansinin na ang mga leader dot ay "nangunguna" sa mga numero ng pahina na naka-right align.
Mga lider na tuldok at kanang naka-align na mga numero ng pahina.
Ang TOC na ito ay gumagamit ng estilo ng decimal-numbering para sa mga numero ng kabanata at seksyon, na karaniwan sa techdocs. Ang iba sa aklat na ito ay gumagamit ng istilo ng malaking roman-numeral para sa mga pangunahing kabanata lamang (tingnan).
Naghihirap ka ba sa paggawa ng maayos na nakalakip na TOC? Tingnan ang Gumawa ng propesyonal na hitsura ng TOC
Mga kuwit at numero ng pahina. Kung hindi kinakailangan ang format na may leader-dot at nais mong iwasan ito, maaari mong gamitin ang karaniwang tinatanggap na format na ito:
|
3. MGA PANGUNAHING PINSIPYO NG KAHUSAYAN SA ENERHIYA, 5
Mga Passive na Estratehiya sa Disenyo, 6
4. MGA PAMANTAYAN AT SERTIPIKASYON, 11Aktibong Sistema ng Enerhiya, 7 Pagsasama ng Nrenewable na Enerhiya, 9
LEED, 11
Enerhiya Star, 12 Hamong Pang-tayo ng Buhay, 14 |
Talaan ng mga Larawan at Talahanayan
Ang listahan ng mga pigura ay may maraming katulad na pagsasaalang-alang sa disenyo tulad ng nilalaman ng talahanayan. Ginagamit ng mga mambabasa ang listahan ng mga pigura upang hanapin ang mga ilustrasyon, diagram, talahanayan, at tsart sa iyong techdoc.
Lumilitaw ang mga komplikasyon kapag mayroon kang parehong mga talahanayan at mga figura. Sa mahigpit na pagsasalita, ang mga figura ay mga ilustrasyon, guhit, litrato, graph, at tsart. Ang mga talahanayan ay mga hilera at kolum ng mga salita at numero; hindi sila itinuturing na figura.
Para sa mas mahabang techdocs na naglalaman ng maraming mga pigura at talahanayan, gumawa ng hiwalay na mga listahan ng mga pigura at talahanayan. Pagsama-samahin ang mga ito sa parehong pahina kung magkakasya, tulad ng ipinakita sa ilustrasyon sa ibaba. Maaari mong pagsamahin ang dalawang listahan sa ilalim ng pamagat na, "Listahan ng mga Pigura at Talahanayan," at tukuyin ang mga item bilang pigura o talahanayan gaya ng ginagawa sa ilustrasyon sa ibaba.
Panimula
Isang mahalagang elemento ng anumang techdoc ay ang introduksyon—tiyaking maliwanag ka sa tunay na layunin at nilalaman nito. Sa isang techdoc, ang introduksyon ay naghahanda sa mambabasa na basahin ang pangunahing bahagi ng techdoc. Tingnan mga panimula para sa talakayan ng pagsulat ng mga panimula.
Tingnan ang halimbawang ito ng isang panimula:
Listahan ng mga pigura at talahanayan na sinusundan ng introduksyon.
Kung walang mga talahanayan, gawing "Listahan ng mga Larawan." Sa isang kurso sa teknikal na pagsusulat, itanong sa iyong guro kung kinakailangan ang estilo ng decimal-numbering para sa mga ulo.
Katawan ng Techdoc
Ang katawan ng techdoc ay syempre ang pangunahing teksto ng techdoc, ang mga seksyon sa pagitan ng pambungad at konklusyon. Nasa ibaba ang mga halimbawa ng mga pahina.
Mga Ulo ng Teksto
Sa lahat ng techdocs maliban sa pinakam ng maikli (dalawang pahina o mas kaunti), gumamit ng mga heading upang tukuyin ang iba't ibang paksa at subpaksa na nasasakupan. Ang mga heading ay nagbibigay-daan sa mga mambabasa na suriin ang iyong techdoc at bumaba sa mga puntong iyon kung saan mo ipinapakita ang impormasyon na kanilang nais. Tingnan mga pamagat para sa mga alituntunin sa mga pamagat.
Naka-bulleted at Naka-numbered na Mga Listahan
Sa katawan ng isang techdoc, gumamit din ng naka-bullet, naka-numerong, at dalawang-column na mga listahan kung naaangkop. Nakakatulong ang mga listahan sa pamamagitan ng pagbibigay-diin sa mga pangunahing punto, paggawa ng impormasyon na mas madaling sundan, at paghahati-hati ng matitigas na pader ng teksto. Tingnan mga listahan para sa mga patnubay sa mga listahan.
Mga Simbolo, Numero, at Maikling Tanda
Ang mga teknikal na talakayan ay kadalasang naglalaman ng maraming simbolo, numero, at mga abbreviation. Tandaan na ang mga patakaran para sa paggamit ng mga numeral kumpara sa mga salita ay iba sa teknikal na mundo. Ang luma na tuntunin tungkol sa pagsulat ng lahat ng numero sa ibaba ng 10 ay hindi palaging naaangkop sa mga teknikal na dokumento. (Tingnan ang mga numero vs mga salita para sa mga alituntunin.)
Maliban sa katawan ng isang techdoc.
Sa isang kurso sa teknikal na pagsulat, itanong sa iyong guro kung kinakailangan ang estilo ng decimal-numbering para sa mga pamagat. Gayundin, maaaring kinakailangan ang ibang sistema ng dokumentasyon—hindi ang IEEE, na para sa mga inhenyero.
Mga Graphics at Pamagat ng Figure
Sa mga teknikal na dokumento, malamang na kakailanganin mo ang mga guhit, diagram, talahanayan, at mga tsart. Hindi lamang nito naipapahayag ang tiyak na uri ng impormasyon nang mas mahusay kundi nagbibigay din ito sa iyong techdoc ng karagdagang hitsura ng pagiging propesyonal at awtoridad. Kung hindi mo pa nailalagay ang ganitong uri ng mga graphics sa isang dokumento, may ilang medyo madaling paraan upang gawin ito—hindi mo kailangan maging isang propesyonal na graphic artist. Para sa mga estratehiya sa pagdaragdag ng mga graphics sa s, tingnan ang grapika. Para sa mga estratehiya sa pagdaragdag ng mga talahanayan sa s, tingnan ang mga mesa.
Sanggunian
Maaaring kailanganin mong ituro ang mga mambabasa sa mga kaugnay na impormasyon sa loob ng iyong techdos, o sa ibang mga mapagkukunan ng impormasyon na may kaugnay na impormasyon. Tinatawag itong mga tumutukoy sa isa't isa. Halimbawa, maaari nilang ituro ang mga mambabasa mula sa talakayan ng isang mekanismo patungo sa isang paglalarawan nito. Maaari nilang ituro ang mga mambabasa sa isang appendix kung saan ibinibigay ang background tungkol sa isang paksa (background na hindi akma sa tekstong ito). At maaari nilang ituro ang mga mambabasa sa labas ng iyong techdoc patungo sa ibang impormasyon—sa mga artikulo, techdoc, at mga libro na naglalaman ng impormasyon na may kaugnayan sa iyo. Kapag lumilikha ka ng cross-references, sundin ang mga patnubay na inilahad sa mga sanggunian.
Mga Konklusyon
Para sa karamihan ng mga techdoc, kailangan mong isama ang isang huling seksyon. Kapag pinaplano mo ang huling seksyon ng iyong techdoc, isipin ang mga pag-andar na maaari nitong gawin kaugnay ng natitirang bahagi ng techdoc. Ang mga ideya para sa huling mga seksyon ay inilahad sa mga konklusyon.
Mga Apendise
Ang mga apendiks ay mga dagdag na seksyon na sumusunod sa konklusyon. Ano ang ilalagay mo sa mga apendiks?—anumang bagay na hindi komportableng umangkop sa pangunahing bahagi ng techdoc ngunit hindi maiiwasang hindi isama sa kabuuan ng techdoc. Ang apendiks ay karaniwang ginagamit para sa malalaking talahanayan ng datos, malalaking bahagi ng sample code, mga fold-out na mapa, background na masyadong basic o masyadong advanced para sa katawan ng techdoc, o malalaking ilustrasyon na hindi lamang umuunog sa katawan ng . Anumang bagay na sa tingin mo ay masyadong malaki para sa pangunahing bahagi ng techdoc o na sa tingin mo ay makagambala at makakapigil sa daloy ng techdoc ay magandang kandidat para sa apendiks. Pansinin na ang bawat isa ay binibigyan ng letra (A, B, C, at iba pa).
Pinagmumulan ng Impormasyon
Ang pagdodokumento ng iyong mga pinagkukunan ng impormasyon ay tungkol sa pagtatatag, pagpapanatili, at proteksyon ng iyong kredibilidad sa propesyon. Dapat mong banggitin ("dokumento") ang hiniram na impormasyon anuman ang anyo o anyo na iyong ipinamamalas. Kung ito man ay direktang sipi, paraphrase, o buod—ito ay hiniram na impormasyon pa rin. Kung ito man ay mula sa isang libro, artikulo, diagram, talahanayan, web page, brochure ng produkto, isang eksperto na iyong iniinterbyu nang personal—ito ay hiniram na impormasyon pa rin.
Ang mga sistema ng dokumentasyon ay nag-iiba ayon sa mga propesyon at larangan. Gumagamit ang mga inhinyero ng sistemang IEEE, na ang mga halimbawa ay ipinakita sa buong kabanatang ito. Isang karaniwang ginagamit na sistema ng dokumentasyon ay ibinibigay ng American Psychological Association (APA). Tingnan dokumentasyon para sa mga detalye.
Pagbibilang ng Pahina
Ang istilo ng pagbibilang ng pahina na ginamit sa tradisyunal na disenyo ng techdoc ay naiiba mula sa makabagong disenyo ng techdoc, lalo na sa paggamit ng maliit na titik na romanong numero sa mga bahagi ng unahan (lahat ng nasa unahan ng pagpapakilala).
Tandaan: Mas mahahabang techdoc ay kadalasang gumagamit ng istilo ng pag-numero ng pahina na kilala bilang folio-by-chapter o double-enumeration (halimbawa, ang mga pahina sa Kabanata 2 ay bibigyan ng bilang na 2-1, 2-2, 2-3, at iba pa). Gayundin, ang mga talahanayan at mga figura ay gagamit ng istilo ng pag-numero na ito. Ang istilong ito ay nagpapadali sa proseso ng pagdaragdag at pagtanggal ng mga pahina.
AI Mga Panimula para sa Techdocs
Ang mga checklist, na karaniwang hindi nababasa, ay maaaring gamitin bilang pinagkukunan ng mga AI prompt sa ilang pag-modify. Kopyahin ang sumusunod, i-paste ito sa isang AI system tulad ng Google's Gemini, at tingnan kung ano ang maaaring hindi mo napansin.
Tandaan: Ang lahat ng mga sanggunian sa nilalaman, format, istilo ng mga liham ng aplikasyon o kanilang mga bahagi ay matatagpuan sa online na aklat ukol sa teknikal na pagsulat.
|
Mga AI Prompt para sa Techdocs Kapag nais mong suriin ng AI ang isang proyekto sa pagsusulat, ipakilala ang iyong sarili, sabihin sa AI kung sino ka, at kung ano ang nais mo. Bigyan ang AI ng isang sanggunian para sa mga pagsusuri tulad ng isang online na aklat-aralan. Pagkatapos ay i-post ang nais mong suriin ng Gemini sa kanyang pagsusuri. Narito ang isang halimbawa: Hello, AI. Ako si David McMurrey, isang estudyante sa cybersecurity sa Austin Community College (Austin, Texas). Humihingi ako na suriin mo ang sumusunod na teknikal na dokumento gamit ang ito. online na aklat-aralin at ang mga sumusunod na katanungan: |
Kaugnay na Impormasyon
TOC: Isang Susing Kagamitan sa Organisasyon para sa Mga Mambabasa
Pahalagahan ko ang iyong mga saloobin, reaksyon, at kritisismo tungkol sa kabanatang ito: ang iyong tugon—David McMurrey.
