Miongozo

Moja mwongozo, kama tunavyoiainisha hapa, ni mchanganyiko wa yafuatayo:

• dhana taarifa
• maelekezo taarifa
• Maelezo ya marejeleo

Vyote vinazingatia mada maalum kwa mahitaji ya hadhira maalum. Ikiwa unachukua kozi ya uandishi wa kiufundi ukitumia kitabu hiki, mradi wako wa kitabu cha mwongozo lazima Jumuisha kwa namna fulani kila mojawapo ya vipengele hivi vitatu. Zaidi ya hayo, vipengele hivi vinapaswa kufaa kwa asili na kimantiki kwa mradi wako wa mwongozo.

Hakikisha uangalie mifano.

Infografiki iliyotengenezwa na NotebookLM ya sura hii

Misingi ya Mwongozo

Madhana. Taarifa za dhana zinaeleza jinsi mambo yanavyofanya kazi, jinsi mambo yanavyowekwa pamoja. Kwa maagizo magumu zaidi, lazima ujue baadhi ya dhana, nadharia, muktadha, na kanuni ili kutekeleza maagizo hayo. Chukulia mfano wa kipengele cha programu kinachokuwezesha kubadilisha au kuunda rangi yako mwenyewe. Kutumia programu kama Photoshop, Illustration, CorelDraw au Paint Shop Pro kufanya hili—vibonye na visogezi halisi— ni rahisi. Lakini kuelewa jinsi tona, ukali, mwangaza, utimilifu wa rangi, wiani, kontrasti, RGB— ni ngumu. Lazima ujue nadharia ya rangi za kompyuta ili kuunda rangi unayohitaji.

Fikiria mfano mwingine: amri rahisi za mfumo wa faili wa Linux—ls, cd, cp, mv, pwd. Ili kutumia amri hizi, unahitaji kuelewa ni nini mafaili na saraka (direktori) ni, na labda pia ni nini mfumo wa uendeshaji pamoja na alama za jokeri. Hauwezi kabisa kuelewa jinsi ya kutumia amri hizi—kufuata maelekezo ukitumia hizo—isipokuwa ukielewa dhana hizi za msingi.

Maelekezo. Ikiwa unaelewa dhana za msingi, basi unaweza kufuata kwa busara taratibu za hatua kwa hatua. Maelekezo ni zile orodha za nambari ambazo zinakuongoza kwa makini kupitia taratibu. Maelekezo yamo kila mahali, kwenye vifungashio vya bidhaa, katika mwongozo wa mtumiaji unaokuja pamoja na vifaa vya nyumbani na kompyuta.

Marejeleo. Kategoria ya mwisho ya taarifa inahusu taarifa za kutafuta, au taarifa za rejea za haraka. Ikiwa ulifuata mfano wa mfumo wa faili uliotajwa hapo juu, ulilazimika kusoma na kujifunza kwanza dhana za mafaili, saraka na ishara za wildcard (alama za kibadilishaji). Kisha ukaweza kufuata na kuelewa maagizo ya kubadilisha saraka, kunakili, kufuta au kuhamisha mafaili. Baada ya muda, hata hivyo, hauhitaji tena maagizo hayo kila mara, lakini mara kwa mara una mahitaji maalum ambayo hayajafunikwa katika sehemu ya maagizo au huwezi kukumbuka taratibu fulani zilizofunikwa katika sehemu hiyo. Wakati huu ndio unapohitaji taarifa za rejea za msingi: unakwenda tu kwenye sehemu hiyo na kuzitafuta kwa haraka.

Na hivyo, baada ya muda, hauhitaji tena sehemu ya dhana wala sehemu ya maelekezo: umezoea taratibu hizo kiasi kwamba unazijua kwa moyo. Lakini wakati mwingine unasahau undani kidogo au una kazi maalum ambayo haujawahi kuifanya kabla —hapo ndipo unapoenda kwenye sehemu ya rejea. Labda unaweza kuondoa kabisa sehemu za dhana na maelekezo na kuzitupa. Sehemu ya rejea pekee ndiyo utakayohitaji.

Muundo na Mtindo wa Mwongozo

Katika kozi ya uandishi wa kiufundi inayotumia kitabu hiki, huenda unatarajiwa kutumia miongozo maalum kwa matumizi ya vichwa, orodha, taarifa, michoro, majedwali, nyaraka, na utangulizi:

Kielelezo cha mwongozo. Kutoka kwenye kiungo hapa chini unaweza kupata toleo la mfano la mwongozo. Linajumuisha kurasa zote zinazohitajika katika muundo mzuri. Katika waraka huu wa Word zimetajwa mitindo ya aya na mitindo ya herufi ambayo itafanya kazi yako iwe rahisi na kuongeza stadi za kitaalamu kwenye mkusanyiko wako wa ujuzi.

Prototipu ya mwongozo

Prototipu ya yaliyomo. Prototipu ya jedwali la yaliyomo ni muhimu sana: inakupatia mitindo ya Word ili kutengeneza jedwali la yaliyomo lenye muonekano wa kitaalamu. Ni vigumu kupata upangaji wa kushoto na kulia pamoja na nukta za uongozi kwa usahihi:

Prototipu ya jedwali la yaliyomo

Mifano ya Mwongozo

Hapa kuna baadhi ya viungo vya mifano ya vitabu vya mwongozo. Kumbuka kwamba kuna baadhi ya matatizo katika mifano; mimi nimeyatoa maoni kuhusu mengi ya matatizo hayo. Baadhi yao karibu kuwa vitabu vya mwongozo. Kile kinachofanya kitabu kuwa mwongozo kwangu ni kuwepo kwa majadiliano ya dhana, maelekezo, na taarifa za marejeo.

Hakikisha kuangalia mifano.

Maagizo ya AI kwa Vitabu vya Mwongozo

Orodha za ukaguzi, ambazo kwa kawaida hazisomwi, zinaweza kutumika kama chanzo cha vichocheo vya AI baada ya marekebisho madogo. Nakili yafuatayo, bandika kwenye mfumo wa AI kama Gemini wa Google, na uone ni nini umekosa.

Kumbuka: Marejeo yote kuhusu yaliyomo, muundo, na mtindo wa techdocs au vipengele vyake yanaweza kupatikana katika kitabu cha mtandaoni cha uandishi wa kiufundi.

Inakuja hivi karibuni!

Ningethamini mawazo yako, hisia zako, na ukosoaji wako kuhusu sura hii: jibu lako—David McMurrey.