Bagaman madalas na hindi pinapansin ng maraming mga gumagamit ng computer, tulungan ang mga file na magbigay ng pangunahing impormasyon tungkol sa kung paano gamitin ang application ng software na nauugnay nila. Sa pamamagitan ng pag-click sa "Tulong," ang isang gumagamit ay maaaring makakuha ng isang pangkalahatang ideya ng mga tampok ng programa, isang paglalarawan ng screen na tinitingnan niya, mga tagubilin sa kung paano gamitin ang programa upang maisagawa ang isang naibigay na gawain o basahin ang mga listahan ng mga madalas itanong tungkol sa programa at ang kanilang mga sagot. Ang pagsulat ng isang file ng tulong ay nangangailangan ng parehong kakayahang magtrabaho kasama ang mga aplikasyon ng software at ang kakayahang ipaliwanag ang mga bagay sa paraang maunawaan ng mga gumagamit.
Mga hakbang
Hakbang 1. Kumuha ng isang kopya ng software na dapat mong idokumento
Kung maaari, dapat ka ring makakuha ng isang kopya ng nakasulat na mga pagtutukoy para sa programa, kahit na hindi lahat ng mga developer ng software ay gumagana sa kanila. Sa ilang mga kaso, ang programmer ay lihis mula sa mga pagtutukoy, batay sa maikling oras ng pag-unlad o hindi makapag-code ng isang partikular na tampok.
Hakbang 2. Kumuha ng isang tool sa pag-aayos ng tulong
Habang posible na lumikha ng isang file ng tulong sa pamamagitan ng kamay, gamit ang isang rich-text-format (.rtf) na file, karamihan sa mga may-akda ng file ng tulong ay gumagamit ng isang application ng software upang isulat ang kanilang mga file ng tulong, tulad ng RoboHelp, Tulong at Manwal, Doc-To -Help, MadCap Flare o HelpLogix. Karamihan sa mga tool sa pag-aari ng tulong ay nagsasama ng isang text editor o gumagana sa isang programa sa pagproseso ng salita tulad ng Microsoft Word at magbigay ng isang interface ng gumagamit na hinahayaan ang may-akda ng tulong na makita kung paano magiging hitsura ang file ng tulong habang sinusulat niya ito habang sinusulat ang computer code sa likod ng mga eksena upang gumana ang tulong ng file. Ang ilang mga tool sa pag-aari ng tulong ay nagsasama rin ng mga editor ng graphics para sa paglikha ng mga screenshot na isasama sa help file.
Mayroong isang bilang ng mga format ng file ng tulong: Ang pinakakaraniwan ay Tulong ng HTML, na ginagamit ng mga application na tumatakbo sa Windows. (Ang isang mas matandang format, WinHelp, ay hindi na sinusuportahan.) Ang Apple at Unix bawat isa ay may kani-kanilang mga format, pati na rin, pati na rin ang Sun Microsystems, kasama ang JavaHelp nito. Ang mga application ng software na idinisenyo upang tumakbo sa ilalim ng maraming mga operating system ay maaaring gumamit ng isang cross-platform help system na tumatakbo sa Web browser ng gumagamit. Alinmang tulong ng tool sa pag-aari na ginagamit mo ang dapat suportahan ang (mga) format ng tulong kung saan ka makakalikha ng mga file ng tulong
Hakbang 3. Lumikha ng file ng proyekto ng tulong
Ang iyong tool sa pag-author ng tulong ay lilikha ng isang file ng proyekto ng tulong para sa iyo, batay sa ibinigay mong filename at iba pang impormasyon. Naglalaman ang pangunahing file ng proyekto ng impormasyon tungkol sa iba pang mga file, na nagsasama ng isang file ng mga nilalaman, isang file ng index, isa o higit pang mga file ng imahe at iba pang mga file.
- Kasama sa file ng mga nilalaman ang teksto sa help file na nagpapaliwanag kung paano gumagana ang application ng software na iyong dinodokumento. Karaniwang pinaghiwalay ang teksto sa mga paksa na sumasakop sa isang tukoy na screen, tampok o pamamaraan.
- Ang index file ay isang listahan ng mga paksa ng help file. Ginagamit ito upang lumikha ng isang talahanayan ng mga nilalaman na maaaring magamit ng mga gumagamit upang pumili ng isang paksa upang matingnan, pati na rin ang isang nahahanap na index sa loob ng help file.
- Ang mga file ng imahe ay mga graphic file ng mga screen ng programa o mga bahagi ng mga screen na ipinapakita sa loob ng help file upang mapahusay ang kakayahan ng mga gumagamit na maunawaan kung ano ang tinutukoy ng teksto ng tulong na file.
Hakbang 4. Ayusin ang laki ng window ng tulong
Maliban kung sinusulat mo ang help file upang lumitaw sa Web browser ng gumagamit, lilitaw ang help file sa sarili nitong window. Hinahayaan ka ng iyong tool sa pag-author ng tulong na ayusin ang pahalang at patayong mga sukat ng window sa isang sukat na hahayaan na basahin ng end user ang file ng tulong nang hindi nito nakagagambala ang application mismo. Ang pangunahing window ng tulong ay madalas sa isang format na tri-pane, na may kaliwa ang talaan ng mga nilalaman at ang piling paksa sa kanan.
Ang mga file ng tulong ay maaari ding magkaroon, bilang karagdagan sa pangunahing window, pangalawang mga bintana na naglalarawan sa isang partikular na tampok nang detalyado at awtomatikong ang laki ng mga pop-up window na nagbibigay ng maikling paglalarawan ng mga tampok. Ang mga file ng tulong ay maaari ring magsama ng naka-embed na teksto na lilitaw lamang kapag naka-highlight na teksto o isang pindutan ang na-click
Hakbang 5. Isulat ang mga paksa ng tulong
Upang magawa ito, kakailanganin mong suriin ang mga detalye o mismong programa upang lumikha ng mga paksa upang idokumento ang mga screen at tampok ng programa. Habang nilikha mo ang bawat paksa, idaragdag ito ng iyong tool sa pag-aayos ng tulong sa talahanayan ng mga nilalaman at index ng help file.
- Habang maaari mong buuin ang talahanayan ng mga nilalaman sa iyong pagpunta, nakakatulong na magkaroon ng ilang plano para sa kung paano ito ayusin. Maaari mong ayusin ang talahanayan ng mga nilalaman sa paligid ng mga screen ng programa, mga tampok nito, mga paraan upang magamit ito o ilang kombinasyon nito.
- Habang sinusulat mo ang mga paksa, isaalang-alang ang iba pang impormasyon sa file ng tulong na nais ng mga gumagamit na magkaroon ng mabilis na pag-access. Maaari kang lumikha ng mga jumps, o hyperlink, sa teksto ng tulong na file na kumonekta sa mga paksang mayroong impormasyon na iyon.
Hakbang 6. Magsama ng mga screenshot, kung kinakailangan
Maraming mga tampok sa programa ang pinakamahusay na ipinaliwanag na may isang kumbinasyon ng teksto at graphics. Maaari kang lumikha ng mga screenshot na alinman sa application na kasama ng iyong tool sa pag-aayos ng tulong o sa isang hiwalay na application, tulad ng Microsoft Paint, Paint Shop Pro o SnagIt.
- Ang teksto at mga screenshot ay dapat na magkasama na inilatag sa isang paksa tulad ng nakikita ng mga gumagamit ang screenshot at ang sumusuporta sa teksto nang walang labis na pag-scroll. Sa maraming mga kaso, gugustuhin mong ipakita ang isang bahagi ng isang screen ng programa sa halip na ang buong screen, o ipakita ang screenshot sa isang mas maliit na sukat kaysa sa orihinal. Ang iyong aplikasyon sa screenshot ay dapat na may kakayahang baguhin ang laki ng screenshot nang hindi lumabo o nawawalan ng detalye.
- Kung mahulaan mo ang mga pagbabago sa interface ng gumagamit sa pagitan ng pagsubok at mga huling bersyon ng programa, baka gusto mong pigilan ang paglikha ng mga screenshot hanggang sa magkaroon ka ng huling bersyon ng programa upang gumana.
Hakbang 7. Lumikha ng isang file ng mapa, kung kinakailangan ang isa
Ang ilang mga programa ay may kasamang mga pindutang "Tulong" para sa isang gumagamit upang mag-click at ipakita ang paksa sa file ng tulong na partikular na naglalarawan kung paano gumagana ang screen na iyon. Ang pagpapakita ng isang paksa sa ganitong paraan ay tinatawag na tulong na sensitibo sa konteksto at nangangailangan ng paglikha ng isang map file para sa programmer na mai-link ang pindutang "Tulong" sa tukoy na paksa sa iyong file ng tulong. Ang iyong tool sa pag-aayos ng tulong ay maaaring lumikha ng isa para sa iyo, o maaaring i-code ito ng programmer at ibigay ito sa iyo upang isama sa help file.
Hakbang 8. Compile ang help file
Lumilikha ang pag-iipon ng aktwal na file ng tulong na isasama sa programa. Para sa karamihan ng mga format ng tulong, isasama nito ang lahat ng mga sangkap ng sangkap na nilikha noong nilikha mo ang file ng tulong, kahit na ang ilang mga hindi naiayos na mga format ng tulong ay nangangailangan din ng mga indibidwal na mga file ng paksa ng tulong upang maisama sa programa.
Hakbang 9. Subukan ang file ng tulong
Kapag naipon mo na ang file ng tulong, kailangan mong subukan ito upang matiyak na ang lahat ng mga hyperlink ay kumonekta sa mga paksang dapat nila at naipakita nang tama ang lahat ng mga graphic. Kailangan ding subukan ang file ng tulong upang matiyak na ang nilalaman ay tumpak at naaangkop para sa mga gumagamit at sa isang pare-parehong format. Gusto mong suriin ang tulong ng file sa iyong sarili at suriin din ito ng mga tao.
Sa mas malaking mga proyekto ng file ng tulong, ang pag-iipon at pagsubok ay patuloy na proseso. Gusto mong i-compile ang help file at suriin ang iyong trabaho nang maraming beses bago lumikha ng huling bersyon
Hakbang 10. Bigyan ang file ng tulong sa developer upang isama sa programa
Nakasalalay sa likas na katangian ng proyekto at tulong ng format ng file, maaaring kailangan mong ibigay sa developer ang maraming mga file, kasama ang isang file ng mapa kung may mga paksang sensitibo sa konteksto.
