Uživatelská příručka je příručka v papírové nebo elektronické podobě (PDF nebo XPS), která obsahuje pokyny k postupu nebo použití něčeho. Přestože jsou „uživatelské příručky“často spojovány s průvodci počítačovými aplikacemi, uživatelské příručky jsou rovněž dodávány s počítači a dalšími elektronickými zařízeními, jako jsou televize, stereofonní zařízení, telefonní systémy, přehrávače MP3 a vybavení pro domácnost a zahradu. Dobrá uživatelská příručka seznámí uživatele s funkcemi produktu a naučí je, jak tyto funkce efektivně využívat. Uživatelská příručka je strukturována tak, aby byla snadno čitelná a odkazovatelná. Zde je několik kroků, které je třeba vzít v úvahu při vývoji efektivního obsahu a navrhování rozvržení uživatelské příručky.
Krok
Část 1 ze 3: Vytvoření vhodné uživatelské příručky
Krok 1. Rozhodněte, kdo bude průvodce používat
Chcete -li napsat dobrou uživatelskou příručku, musíte si vytvořit uživatelský profil, a to buď formálně vytvořením písemného profilu, nebo neformálně tím, že si uděláte čas na přiměřené předpoklady o vlastnostech uživatele. Takové profily jsou užitečné, když jste součástí týmu pro psaní uživatelských příruček a při práci na zamýšleném produktu od konceptu po konečnou podobu. Při vytváření uživatelského profilu zvažte následující faktory:
- Poloha uživatele bude průvodce používat například doma, v kanceláři, na vzdáleném pracovišti nebo v autě. Tento faktor určuje nejen obsah, ale také styl psaní, který si průvodce osvojí.
- Jak bude uživatel příručku používat. Pokud je používají jen zřídka nebo je potřebují pouze k nalezení informací, je nejlepší, když je průvodce vytvořen ve formě referenčního dokumentu. Na druhou stranu, pokud jej uživatel bude na začátku používat pravidelně, k referenční části by měl být připojen oddíl „Jak začít“a pokyny k nejběžnějším funkcím, které bude produkt plnit.
- Kolik zkušeností má uživatel s produktem nebo podobnou položkou. Pokud je produkt nový nebo se velmi liší od podobných produktů, musíte uvést vysvětlení, jak se liší od ostatních, a pokyny, jak jej používat. Pokud se produkt zabývá něčím, co je pro uživatele často obtížné, například počítačová aplikace, musíte srozumitelným způsobem poskytnout příslušné informace a podrobnosti.
Krok 2. Vytvořte průvodce, který bude srozumitelný potřebám uživatele
Pokud uživatelé nejsou technicky zdatní lidé, je pravděpodobně nejlepší vyhnout se vysoce odbornému jazyku a poskytnout jasná a jednoduchá vysvětlení. Text by měl být také uspořádán tak, aby se podobal způsobu, jakým uživatel myslí. Seznam funkcí produktu seskupených podle funkcí často dává větší smysl než podle nejčastěji používaných funkcí.
Někdy je použití technických termínů nevyhnutelné, například pro vytváření grafických aplikací, které obsahují Fibonacciho grafy spolu s koláčovými grafy a běžnějšími sloupcovými grafy. V takovém případě by bylo lepší definovat pojmy a poskytnout informace, například vysvětlení toho, co je Fibonacciho graf a jak se používá ve finanční analýze
Krok 3. Popište problém, který se uživatel pokouší vyřešit, a poté poskytněte řešení tohoto problému
Nabízet funkce jako řešení běžných problémů je dobré při inzerci produktu, ale jakmile zákazník produkt vlastní, musí pochopit, jak jej používat. Identifikujte problém, se kterým se uživatel setká, popište jej v uživatelské příručce a poté postupujte podle pokynů k jeho řešení.
Pokud je problém složitý, rozdělte ho na menší kousky. Zapište si každou sekci s pokyny, jak ji vyřešit nebo se s ní vypořádat, a poté se v pořadí sledujte. Rozdělení informací tímto způsobem je známé jako metoda shlukování nebo rozdělení
Část 2 ze 3: Součásti uživatelské příručky
Krok 1. Vytvořte odpovídající titulní a titulní stránku
Budete potřebovat obal pro každou uživatelskou příručku, která je více než referenční karta, a titulní stránku pro průvodce, který obsahuje více než skládaný list papíru (o délce 4 stránky nebo více).
- Pokud je příručka chráněna autorskými právy, musí být na přední a zadní obálce a na titulní stránce uvedeno upozornění na autorská práva.
- Pokud existují podmínky pro používání příručky a produktů s ní spojených, uveďte je prosím na vnitřní straně předního krytu.
Krok 2. Vložte odkaz na související dokument v úvodu
Pokud existuje více než jedna uživatelská příručka, odkazujte zde na jiný dokument, včetně správného čísla verze. Předmluva je také místem pro vložení části „Jak používat tuto příručku“, pokud existuje.
Krok 3. Pokud je průvodce delší než 10 stran, zahrňte obsah
Krok 4. Umístěte pokyny/postupy a referenční materiály na tělo průvodce
Ve většině případů by měl mít postup i referenční materiál každý svůj vlastní oddíl. Můžete však uživatelům sdělit, aby odkazovali na konkrétní obsah v jedné sekci a odlišili ho od ostatních sekcí. Uživatel tak může rychle najít informace, které hledá.
- Postupy by měly být napsány v konzistentní struktuře v celém návodu k použití. Začněte s přehledem funkcí produktu, poté vysvětlete, co by měl uživatel dělat a jaké výsledky získá nebo uvidí. Kroky by měly být očíslovány a začínat slovesem akcí, stejně jako jsou kroky zapsány v každé části tohoto článku.
- Referenční materiál může obsahovat kontrolní seznamy, tipy pro řešení potíží a často kladené otázky. Na konci příručky může být přidán glosář a rejstřík, ačkoli na začátku může být poskytnut glosář často používaných výrazů. Rejstřík lze vynechat, pokud má průvodce méně než 20 stran.
Krok 5. K podpoře textu použijte podle potřeby grafické obrázky
Grafické obrázky nebo snímky obrazovky mohou lépe ilustrovat určité body v průvodci než text, zvláště u složitých postupů, kde uživatelé potřebují vizuální potvrzení, aby se ujistili, že postupují správně. Grafické kresby lze vytvářet pomocí počítačem podporovaných návrhů (CAD) nebo aplikací pro úpravu grafiky, aplikací pro digitální fotoaparáty a zpracování fotografií, nebo chcete-li používat snímky obrazovky, použijte funkce snímků obrazovky zabudované ve vašem počítači nebo grafický program s možnostmi snímání obrazovky.
- Jakmile vytvoříte grafický obrázek, uložte jej v komprimovaném formátu, abyste jej mohli použít v aplikaci pro zpracování textu nebo publikování na počítači. Musíte také zmenšit velikost obrázku, aby lépe odpovídal stránce, ale přesto poskytnout uživateli úplné podrobnosti. (V případě potřeby můžete původní obrázek oříznout na sekce a zobrazit příslušné sekce spolu s podpůrným textem).
- Pokud v postupu použijete více grafických obrázků, ujistěte se, že jsou obrázky vytvořeny v konzistentní velikosti, buď ve stejných rozměrech délky a šířky, nebo v poměru k velikosti původního obrázku. Tak bude obrázek vypadat pro uživatele atraktivnější. Totéž platí při pořizování snímků obrazovky z počítače; ujistěte se, že počítač při fotografování zobrazuje standardní barevné schéma, jinak průvodce zobrazí barevný snímek obrazovky.
- Zatímco aplikace pro úpravu obrázků, jako je Photoshop a Paint Shop Pro, mají dobré funkce pro pořizování obrázků, programy určené k pořizování snímků obrazovky, jako je Snagit, také nabízejí možnost snadno upravovat, katalogizovat a přidávat poznámky k snímkům.
Část 3 ze 3: Navrhování snadno použitelné uživatelské příručky
Krok 1. Vyberte některá snadno čitelná písma
Přestože počítač může podporovat řadu písem, účel vytvoření uživatelské příručky je snadno čitelný. Výběr více odpovídajících písem je nejlepším způsobem, jak toho dosáhnout. Písma lze seskupit do dvou typů: patkové a bezpatkové.
- Patková písma mají na okrajích hlavních řádků, které tvoří písmena, malé ozdobné čáry. Mezi patková písma patří Times New Roman, Baskerville a Book Antiqua. Patková písma jsou ideální pro většinu textu zobrazeného ve velikostech 10–12 v hlavním těle tiskových průvodců.
- Bezpatková písma obsahují pouze řádky, které tvoří písmena, bez příkras. Mezi písma, která patří do bezpatkové skupiny, patří Arial, Calibri a Century Gothic. Bezpatková písma lze použít pro většinu textových velikostí 8 až 10 v souborech PDF nebo v online průvodcích, přestože je nezdobený, znesnadňuje čtení vět zobrazovaných v písmech 12 nebo větších. Písma však lze efektivně použít ve větších velikostech k zobrazení nadpisů a nadpisů a v menších velikostech jsou ideální pro poznámky pod čarou a čísla ve sloupcích a tabulkách.
- Obecně je nejlepší zvolit si jako průvodce jednoduché písmo, jako je Arial nebo Times New Roman, ačkoli pro citáty nebo názvy můžete použít ozdobné písmo, pokud píšete průvodce pro videohru zasazenou do prostředí fantasy nebo sci -fi. (V případě citací můžete často použít jednoduché písmo a celý citát zobrazit kurzívou).
- Poté, co se rozhodnete, která písma použít, vytvořte ukázkové stránky, abyste ověřili, že vypadají dobře na papíře. Než budete pokračovat v procesu psaní, měli byste také ukázat tuto ukázkovou stránku osobě odpovědné za poskytnutí souhlasu se zobrazením průvodce.
Krok 2. Přemýšlejte o rozložení
Jakmile vyberete písmo pro průvodce, budete se muset rozhodnout, jak strukturovat obsah v horní části stránky.
- Obecně platí, že byste měli pravděpodobně umístit název dokumentu nebo název kapitoly do záhlaví nebo zápatí, například pomocí záhlaví průvodce na levé straně stránky a záhlaví kapitol na pravé straně stránky. Číslo stránky musíte umístit do záhlaví nebo zápatí, buď mimo (záhlaví nebo zápatí), nebo na střed (pouze v zápatí). Také budete muset odlišit první stránku každé sekce nebo kapitoly od ostatních stránek tak, že číslo stránky umístíte doprostřed zápatí a další stránku do vnějšího rohu záhlaví.
- Možná budete muset vložit text do barevného pole nebo bloku, aby se odlišil od zbytku textu. Ujistěte se, že jste vybrali barvu nebo úroveň blokování, aby text nebyl obtížně čitelný.
- Ponechte na všech stranách poměrně široký okraj, s okrajem navíc, který bude spojen.
Krok 3. Zvažte typ svazku v uživatelské příručce
Pokud je průvodce delší než 4 stránky, musí být stránky vázány určitým způsobem. Přestože lze interní dokumenty sešívat sešívačkou v rohu stránky, externí uživatelská příručka dodaná s produktem je obvykle sešita jednou z následujících 3 metod:
- Metoda bočního sešívání (připevněná k bokům stránky sešívačkou) pro vodítka tištěná na skládaný papír 21 x 27,5 cm, 21 x 35 cm nebo 27,5 x 42,5 cm. Tímto způsobem je svázána většina levných průvodců o 48 nebo méně stranách.
- Metoda sešití sedla (sešitá na stranu stránky) se používá častěji u referenčních příruček třetích stran než u průvodců obsažených u jiných produktů než automobilů, i když některé delší vodítka jsou tímto způsobem vázána. (Průvodce Paint Shop Pro původně obsahoval průvodce pro sešívání, zatímco byl stále vyráběn JASC Software).
- Spirálová vazba je nejvhodnější pro vodítka používaná v drsnějších prostředích, například venku (v takovém případě nejsou metody sešívání do stran a sešívání v sedle dostatečně silné, aby stránky prokluzovaly). Některé vodítka se spirálovou vazbou mohou mít také stránky laminované plastem, které zabrání jejich poškození za mokra nebo působení bláta.
Krok 4. Vytvořte vzorový dokument pro vedení
Mnoho aplikací pro zpracování textu a publikování na počítači nabízí možnost vytváření šablonových dokumentů pro uživatelské příručky. Při psaní se tedy text automaticky zobrazí s písmem, které jste vybrali pro část průvodce, na kterém pracujete. (Tento článek byl původně napsán pomocí šablony aplikace Microsoft Word). Většina těchto programů také obsahuje standardní sadu šablon, které můžete podle potřeby upravovat, abyste si nemuseli vytvářet vlastní od začátku.
