Informační reference - je nedílnou součástí každého produktu nebo služby. Pomáhá uživatelům pochopit zařízení nabízených možností, odpovědět na jejich otázky a pomoci vypořádat se s problémy, které nastanou. Chcete-li vytvořit účinnou referenční dokumentaci, musíte dodržovat konkrétní akční plán.
Prvním krokem při vytváření informační nápovědy je analyzovat cílové publikum. Určete, kdo bude váš produkt používat a jak technicky zdatní mohou být. To vám umožní posoudit úroveň detailů a technickou hloubku složeného nápovědy. Pokud je váš produkt určen pro široké publikum, doporučuje se napsat nápovědu nejjednodušším a nejsrozumitelnějším jazykem. Pokud je váš produkt zaměřen na zkušené uživatele, může být vyžadován podrobnější popis funkčnosti.
Druhým krokem je výběr formátu a struktury. Můžete si vybrat mezi různými formáty nápovědy: webová stránka, dokument PDF, vestavěná Nápověda v programu atd. Určete, který formát bude pro vaše uživatele nejpohodlnější a nejdostupnější. Určete strukturu nápovědy. Které sekce budou nejdůležitější? Jaký postup při poskytování informací bude nejlogičtější? Upřesněte všechny potřebné sekce pro každou položku vašeho produktu. Pokud je vaším produktem například software, můžete zadat sekce s pokyny k instalaci, hlavní funkce, pokyny k použití a řešení problémů.
Kroky k vytvoření informační nápovědy
Krok 1: Určete cíl a publikum nápovědy. Pochopení toho, pro jaký účel je nápověda vytvořena a kdo ji bude používat, pomůže identifikovat potřebné sekce a informace.
Krok 2: Strukturujte obsah nápovědy. Rozdělte informace do logických bloků a vytvořte záhlaví pro každý z nich. To umožní čtenářům rychle najít potřebné informace.
Krok 3: Napište Úvod. V prvním odstavci vysvětlete účel nápovědy a jak může být pro čtenáře užitečný. Poté stručně popište obsah oddílů.
Krok 4: Vypracujte podrobné pokyny pro každou sekci. Používejte srozumitelný a jasný jazyk. Pokyny musí být strukturované a konzistentní, aby je čtenáři mohli snadno sledovat.
Krok 5: Používejte vizuální prvky. Pro přehlednost zvýrazněte klíčová slova nebo fráze tučným nebo kurzívou. Pomocí číslovaných seznamů nebo označených seznamů prezentujte informace vhodným způsobem.
Krok 6: Proveďte úpravy a úpravy. Zkontrolujte strukturu a přehlednost nápovědy. Ujistěte se, že pokyny jsou snadno srozumitelné a konzistentní. Opravte všechny gramatické a interpunkční chyby.
Krok 7: Otestujte nápovědu. Požádejte několik čtenářů, aby si přečetli vaši nápovědu a poskytli zpětnou vazbu. Použijte jejich komentáře a návrhy ke zlepšení nápovědy.
Krok 8: Udělejte si referenci. Pomocí značky vytvořte nadpisy, odstavce a seznamy. Stylizujte nápovědu pro zlepšení její čitelnosti a přitažlivosti.
Krok 9: Poskytněte nápovědu uživatelům. Umístěte nápovědu na svůj web nebo aplikaci. Ujistěte se, že je snadno dostupná a uživatelé mohou rychle najít požadované informace.
Stanovení původních cílů
Než začnete vytvářet informační nápovědu, musíte určit cíle, kterých chcete dosáhnout. Nastavení počátečních cílů vám pomůže jasně pochopit, co přesně chcete svým čtenářům sdělit a jaký bude konečný výsledek.
Při určování cílů věnujte pozornost následujícím otázkám:
- Kdo je vaší cílovou skupinou? Kdo si přečte informační tabuli?
- Jaký problém nebo otázku chcete vyřešit nebo odpovědět?
- Jaké znalosti, dovednosti nebo informace chcete předat?
- Jaký formát bude nejvhodnější pro vaši informační referenci: textový, grafický nebo kombinovaný?
- Jaké množství informací potřebujete sdělit?
Odpovědi na tyto otázky vám pomohou určit obsah, strukturu a styl vašeho informačního nápovědy a také vám pomohou posoudit, jak úspěšně bylo dosaženo vašich cílů v konečném důsledku.