Aj keď mnoho používateľov počítačov často ignoruje, súbory pomocníka poskytujú kľúčové informácie o tom, ako používať softvérovú aplikáciu, s ktorou sú spojené. Kliknutím na položku „Pomocník“môže používateľ získať prehľad o funkciách programu, popis obrazovky, na ktorú sa pozerá, pokyny, ako používať program na vykonanie danej úlohy alebo si prečítať zoznamy často kladených otázok o programe. program a ich odpovede. Na napísanie súboru pomoci je potrebná schopnosť pracovať so softvérovými aplikáciami a schopnosť vysvetliť veci tak, aby ich používatelia pochopili.
Kroky
Krok 1. Získajte kópiu softvéru, ktorý chcete dokumentovať
Ak je to možné, mali by ste dostať aj kópiu písomných špecifikácií programu, aj keď nie všetci vývojári softvéru s nimi pracujú. V niektorých prípadoch sa programátor odchýli od špecifikácií na základe krátkeho času vývoja alebo neschopnosti kódovať konkrétnu funkciu.
Krok 2. Získajte nástroj na tvorbu pomocníka
Aj keď je možné vytvoriť pomocný súbor ručne, pomocou súboru s formátom RTF (.rtf) väčšina autorov pomocných súborov používa na písanie svojich pomocných súborov softvérovú aplikáciu, ako napríklad RoboHelp, Help and Manual, Doc-To. -Help, MadCap Flare alebo HelpLogix. Väčšina nástrojov na vytváranie pomoci obsahuje textový editor alebo prácu s programom na spracovanie textu, akým je napríklad Microsoft Word, a poskytuje používateľské rozhranie, ktoré autorovi pomoci umožňuje vidieť, ako bude súbor pomocníka vyzerať pri písaní počítačového kódu v zákulisí. aby súbor pomocníka fungoval. Niektoré nástroje na pomoc pri tvorbe obsahu obsahujú aj grafické editory na vytváranie snímok obrazovky, ktoré sa majú zahrnúť do súboru pomocníka.
Existuje niekoľko formátov súborov pomocníka: Najbežnejší je pomocník HTML, ktorý používajú aplikácie spustené v systéme Windows. (Starší formát, WinHelp, už nie je podporovaný.) Apple a Unix majú svoje vlastné formáty, rovnako ako Sun Microsystems so svojou JavaHelp. Softvérové aplikácie navrhnuté na beh pod niekoľkými operačnými systémami môžu používať multiplatformový systém pomoci, ktorý beží vo webovom prehliadači používateľa. Bez ohľadu na to, ktorý nástroj na tvorbu pomoci použijete, mal by podporovať formáty pomoci, v ktorých sa chystáte vytvárať súbory pomocníka
Krok 3. Vytvorte súbor projektu pomocníka
Váš nástroj na vytváranie pomoci pre vás vytvorí súbor projektu pomoci na základe vami zadaného názvu súboru a ďalších informácií. Hlavný súbor projektu obsahuje informácie o ostatných súboroch, medzi ktoré patrí súbor s obsahom, indexový súbor, jeden alebo viac obrazových súborov a ďalšie súbory.
- Súbor obsahu obsahuje text v súbore pomocníka, ktorý vysvetľuje, ako funguje softvérová aplikácia, ktorú dokumentujete. Text je zvyčajne rozdelený na témy, ktoré pokrývajú konkrétnu obrazovku, funkciu alebo postup.
- Indexový súbor je zoznam tém súboru pomocníka. Slúži na vytvorenie obsahu, ktorý môžu používatelia použiť na výber témy na zobrazenie, a tiež indexu, ktorý je možné prehľadávať v súbore pomocníka.
- Súbory s obrázkami sú grafické súbory programových obrazoviek alebo časti týchto obrazoviek zobrazené v súbore pomocníka, aby sa zlepšila schopnosť používateľov porozumieť tomu, na čo odkazuje text súboru pomoci.
Krok 4. Upravte veľkosť okna pomoci
Pokiaľ nepíšete súbor pomocníka, ktorý sa má zobraziť vo webovom prehliadači používateľa, súbor pomocníka sa zobrazí vo vlastnom okne. Váš nástroj na tvorbu pomocníka vám umožní prispôsobiť horizontálne a vertikálne rozmery okna na veľkosť, ktorá koncovému používateľovi umožní prečítať si súbor pomocníka bez toho, aby vám prekážal v aplikácii samotnej. Hlavné okno pomoci je často v trojpanelovom formáte, obsah je vľavo a vybratá téma vpravo.
Súbory pomocníka môžu mať okrem hlavného okna aj sekundárne okná, ktoré podrobne opisujú konkrétnu funkciu, a automaticky dimenzované vyskakovacie okná, ktoré poskytujú krátky popis funkcií. Súbory pomoci môžu obsahovať aj vložený text, ktorý sa zobrazí iba vtedy, keď kliknete na zvýraznený text alebo na tlačidlo
Krok 5. Napíšte témy pomoci
Ak to chcete urobiť, musíte si prečítať špecifikácie alebo samotný program a vytvoriť témy na dokumentáciu obrazoviek a funkcií programu. Keď vytvoríte každú tému, váš nástroj na tvorbu pomocníka ju pridá do obsahu a indexu súboru pomoci.
- Aj keď si obsah môžete zostavovať za pochodu, pomôže vám to mať nejaký plán, ako ho zorganizovať. Obsah môžete usporiadať okolo obrazoviek programu, jeho funkcií, spôsobov použitia alebo ich kombinácie.
- Pri písaní tém zvážte ďalšie informácie v súbore pomoci, ku ktorým budú chcieť mať používatelia rýchly prístup. V texte súboru pomocníka môžete vytvárať skoky alebo hypertextové odkazy, ktoré sa spájajú s témami, ktoré obsahujú tieto informácie.
Krok 6. V prípade potreby zahrňte snímky obrazovky
Mnoho funkcií programu je najlepšie vysvetliť kombináciou textu a grafiky. Snímky obrazovky môžete vytvárať buď pomocou aplikácie, ktorá sa dodáva s vašim nástrojom na tvorbu pomocníka, alebo pomocou samostatnej aplikácie, ako napríklad Microsoft Paint, Paint Shop Pro alebo SnagIt.
- Text a snímky obrazovky by mali byť usporiadané spoločne v téme, aby používatelia mohli snímku obrazovky a jej podporný text vidieť bez zbytočného posúvania. V mnohých prípadoch budete chcieť namiesto celej obrazovky zobraziť časť obrazovky programu alebo snímku obrazovky zobraziť v menšej veľkosti ako originál. Vaša aplikácia na snímanie obrazovky by mala mať možnosť zmeniť veľkosť snímky obrazovky bez rozmazania alebo straty detailov.
- Ak očakávate zmeny v používateľskom rozhraní medzi testovacou a konečnou verziou programu, možno budete musieť odložiť vytváranie snímok obrazovky, kým nebudete mať konečnú verziu programu, s ktorou budete pracovať.
Krok 7. Vytvorte súbor mapy, ak je potrebný
Niektoré programy obsahujú tlačidlá „Pomocník“, na ktoré môže používateľ kliknúť a zobraziť tému v súbore pomoci, ktorý konkrétne popisuje, ako táto obrazovka funguje. Zobrazenie témy týmto spôsobom sa nazýva kontextová pomoc a vyžaduje vytvorenie mapového súboru pre programátora, ktorý prepojí tlačidlo „Pomocník“s konkrétnou témou v súbore pomoci. Váš nástroj na tvorbu pomocníka vám ho môže vytvoriť alebo ho môže programátor kódovať a poskytnúť vám ho do súboru pomoci.
Krok 8. Zostavte súbor pomocníka
Kompilácia vytvorí skutočný súbor pomocníka, ktorý bude súčasťou programu. Pri väčšine formátov pomoci to bude zahŕňať všetky súbory súčastí, ktoré boli vytvorené pri vytváraní súboru pomocníka, aj keď niektoré nekomprimované formáty pomoci tiež vyžadujú, aby boli do programu zahrnuté jednotlivé súbory s témou pomoci.
Krok 9. Otestujte súbor pomocníka
Hneď ako zostavíte súbor pomocníka, musíte ho otestovať, aby ste sa presvedčili, že všetky hypertextové odkazy sa správne spájajú s témami, ktorých sa týkajú, a so všetkými grafickými prvkami. Je tiež potrebné otestovať súbor pomocníka, aby sa zabezpečilo, že obsah je presný a vhodný pre používateľov a v konzistentnom formáte. Súbor pomocníka si budete chcieť sami prezrieť a nechať ho skontrolovať aj ľuďmi, ktorí aplikáciu testujú.
Pri väčších projektoch súborov pomocníka prebieha kompilácia a testovanie. Pred vytvorením konečnej verzie budete chcieť zostaviť súbor pomocníka a niekoľkokrát skontrolovať svoju prácu
Krok 10. Poskytnite vývojárovi súbor pomocníka, ktorý ho zahrnie do programu
V závislosti od povahy projektu a formátu súboru pomocníka môže byť potrebné poskytnúť vývojárovi niekoľko súborov vrátane súboru mapy, ak existujú kontextové témy.
