Kuigi paljud arvutikasutajad seda sageli ignoreerivad, pakuvad abifailid põhiteavet sellega seotud tarkvararakenduse kasutamise kohta. Kui klõpsate nupul „Abi”, saab kasutaja ülevaate programmi funktsioonidest, vaadatava ekraani kirjelduse, juhised selle kohta, kuidas programmi antud ülesande täitmiseks kasutada, või lugeda loendeid korduma kippuvate küsimuste kohta programm ja nende vastused. Abifaili kirjutamine nõuab nii tarkvararakendustega töötamise oskust kui ka oskust selgitada asju kasutajale arusaadaval viisil.
Sammud
Samm 1. Hankige koopia tarkvarast, mida soovite dokumenteerida
Võimalusel peaksite hankima ka programmi kirjalike spetsifikatsioonide koopia, kuigi mitte kõik tarkvaraarendajad ei tööta nendega. Mõnel juhul kaldub programmeerija spetsifikatsioonidest kõrvale lühikese arendamisaja või teatud funktsiooni kodeerimata jätmise tõttu.
Samm 2. Hankige abi koostamise tööriist
Kuigi abifaili on võimalik luua käsitsi, kasutades rikkaliku teksti vormingus (.rtf) faili, kasutavad enamik abifailide autoreid oma abifailide kirjutamiseks tarkvararakendust, näiteks RoboHelp, Help and Manual, Doc-To -Abi, MadCap Flare või HelpLogix. Enamik abi koostamise tööriistu hõlmavad tekstiredaktorit või töötavad koos tekstitöötlusprogrammiga, nagu Microsoft Word, ja pakuvad kasutajaliidest, mis võimaldab abiautoril näha, kuidas abifail näeb välja, kui ta seda kirjutades kirjutab, kirjutades samal ajal kulisside taga abifaili toimimiseks. Mõned abitööriistad sisaldavad ka graafika redigeerijaid abifaili kaasatavate ekraanipiltide loomiseks.
Abi failivorminguid on mitmeid: Kõige tavalisem on HTML -abi, mida kasutavad Windowsiga töötavad rakendused. (Vanemat vormingut WinHelp enam ei toetata.) Apple'il ja Unixil on samuti oma vorming, samuti Sun Microsystemsil oma JavaHelpiga. Tarkvararakendused, mis on loodud töötama mitme operatsioonisüsteemi all, võivad kasutada platvormideülest abisüsteemi, mis töötab kasutaja veebibrauseris. Ükskõik, millist abi koostamise tööriista kasutate, peaks see toetama abivormingut (-vorme), millesse abifailid luuakse
Samm 3. Looge abiprojekti fail
Teie abi koostamise tööriist loob teie jaoks failinime ja muu teabe põhjal abiprojekti faili. Põhiprojektifail sisaldab teavet teiste failide kohta, mis sisaldavad sisufaili, indeksifaili, ühte või mitut pildifaili ja muid faile.
- Sisufail sisaldab abifailis teksti, mis selgitab, kuidas teie dokumenteeritav tarkvararakendus töötab. Tavaliselt on tekst jaotatud teemadeks, mis hõlmavad teatud ekraani, funktsiooni või protseduuri.
- Indeksifail on abifaili teemade loend. Seda kasutatakse sisukorra loomiseks, mille abil kasutajad saavad valida vaadatava teema, samuti abifailis otsitava indeksi.
- Pildifailid on programmiekraanide graafilised failid või nende ekraanide osad, mis kuvatakse abifailis, et parandada kasutajate võimet mõista, millele abifaili tekst viitab.
Samm 4. Reguleerige abiakna suurust
Kui te ei kirjuta abifaili kasutaja veebibrauserisse, kuvatakse abifail oma aknas. Teie abi koostamise tööriist võimaldab teil kohandada akna horisontaalseid ja vertikaalseid mõõtmeid suuruseks, mis võimaldab lõppkasutajal lugeda abifaili, ilma et see takistaks rakendust ennast. Peamine abiaken on sageli kolme paani vormingus, sisukord vasakul ja valitud teema paremal.
Abifailidel võivad lisaks peaaknale olla ka sekundaarsed aknad, mis kirjeldavad konkreetset funktsiooni üksikasjalikult, ja automaatselt suuruse muutvad hüpikaknad, mis kirjeldavad funktsioone. Abifailid võivad sisaldada ka manustatud teksti, mis kuvatakse ainult esiletõstetud teksti või nupu klõpsamisel
Samm 5. Kirjutage abiteemad
Selleks peate üle vaatama spetsifikatsioonid või programmi enda, et luua teemad programmi ekraanide ja funktsioonide dokumenteerimiseks. Iga teema loomisel lisab teie abi koostamise tööriist selle abifaili sisukorda ja indeksisse.
- Kuigi saate sisukorra koostada, aitab see koostada mõningaid plaane. Sisukorra saate korraldada programmi ekraanide, funktsioonide, kasutusviiside või nende kombinatsioonide ümber.
- Teemade kirjutamisel arvestage abifailis muud teavet, millele kasutajad soovivad kiiret juurdepääsu. Saate luua hüppeid või hüperlinke abifaili teksti, mis ühendab neid andmeid sisaldavate teemadega.
Samm 6. Vajadusel lisage ekraanipildid
Paljusid programmi funktsioone saab kõige paremini selgitada teksti ja graafika kombinatsiooniga. Ekraanipilte saate luua kas abi koostamise tööriistaga kaasas oleva rakendusega või eraldi rakendusega, näiteks Microsoft Paint, Paint Shop Pro või SnagIt.
- Tekst ja ekraanipildid tuleks paigutada teemasse koos nii, et kasutajad näeksid ekraanipilti ja selle lisateksti ilma liigse kerimiseta. Paljudel juhtudel soovite kogu ekraani asemel näidata programmi ekraani osa või kuvada ekraanipildi originaalist väiksema suurusega. Teie ekraanipildirakendus peaks suutma muuta ekraanipildi suurust hägustamata või üksikasju kaotamata.
- Kui prognoosite programmi test- ja lõppversiooni kasutajaliideses muudatusi, võiksite ekraanipiltide loomisest loobuda, kuni saate töötada programmi lõpliku versiooniga.
Samm 7. Vajadusel looge kaardifail
Mõned programmid sisaldavad nuppe „Abi”, et kasutaja saaks klõpsata ja kuvada teemat abifailis, mis kirjeldab täpselt selle ekraani toimimist. Teema kuvamist sel viisil nimetatakse kontekstitundlikuks abiks ja see nõuab programmeerija jaoks kaustafaili loomist, et linkida nupp "Abi" konkreetse teemaga teie abifailis. Teie abi koostamise tööriist saab selle teile luua või programmeerija saab selle kodeerida ja anda teile abifaili lisamiseks.
Samm 8. Koostage abifail
Kompileerimine loob tegeliku abifaili, mis lisatakse programmi. Enamiku abivormingute puhul hõlmab see kõiki abifaili loomisel loodud komponendifaile, kuigi mõned kompileerimata abivormingud nõuavad ka üksikute abiteemade failide lisamist programmi.
Samm 9. Testige abifaili
Kui olete abifaili koostanud, peate seda testima, veendumaks, et kõik hüperlingid ühenduvad nende teemadega, millega nad peaksid, ja kogu graafika kuvatakse õigesti. Samuti tuleb abifaili testida, et tagada sisu täpne ja kasutajatele sobiv ning ühtses vormingus. Soovite abifaili ise üle vaadata ja lasta rakendust testivatel inimestel ka see üle vaadata.
Suuremate abifailiprojektide puhul on koostamine ja testimine pidevad protsessid. Soovite enne lõpliku versiooni loomist abifaili koostada ja oma tööd mitu korda kontrollida
Samm 10. Andke abifail arendajale, et see programmiga kaasata
Sõltuvalt projekti olemusest ja abifailivormingust peate võib-olla esitama arendajale mitu faili, sealhulgas ka kaardifaili, kui on kontekstitundlikke teemasid.
