Nors daugelis kompiuterių vartotojų dažnai ignoruoja, pagalbos failai pateikia pagrindinę informaciją apie tai, kaip naudoti su jais susietą programinę įrangą. Spustelėjęs „Pagalba“, vartotojas gali gauti programos funkcijų apžvalgą, ekrano, į kurį jis žiūri, aprašymą, instrukcijas, kaip naudoti programą tam tikrai užduočiai atlikti, arba perskaityti dažniausiai užduodamų klausimų apie programa ir jų atsakymai. Norint parašyti pagalbos failą, reikia mokėti dirbti su programine įranga ir paaiškinti dalykus taip, kaip vartotojai gali suprasti.
Žingsniai
Žingsnis 1. Gaukite programinės įrangos, kurią norite dokumentuoti, kopiją
Jei įmanoma, taip pat turėtumėte gauti rašytinių programos specifikacijų kopiją, nors ne visi programinės įrangos kūrėjai su jomis dirba. Kai kuriais atvejais programuotojas nukryps nuo specifikacijų dėl trumpo kūrimo laiko arba nesugebėjimo koduoti tam tikros funkcijos.
2 žingsnis. Gaukite pagalbos kūrimo įrankį
Nors pagalbos failą galima sukurti rankiniu būdu, naudojant turtingo teksto formato (.rtf) failą, dauguma pagalbos failų autorių naudoja programinę įrangą, kad parašytų savo pagalbos failus, pvz., „RoboHelp“, „Help and Manual“, „Doc-To“-Pagalba, „MadCap Flare“arba „HelpLogix“. Dauguma pagalbos kūrimo įrankių apima teksto redaktorių arba darbą su teksto apdorojimo programa, pvz., „Microsoft Word“, ir suteikia vartotojo sąsają, leidžiančią pagalbos autoriui pamatyti, kaip pagalbos failas atrodys, kai jis rašys, rašydamas kompiuterio kodą už kadro kad pagalbos failas veiktų. Kai kuriuose pagalbos kūrimo įrankiuose taip pat yra grafikos redaktorių, skirtų sukurti ekrano kopijas, kurias reikia įtraukti į pagalbos failą.
Yra keli pagalbos failų formatai: Dažniausiai naudojamas HTML žinynas, kurį naudoja programos, veikiančios „Windows“. (Senesnis formatas „WinHelp“nebepalaikomas.) „Apple“ir „Unix“taip pat turi savo formatus, taip pat „Sun Microsystems“su „JavaHelp“. Programinės įrangos programos, skirtos veikti keliose operacinėse sistemose, gali naudoti kelių platformų pagalbos sistemą, kuri veikia vartotojo žiniatinklio naršyklėje. Nepriklausomai nuo jūsų naudojamo pagalbos kūrimo įrankio, turėtų būti palaikomas pagalbos formatas (-ai), kuriuo (-iais) ketinate kurti pagalbos failus
Žingsnis 3. Sukurkite pagalbos projekto failą
Pagalbos kūrimo įrankis pagal jums pateiktą failo pavadinimą ir kitą informaciją sukurs pagalbos projekto failą. Pagrindiniame projekto faile yra informacijos apie kitus failus, įskaitant turinio failą, rodyklės failą, vieną ar kelis vaizdo failus ir kitus failus.
- Turinio faile yra pagalbos faile esantis tekstas, kuriame paaiškinama, kaip veikia programuojama programa, kurią dokumentuojate. Tekstas paprastai yra suskirstytas į temas, apimančias tam tikrą ekraną, funkciją ar procedūrą.
- Rodyklės failas yra pagalbos failo temų sąrašas. Jis naudojamas kuriant turinį, kurį naudotojai gali pasirinkti norėdami peržiūrėti temą, taip pat paieškos failo rodyklę pagalbos faile.
- Vaizdo failai yra programos ekranų grafiniai failai arba tų ekranų dalys, rodomos pagalbos faile, kad vartotojai galėtų geriau suprasti, į ką kreipiamasi pagalbos failo tekstas.
Žingsnis 4. Sureguliuokite pagalbos lango dydį
Jei nerašote pagalbos failo, kad jis būtų rodomas vartotojo žiniatinklio naršyklėje, pagalbos failas bus rodomas jo lange. Pagalbos kūrimo įrankis leis jums pritaikyti horizontalius ir vertikalius lango matmenis iki tokio dydžio, kad galutinis vartotojas galėtų perskaityti pagalbos failą, netrukdydamas pačiai programai. Pagrindinis pagalbos langas dažnai yra trijų langų formato, turinio lentelė yra kairėje, o pasirinkta tema-dešinėje.
Pagalbos failai, be pagrindinio lango, gali turėti ir antrinius langus, kuriuose išsamiai aprašoma tam tikra funkcija, ir automatiškai iškylančių langų, kuriuose pateikiami trumpi funkcijų aprašymai, dydį. Pagalbos failai taip pat gali apimti įterptąjį tekstą, kuris rodomas tik tada, kai paryškinamas tekstas arba paspaudžiamas mygtukas
Žingsnis 5. Parašykite pagalbos temas
Norėdami tai padaryti, turėsite peržiūrėti specifikacijas arba pačią programą, kad sukurtumėte temas, skirtas dokumentuoti programos ekranus ir funkcijas. Kai kuriate kiekvieną temą, pagalbos kūrimo įrankis pridės ją prie pagalbos failo turinio ir rodyklės.
- Nors turinį galite sudaryti eidami, tai padeda turėti tam tikrą planą, kaip jį organizuoti. Turinio lentelę galite sutvarkyti pagal programos ekranus, jos ypatybes, naudojimo būdus arba kai kuriuos jų derinius.
- Rašydami temas, pagalvokite apie kitą informaciją, pateiktą pagalbos faile, kurią vartotojai norės greitai pasiekti. Pagalbos failo tekste galite sukurti šuolius arba hipersaitus, susijusius su temomis, kuriose yra tokia informacija.
6. Jei reikia, įtraukite ekrano kopijas
Daugelis programos funkcijų geriausiai paaiškinamos teksto ir grafikos deriniu. Ekrano kopijas galite kurti naudodami programą, kuri pateikiama kartu su pagalbos kūrimo įrankiu, arba su atskira programa, pvz., „Microsoft Paint“, „Paint Shop Pro“ar „SnagIt“.
- Tekstas ir ekrano kopijos turėtų būti išdėstytos kartu temoje, kad vartotojai galėtų matyti ekrano kopiją ir ją papildantį tekstą be nereikalingo slinkimo. Daugeliu atvejų norėsite parodyti programos ekrano dalį, o ne visą ekraną, arba ekrano kopiją rodyti mažesniu dydžiu nei originalas. Jūsų ekrano kopijos programa turėtų galėti pakeisti ekrano dydį, neryškindama ir neprarasdama detalių.
- Jei numatote, kad pasikeis vartotojo sąsaja tarp bandomosios ir galutinės programos versijų, galbūt norėsite susilaikyti nuo ekrano kopijų kūrimo, kol turėsite galutinę programos versiją.
Žingsnis 7. Jei reikia, sukurkite žemėlapio failą
Kai kuriose programose yra mygtukai „Pagalba“, kad vartotojas spustelėtų ir rodytų temą pagalbos faile, kuriame konkrečiai aprašoma, kaip veikia šis ekranas. Taip rodyti temą vadinama kontekstinei pagalbai ir programuotojui reikia sukurti žemėlapio failą, kad mygtukas „Pagalba“būtų susietas su konkrečia jūsų pagalbos failo tema. Pagalbos kūrimo įrankis gali jums sukurti, arba programuotojas gali jį koduoti ir suteikti jums, kad jis būtų įtrauktas į pagalbos failą.
Žingsnis 8. Sudarykite pagalbos failą
Vykdant sukuriamas tikrasis pagalbos failas, kuris bus įtrauktas į programą. Daugelyje pagalbos formatų bus įtraukti visi komponentų failai, kurie buvo sukurti kuriant pagalbos failą, nors kai kurie nesukompiliuoti pagalbos formatai taip pat reikalauja, kad atskiri pagalbos temos failai būtų įtraukti į programą.
Žingsnis 9. Išbandykite pagalbos failą
Sudarę pagalbos failą, turite jį išbandyti, kad įsitikintumėte, jog visos hipersaitai jungiasi prie temų, kurioms jie turėtų būti skirti, ir visa grafika rodoma teisingai. Pagalbos failas taip pat turi būti išbandytas, siekiant užtikrinti, kad turinys būtų tikslus, tinkamas vartotojams ir nuoseklaus formato. Norėsite patys peržiūrėti pagalbos failą ir paprašyti, kad jį peržiūrintys žmonės taip pat peržiūrėtų.
Didesniuose pagalbos failų projektuose kompiliavimas ir testavimas yra nuolatiniai procesai. Prieš sukurdami galutinę versiją, norėsite surinkti pagalbos failą ir kelis kartus patikrinti savo darbą
Žingsnis 10. Pateikite pagalbos failą kūrėjui, kad jis būtų įtrauktas į programą
Atsižvelgiant į projekto pobūdį ir pagalbos failo formatą, gali tekti pateikti kūrėjui kelis failus, įskaitant žemėlapio failą, jei yra kontekstui svarbių temų.
