Lai gan daudzi datoru lietotāji to bieži ignorē, palīdzības faili sniedz galveno informāciju par to, kā izmantot ar tiem saistīto lietojumprogrammu. Noklikšķinot uz "Palīdzība", lietotājs var iegūt pārskatu par programmas funkcijām, ekrāna aprakstu, uz kuru viņš skatās, norādījumus par programmas izmantošanu, lai veiktu noteiktu uzdevumu, vai izlasīt bieži uzdoto jautājumu sarakstus par programma un viņu atbildes. Lai rakstītu palīdzības failu, ir nepieciešama gan spēja strādāt ar programmatūras lietojumprogrammām, gan spēja izskaidrot lietas lietotājiem saprotamā veidā.
Soļi
1. solis. Iegūstiet dokumentējamās programmatūras kopiju
Ja iespējams, jums vajadzētu arī iegūt programmas rakstisko specifikāciju kopiju, lai gan ne visi programmatūras izstrādātāji ar tiem strādā. Dažos gadījumos programmētājs novirzīsies no specifikācijām, pamatojoties uz īsu izstrādes laiku vai nespēju kodēt noteiktu funkciju.
2. Iegūstiet palīdzības autorēšanas rīku
Lai gan palīdzības failu ir iespējams izveidot ar rokām, izmantojot bagātināta teksta formāta (.rtf) failu, lielākā daļa palīdzības failu autoru izmanto programmatūras lietojumprogrammu, lai rakstītu savus palīdzības failus, piemēram, RoboHelp, Help and Manual, Doc-To -Help, MadCap Flare vai HelpLogix. Lielākā daļa palīdzības rakstīšanas rīku ietver teksta redaktoru vai darbu ar tekstapstrādes programmu, piemēram, Microsoft Word, un nodrošina lietotāja saskarni, kas ļauj palīdzības autoram redzēt, kā palīdzības fails izskatīsies, kad viņš to raksta, rakstot datora kodu aiz ainas. lai palīdzības fails darbotos. Daži palīdzības autorēšanas rīki ietver arī grafikas redaktorus, lai izveidotu ekrānuzņēmumus, kas jāiekļauj palīdzības failā.
Ir vairāki palīdzības failu formāti: Visizplatītākā ir HTML palīdzība, ko izmanto lietojumprogrammas, kas darbojas sistēmā Windows. (Vecāks formāts WinHelp vairs netiek atbalstīts.) Apple un Unix katram ir savi formāti, kā arī Sun Microsystems ar savu JavaHelp. Programmatūras lietojumprogrammas, kas paredzētas darbībai vairākās operētājsistēmās, var izmantot starpplatformu palīdzības sistēmu, kas darbojas lietotāja tīmekļa pārlūkprogrammā. Neatkarīgi no izmantotā palīdzības rakstīšanas rīka jāatbalsta palīdzības formāts (-i), kurā (-os) plānojat izveidot palīdzības failus
3. solis. Izveidojiet palīdzības projekta failu
Jūsu palīdzības rakstīšanas rīks izveidos jums palīdzības projekta failu, pamatojoties uz jūsu norādīto faila nosaukumu un citu informāciju. Galvenais projekta fails satur informāciju par citiem failiem, kas ietver satura failu, indeksa failu, vienu vai vairākus attēlu failus un citus failus.
- Satura failā ir iekļauts palīdzības faila teksts, kurā paskaidrots, kā darbojas jūsu dokumentētā lietojumprogramma. Teksts parasti ir sadalīts tēmās, kas aptver noteiktu ekrānu, funkciju vai procedūru.
- Indeksa fails ir palīdzības faila tēmu saraksts. To izmanto, lai izveidotu satura rādītāju, ko lietotāji var izmantot, lai atlasītu skatāmo tēmu, kā arī meklēšanas indeksu palīdzības failā.
- Attēlu faili ir programmu ekrānu grafiskie faili vai to ekrānu daļas, kas tiek parādītas palīdzības failā, lai uzlabotu lietotāju spēju saprast, uz ko atsaucas palīdzības faila teksts.
Solis 4. Pielāgojiet palīdzības loga izmēru
Ja vien jūs nerakstāt palīdzības failu, lai tas tiktu parādīts lietotāja tīmekļa pārlūkprogrammā, palīdzības fails parādīsies savā logā. Palīdzības rakstīšanas rīks ļaus pielāgot loga horizontālos un vertikālos izmērus tādā izmērā, kas ļaus galalietotājam izlasīt palīdzības failu, netraucējot pašai lietojumprogrammai. Galvenais palīdzības logs bieži ir trīs rūtu formātā, satura rādītājs atrodas kreisajā pusē un atlasītā tēma labajā pusē.
Palīdzības failos papildus galvenajam logam var būt arī sekundārie logi, kas detalizēti apraksta kādu konkrētu līdzekli, un automātiski tiek mainīti uznirstošo logu izmēri, kas sniedz īsus funkciju aprakstus. Palīdzības failos var iekļaut arī iegulto tekstu, kas tiek parādīts tikai tad, kad tiek iezīmēts teksts vai noklikšķināts uz pogas
5. solis. Uzrakstiet palīdzības tēmas
Lai to izdarītu, jums ir jāpārskata specifikācijas vai pati programma, lai izveidotu tēmas, kas dokumentētu programmas ekrānus un funkcijas. Veidojot katru tēmu, palīdzības autorēšanas rīks to pievienos palīdzības faila satura rādītājam un rādītājam.
- Lai gan jūs varat izveidot satura rādītāju, dodoties uz priekšu, tas palīdz izveidot plānu, kā to organizēt. Jūs varat sakārtot satura rādītāju ap programmas ekrāniem, tās funkcijām, lietošanas veidiem vai kādu to kombināciju.
- Rakstot tēmas, ņemiet vērā citu informāciju palīdzības failā, kurai lietotāji vēlēsies ātri piekļūt. Palīdzības faila tekstā varat izveidot lēcienus vai hipersaites, kas savieno ar tēmām, kurās ir šī informācija.
6. solis. Ja nepieciešams, iekļaujiet ekrānuzņēmumus
Daudzas programmas funkcijas vislabāk var izskaidrot ar teksta un grafikas kombināciju. Ekrānuzņēmumus varat izveidot, izmantojot lietojumprogrammu, kas tiek piegādāta kopā ar palīdzības autorēšanas rīku, vai ar atsevišķu lietojumprogrammu, piemēram, Microsoft Paint, Paint Shop Pro vai SnagIt.
- Teksts un ekrānuzņēmumi jāizvieto kopā tēmā tā, lai lietotāji varētu redzēt ekrānuzņēmumu un tā papildtekstu bez liekas ritināšanas. Daudzos gadījumos jūs vēlaties parādīt programmas ekrāna daļu, nevis visu ekrānu, vai arī parādīt ekrānuzņēmumu mazākā izmērā nekā oriģināls. Ekrānuzņēmuma lietojumprogrammai vajadzētu būt iespējai mainīt ekrānuzņēmuma izmērus, nesapludinot vai nezaudējot detaļas.
- Ja paredzat izmaiņas lietotāja saskarnē starp programmas testa un galīgajām versijām, iespējams, vēlēsities apturēt ekrānuzņēmumu izveidi, līdz būs pieejama programmas galīgā versija.
7. solis. Ja nepieciešams, izveidojiet kartes failu
Dažas programmas ietver pogas "Palīdzība", lai lietotājs varētu noklikšķināt un parādīt tēmu palīdzības failā, kas īpaši apraksta šī ekrāna darbību. Tēmas parādīšana šādā veidā tiek saukta par kontekstjutīgu palīdzību, un programmētājam ir jāizveido kartes fails, lai saistītu pogu "Palīdzība" ar konkrētu palīdzības faila tēmu. Jūsu palīdzības rakstīšanas rīks var jums to izveidot, vai arī programmētājs var to kodēt un dot jums, lai to iekļautu palīdzības failā.
8. solis. Apkopojiet palīdzības failu
Apkopojot tiek izveidots faktiskais palīdzības fails, kas tiks iekļauts programmā. Lielākajai daļai palīdzības formātu tas ietvers visus komponentu failus, kas tika izveidoti, kad izveidojāt palīdzības failu, lai gan daži nesakopoti palīdzības formāti pieprasa, lai programmā tiktu iekļauti arī atsevišķi palīdzības tēmas faili.
9. darbība. Pārbaudiet palīdzības failu
Kad esat apkopojis palīdzības failu, tas ir jāpārbauda, lai pārliecinātos, ka visas hipersaites ir savienotas ar tām domātajām tēmām un visa grafika tiek parādīta pareizi. Palīdzības fails ir arī jāpārbauda, lai nodrošinātu, ka saturs ir precīzs un atbilstošs lietotājiem un konsekventā formātā. Jūs pats vēlaties pārskatīt palīdzības failu un ļaut arī cilvēkiem, kuri pārbauda lietojumprogrammu, to pārskatīt.
Lielākos palīdzības failu projektos apkopošana un testēšana ir nepārtraukti procesi. Pirms galīgās versijas izveides vēlaties apkopot palīdzības failu un vairākas reizes pārbaudīt savu darbu
10. solis. Sniedziet palīdzības failu izstrādātājam, lai to iekļautu programmā
Atkarībā no projekta rakstura un palīdzības faila formāta, iespējams, jums būs jāsniedz izstrādātājam vairāki faili, tostarp kartes fails, ja ir konteksta jutīgas tēmas.
