Přestože je mnoho uživatelů počítačů často ignorováno, soubory nápovědy poskytují klíčové informace o tom, jak používat softwarovou aplikaci, se kterou jsou spojeny. Kliknutím na „Nápověda“může uživatel získat přehled o funkcích programu, popis obrazovky, na kterou se dívá, pokyny, jak pomocí programu provést daný úkol nebo si přečíst seznamy častých dotazů ohledně program a jejich odpovědi. Psaní souboru nápovědy vyžaduje jak schopnost pracovat se softwarovými aplikacemi, tak schopnost vysvětlit věci tak, aby jim uživatelé rozuměli.
Kroky
Krok 1. Získejte kopii softwaru, který chcete dokumentovat
Pokud je to možné, měli byste také získat kopii písemných specifikací programu, i když s nimi nepracují všichni vývojáři softwaru. V některých případech se programátor odchýlí od specifikací na základě krátké doby vývoje nebo neschopnosti kódovat konkrétní funkci.
Krok 2. Získejte nástroj pro vytváření nápovědy
Přestože je možné vytvořit soubor nápovědy ručně, pomocí souboru RTF (Rich-Text-Format) většina autorů souborů nápovědy používá k psaní souborů nápovědy softwarovou aplikaci, například RoboHelp, Help and Manual, Doc-To -Help, MadCap Flare nebo HelpLogix. Většina nástrojů pro vytváření nápovědy zahrnuje textový editor nebo práci s programem pro zpracování textu, jako je Microsoft Word, a poskytuje uživatelské rozhraní, které autorovi nápovědy umožňuje vidět, jak bude soubor nápovědy vypadat, když jej píše, zatímco píše počítačový kód v zákulisí aby soubor nápovědy fungoval. Některé nástroje pro vytváření nápovědy obsahují také grafické editory pro vytváření snímků obrazovky, které je třeba zahrnout do souboru nápovědy.
Existuje řada formátů souborů nápovědy: Nejběžnější je nápověda HTML, kterou používají aplikace spuštěné ve Windows. (Starší formát, WinHelp, již není podporován.) Apple a Unix mají své vlastní formáty, stejně jako Sun Microsystems se svou JavaHelp. Softwarové aplikace navržené pro běh pod několika operačními systémy mohou používat multiplatformní systém nápovědy, který běží ve webovém prohlížeči uživatele. Ať už použijete jakýkoli nástroj pro vytváření nápovědy, měl by podporovat formáty nápovědy, ve kterých budete vytvářet soubory nápovědy
Krok 3. Vytvořte soubor projektu nápovědy
Váš nástroj pro vytváření nápovědy pro vás vytvoří soubor projektu nápovědy na základě vámi zadaného názvu souboru a dalších informací. Hlavní soubor projektu obsahuje informace o ostatních souborech, které zahrnují soubor s obsahem, indexový soubor, jeden nebo více obrazových souborů a další soubory.
- Soubor obsahu obsahuje text v souboru nápovědy, který vysvětluje, jak softwarová aplikace, kterou dokumentujete, funguje. Text je obvykle rozdělen na témata, která pokrývají konkrétní obrazovku, funkci nebo postup.
- Indexový soubor je seznam témat souboru nápovědy. Slouží k vytvoření obsahu, který mohou uživatelé použít k výběru tématu k zobrazení, a také k prohledávatelnému rejstříku v souboru nápovědy.
- Soubory obrázků jsou grafické soubory obrazovek programu nebo části těchto obrazovek zobrazené v souboru nápovědy, aby se zlepšila schopnost uživatelů porozumět tomu, na co text souboru nápovědy odkazuje.
Krok 4. Upravte velikost okna nápovědy
Pokud nepíšete soubor nápovědy, který se má zobrazit ve webovém prohlížeči uživatele, soubor nápovědy se zobrazí ve vlastním okně. Váš nástroj pro vytváření nápovědy vám umožní upravit horizontální a vertikální rozměry okna na velikost, která koncovému uživateli umožní přečíst si soubor nápovědy, aniž by překážel samotné aplikaci. Hlavní okno nápovědy je často ve formátu tří podoken, obsah vlevo a vybrané téma vpravo.
Soubory nápovědy mohou mít kromě hlavního okna také sekundární okna, která podrobně popisují konkrétní funkci, a automaticky upravující velikost vyskakovacích oken, která poskytují krátký popis funkcí. Soubory nápovědy mohou také obsahovat vložený text, který se zobrazí pouze při kliknutí na zvýrazněný text nebo na tlačítko
Krok 5. Napište témata nápovědy
Chcete -li to provést, musíte si přečíst specifikace nebo samotný program, abyste vytvořili témata dokumentující obrazovky a funkce programu. Při vytváření každého tématu vás nástroj pro vytváření nápovědy přidá do obsahu a rejstříku souboru nápovědy.
- I když můžete obsah sestavovat za pochodu, pomůže vám to mít nějaký plán, jak ho uspořádat. Obsah můžete uspořádat kolem obrazovek programu, jeho funkcí, způsobů použití nebo jejich kombinace.
- Při psaní témat zvažte další informace v souboru nápovědy, ke kterým budou uživatelé chtít mít rychlý přístup. V textu souboru nápovědy můžete vytvářet skoky nebo hypertextové odkazy, které se připojují k tématům, která mají tyto informace.
Krok 6. V případě potřeby zahrňte snímky obrazovky
Mnoho funkcí programu lze nejlépe vysvětlit kombinací textu a grafiky. Snímky obrazovky můžete vytvářet buď pomocí aplikace, která je součástí vašeho nástroje pro vytváření nápovědy, nebo pomocí samostatné aplikace, jako je Microsoft Paint, Paint Shop Pro nebo SnagIt.
- Text a snímky obrazovky by měly být uspořádány společně v tématu tak, aby uživatelé mohli snímek obrazovky a její podpůrný text vidět bez zbytečného posouvání. V mnoha případech budete chtít místo celé obrazovky zobrazit část obrazovky programu nebo snímek obrazovky zobrazit v menší velikosti než originál. Vaše aplikace pro snímky obrazovky by měla být schopna změnit velikost obrazovky bez rozmazání nebo ztráty detailů.
- Pokud očekáváte změny v uživatelském rozhraní mezi testovací a finální verzí programu, možná budete chtít s tvorbou snímků obrazovky počkat, dokud nebudete mít konečnou verzi programu, se kterou budete pracovat.
Krok 7. V případě potřeby vytvořte soubor mapy
Některé programy obsahují tlačítka „Nápověda“, na která má uživatel kliknout a zobrazit téma v souboru nápovědy, který konkrétně popisuje, jak tato obrazovka funguje. Zobrazování tématu tímto způsobem se nazývá kontextová nápověda a vyžaduje vytvoření mapového souboru pro programátora, který propojí tlačítko „Nápověda“s konkrétním tématem v souboru nápovědy. Váš nástroj pro vytváření nápovědy vám jej může vytvořit, nebo jej může programátor kódovat a dát vám jej zahrnout do souboru nápovědy.
Krok 8. Zkompilujte soubor nápovědy
Kompilace vytvoří skutečný soubor nápovědy, který bude součástí programu. U většiny formátů nápovědy to bude zahrnovat všechny soubory komponent, které byly vytvořeny při vytváření souboru nápovědy, ačkoli některé nekompilované formáty nápovědy také vyžadují, aby byly do programu zahrnuty jednotlivé soubory témat nápovědy.
Krok 9. Otestujte soubor nápovědy
Jakmile zkompilujete soubor nápovědy, musíte jej otestovat, abyste se ujistili, že se všechny hypertextové odkazy správně připojují k tématům, která mají mít, a veškerou grafiku. Soubor nápovědy je také třeba otestovat, aby bylo zajištěno, že je obsah přesný a vhodný pro uživatele a v konzistentním formátu. Budete si chtít sami prohlédnout soubor nápovědy a nechat jej zkontrolovat také lidmi, kteří aplikaci testují.
U větších projektů souborů nápovědy jsou kompilace a testování probíhajícími procesy. Před vytvořením konečné verze budete chtít zkompilovat soubor nápovědy a několikrát zkontrolovat svou práci
Krok 10. Předejte vývojáři soubor nápovědy, který zahrne do programu
V závislosti na povaze projektu a formátu souboru nápovědy může být nutné poskytnout vývojáři několik souborů, včetně souboru mapy, pokud existují kontextová témata.
