Kako napraviti datoteku pomoći: 10 koraka (sa slikama)

Sadržaj:

Kako napraviti datoteku pomoći: 10 koraka (sa slikama)
Kako napraviti datoteku pomoći: 10 koraka (sa slikama)

Video: Kako napraviti datoteku pomoći: 10 koraka (sa slikama)

Video: Kako napraviti datoteku pomoći: 10 koraka (sa slikama)
Video: Kako resiti problem kada vam nedostaje DLL fajl 2024, Ožujak
Anonim

Iako ih mnogi korisnici računala č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 značajki programa, opis ekrana koji gleda, upute o tome kako koristiti program za izvršavanje zadanog zadatka ili pročitati popis često postavljanih pitanja o programa i njihovih odgovora. Pisanje datoteke pomoći zahtijeva i sposobnost rada sa softverskim aplikacijama i sposobnost objašnjavanja stvari na način koji korisnici mogu razumjeti.

Koraci

Napravite datoteku pomoći Korak 1
Napravite datoteku pomoći Korak 1

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 odstupati od specifikacija, na temelju kratkog vremena razvoja ili nemogućnosti kodiranja određene značajke.

Napravite datoteku pomoći Korak 2
Napravite datoteku pomoći Korak 2

Korak 2. Dobijte 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 te 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čunalni kod iza scene kako bi datoteka pomoći funkcionirala. Neki alati za pisanje pomoći također uključuju grafičke uređivače za izradu snimaka zaslona koji se uključuju 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. Softverske aplikacije dizajnirane za rad pod nekoliko operativnih sustava mogu koristiti sustav za pomoć na više platformi koji se pokreće u web-pregledniku korisnika. Koji god alat za pisanje pomoći koji koristite trebao bi podržavati formate pomoći u kojima ćete stvarati datoteke pomoći

Napravite datoteku pomoći Korak 3
Napravite datoteku pomoći Korak 3

Korak 3. Izradite datoteku projekta pomoći

Vaš alat za izradu pomoći stvorit će datoteku projekta pomoći na temelju 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 slikovnih datoteka i druge datoteke.

  • Datoteka sa sadržajem uključuje tekst u datoteci pomoći koji objašnjava kako funkcionira softverska aplikacija koju dokumentirate. Tekst se obično raščlanjuje na teme koje pokrivaju određeni zaslon, značajku ili postupak.
  • Indeksna datoteka popis je tema datoteka pomoći. Koristi se za stvaranje 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 tih zaslona prikazani u datoteci pomoći kako bi poboljšali sposobnost korisnika da razumiju na što se odnosi tekst datoteke pomoći.
Napravite datoteku pomoći Korak 4
Napravite datoteku pomoći Korak 4

Korak 4. Podesite veličinu prozora za pomoć

Osim ako ne pišete datoteku pomoći koja će se pojaviti u korisničkom web pregledniku, datoteka pomoći pojavit će se u vlastitom prozoru. Alat za izradu pomoći pomoći ć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 obliku 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 značajku i automatsko određivanje veličine skočnih prozora koji daju kratke opise značajki. Datoteke pomoći mogu također sadržavati ugrađeni tekst koji se pojavljuje samo kada se klikne istaknuti tekst ili gumb

Napravite datoteku pomoći Korak 5
Napravite datoteku pomoći Korak 5

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 značajke programa. Dok stvarate svaku temu, vaš alat za izradu 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 zaslonima programa, njegovim značajkama, 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.
Napravite datoteku pomoći Korak 6
Napravite datoteku pomoći Korak 6

Korak 6. Uključite snimke zaslona, 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 autorsko djelo, ili s zasebnom aplikacijom, kao što su Microsoft Paint, Paint Shop Pro ili SnagIt.

  • Tekst i snimke zaslona trebali bi biti postavljeni zajedno u temu tako da korisnici mogu vidjeti snimku zaslona i popratni tekst bez nepotrebnog pomicanja. U mnogim slučajevima poželjet ćete prikazati dio zaslona programa umjesto cijelog zaslona ili snimku zaslona u manjoj veličini od izvornika. Vaša aplikacija za snimku zaslona trebala bi moći promijeniti veličinu snimke zaslona bez zamućenja 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.
Napravite datoteku pomoći Korak 7
Napravite datoteku pomoći Korak 7

Korak 7. Izradite 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ć koja je osjetljiva na kontekst i zahtijeva stvaranje datoteke karte za programera da poveže gumb "Pomoć" s 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.

Napravite datoteku pomoći Korak 8
Napravite datoteku pomoći Korak 8

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, to će uključivati sve datoteke komponenti koje su nastale kada ste stvorili datoteku pomoći, iako neki nekompilirani formati pomoći također zahtijevaju da se pojedinačne datoteke tema pomoći uključe u program.

Napravite datoteku pomoći Korak 9
Napravite datoteku pomoći Korak 9

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 ispravno prikazuju. Datoteka pomoći također se mora testirati kako bi se osiguralo da je sadržaj točan i prikladan za korisnike te u dosljednom formatu. Morat ćete sami pregledati datoteku pomoći, a ljudi koji je testiraju također je pregledaju.

Na većim projektima datoteka pomoći, sastavljanje i testiranje su u tijeku. Prije stvaranja konačne verzije htjet ćete sastaviti datoteku pomoći i provjeriti svoj rad

Napravite datoteku pomoći Korak 10
Napravite datoteku pomoći Korak 10

Korak 10. Dajte datoteku pomoći razvojnom programeru da je uključi u program

Ovisno o prirodi projekta i formatu datoteke pomoći, možda ćete razvojnom programeru morati dati nekoliko datoteka, uključujući datoteku karte ako postoje teme koje se odnose na kontekst.

Preporučeni: