Iako ih mnogi korisnici računara često zanemaruju, datoteke pomoći pružaju ključne informacije o tome kako koristiti softversku aplikaciju s kojom su povezani. Klikom na "Pomoć" korisnik može dobiti pregled funkcija programa, opis ekrana koji gleda, upute o tome kako koristiti program za izvršavanje zadanog zadatka ili pročitati popis često postavljanih pitanja o program i njihovi odgovori. Pisanje datoteke pomoći zahtijeva i sposobnost rada sa softverskim aplikacijama i sposobnost objašnjavanja stvari na način koji korisnici mogu razumjeti.
Koraci
Korak 1. Nabavite kopiju softvera koji želite dokumentirati
Ako je moguće, trebali biste dobiti i kopiju pisanih specifikacija programa, iako svi programeri softvera ne rade s njima. U nekim slučajevima, programer će odstupiti od specifikacija, na osnovu kratkog vremena razvoja ili nemogućnosti kodiranja određene funkcije.
Korak 2. Nabavite alat za pisanje pomoći
Iako je moguće ručno stvoriti datoteku pomoći, koristeći datoteku bogatog teksta (.rtf), većina autora datoteka pomoći koristi softversku aplikaciju za pisanje datoteka pomoći, kao što su RoboHelp, Pomoć i priručnik, Doc-To -Pomoć, MadCap Flare ili HelpLogix. Većina alata za pisanje pomoći uključuje uređivač teksta ili rad s programom za obradu teksta kao što je Microsoft Word i pružaju korisničko sučelje koje autoru pomoći omogućuje da vidi kako će datoteka pomoći izgledati dok je piše dok piše računarski kod iza scene kako bi datoteka pomoći funkcionirala. Neki alati za pisanje pomoći takođe uključuju grafičke uređivače za kreiranje snimaka ekrana za uključivanje u datoteku pomoći.
Postoji nekoliko formata datoteka pomoći: Najčešći je HTML Help, koji koriste aplikacije koje rade u sustavu Windows. (Stariji format, WinHelp, više nije podržan.) Apple i Unix imaju svaki svoj format, kao i Sun Microsystems sa svojom JavaHelp funkcijom. Softverske aplikacije dizajnirane za rad pod nekoliko operativnih sistema mogu koristiti sistem za pomoć na više platformi koji radi u korisnikovom web pregledniku. Koji god alat za pisanje pomoći koji koristite trebao bi podržavati formate pomoći u kojima ćete stvarati datoteke pomoći
Korak 3. Kreirajte datoteku projekta pomoći
Vaš alat za izradu pomoći kreirat će datoteku projekta pomoći za vas, na osnovu naziva datoteke koji navedete i drugih informacija. Glavna datoteka projekta sadrži informacije o drugim datotekama, koje uključuju datoteku sadržaja, datoteku indeksa, jednu ili više datoteka slika i druge datoteke.
- Datoteka sa sadržajem uključuje tekst u datoteci pomoći koji objašnjava kako funkcionira softverska aplikacija koju dokumentujete. Tekst se obično raščlanjuje na teme koje pokrivaju određeni ekran, funkciju ili postupak.
- Indeksna datoteka je popis tema datoteke pomoći. Koristi se za kreiranje sadržaja koji korisnici mogu koristiti za odabir teme za pregled, kao i indeksa za pretraživanje unutar datoteke pomoći.
- Slikovne datoteke su grafičke datoteke ekrana programa ili dijelovi ekrana prikazani u datoteci pomoći kako bi poboljšali sposobnost korisnika da razumiju na šta se odnosi tekst datoteke pomoći.
Korak 4. Podesite veličinu prozora za pomoć
Osim ako ne pišete datoteku pomoći koja će se pojaviti u web pregledniku korisnika, datoteka pomoći će se pojaviti u vlastitom prozoru. Vaš alat za pisanje pomoći omogućit će vam da prilagodite vodoravne i okomite dimenzije prozora na veličinu koja će omogućiti krajnjem korisniku čitanje datoteke pomoći, a da to ne ometa samu aplikaciju. Glavni prozor za pomoć često je u tri okna, sa sadržajem s lijeve strane i odabranom temom s desne strane.
Datoteke pomoći mogu, osim glavnog prozora, imati i sekundarne prozore koji detaljno opisuju određenu funkciju i automatske veličine iskačućih prozora koji daju kratke opise funkcija. Datoteke pomoći mogu uključivati i ugrađeni tekst koji se pojavljuje samo kada se klikne na označeni tekst ili na dugme
Korak 5. Napišite teme pomoći
Da biste to učinili, morat ćete pregledati specifikacije ili sam program kako biste stvorili teme koje će dokumentirati zaslone i funkcije programa. Dok kreirate svaku temu, vaš alat za pisanje pomoći dodat će je u sadržaj i indeks datoteke pomoći.
- Iako možete sastaviti sadržaj dok idete, pomaže vam imati neki plan kako ga organizirati. Sadržaj možete organizirati po ekranima programa, njegovim karakteristikama, načinima korištenja ili nekoj njihovoj kombinaciji.
- Dok pišete teme, razmislite o drugim podacima u datoteci pomoći kojima će korisnici htjeti imati brz pristup. Možete stvoriti skokove ili hiperveze u tekstu datoteke pomoći koji se povezuje s temama koje sadrže te informacije.
Korak 6. Uključite snimke ekrana, ako je potrebno
Mnoge značajke programa najbolje je objasniti kombinacijom teksta i grafike. Snimke zaslona možete stvoriti ili s aplikacijom koja dolazi s vašim alatom za autorizaciju, ili s zasebnom aplikacijom, poput Microsoft Paint, Paint Shop Pro ili SnagIt.
- Tekst i snimke ekrana trebaju biti postavljeni zajedno u temu tako da korisnici mogu vidjeti snimak ekrana i njegov prateći tekst bez nepotrebnog pomicanja. U mnogim slučajevima ćete htjeti prikazati dio ekrana programa umjesto cijelog ekrana ili prikazati snimak ekrana u manjoj veličini od originala. Vaša aplikacija za snimanje zaslona trebala bi moći promijeniti veličinu snimke zaslona bez zamagljivanja ili gubitka detalja.
- Ako očekujete promjene u korisničkom sučelju između testne i konačne verzije programa, možda ćete htjeti odgoditi stvaranje snimaka zaslona dok ne dobijete konačnu verziju programa za rad.
Korak 7. Kreirajte datoteku karte, ako je potrebna
Neki programi uključuju gumbe "Pomoć" za korisnika da klikne i prikaže temu u datoteci pomoći koja posebno opisuje kako taj zaslon radi. Prikazivanje teme na ovaj način naziva se pomoć prilagođena kontekstu i zahtijeva stvaranje datoteke karte za programera da poveže dugme "Pomoć" sa određenom temom u datoteci pomoći. Vaš alat za pisanje pomoći može vam ga stvoriti ili ga programer može kodirati i dati vam da ga uključite u datoteku pomoći.
Korak 8. Sastavite datoteku pomoći
Kompilacija stvara stvarnu datoteku pomoći koja će biti uključena u program. Za većinu formata pomoći, ovo će uključivati sve datoteke komponente koje su nastale kada ste kreirali datoteku pomoći, iako neki nekompilirani formati pomoći također zahtijevaju da se pojedinačne datoteke tema pomoći uključe u program.
Korak 9. Testirajte datoteku pomoći
Nakon što sastavite datoteku pomoći, morate je testirati kako biste bili sigurni da se sve hiperveze povezuju s temama koje bi trebale i da se svi grafički prikazi pravilno prikazuju. Datoteku za pomoć također je potrebno testirati kako bi se osiguralo da je sadržaj točan i prikladan za korisnike i u dosljednom formatu. Vi ćete htjeti sami pregledati datoteku pomoći, a ljudi koji je testiraju će je pregledati.
Na većim projektima datoteka pomoći, sastavljanje i testiranje su tekući procesi. Prije stvaranja konačne verzije htjet ćete sastaviti datoteku pomoći i provjeriti svoj rad
Korak 10. Dajte datoteku pomoći programeru da je uključi u program
Ovisno o prirodi projekta i formatu datoteke pomoći, razvojnom programeru ćete možda morati dostaviti nekoliko datoteka, uključujući datoteku karte ako postoje teme koje se odnose na kontekst.
