- Sura hii, pamoja na sehemu nyingine za kitabu cha Uandishi wa Kiufundi, inazingatia stadi za uandishi wa kiufundi. Maudhui ya kiufundi hapa hayahakikishwi kuwa yatafanikiwa, yatakuwa sahihi au ya kisasa.
- Sura hii imetafsiriwa kwa kutumia OpenAI ChatGPT. Tafadhali ripoti matatizo ya lugha kwa admin@mcmassociates.io.
- Maandishi yaliyo kwenye picha katika ukurasa huu yatatafsiriwa haraka iwezekanavyo.
- Bofya hapa kumsaidia David McMurrey kulipia gharama za upangishaji wa tovuti: Changia kiasi chochote! Online Technical Writing itaendelea kuwa bure.
Tafadhali bonyeza hapa ili kusaidia. David McMurrey lipa kwa upangishaji wa tovuti:
Toa kiasi kidogo chochote unachoweza!
Uandishi wa Kiufundi mtandaoni utabaki bure.
Nyaraka za kiufundi (ikiwa ni pamoja na vitabu vya mwongozo, waraka meupe na miongozo) zina muundo tofauti kulingana na sekta, taaluma, au shirika. Sura hii inakuonyesha muundo mmoja wa jadi. Ikiwa unachukua kozi ya uandishi wa kiufundi, hakikisha muundo unaowasilishwa katika sura hii unakubalika. Ndivyo ilivyo pia ikiwa unaandika nyaraka za kiufundi katika muktadha wa sayansi, biashara, au serikali.
Infografiki iliyotengenezwa na NotebookLM ya sura hii
Kumbuka: Kwa miaka mingi kitabu hiki cha uandishi wa kiufundi mtandaoni kilitumia neno 'ripoti' kwa jumla kuashiria karibu chochote chenye taarifa za kiufundi. Lakini kwa sababu 'ripoti' inarejelea aina maalum ya nyaraka ya kiufundi, ilibidi kubadilisha neno la jumla kuwa 'techdoc', ambalo ni ufupisho wa 'nyaraka ya kiufundi'.
Techdocs (jina la jumla kwa nyaraka za kiufundi) zina vipimo kama aina nyingine yoyote ya mradi. Vipimo vya techdocs vinahusisha mpangilio, muundo na maudhui, muundo wa vichwa na orodha, usanifu wa michoro, n.k. Faida ya muundo na fomati iliyohitajika kwa techdocs ni kwamba wewe au mtu mwingine yeyote anaweza kutegemea kwamba zimeundwa kwa njia inayojulikana—unajua nini cha kutafuta na wapi cha kukitafuta. Techdocs kawaida husomwa kwa haraka—watu wana haraka kupata taarifa wanazohitaji, ukweli muhimu, hitimisho, na mambo mengine muhimu. Muundo wa kawaida wa techdoc ni kama mtaa unaojulikana.
Unapochambua muundo wa nyaraka za kiufundi, zingatia jinsi baadhi ya sehemu zinavyorudiwa. Kurudiwa kwa yaliyomo kunahusiana na jinsi watu wanavyosoma nyaraka hizo. Hawasomi nyaraka za kiufundi kutoka mwanzo hadi mwisho: wanaweza kuanza na muhtasari wa kiutendaji, kuruka sehemu mbalimbali, na labda wasisome kila ukurasa. Changamoto yako ni kubuni nyaraka za kiufundi ili wasomaji hao wakutane na fakti zako muhimu na hitimisho zako, bila kujali wanayasoma kiasi gani ya nyaraka au kwa mpangilio gani wanayosoma.
Hakikisha uone mfano wa nyaraka za kiufundi.
Vipengele vya kawaida vya ripoti ya kiufundi vinajadiliwa katika sura hii. Sehemu zifuatazo zitakuongoza kupitia kila moja ya vipengele hivi, zikionyesha sifa kuu. Unaposoma na kutumia miongozo hii, kumbuka kwamba hizi ni miongozo, sio amri. Makampuni, taaluma, na mashirika mbalimbali wana miongozo yao tofauti kwa nyaraka za kiufundi; utahitaji kuendana na miongozo hiyo pamoja na ile inayowasilishwa hapa.
Ujumbe wa Uwasilishaji
Ujumbe wa kuwasilisha unaweza kuwa barua ya kifuniko (au kumbukumbu ya ndani/memo) au barua pepe. Barua ya kimwili (au kumbukumbu) imeambatishwa kwa upande wa nje wa nyaraka ya kiufundi kwa klipu ya karatasi au imefungwa ndani ya nyaraka ya kiufundi. Barua pepe ina kiungo kwenye nyaraka ya kiufundi au nyaraka ya kiufundi imeambatishwa. Ni mawasiliano kutoka kwako—mwandishi wa nyaraka ya kiufundi—kwa mpokeaji, mtu aliyeiomba nyaraka ya kiufundi na ambaye anaweza hata kuwa anakulipa kwa ushauri wako wa kitaalamu. Kwa ujumla, inasema "Sawa, hapa kuna nyaraka ya kiufundi tuliyokubaliana nitakayomaliza ifikapo tarehe fulani. Kwa kifupi, ina mambo fulani, lakini haijajumuisha mambo mengine. Nijulishe ikiwa inakidhi mahitaji yako." Ujumbe wa kuwasilisha unaelezea muktadha—matukio yaliyopelekea kuundwa kwa nyaraka ya kiufundi. Ina taarifa kuhusu nyaraka ya kiufundi ambazo hazifai kuwekwa ndani ya nyaraka ya kiufundi.
Mifano ya barua ya kuwasilisha na ujumbe wa kuwasilisha.
Katika mfano wa barua ya kuwasilisha, angalia muundo wa kawaida wa barua za kibiashara. Ikiwa unaandika waraka wa ndani wa kiufundi, tumia muundo wa kumbukumbu badala yake; katika kila kesi, maudhui na mpangilio ni sawa:
Aya ya kwanza. Inataja jina la nyaraka ya kiufundi, ikiwa imeandikwa kwa italiki. Pia inataja tarehe ya makubaliano ya kuandika nyaraka ya kiufundi.
Kipara cha katikati. Inalenga kusudi la hati ya kiufundi na hutoa muhtasari mfupi wa yaliyomo ndani yake.
Aya ya mwisho. Inahamasisha msomaji kuwasiliana ikiwa kuna maswali, maoni, au wasiwasi. Inaishia kwa ishara ya nia njema, ikionyesha matumaini kwamba msomaji atapata nyaraka ya kiufundi inayoridhisha.
Kama kwa kipengele chochote kingine katika nyaraka ya kiufundi, huenda ukalazimika kubadilisha yaliyomo ya ujumbe huu (au kumbusho) kwa hali maalum. Kwa mfano, unaweza kutaka kuongeza aya nyingine, ukorodheshe maswali ungependa wasomaji wayazingatie wanapokagua nyaraka ya kiufundi.
Vifuniko, Ukurasa wa Kichwa na Lebeli
Ikiwa nyaraka yako ya kiufundi ina zaidi ya kurasa kumi, ifunge kwa njia fulani na tengeneza lebo kwa kifuniko.
Mifuniko
Vifuniko vinatoa nyaraka za kiufundi muonekano thabiti na wa kitaalamu, pamoja na ulinzi. Unaweza kuchagua kati ya aina nyingi za vifuniko. Zingatia vidokezo hivi:
- Hazikubaliki kabisa ni vifuniko vya plastiki wazi (au vyenye rangi) vilivyo na jalizi ya plastiki upande wa kando ya kushoto. Hizi ni kama kitu kinachotoka kwenye somo la Kiingereza kwa wanafunzi wa mwaka wa kwanza; zaidi ya hayo, zinachosha kutumia—wasomaji lazima wapambane kuziweka wazi na wasumbuke na umeme wa statiki unaotokana nazo.
- Kifuniko kinachokubalika kidogo ni kile ambacho unapiga mashimo katika kurasa, kuzipakia kurasa, na kupinda vifungo vidogo vya chuma. Ikiwa unatumia aina hii, acha nusu inchi ya ziada kwenye kando ya kushoto ili wasomaji wasilazimike kutenganisha kurasa kwa nguvu. Bila shaka, aina hii ya kifuniko huzuia kurasa zisilete kwa usawa: wasomaji lazima wakamate vitu vinavyopatikana au watumie sehemu mbalimbali za miili yao kuzipa uzito.
- Vifuniko vyema kabisa ni vile vinavyomruhusu nyaraka za kiufundi kubaki wazi peke yake (angalia mchoro katika sehemu inayofuata). Ni faraja kubwa kwa nyaraka za kiufundi kubaki wazi kiganjani mwako au juu ya dawati lako. Aina hii hutumia spiral ya plastiki kwa ufungaji na karatasi nene za kadi kwa vifuniko. Uliza kwenye duka lako la nakala kuhusu aina hizi za ufungaji; ni nafuu na zinaongeza muonekano wa kitaalamu wa kazi yako. Tazama mfano ulioigwa wa ufungaji kwa spiral ya plastiki hapa chini.
Kwa ujumla, daftari za karatasi zisizofungwa (loose-leaf) au vifunga vya pete hupendekezwa kidogo. Hivi ni vikubwa mno kwa nyaraka fupi za kiufundi, na mashimo ya kurasa mara nyingi hupasuka. Bila shaka, kifunga cha pete hurahisisha kubadilisha kurasa; ikiwa hivyo ndivyo nakala yako ya kiufundi itakavyotumika, basi ni chaguo zuri. Kwenye "ngazi ya juu" kuna vifuniko vya kifahari kupita kiasi vinavyoonekana kama ngozi bandia na viongezaji vya rangi ya dhahabu. Epuka hivyo—zifanye ziwe za kawaida, rahisi, na zenye utendaji.
Ukurasa wa Kichwa
Katika umbo lake rahisi kabisa, kichwa cha nyaraka ya kiufundi ni nakala ya kile kilicho kwenye jalada la mbele—labda kwa maelezo machache yaliyoongezwa.
Angalia ukurasa wa kichwa Muhtasari na Muhtasari wa Mtendaji.
Lebo
Hakikisha uunde lebo kwa ajili ya kifuniko cha nyaraka yako ya kiufundi. Ni hatua ambayo baadhi ya waandishi wa nyaraka za kiufundi huisahau. Bila lebo, nyaraka ya kiufundi huwa isiyojulikana; huachwa bila kuzingatiwa.
Njia bora ya kutengeneza lebo ni kutumia programu yako ya kusindika maneno kubuni lebo kwenye ukurasa wa kawaida, ukiweka sanduku la grafiki linalozunguka taarifa za lebo. Chapisha, kisha nenda duka la nakala na uifotokopiwe moja kwa moja kwenye kifuniko cha nyaraka za kiufundi.
Hakuna mengi yanayoandikwa kwenye lebo: kichwa cha hati ya kiufundi, jina lako, jina la shirika lako, nambari ya ufuatiliaji ya hati ya kiufundi, na tarehe. Hakuna mahitaji ya kawaida kwa lebo, ingawa kampuni yako au shirika linapaswa kuwa na mahitaji yake. (Mfano wa lebo ya hati ya kiufundi umeonyeshwa hapa chini.)
Barua ya kuwasilisha na jalada la waraka wa kiufundi (ikiwa na lebo ya jalada).
Muhtasari na Muhtasari Mtendaji
Nyaraka nyingi za kiufundi zina angalau muhtasari mmoja—wakati mwingine mbili, katika kesi hiyo muhtasari huchukua majukumu tofauti. Muhtasari hufupisha yaliyomo ya nyaraka za kiufundi, lakini aina tofauti za muhtasari hufanya hivyo kwa njia tofauti:
- Muhtasari wa maelezo. Jenis hii hutoa muhtasari wa kusudi na yaliyomo ya hati ya kiufundi. Katika baadhi ya miundo ya hati ya kiufundi, muhtasari wa maelezo unawekwa chini ya ukurasa wa kichwa, kama ilivyoonyeshwa ifuatayo:
Muhtasari wa maelezoKawaida, huwekwa kwenye ukurasa wa kichwa (sio kwenye jalada). - Muhtasari Mtendaji. Aina nyingine ya kawaida ni muhtasari wa kiutendaji, ambao pia unafupisha ukweli muhimu na hitimisho zilizomo katika nyaraka za kiufundi. Tazama mfano unaoonyeshwa hapa chini. Ni kana kwamba umetumia kalamu ya wazi ya manjano kuashiria sentensi muhimu katika nyaraka za kiufundi kisha kuzitoa zote na kuzihamisha kwenye ukurasa tofauti na kuzihariri ili ziwe rahisi kusoma. Kwa kawaida, muhtasari wa kiutendaji huwa sehemu ya moja kwa kumi hadi moja kwa ishirini ya urefu wa nyaraka za kiufundi zenye kurasa kumi hadi hamsini. Kwa nyaraka za kiufundi ndefu zaidi, zile zenye kurasa zaidi ya hamsini, muhtasari wa kiutendaji haupaswi kuzidi kurasa mbili. Lengo la muhtasari wa kiutendaji ni kutoa muhtasari wa nyaraka za kiufundi—ambayo inaweza kusomwa kwa haraka.
Iwapo muhtasari wa utendaji, utangulizi, na ujumbe wa kuwasilisha vinakuonekana kurudia-rudia, kumbuka kwamba wasomaji si lazima waanze mwanzoni mwa nyaraka za kiufundi na kusoma ukurasa kwa ukurasa hadi mwisho. Huwaruka sehemu mbalimbali: wanaweza kupitia jedwali la yaliyomo; kwa kawaida wanapitia kwa haraka muhtasari wa utendaji kutafuta habari muhimu na hitimisho. Wanaweza kusoma kwa makini sehemu moja au mbili tu kutoka mwili wa nyaraka za kiufundi, kisha kupuuza zilizobaki. Kwa sababu hizi, nyaraka za kiufundi zimeundwa zikiwa na kurudia kwa kiasi ili wasomaji waweze kuona taarifa muhimu bila kujali wapi wanapoanza kusoma ndani ya nyaraka.
Jedwali la Maudhui (linalokuja kwanza), kisha muhtasari mtendaji.
Jedwali la Maudhui
Ukitumia muundo wowote wa jedwali la yaliyomo (TOC), haya ni viwango vya kawaida:
- Nambari ya ukurasa wa kuanzia tu. Ingawa baadhi ya jenereta za orodha ya maudhui za kiotomatiki zinaonyesha anuwai ya kurasa, kanuni ni kutumia nambari ya ukurasa wa kwanza pekee.
- Viwango vya vichwa vya habari vya kujumuisha. Kama ilivyoonyeshwa katika Jedwali la Yaliyomo (TOC) hapo juu, onyesha ngazi mbili za juu za vichwa isipokuwa nyaraka ya kiufundi ina vichwa vidogo vingi. Jedwali la Yaliyomo linapaswa kutoa njia ya kuona kwa mtazamo mmoja ili kupata taarifa kwa haraka.
- Nafasi na matumizi ya herufi kubwa. Angalia jinsi vipengele vya maandishi katika jedwali la maudhui hapo juu vinavyopangwa kwa pembeni. Vichwa vya ngazi ya kwanza vinatumia herufi zote kubwa; vichwa vya ngazi ya pili vinatumia herufi kubwa mwanzoni kwa kila neno kuu; vichwa vya ngazi ya tatu vinatumia mtindo wa sentensi, yaani herufi kubwa tu mwanzoni ya sentensi.
- Nafasi ya wima. Tambua kwamba sehemu za ngazi ya kwanza zina nafasi ya ziada juu na chini, ambayo huongeza urahisi wa kusoma.
- Kurasa zote katika techdoc (ndani yake lakini bila kujumuisha jalada la mbele na jalada la nyuma) zimepewa nambari; lakini kwenye baadhi ya kurasa, nambari hazionyeshwi.
- Katika muundo wa kisasa, kurasa zote za nyaraka zinatumia tarakimu za Kiarabu; katika muundo wa jadi, kurasa zote kabla ya utangulizi (ukurasa wa kwanza wa mwili wa ) zinatumia tarakimu ndogo za Kirumi.
- Kwenye kurasa maalum, kama ukurasa wa kichwa na ukurasa wa kwanza wa utangulizi, nambari za kurasa hazionyeshwi.
- Nambari za kurasa zinaweza kuwekwa katika mojawapo ya maeneo kadhaa kwenye ukurasa. Kawaida, chaguo bora na rahisi zaidi ni kuweka nambari za kurasa katikati chini ya ukurasa (kumbuka kuzificha kwenye kurasa maalum).
- Ikiwa unaweka nambari za kurasa juu ya ukurasa, lazima uzifiche kwenye ukurasa unaoanza sura au sehemu ambapo kichwa au jina lipo juu ya ukurasa.
- Je, nyaraka ya kiufundi (ripoti) ina yafuatayo (imefomatiwa ipasavyo) kwa mpangilio huu: ujumbe wa kuwasilisha; ukurasa wa kichwa; jedwali la yaliyomo; orodha ya michoro, meza, au zote mbili; utangulizi; sehemu za mwili (sura); viambatisho (kama inahitajika); vyanzo vya taarifa; gamba la nyuma (kama inahitajika). Kwa maelezo zaidi, angalia Ubunifu wa nyaraka za kiufundi.
- Ingawa inaweza kuwa mwerevu na yenye ucheshi, je, kichwa cha nyaraka ya kiufundi kinaonyesha kwa kutosha mada yake? Kwa maelezo, angalia Vichwa vya nyaraka za kiufundi.
- Ikiwa jadwali la yaliyomo na orodha ya michoro (na jedwali) zinatumia nukta za kuongoza, je, nambari za kurasa zimepangwa kulia? Ikiwa jadwali la yaliyomo na orodha ya michoro (na jedwali) zina nambari za kurasa kwenye ukingo wa kulia wa ukurasa, je, nukta za kuongoza zinatumika? Kwa maelezo zaidi, angalia Orodha za Yaliyomo na Orodha ya Michoro (na Majedwali).
- Je, utangulizi unaonyesha kwa kutosha mada, kusudi, na hadhira iliyokusudiwa ya waraka la kiufundi? Je, unaorodhesha mada ndogo zitakazofunikwa na inaonyesha wigo (yale yasiyofunikwa)? Kwa maelezo zaidi, angalia Utangulizi.
- Je, nyaraka hii ya kiufundi ina maelezo ya kutosha, mambo maalum, mifano—chochote kinachohitajika kuelezea madai, mambo ya jumla?
- Kwa kuzingatia mada, kusudi, na wasikilizaji, kuna yaliyomo muhimu yanayokosekana katika waraka huu wa kiufundi? Je, kuna yaliyomo yasiyo ya lazima? Je, kuna taarifa yoyote katika waraka huu wa kiufundi ambayo si sahihi kiufundi? Je, kuna taarifa muhimu za kiufundi zinazokosekana?
- Je, katika hati hii ya kiufundi kuna taarifa yoyote waziwazi iliyochukuliwa kutoka kwa vyanzo vingine ambayo haijaandikwa au kuhifadhiwa kwa njia yoyote?
- Je, marejeleo (marejeo kwa vipengee katika orodha ya vyanzo vya habari) yanaonekana katika mwili wa waraka wa kiufundi yaliyopangwa kwa mujibu wa mtindo wa APA, MLA, au mtindo wa IEEE uliobadilishwa? Je, vipengee vilivyomo katika orodha ya vyanzo vya habari vimepangwa kwa mujibu wa mtindo wa APA, MLA, au mtindo wa IEEE uliobadilishwa? Kwa maelezo, tazama Nyaraka: vyanzo vya taarifa vilivyokopwa.
- Je, jedwali zote na takwimu zisizo za mapambo zina kichwa kinachofafanua (caption) na chanzo (ikiwa kinahitajika)? Kwa maelezo, angalia Vichwa vya jedwali.
- Je, jedwali zote na michoro zisizo za mapambo ziko karibu iwezekanavyo na maandishi yanayohusiana nazo?
- Je, marejeo mafupi ya ufafanuzi hutokea kabla ya jedwali na takwimu zisizo za mapambo? Kwa maelezo, angalia Marejeleo ya ufafanuzi.
- Je, muundo wa kawaida wa vichwa vikuu na vichwa vidogo unatumika katika mwili wa nyaraka ya kiufundi? Kwa maelezo, angalia Vichwa.
- Je, sehemu kuu (sura) za nyaraka za kiufundi huanza ukurasa mpya katika matoleo ya kuchapishwa?
- Je, orodha za wima zilizo na nambari zinatumiwa kwa vipengee vya orodha vinavyopaswa kuwa katika mpangilio maalum? Je, orodha za wima zilizo na nukta zinatumiwa kwa vipengee vya orodha ambavyo havina mpangilio uliohitajika? Je, sentensi za utangulizi zinatumiwa kabla ya orodha zote? Kwa maelezo, angalia Orodha za wima.
- Je, nukuu za moja kwa moja zimepewa utambulisho (attribution), na je, utambulisho huo umewekwa alama kwa usahihi? Je, nukuu zote za moja kwa moja, muhtasari na parafrazi zimeelezwa ipasavyo kwa mujibu wa mitindo ya APA, MLA, au IEEE iliyorekebishwa? Kwa maelezo zaidi, angalia Nukuu na Mikopo.
- Je, maandishi ya nyaraka ya kiufundi hayana makosa ya sarufi, matumizi, na alama za uakifishaji? Kwa maelezo zaidi, angalia Matatizo ya kawaida ya sarufi, matumizi, na tahajia.
- Je, maandishi ya techdoc hayana maneno mengi yasiyo ya lazima na makosa mengine ya mtindo wa sentensi? Kwa maelezo, angalia Maneno mengi, matatizo mengine ya mtindo wa sentensi.
- Je, nyaraka hii ya kiufundi inaweza kueleweka na hadhira yake lengwa (kama ilivyoainishwa katika ujumbe wa kuwasilisha na utangulizi)? Kwa maelezo, ona Uchambuzi wa hadhira, na kuona Kutafsiri Maudhui ya Kiufundi.
- Akili ya bandia, ili kukamilisha tathmini yako ya nyaraka yangu ya kiufundi, toa alama ya nambari kutoka 100 hadi 55).
Mstari wa nukta na nambari za kurasa zilizopangwa kulia. Kwa orodha ya maudhui ya jadi inayotumia alama za vidoti zinazongoza na nambari za kurasa zilizopangwa kulia:
Upangaji wa kulia. Katika mfano huu, zingatia kwamba vidoti vya muongozo "vinaongoza" hadi namba za ukurasa ambazo zimepangiliwa kulia.
Nukta za kuongoza na nambari za kurasa zilizopangwa kulia.
Jedwali hili la yaliyomo linatumia mtindo wa nambari za desimali kwa nambari za sura na sehemu, ambao ni wa kawaida katika nyaraka za kiufundi. Wengine katika kitabu hiki wanatumia mtindo wa nambari za Kirumi kwa herufi kubwa kwa sura za ngazi ya juu pekee (angalia ).
Unapata shida kuunda Jedwali la Yaliyomo lililopangwa vizuri? Angalia Tengeneza jedwali la maudhui lenye muonekano wa kitaalamu.
Vikoma na nambari za kurasa. Ikiwa muundo wa 'leader-dot' hauhitajiki na ungependa kuuepuka, unaweza kutumia muundo huu unaokubalika kwa kawaida:
|
3. KANUNI KUU ZA UFANISI WA NISHATI, 5
Mikakati ya Ubunifu Pasivu, 6
4. VIWANGO NA VYETI, 11Mifumo ya Nishati Hai, 7 Uunganishaji wa Nishati Mbadala, 9
LEED, 11
Nyota ya Nishati, kumi na mbili Changamoto ya Jengo Hai, kumi na nne |
Orodha ya Michoro na Majedwali
Orodha ya michoro ina mambo mengi ya kubuni yanayofanana na yale ya jedwali la yaliyomo. Wasomaji hutumia orodha ya michoro kupata vielelezo, michoro, majedwali, na chati katika nyaraka yako ya kiufundi.
Matatizo hutokea unapokuwa na jedwali na vielelezo. Kwa kusema kwa usahihi, vielelezo ni maonyesho, michoro, picha, grafu, na chati. Jedwali ni safu na nguzo za maneno na nambari; hayahesabiwi kuwa vielelezo.
Kwa nyaraka za kiufundi ndefu ambazo kila moja ina takriban michoro na jedwali nyingi, tengeneza orodha tofauti za michoro na za jedwali. Ziweke pamoja kwenye ukurasa mmoja ikiwa zinaweza kuendana, kama ilivyoonyeshwa katika mchoro hapa chini. Unaweza kuunganisha orodha hizo mbili chini ya kichwa "Orodha ya Michoro na Jedwali" na kutambulisha vipengee kama "mchoro" au "jedwali" kama ilivyoonyeshwa katika mchoro hapa chini.
Utangulizi
Sehemu muhimu ya kila nyaraka ya kiufundi ni utangulizi wake—hakikisha unaelewa wazi kusudi lake halisi na yaliyomo. Kwenye nyaraka ya kiufundi, utangulizi humtayarisha msomaji kusoma sehemu kuu ya nyaraka. Tazama utangulizi Kwa mjadala kuhusu kuandika utangulizi.
Tazama mfano huu wa utangulizi:
Orodha ya michoro na jedwali ikifuatiwa na utangulizi.
Ikiwa hakuna jedwali, fanya iwe "Orodha ya Michoro." Katika kozi ya uandishi wa kiufundi, muulize mwalimu wako ikiwa mtindo wa nambari za desimali kwa vichwa unahitajika.
Maudhui ya nyaraka ya kiufundi
Mwili wa nyaraka ya kiufundi ni, bila shaka, maandishi makuu ya nyaraka hiyo — sehemu zilizo kati ya utangulizi na hitimisho. Hapa chini zimeonyeshwa kurasa za mfano.
Vichwa
Katika nyaraka za kiufundi zote isipokuwa zile fupi kabisa (kurasa mbili au chini yake), tumia vichwa vya habari kuweka alama kwa mada mbalimbali na mada ndogo zinazofunikwa. Vichwa vya habari huwasaidia wasomaji kupitia nyaraka yako ya kiufundi kwa haraka na kumwongoza msomaji hadi sehemu zile ambapo unawasilisha taarifa wanazotaka. Angalia vichwa kwa miongozo kuhusu vichwa.
Orodha za nukta na nambari
Kwenye mwili wa nyaraka za kiufundi, pia tumia orodha zilizo na alama, zilizo na nambari, na za nguzo mbili inapofaa. Orodha husaidia kusisitiza hoja kuu, kufanya taarifa ziwe rahisi kufuatilia, na kuvunja kuta ndefu za maandishi. Tazama orodha Kwa miongozo kuhusu orodha.
Alama, Nambari, na Fupisho
Majadiliano ya kiufundi kwa kawaida huwa na alama nyingi, nambari, na vifupisho. Kumbuka kwamba kanuni za kutumia tarakimu badala ya maneno ni tofauti katika mazingira ya kiufundi. Sheria ya zamani kuhusu kuandika kwa maneno nambari zote chini ya 10 haitumiki kila wakati katika nyaraka za kiufundi. (Angalia nambari dhidi ya maneno kwa miongozo.)
Isipokuwa kutoka kwa sehemu kuu ya nyaraka ya kiufundi.
Katika kozi ya uandishi wa kiufundi, muulize mwalimu wako ikiwa mtindo wa nambari za desimali kwa vichwa unahitajika. Pia, mfumo tofauti wa uandishi wa nyaraka unaweza kuhitajika—sio IEEE, ambao ni kwa wahandisi.
Grafiki na Vichwa vya Vielelezo
Katika nyaraka za kiufundi, kuna uwezekano uta hitaji michoro, diagramu, meza, na chati. Hizi si tu zinawasilisha aina fulani za taarifa kwa ufanisi zaidi, bali pia zinampa nyaraka zako za kiufundi mwonekano wa ziada wa kitaalamu na mamlaka. Ikiwa haujawahi kuweka aina hizi za grafiki kwenye hati, kuna njia zinazofaa na rahisi kufanya hivyo—huna haja ya kuwa msanii mtaalamu wa grafiki. Kwa mikakati ya kuongeza grafiki kwenye s, angalia grafiki. Kwa mikakati ya kuongeza majedwali kwa s, angalia meza.
Marejeo
Unaweza kuhitaji kuelekeza wasomaji kwa habari zinazohusiana kwa karibu ndani ya techdos zako, au kwa vyanzo vingine vya habari vinavyotoa taarifa zinazohusiana. Hizi huitwa marejeleo yanayohusiana. Kwa mfano, zinaweza kuelekeza wasomaji kutoka kwenye mjadala wa utaratibu hadi kwenye mchoro unaoonyesha. Zinaweza kuelekeza wasomaji kwenye kiambatisho ambacho kinatoa maelezo ya msingi kuhusu mada (maelezo ya msingi ambayo hayawezi kuingizwa ndani ya maandishi). Na zinaweza kuelekeza wasomaji nje ya nyaraka zako za kiufundi hadi kwa habari nyingine—kwa makala, nyaraka za kiufundi, na vitabu vinavyomo taarifa zinazohusiana na zako. Unapounda marejeleo ya msalaba, fuata miongozo hii iliyowasilishwa katika marejeo ya msalaba.
Hitimisho
Kwa nyaraka nyingi za kiteknolojia, utahitaji kujumuisha sehemu ya mwisho. Unapopanga sehemu ya mwisho ya nyaraka yako ya kiteknolojia, fikiria kuhusu kazi ambazo inaweza kutekeleza kuhusiana na sehemu nyingine za nyaraka hiyo. Mawazo ya sehemu za mwisho yanatolewa katika mahitimisho.
Viambatisho
Viambatisho ni sehemu za ziada zinazofuata baada ya hitimisho. Unaweka nini katika viambatisho?—chochote ambacho hakifai vizuri katika sehemu kuu ya nyaraka ya kiufundi lakini hakiwezi kutolewa kabisa kwenye nyaraka ya kiufundi. Kiambatisho kwa kawaida hutumika kwa jedwali kubwa za data, vipande vikubwa vya msimbo wa mfano, ramani zinazoweza kufunguka, taarifa za msingi ambazo ni za msingi mno au za juu mno kwa mwili wa nyaraka ya kiufundi, au michoro mikubwa ambayo haiendani kabisa na mwili wa . Kile chochote unachokiona ni kikubwa mno kwa sehemu kuu ya nyaraka ya kiufundi au unachodhani kitakuwa cha kuvuruga na kukatisha mtiririko wa nyaraka ya kiufundi ni mgombea mzuri kwa kiambatisho. Kumbuka kwamba kila kiambatisho hupewa herufi (A, B, C, na kadhalika).
Vyanzo vya Habari
Kudokumentesha vyanzo vyako vya taarifa ni kuhusu kuanzisha, kudumisha, na kulinda uaminifu wako katika taaluma. Lazima utoe rejea ("kudokumentesha") kwa taarifa zilizokopwa bila kujali sura au fomu unazowasilisha nazo. Iwe unai-nukuu moja kwa moja, kuibadilisha kwa maneno yako, au kuifupisha— bado ni taarifa iliyokopwa. Iwe inatoka kitabu, makala, mchoro, jedwali, ukurasa wa wavuti, brosha ya bidhaa, au mtaalamu ambaye umemuhoji ana kwa ana— bado ni taarifa iliyokopwa.
Mifumo ya nyaraka hutofautiana kulingana na wataalamu na nyanja. Wainjiniya wanatumia mfumo wa IEEE; mifano yake inaonyeshwa katika sura hii nzima. Mfumo mwingine wa uandikishaji unaotumika mara kwa mara umetolewa na Chama cha Wanasaikolojia wa Marekani (APA). Angalia nyaraka kwa maelezo.
Nambari za Kurasa
Mtindo wa nambari za kurasa unaotumika katika usanifu wa jadi wa nyaraka za kiufundi unatofautiana na ule wa usanifu wa kisasa wa nyaraka za kiufundi, hasa kwa matumizi ya tarakimu ndogo za Kirumi katika sehemu ya awali (kila kitu kabla ya utangulizi).
Kumbuka: Nyaraka za kiufundi ndefu mara nyingi hutumia mtindo wa kupangilia nambari za kurasa unaojulikana kama "folio kwa sura" au "uparishaji wa nambari mara mbili" (kwa mfano, kurasa katika Sura ya 2 zingeandikishwa 2-1, 2-2, 2-3, na kadhalika). Vivyo hivyo, jedwali na michoro vitatumia mtindo huu wa kuorodhesha nambari. Mtindo huu unarahisisha mchakato wa kuongeza na kuondoa kurasa.
Maelekezo ya AI kwa Nyaraka za Kiufundi
Orodha za ukaguzi, ambazo kwa kawaida hazisomwi, zinaweza kutumika kama chanzo cha maagizo kwa AI kwa marekebisho machache. Nakili yafuatayo, bandika katika mfumo wa AI kama Gemini ya Google, na uone unaweza kuwa ulikosa nini.
Kumbuka: Marejeo yote kuhusu maudhui, muundo, mtindo wa barua za maombi au vipengele vyake yanaweza kupatikana katika hiyo kitabu cha mtandaoni cha uandishi wa kiufundi.
|
Maagizo ya AI kwa Nyaraka za Kiufundi Unapotaka AI itathmini mradi wa uandishi, jitambulisha, mwambie AI wewe ni nani na unataka nini. Mpe AI kitambulisho cha marejeo kwa ajili ya kufanya tathmini, kama kitabu cha mtandaoni. Kisha chapisha kile unachotaka Gemini ikague katika tathmini yake. Hapa kuna mfano: Habari, Akili ya bandia. Mimi ni David McMurrey, mwanafunzi wa usalama wa mtandao katika Austin Community College (Austin, Texas). Ninaomba kwamba utathmini hati ya kiufundi ifuatayo kwa kutumia hii Kitabu cha mtandaoni na maswali yafuatayo: |
Taarifa Zinazohusiana
Jedwali la Maudhui: Zana Muhimu ya Kupanga kwa Wasomaji
Ningethamini mawazo, majibu, na ukosoaji wako kuhusu sura hii: jibu lako—David McMurrey.
