Miongozo ya Watumiaji

Tuambie ulipo!

Yaliyomo ya Sehemu Hii

Ujumbe wa uwasilishaji
Jalada la mbele na la nyuma, kurasa za kichwa
Taarifa ya toleo na alama za biashara
Jedwali la yaliyomo
Dibaji
Sura kuu za mwongozo wa mtumiaji
Viambatisho
Faharasa
Uwekaji wa nambari za kurasa
Maelekezo ya AI kwa miongozo ya watumiaji

Faharasa kuu

Maoni yako kuhusu sura hii

Tafuta!

Kozi Zinazohusiana

McMurrey Associates: Kozi za Mawasiliano ya Kiufundi

Tafadhali bofya hapa kumsaidia David McMurrey kulipia huduma ya upangishaji wa tovuti:
Changia kiasi chochote kidogo unachoweza
Uandishi wa kiufundi mtandaoni utaendelea kuwa bure.

Ukurasa huu uko kwenye matengenezo.

Nyaraka za kiufundi (ikiwemo vitabu vya mwongozo, makala za kiufundi, na miongozo) huwa na miundo tofauti kulingana na sekta, taaluma, au shirika. Sura hii inaonyesha muundo mmoja wa jadi. Ikiwa unasoma kozi ya uandishi wa kiufundi, hakikisha kuwa muundo unaowasilishwa katika sura hii unakubalika. Hali hii ni sawa pia ikiwa unaandika waraka wa kiufundi katika muktadha wa sayansi, biashara, au serikali.

Infografia ya sura hii iliyozalishwa na NotebookLLM

Kumbuka: Kwa miaka mingi, kitabu hiki cha mtandaoni cha uandishi wa kiufundi kilitumia neno “ripoti” kwa ujumla kurejelea karibu kila kitu kilichokuwa na taarifa za kiufundi. Hata hivyo, kwa kuwa “ripoti” inarejelea aina maalum ya waraka wa kiufundi, ilibidi kubadilisha matumizi ya neno la jumla kuwa “mwongozo wa mtumiaji,” kifupi cha waraka wa kiufundi.

Miongozo ya watumiaji (jina la jumla kwa nyaraka za kiufundi) huwa na mahitaji maalum kama ilivyo kwa aina nyingine yoyote ya mradi. Mahitaji ya miongozo ya watumiaji yanahusisha mpangilio wa ukurasa, mpangilio wa maudhui, muundo wa vichwa na orodha, muundo wa michoro, na kadhalika. Faida ya kuwa na muundo na mpangilio unaotakiwa ni kwamba wewe au mtu mwingine yeyote mnaweza kutarajia mwongozo huo kuandaliwa kwa namna iliyozoeleka—unajua cha kutafuta na mahali pa kukitafuta. Miongozo ya watumiaji mara nyingi husomwa kwa haraka—watu huwa na haraka ya kufikia taarifa wanazohitaji, hoja muhimu, hitimisho, na mambo mengine ya msingi. Muundo wa kawaida wa mwongozo wa mtumiaji ni kama kitongoji kinachofahamika.

Unapochambua muundo wa mwongozo wa mtumiaji, angalia jinsi baadhi ya sehemu zinavyojirudia. Kurudia huku kunahusiana na namna watu wanavyosoma miongozo ya watumiaji. Hawasomi mwongozo mzima kuanzia mwanzo hadi mwisho: wanaweza kuanza na muhtasari wa utendaji, kurukaruka kutoka sehemu moja hadi nyingine, na huenda wasisome kila ukurasa. Changamoto yako ni kubuni miongozo ya watumiaji ili wasomaji hawa wakutane na hoja zako kuu na hitimisho lako, bila kujali ni kiasi gani wanasoma au kwa mpangilio gani.

Hakikisha unaangalia mifano ya miongozo ya watumiaji.

Vipengele vya kawaida vya ripoti ya kiufundi ya jadi vinajadiliwa katika sura hii. Sehemu zifuatazo zinakuongoza kupitia kila kipengele, zikionyesha sifa zake muhimu. Unaposoma na kutumia miongozo hii, kumbuka kwamba ni miongozo tu, si amri. Kampuni, taaluma, na mashirika tofauti yana miongozo yao tofauti kuhusu miongozo ya watumiaji—utahitaji kuzoea mazoea yako kulingana na miongozo hiyo pamoja na ile inayowasilishwa hapa.

Ujumbe wa Uwasilishaji

Ujumbe wa uwasilishaji unaweza kuwa barua ya kufunika (au kumbukumbu) au barua pepe. Barua ya karatasi (au kumbukumbu) huambatanishwa nje ya mwongozo wa mtumiaji kwa klipu ya karatasi au kufungwa ndani ya mwongozo huo. Barua pepe huwa na kiungo cha kwenda kwenye mwongozo wa mtumiaji au huambatanisha mwongozo huo. Ni mawasiliano kutoka kwako—wewe mwandishi wa mwongozo wa mtumiaji—kwenda kwa mpokeaji, yaani mtu aliyeomba mwongozo huo na ambaye huenda hata anakulipa kwa ushauri wako wa kitaalamu. Kimsingi, inasema: “Sawa, huu hapa ni mwongozo wa mtumiaji tuliokubaliana kwamba ningeukamilisha kufikia tarehe fulani. Kwa ufupi, una mambo haya na yale, lakini haujumuishi mambo haya mengine. Nijulishe ikiwa unakidhi mahitaji yako.” Ujumbe wa uwasilishaji unaeleza muktadha—matukio yaliyosababisha kuandaliwa kwa mwongozo wa mtumiaji. Unajumuisha taarifa kuhusu mwongozo wa mtumiaji ambazo hazipaswi kuwepo ndani ya mwongozo wenyewe.

Mifano ya barua ya uwasilishaji na ujumbe wa uwasilishaji.

Katika mfano wa barua ya uwasilishaji, angalia muundo wa kawaida wa barua ya kibiashara. Ikiwa unaandika mwongozo wa mtumiaji wa ndani ya shirika, tumia muundo wa kumbukumbu; kwa vyovyote vile, maudhui na mpangilio ni yale yale:

Aya ya kwanza. Hutaja jina la mwongozo wa mtumiaji, likiandikwa kwa italiki. Pia hutaja tarehe ya makubaliano ya kuandika mwongozo wa mtumiaji.

Aya ya kati. Hujikita katika madhumuni ya mwongozo wa mtumiaji na kutoa muhtasari mfupi wa yaliyomo ndani yake.

Aya ya mwisho. Humhimiza msomaji kuwasiliana ikiwa ana maswali, maoni, au wasiwasi. Hufunga kwa ishara ya nia njema, ikieleza matumaini kwamba msomaji atauona mwongozo wa mtumiaji kuwa wa kuridhisha.

Kama ilivyo kwa kipengele kingine chochote katika mwongozo wa mtumiaji, huenda ukahitaji kurekebisha maudhui ya ujumbe huu (au kumbukumbu) kulingana na hali maalum. Kwa mfano, unaweza kutaka kuongeza aya nyingine inayoorodhesha maswali ambayo ungependa wasomaji wazingatie wanapokagua mwongozo wa mtumiaji.

Jalada la mbele na la nyuma, ukurasa wa kichwa

Ikiwa mwongozo wako wa mtumiaji una zaidi ya kurasa kumi, uufunge kwa njia fulani na uandae lebo ya jalada.

Jalada la Mbele na la Nyuma

Ukurasa wa Kichwa, Taarifa ya Toleo, Hakimiliki, na Alama za Biashara

Sura Kuu za Mwongozo wa Mtumiaji

Viambatisho

Faharasa

Kwa urahisi wake, kichwa cha mwongozo wa mtumiaji mara nyingi ni nakala ya kilichoandikwa kwenye jalada la mbele—labda kikiwa na maelezo machache ya ziada.

Taarifa ya Toleo

Jedwali la Yaliyomo

Bila kujali muundo wa jedwali la yaliyomo (TOC) unaoutumia, haya ni viwango vya kawaida:

• Nambari ya ukurasa wa kuanzia pekee. Ingawa baadhi ya zana za kiotomatiki huonyesha anuwai ya kurasa, kiwango cha kawaida ni kuonyesha nambari ya ukurasa wa kwanza pekee.
• Viwango vya vichwa vya kujumuisha. Kama inavyoonyeshwa kwenye TOC hapo juu, onyesha viwango viwili vya juu vya vichwa isipokuwa mwongozo wa mtumiaji una vichwa vidogo vingi. TOC inapaswa kutoa njia ya haraka ya kupata taarifa kwa mtazamo mmoja.
• Nafasi na matumizi ya herufi kubwa. Angalia jinsi vipengele vya maandishi katika TOC hapo juu vilivyopangwa kwa kuachwa nafasi. Vichwa vya kiwango cha kwanza hutumia herufi kubwa zote; vya kiwango cha pili hutumia herufi kubwa za mwanzo wa kila neno kuu; vya kiwango cha tatu hutumia mtindo wa sentensi.
• Nafasi ya wima. Angalia kuwa sehemu za kiwango cha kwanza zina nafasi ya ziada juu na chini, jambo linaloongeza usomaji.

Kulingana na mahitaji ya shirika lako, una chaguo mbili za muundo wa jedwali la yaliyomo (TOC):

Jedwali hili la yaliyomo linatumia mtindo wa nambari za desimali kwa sura na sehemu, ambao ni wa kawaida katika miongozo ya watumiaji. Mengine katika kitabu hiki hutumia mtindo wa nambari za Kirumi kwa herufi kubwa kwa sura za kiwango cha juu pekee.

Unapata shida kuunda TOC iliyopangwa vizuri? Tazama Unda jedwali la yaliyomo linaloonekana kitaalamu.

Alama za koma na nambari za kurasa. Ikiwa muundo wa nukta za mwongozo hauhitajiki na unapendelea kuziepuka, unaweza kutumia muundo huu unaokubalika kwa kawaida:

Dibaji

Tazama mfano huu wa dibaji:

Ikiwa hakuna majedwali, iite “Orodha ya Vielelezo.” Katika kozi ya uandishi wa kiufundi, muulize mwalimu wako ikiwa mtindo wa nambari za desimali kwa vichwa unahitajika.

Sura Kuu za Mwongozo wa Mtumiaji

Mwili wa mwongozo wa mtumiaji bila shaka ni maandishi makuu ya mwongozo huo—sehemu kati ya utangulizi na hitimisho. Zilizoonyeshwa hapa chini ni kurasa za mfano.

Viambatisho

Viambatisho ni sehemu za ziada zinazofuata baada ya hitimisho. Unaweka nini katika viambatisho?—chochote ambacho hakiingii kwa urahisi katika sehemu kuu ya mwongozo wa mtumiaji lakini hakiwezi kuachwa kabisa. Kiambatisho hutumika kwa kawaida kwa majedwali makubwa ya data, vipande vikubwa vya msimbo wa mfano, ramani zinazofunguka, maelezo ya msingi yaliyo rahisi sana au ya juu sana kwa mwili wa mwongozo, au vielelezo vikubwa ambavyo haviingii vizuri katika mwili wa mwongozo. Kitu chochote unachohisi ni kikubwa mno kwa sehemu kuu ya mwongozo au kinachoweza kuvuruga mtiririko wa maandishi ni mgombea mzuri wa kiambatisho. Angalia kuwa kila kiambatisho hupewa herufi (A, B, C, na kadhalika).

Faharasa

Kurekodi vyanzo vyako vya taarifa kunahusu kuanzisha, kudumisha, na kulinda uaminifu wako katika taaluma. Lazima urekodi (“unukuu”) taarifa yoyote uliyoazima bila kujali namna unavyoitoa. Iwe unanukuu moja kwa moja, unafupisha, au unaeleza kwa maneno yako—bado ni taarifa iliyoazimwa. Iwe inatoka kwenye kitabu, makala, mchoro, jedwali, ukurasa wa wavuti, brosha ya bidhaa, au mtaalamu uliyemhoji ana kwa ana—bado ni taarifa iliyoazimwa.

Mifumo ya uandishi wa marejeleo hutofautiana kulingana na taaluma na nyanja. Wahandisi hutumia mfumo wa IEEE, mifano yake imeonyeshwa katika sura hii. Mfumo mwingine unaotumika sana hutolewa na Shirika la Saikolojia la Marekani (APA). Tazama uandishi wa marejeleo kwa maelezo zaidi.

Vipengele Vingine vya Mwongozo wa Mtumiaji

Uwekaji wa Nambari za Kurasa

Mtindo wa uwekaji wa nambari za kurasa unaotumika katika muundo wa jadi wa mwongozo wa mtumiaji hutofautiana na muundo wa kisasa hasa kwa matumizi ya nambari za Kirumi ndogo katika sehemu za awali (kila kitu kabla ya utangulizi).

Vichwa

Katika miongozo yote ya watumiaji isipokuwa ile mifupi sana (kurasa mbili au chini), tumia vichwa kutenganisha mada na mada ndogo. Vichwa humwezesha msomaji kuchanganua mwongozo kwa haraka na kushuka kwenye sehemu ambazo zinawasilisha taarifa wanazohitaji. Tazama vichwa kwa miongozo ya matumizi ya vichwa.

Orodha zenye Nukta na Zenye Nambari

Katika mwili wa mwongozo wa mtumiaji, tumia pia orodha zenye nukta, zenye nambari, na orodha za safu mbili pale inapofaa. Orodha husaidia kwa kusisitiza hoja muhimu, kurahisisha ufuatiliaji wa taarifa, na kuvunja kuta ndefu za maandishi. Tazama orodha kwa miongozo ya matumizi ya orodha.

Alama, Nambari, na Vifupisho

Mijadala ya kiufundi kwa kawaida huwa na alama, nambari, na vifupisho vingi. Kumbuka kwamba kanuni za kutumia nambari badala ya maneno hutofautiana katika ulimwengu wa kiufundi. Kanuni ya zamani ya kuandika nambari zote chini ya 10 kwa maneno haitumiki kila wakati katika miongozo ya watumiaji ya kiufundi. (Tazama nambari dhidi ya maneno kwa miongozo.)

Michoro na Vichwa vya Vielelezo

Katika nyaraka za kiufundi, huenda ukahitaji michoro, ramani, majedwali, na chati. Hivi si tu huwasilisha aina fulani za taarifa kwa ufanisi zaidi bali pia huipa mwongozo wako wa mtumiaji mwonekano wa kitaalamu na mamlaka zaidi. Ikiwa hujawahi kuongeza michoro ya aina hizi katika waraka, kuna njia rahisi kiasi za kufanya hivyo—huhitaji kuwa msanii wa kitaalamu. Kwa mikakati ya kuongeza michoro, tazama michoro. Kwa mikakati ya kuongeza majedwali, tazama majedwali.

Marejeleo ya Msalaba

Huenda ukahitaji kuwaelekeza wasomaji kwenye taarifa zinazohusiana kwa karibu ndani ya waraka wako wa kiufundi, au kwenye vyanzo vingine vyenye taarifa muhimu. Haya huitwa marejeleo ya msalaba. Kwa mfano, yanaweza kumwelekeza msomaji kutoka maelezo ya kifaa kwenda kwenye mchoro wake; au kwenda kwenye kiambatisho chenye maelezo ya msingi yasiyofaa kuwekwa kwenye maandishi makuu; au nje ya mwongozo wako kwenda kwenye makala, miongozo, au vitabu vingine vyenye taarifa zinazohusiana. Unapounda marejeleo ya msalaba, fuata miongozo iliyowasilishwa katika marejeleo ya msalaba.

• Kurasa zote katika mwongozo wa mtumiaji (ndani yake lakini bila kuhesabu jalada la mbele na la nyuma) hupewa nambari; hata hivyo, kwenye baadhi ya kurasa nambari hizo hazionyeshwi.
• Katika muundo wa kisasa, kurasa zote hutumia nambari za Kiarabu; katika muundo wa jadi, kurasa zote kabla ya utangulizi hutumia nambari za Kirumi ndogo.
• Katika kurasa maalum, kama ukurasa wa kichwa na ukurasa wa kwanza wa utangulizi, nambari za kurasa hazionyeshwi.
• Nambari za kurasa zinaweza kuwekwa katika maeneo mbalimbali ya ukurasa. Kwa kawaida, chaguo bora na rahisi zaidi ni chini katikati ya ukurasa (ukikumbuka kuzificha kwenye kurasa maalum).
• Ikiwa utaweka nambari za kurasa juu ya ukurasa, lazima uzifiche kwenye kurasa za mwanzo wa sura au sehemu ambako kichwa kiko juu ya ukurasa.

Kumbuka: Miongozo mirefu ya watumiaji mara nyingi hutumia mtindo wa uwekaji nambari unaoitwa folio-kwa-sura au uorodheshaji mara mbili (kwa mfano, kurasa katika Sura ya 2 hupewa nambari 2-1, 2-2, 2-3, n.k.). Vivyo hivyo, majedwali na vielelezo hutumia mtindo huu. Mtindo huu hurahisisha mchakato wa kuongeza au kuondoa kurasa.

Maelekezo ya Akili Bandia (AI) kwa Miongozo ya Watumiaji

Orodha za ukaguzi, ambazo kwa kawaida hazisomwi, zinaweza kutumika kama chanzo cha maelekezo ya AI kwa marekebisho fulani. Nakili yafuatayo, yape kwenye mfumo wa AI kama vile Gemini ya Google, kisha uone ni mambo gani huenda umekosa.

Kumbuka: Marejeleo yote ya maudhui, mpangilio, na mtindo wa ripoti za data au vipengele vyake yanapatikana katika kitabu cha mtandaoni cha uandishi wa kiufundi.

Taarifa Zinazohusiana

Jinsi ya Kuandika Mada za Usaidizi Zinazoeleweka kwa Watumiaji Wanaoanza. clickhelp.com

Ningefurahi kupata mawazo, maoni, na ukosoaji wako kuhusu sura hii: maoni yako—David McMurrey.