Čeprav jih številni uporabniki računalnikov pogosto ignorirajo, datoteke pomoči vsebujejo ključne informacije o uporabi programske opreme, s katero so povezane. S klikom na "Pomoč" lahko uporabnik dobi pregled nad funkcijami programa, opis zaslona, ki ga gleda, navodila za uporabo programa za izvajanje določene naloge ali branje seznamov pogostih vprašanj o program in njihovi odgovori. Pisanje datoteke pomoči zahteva tako sposobnost dela s programskimi aplikacijami kot tudi sposobnost razlage stvari na način, ki ga uporabniki razumejo.
Koraki
Korak 1. Pridobite kopijo programske opreme, ki jo želite dokumentirati
Če je mogoče, morate dobiti tudi kopijo pisnih specifikacij programa, čeprav vsi razvijalci programske opreme ne delajo z njimi. V nekaterih primerih bo programer odstopal od specifikacij glede na kratek čas razvoja ali pa ne bo mogel kodirati določene funkcije.
Korak 2. Pridobite orodje za ustvarjanje pomoči
Čeprav je mogoče datoteko pomoči ustvariti ročno z uporabo datoteke z bogatim besedilom (.rtf), večina avtorjev datotek za pomoč uporablja programsko aplikacijo za pisanje svojih datotek pomoči, kot so RoboHelp, Pomoč in priročnik, Doc-To -Pomagajte, MadCap Flare ali HelpLogix. Večina orodij za ustvarjanje pomoči vključuje urejevalnik besedil ali delo s programom za urejanje besedil, kot je Microsoft Word, in nudi uporabniški vmesnik, ki avtorju pomoči omogoča, da vidi, kako bo videti datoteka pomoči, ko jo piše med pisanjem računalniške kode v ozadju da bo datoteka pomoči delovala. Nekatera orodja za ustvarjanje pomoči vključujejo tudi grafične urejevalnike za ustvarjanje posnetkov zaslona, ki jih želite vključiti v datoteko pomoči.
Obstaja več oblik datotek pomoči: najpogostejša je pomoč HTML, ki jo uporabljajo aplikacije, ki se izvajajo v sistemu Windows. (Starejša oblika, WinHelp, ni več podprta.) Apple in Unix imata vsak svoj format, prav tako pa Sun Microsystems s svojo JavaHelp. Programske aplikacije, zasnovane za delovanje v več operacijskih sistemih, lahko uporabljajo sistem za pomoč med platformami, ki deluje v uporabnikovem spletnem brskalniku. Katero koli orodje za ustvarjanje pomoči, ki ga uporabljate, mora podpirati formate pomoči, v katerih boste ustvarili datoteke pomoči
Korak 3. Ustvarite datoteko projekta pomoči
Orodje za ustvarjanje pomoči bo za vas ustvarilo datoteko projekta pomoči na podlagi imena datoteke, ki ga posredujete, in drugih informacij. Glavna datoteka projekta vsebuje informacije o drugih datotekah, ki vključujejo datoteko z vsebino, datoteko indeksa, eno ali več slikovnih datotek in druge datoteke.
- Datoteka z vsebino vključuje besedilo v datoteki za pomoč, ki pojasnjuje, kako deluje programska oprema, ki jo dokumentirate. Besedilo je običajno razčlenjeno na teme, ki pokrivajo določen zaslon, funkcijo ali postopek.
- Indeksna datoteka je seznam tem datoteke pomoči. Uporablja se za ustvarjanje kazala, s katerim lahko uporabniki izberejo temo za ogled, in indeksa za iskanje v datoteki za pomoč.
- Slikovne datoteke so grafične datoteke zaslonov programa ali deli teh zaslonov, prikazani v datoteki za pomoč, da povečajo uporabnikovo sposobnost razumevanja, na kaj se nanaša besedilo datoteke pomoči.
Korak 4. Prilagodite velikost okna za pomoč
Razen če ne pišete datoteke za pomoč v uporabnikovem spletnem brskalniku, se bo datoteka za pomoč prikazala v svojem oknu. Orodje za ustvarjanje pomoči vam bo omogočilo, da vodoravne in navpične dimenzije okna prilagodite velikosti, ki bo končnemu uporabniku omogočila branje datoteke pomoči, ne da bi to oviralo aplikacijo. Glavno okno za pomoč je pogosto v obliki tri podokna, z kazalom na levi in izbrano temo na desni.
Datoteke za pomoč imajo lahko poleg glavnega okna tudi sekundarna okna, ki podrobno opisujejo določeno funkcijo in samodejno prilagajajo velikost pojavnih oken, ki dajejo kratek opis funkcij. Datoteke za pomoč lahko vsebujejo tudi vdelano besedilo, ki se prikaže le, če pritisnete označeno besedilo ali gumb
Korak 5. Napišite teme pomoči
Če želite to narediti, morate pregledati specifikacije ali sam program, da ustvarite teme za dokumentiranje zaslonov in funkcij programa. Ko ustvarite vsako temo, jo bo vaše orodje za ustvarjanje pomoči dodalo v kazalo in kazalo datoteke pomoči.
- Medtem ko lahko sestavite kazalo, lahko pomagate imeti načrt, kako ga organizirati. Kazalo lahko organizirate po zaslonih programa, njegovih funkcijah, načinih uporabe ali nekaterih kombinacijah.
- Ko pišete teme, razmislite o drugih informacijah v datoteki za pomoč, do katerih bodo uporabniki želeli imeti hiter dostop. V besedilu datoteke za pomoč lahko ustvarite skoke ali hiperpovezave, ki se povezujejo s temami, ki vsebujejo te informacije.
Korak 6. Po potrebi vključite posnetke zaslona
Mnoge funkcije programa je najbolje razložiti s kombinacijo besedila in grafike. Posnetke zaslona lahko ustvarite z aplikacijo, ki je priložena orodju za avtoring, ali z ločeno aplikacijo, na primer Microsoft Paint, Paint Shop Pro ali SnagIt.
- Besedilo in posnetki zaslona morajo biti sestavljeni skupaj v temo, tako da lahko uporabniki vidijo posnetek zaslona in njegovo podporno besedilo brez nepotrebnega drsenja. V mnogih primerih boste želeli prikazati del zaslona programa namesto celotnega zaslona ali posnetek zaslona v manjši velikosti od izvirnika. Vaša aplikacija za posnetek zaslona mora imeti možnost spreminjanja velikosti posnetka zaslona brez zameglitve ali izgube podrobnosti.
- Če pričakujete spremembe v uporabniškem vmesniku med preskusno in končno različico programa, boste morda želeli zadržati pri ustvarjanju posnetkov zaslona, dokler ne boste imeli končne različice programa za delo.
Korak 7. Ustvarite datoteko zemljevida, če jo potrebujete
Nekateri programi vključujejo gumbe »Pomoč«, s katerimi lahko uporabnik klikne in prikaže temo v datoteki za pomoč, ki natančno opisuje, kako ta zaslon deluje. Prikazovanje teme na ta način se imenuje kontekstno občutljiva pomoč in zahteva, da programer ustvari datoteko zemljevida, da poveže gumb »Pomoč« s posebno temo v datoteki za pomoč. Orodje za ustvarjanje pomoči vam lahko ustvari orodje ali pa ga programer kodira in vam ga dodeli v datoteko pomoči.
Korak 8. Sestavite datoteko pomoči
S sestavljanjem se ustvari dejanska datoteka pomoči, ki bo vključena v program. Za večino formatov pomoči bo to vključevalo vse komponente komponent, ki so bile ustvarjene, ko ste ustvarili datoteko pomoči, čeprav nekatere nekompilirane oblike pomoči zahtevajo tudi, da so v program vključene posamezne datoteke s temami pomoči.
Korak 9. Preizkusite datoteko pomoči
Ko sestavite datoteko pomoči, jo morate preizkusiti in se prepričati, da se vse hiperpovezave povežejo s temami, ki naj bi jih imele, in da so vse grafike pravilno prikazane. Datoteko za pomoč je treba tudi preizkusiti, da se zagotovi, da je vsebina točna in primerna za uporabnike ter v dosledni obliki. Datoteko za pomoč boste želeli pregledati sami in jo preizkusiti tudi ljudje, ki preizkušajo aplikacijo.
Pri večjih projektih datotek pomoči so zbiranje in testiranje v teku. Preden ustvarite končno različico, boste želeli sestaviti datoteko pomoči in večkrat preveriti svoje delo
Korak 10. Dajte datoteko pomoči razvijalcu, da jo vključi v program
Odvisno od narave projekta in oblike datoteke pomoči boste morda morali razvijalcu posredovati več datotek, vključno z datoteko zemljevida, če obstajajo teme, odvisne od konteksta.
