Nyaraka nzuri za programu, iwe ni nyaraka za vipimo kwa waandaaji programu na wanaojaribu, hati za kiufundi kwa watumiaji wa ndani, au miongozo na faili za msaada kwa watumiaji wa mwisho, itasaidia watumiaji kuelewa huduma na programu. Nyaraka nzuri ni nyaraka ambazo ni maalum, wazi, na zinafaa, na habari zote ambazo mtumiaji anahitaji. Nakala hii itakuongoza kuandika nyaraka za programu kwa watumiaji wa kiufundi na watumiaji wa mwisho.
Hatua
Njia ya 1 ya 2: Kuandika Nyaraka za Programu kwa Watumiaji wa Ufundi
Hatua ya 1. Jua habari gani ya kujumuisha
Hati ya vipimo hutumiwa kama mwongozo wa rejeleo kwa wabuni wa viunzi, waandaaji programu wanaoandika nambari, na wanaojaribu ambao wanathibitisha utendaji wa programu. Habari ambayo inahitaji kujumuishwa itategemea mpango unaoundwa, lakini inaweza kujumuisha yafuatayo:
- Faili muhimu katika programu, kama faili zilizoundwa na timu ya maendeleo, hifadhidata zilizopatikana wakati programu inaendesha, na programu za mtu wa tatu.
- Kazi na sehemu ndogo, pamoja na ufafanuzi wa matumizi ya kazi / kanuni ndogo, pembejeo na pato.
- Vigeuzi vya programu na vipindi, na jinsi vinatumiwa.
- Muundo wa mpango wa jumla. Kwa mipango inayotegemea gari, huenda ukahitaji kuelezea kila moduli na maktaba. Au, ikiwa unaandika mwongozo wa programu inayotegemea wavuti, unaweza kuhitaji kuelezea faili zipi zinazotumiwa na kila ukurasa.
Hatua ya 2. Amua ni kiwango gani cha nyaraka kinachopaswa kuwapo na kinachoweza kutenganishwa na nambari ya mpango
Nyaraka zaidi za kiufundi ambazo zimejumuishwa kwenye nambari ya programu, itakuwa rahisi kuisasisha na kuitunza, na pia kuelezea matoleo tofauti ya programu. Kwa kiwango cha chini, nyaraka katika nambari ya programu inapaswa kujumuisha utumiaji wa kazi, sehemu ndogo, vigeuzi, na viboreshaji.
- Ikiwa nambari yako ya chanzo ni ndefu, unaweza kuandika nyaraka kwenye faili ya msaada, ambayo inaweza kuorodheshwa au kutafutwa na maneno kadhaa. Faili tofauti za nyaraka zinafaa ikiwa mantiki ya programu imegawanyika kwa kurasa kadhaa na inajumuisha faili za msaada, kama programu ya wavuti.
- Lugha zingine za programu (kama Java, Visual Basic. NET, au C #) zina viwango vyao vya nyaraka. Katika hali kama hizo, fuata nyaraka za kawaida ambazo lazima zijumuishwe kwenye nambari ya chanzo.
Hatua ya 3. Chagua zana inayofaa ya nyaraka
Katika hali nyingine, zana ya nyaraka imedhamiriwa na lugha ya programu inayotumika. Lugha C ++, C #, Visual Basic, Java, PHP, na zingine zina zana zao za nyaraka. Walakini, ikiwa sio hivyo, zana zinazotumiwa zitategemea nyaraka zinazohitajika.
- Kichakataji maneno kama Microsoft Word inafaa kuunda faili za maandishi, maadamu nyaraka ni fupi na rahisi. Ili kuunda nyaraka ndefu na maandishi magumu, waandishi wengi wa kiufundi huchagua zana maalum ya nyaraka, kama Adobe FrameMaker.
- Faili za usaidizi za kuweka nambari ya chanzo zinaweza kuundwa na mpango wa jenereta ya faili ya msaada, kama vile RoboHelp, Msaada na Mwongozo, Doc-To-Help, MadCap Flare, au HelpLogix.
Njia 2 ya 2: Kuandika Nyaraka za Programu kwa Watumiaji wa Mwisho
Hatua ya 1. Jua sababu za kibiashara zilizo msingi wa uundaji wa mwongozo
Wakati sababu kuu ya nyaraka za programu ni kusaidia watumiaji kuelewa jinsi ya kutumia programu hiyo, kuna sababu zingine kadhaa ambazo zinaweza kuwa msingi wa uundaji wa nyaraka, kama vile kusaidia idara ya uuzaji kuuza programu hiyo, kuboresha picha ya kampuni, na kupunguza msaada wa kiufundi gharama. Katika visa vingine, nyaraka zinahitajika kufuata kanuni au mahitaji mengine ya kisheria.
Walakini, nyaraka sio mbadala nzuri ya kiolesura. Ikiwa programu inahitaji nyaraka nyingi kufanya kazi, inapaswa kutengenezwa kuwa ya angavu zaidi
Hatua ya 2. Jua hadhira lengwa ya nyaraka
Kwa ujumla, watumiaji wa programu wana ujuzi mdogo wa kompyuta zaidi ya programu zinazotumiwa nao. Kuna njia kadhaa za kukidhi mahitaji yao ya nyaraka:
- Makini na kichwa cha mtumiaji wa programu. Kwa mfano, msimamizi wa mfumo kwa ujumla anaelewa matumizi anuwai ya kompyuta, wakati katibu anajua tu programu ambazo hutumia kuingiza data.
- Makini na watumiaji wa programu. Ingawa nafasi zao kwa ujumla zinaambatana na majukumu yaliyofanywa, nafasi hizi zinaweza kuwa na mzigo tofauti wa kazi, kulingana na mahali pa biashara. Kwa kuhoji watumiaji watarajiwa, unaweza kujua ikiwa tathmini yako ya jina la kazi ni sahihi.
- Makini na nyaraka zilizopo. Nyaraka za utendaji wa programu na vipimo vinaweza kuonyesha kile watumiaji wanahitaji kujua ili kuzitumia. Walakini, kumbuka kuwa watumiaji wanaweza kuwa hawapendi kujua "matumbo" ya programu.
- Jua kinachohitajika kumaliza kazi, na inachukua nini kabla ya kuimaliza.
Hatua ya 3. Tambua fomati inayofaa kwa nyaraka
Nyaraka za programu zinaweza kupangwa kwa muundo 1 au 2, ambayo ni vitabu vya rejea na miongozo. Wakati mwingine, kuchanganya fomati mbili ni suluhisho nzuri.
- Fomati za marejeleo hutumiwa kuelezea huduma zote za programu, kama vifungo, tabo, uwanja, na masanduku ya mazungumzo, na jinsi zinavyofanya kazi. Faili zingine za usaidizi zimeandikwa katika muundo huu, haswa zile ambazo ni nyeti kwa muktadha. Mtumiaji anapobofya Usaidizi kwenye skrini fulani, mtumiaji atapokea mada inayofaa.
- Fomati ya mwongozo hutumiwa kuelezea jinsi ya kufanya kitu na programu. Miongozo kwa ujumla imechapishwa au muundo wa PDF, ingawa kurasa zingine za msaada pia zinajumuisha maagizo ya jinsi ya kufanya vitu kadhaa. (Kwa ujumla, fomati za mwongozo sio nyeti za muktadha, lakini zinaweza kuunganishwa kutoka kwa mada nyeti ya muktadha). Vitabu vya mkono kwa ujumla viko katika mfumo wa mwongozo, na muhtasari wa majukumu ya kufanywa katika maelezo na mwongozo uliopangwa kwa hatua.
Hatua ya 4. Amua juu ya aina ya nyaraka
Nyaraka za programu kwa watumiaji zinaweza kuwekwa katika moja au zaidi ya fomati zifuatazo: miongozo iliyochapishwa, faili za PDF, faili za msaada, au msaada mkondoni. Kila aina ya nyaraka imeundwa kukuonyesha jinsi ya kutumia kazi za programu, iwe ni mwongozo au mafunzo. Nyaraka mkondoni na kurasa za msaada zinaweza pia kujumuisha video za maonyesho, maandishi, na picha za tuli.
Msaada mkondoni na faili za usaidizi zinapaswa kuorodheshwa na kutafutwa kwa kutumia maneno muhimu ili watumiaji waweze kupata habari wanayohitaji haraka. Ingawa programu ya jenereta ya faili ya msaada inaweza kuunda faharisi kiatomati, bado inashauriwa uunda faharisi kwa kutumia maneno muhimu yaliyotafutwa
Hatua ya 5. Chagua zana inayofaa ya nyaraka
Vitabu vilivyochapishwa au PDF zinaweza kuundwa na programu ya kusindika neno kama vile Neno au mhariri wa maandishi wa hali ya juu kama vile FrameMaker, kulingana na urefu na ugumu wa faili. Faili za usaidizi zinaweza kuandikwa na mpango wa kuunda faili ya msaada, kama vile RoboHelp, Msaada na Mwongozo, Doc-To-Help, Flare, HelpLogix, au HelpServer.
Vidokezo
- Maandishi ya nyaraka za programu yanapaswa kujengwa kwa njia ambayo ni rahisi kusoma. Weka picha karibu na maandishi yanayofaa iwezekanavyo. Vunja nyaraka na sehemu na mada kimantiki. Kila sehemu au mada inapaswa kuelezea shida maalum, kazi zote na huduma za programu. Maswala yanayohusiana yanaweza kuelezewa na viungo au orodha za kumbukumbu.
- Kila moja ya zana za nyaraka zilizoelezewa katika kifungu hiki zinaweza kuongezewa na programu ya kutengeneza skrini, kama SnagIt ikiwa hati yako inahitaji viwambo vya skrini kadhaa. Kama nyaraka zingine, unapaswa pia kujumuisha viwambo vya skrini kusaidia kuelezea jinsi programu inavyofanya kazi, badala ya "kumshawishi" mtumiaji.
- Kuzingatia mtindo ni muhimu sana, haswa ikiwa unaandika nyaraka za programu kwa watumiaji wa mwisho. Wasiliana na watumiaji na kiwakilishi "wewe", badala ya "mtumiaji".
