Jak psát jasné a stručné uživatelské příručky
Co je uživatelská příručka?
Uživatelská příručka má různé názvy. Technické dokumenty, příručky údržby a návody k použití jsou všechny názvy, které odkazují na stejnou položku. Uživatelská příručka je vytvořena, aby pomohla zákazníkům správně používat váš produkt nebo službu nebo vyřešit problémy, ke kterým během používání dojde. Mohou být k dispozici v tištěné, digitální nebo obou formátech.
Návody k použití poskytují koncovému uživateli komplexní pokyny krok za krokem a určitou podporu při řešení problémů. Obsah by měl být přítomen v každé uživatelské příručce, protože jde spíše o referenční materiály než o knihy, které je třeba číst od začátku do konce. Do své uživatelské příručky byste měli přidat výukový program pro rychlý start nebo spuštění, aby uživatelé mohli snadno začít produkt používat.
druhy uživatelských příruček
Pro různé předměty a cíle lze vytvořit uživatelské příručky. Zde jsou některé z vašich možností, tak se na ně pojďme podívat.
- Návod k použití
Návod k použití je typ uživatelské příručky, která nabízí přímočaré pokyny pro použití produktu způsobem, k němuž byl určen. - Školicí příručka
Tento druh uživatelské příručky nabízí seznam pokynů pro dokončení určitého úkolu, projektu nebo zakázky. - Servisní příručka
Servisní příručky jsou uživatelské příručky, které popisují, jak se starat a udržovat stroj nebo zařízení u různých stages jeho životnosti. - Uživatelská příručka
Uživatelské příručky jsou technické publikace, které vysvětlují, jak správně používat nebo obsluhovat produkt. - Návod k obsluze
Role, povinnosti a postupy specifické pro podnik nebo organizaci jsou popsány v provozních příručkách. - Manuál organizační politiky
Manuál organizačních zásad je dokumentace definující zásady, postupy a osvědčené postupy společnosti. - Manuál standardních operačních postupů (SOP).
Uživatelé těží z podrobných instrukcí standardních provozních postupů pro provádění zavedených postupů.
Proč vaše firma potřebuje uživatelské příručky?
Lidé jsou lépe vybaveni k tomu, aby zvládli problémy sami s podporou uživatelské příručky. Slušná uživatelská příručka může vašim zákazníkům poskytnout nástroje, které potřebují k rychlému a efektivnímu dosažení hodnoty, kterou od vašeho produktu nebo služby požadují v dnešní kultuře okamžitého uspokojení.
Vynikající služby zákazníkům je třeba doplnit uživatelskými manuály. Psaní vynikajících uživatelských příruček poskytne následující výhodytages pro vaši společnost:
- Aby bylo přihlášení a školení jednodušší
Dobře napsané uživatelské příručky mohou zjednodušit procedury zařazování a školení. To je pravda, vývojem a implementací špičkových uživatelských příruček mohou získat vaši zaměstnanci i vaši spotřebitelé.
Vaše společnost může využít uživatelské příručky, které novým zaměstnancům pomohou projít některými procesy a systémy, které jsou součástí jejich nových rolí, než aby pouze zakládali složitá osobní školení, která mají značné časové a finanční náklady. Vzhledem k tomu, že se zaměstnanci mohou učit při plnění povinností souvisejících s jejich pozicí díky uživatelským příručkám, může dojít ke ztrátě méně hodin během onboardingu. - Chcete-li snížit náklady na podporu
Uživatelské příručky jsou skvělým doplňkem vašeho úsilí o služby zákazníkům pro spotřebitele, ale také dobře slouží majiteli firmy jako součást systému zákaznické podpory.
Zákazníci s větší pravděpodobností najdou řešení ihned a je méně pravděpodobné, že budou muset kontaktovat technika nebo zástupce se specializovanou podporou, když jim poskytnete rychlý přístup k prohledávatelné uživatelské příručce. - Pro úsporu času
Jak vaši zákazníci, tak vaši zaměstnanci, od zaměstnanců na základní úrovni až po management, mohou ušetřit čas používáním uživatelských příruček. Když budou mít vaši klienti k dispozici uživatelské příručky, nebudou muset ztrácet čas hledáním informací o tom, jak produkt používat, protože k těmto informacím budou mít okamžitý přímý přístup.
Když jsou vaši zaměstnanci vybaveni užitečnými uživatelskými příručkami, nemusí ztrácet čas nezávislým vyhledáváním řešení nebo monopolizovat pozornost svých spolupracovníků a manažerů dotazy, protože mají přístup k řešení přímo ve své uživatelské příručce! - Chcete-li minimalizovat odpovědnost
Jedním ze způsobů, jak prokázat, že jste svůj produkt důkladně otestovali a víte, jak jej bezpečně používat, je napsat a distribuovat uživatelské příručky. To může výrazně snížit veškeré povinnosti spojené s výrobou něčeho pro širokou veřejnost.
Zapsat si varování a bezpečnostní opatření a zpřístupnit je uživatelům prostřednictvím uživatelské příručky je účinný (i když ne zcela bezpečný) způsob, jak se vyhnout právním problémům souvisejícím se zraněními nebo jinými škodami způsobenými nesprávným používáním, pokud by produkt, který prodáváte, mohl být pro uživatele nebezpečný (např. topidla, elektrické nářadí atd.).
Které komponenty tvoří nejlepší uživatelské příručky?
Existují některé doporučené postupy pro dokumentaci koncových uživatelů, které je třeba dodržovat bez ohledu na to, co je třeba, i když je každý produkt jedinečný a bude potřebovat odlišné komponenty, aby bylo možné vytvořit skutečně vynikající uživatelskou dokumentaci.
- Obyčejný jazyk
Nic nebude dráždit vaše zákazníky více – kromě toho, že žádnou nenabídnete – než zjištění, že jejich uživatelská příručka je plná žargonu a těžko srozumitelného jazyka. Vaše uživatelské pokyny se obtížně používají kvůli těmto jazykovým volbám, které také nepodporují vynikající služby zákazníkům. Zajištění toho, že píšete pro uživatele, nikoli pro vývojáře, je klíčovou součástí vytváření skvělých uživatelských příruček. Nepředpokládejte, že váš koncový uživatel něco zná nebo je s něčím obeznámen. Zkratky, žargon a kancelářská terminologie způsobí, že se vaši klienti budou cítit špatně informovaní, frustrovaní a nepřipravení. Sladkým bodem pro vytvoření uživatelské příručky je nalezení rovnováhy mezi tím, že nepíšete, jako by vaši spotřebitelé byli děti (samozřejmě pokud jimi nejsou!), a poskytujete jim další pomoc, kterou potřebují, aby zcela porozuměli tomu, jak produkt používat, jednoduše jazyk. - Jednoduchost
Psaní uživatelské příručky vyžaduje jednoduchost. Tento koncept by se měl odrazit jak v obsahu, tak v designu. Pokud svou dokumentaci přeplníte složitými obrázky a dlouhými pasážemi textu, bude se vám zdát příliš sofistikovaná a těžko pochopitelná. Tento druh uživatelské příručky pravděpodobně zastraší vašeho uživatele a přiměje ho, aby zavolal na vaši linku pomoci, místo aby se pokoušel svůj problém vyřešit sám. - Vizuály
Zásada „Ukaž, neříkej“ je základním kamenem psaní uživatelské příručky. Komentované snímky obrazovky, filmy a další vizuální obsah jsou velmi užitečné pro pochopení pojmů. Často je mnohem užitečnější něco vidět v akci, než o tom číst. Vizuální prvky nejen že rozbíjejí dlouhé pasáže textu, ale také snižují množství textu v uživatelských příručkách, které může být děsivé. Bylo prokázáno, že lidé uchovávají vizuální informace o 7 % rychleji než písemné informace. Ve studii Techsmith se také ukázalo, že 67 % lidí vykonávalo úkoly efektivněji, když jim byly poskytnuty pokyny, které k předávání informací zahrnovaly snímky obrazovky s poznámkami spíše než samotná slova. - Zaměřte se na problém, který je třeba vyřešit
Je docela pravděpodobné, že někdo koupil váš produkt, aby vyřešil problém. Při vytváření uživatelské příručky, která bude přiložena k produktu, je nezbytné se na tento problém soustředit. Místo toho, abyste vyjmenovávali a diskutovali o všech funkcích, které váš produkt nabízí, nebo o zajímavých designových prvcích, které jste začlenili, informujte o nich své uživatele způsobem, který usnadní používání produktu. Při popisu dejte řešený problém do kontextu vlastností a výhod vašeho produktu. - Logický tok a hierarchie
Aby bylo pro uživatele zřejmé, co se dozví z každé části vaší uživatelské příručky, použijte záhlaví a podnadpisy, které mají jasnou hierarchickou strukturu. Abyste bez námahy provedli své zákazníky vším, co potřebují vědět, od začátku do konce, měla by zvolená hierarchie sledovat logický tok. Ujistěte se, že začínáte se základy a začleňte logický postup směrem k sofistikovanějším funkcím vašeho produktu. - Seznam obsahu
Vaše uživatelská příručka bude pro čtenáře nejužitečnější, pokud bude začínat obsahem. Aniž byste se museli prohrabávat mnoha stránkami informací, které nesouvisejí s aktuálním problémem, kterému čelí, je pro někoho známý přístup, jak rychle a snadno prozkoumat dokument. - Udělejte to prohledávatelné
I když si své uživatelské příručky vytisknete, je pravděpodobné, že digitální dokumentace bude vaší hlavní prioritou. Je docela pravděpodobné, že vaše uživatelské příručky budou nejčastěji využívány v digitální podobě ve světě, kde má většina lidí smartphone neustále u sebe. Přidání prohledávatelné funkce do vašich digitálních uživatelských příruček podpoří příjemné snadné použití pro uživatele, kteří chtějí vyřešit problém tím, že k nim přistoupí, podobně jako obsah slouží k nasměrování uživatelů na správné místo v tištěném dokumentu. - Přístupnost
Je možné, že někteří lidé, kteří potřebují vaši uživatelskou příručku, by mohli využít další pomoc, aby zajistili její správnou funkci. Bez ohledu na to, zda jsou vyžadovány zákonem, jsou požadavky na přístupnost obecně dobrou praxí. Udržování požadavků na přístupnost ve vašich uživatelských příručkách je jen vynikající obchodní praktika. Zásadní je navrhování uživatelských příruček s obsahem, který je přístupný uživatelům, kteří by mohli mít vizuální, zvukové nebo kognitivní problémy. - Dobře navržený
Při vytváření uživatelských příruček zvažte své publikum. Budou mnohem více nakloněni tomu efektivněji využít, pokud uděláte něco, na co se rádi dívají! Vyhněte se používání dlouhých textových bloků a poskytněte dostatek volného místa. Kombinace těchto dvou charakteristik může spotřebitelům pomoci vypadat méně děsivě a učení čehokoli nového se zdá být vzrušující, nikoli hrozivé. I zde platí přístup „ukaž, neříkej“, který jsme popsali dříve. Pro tištěné i digitální uživatelské příručky je přidání vizuálů a fotografií k textu skvělou alternativou. U digitálních uživatelských příruček jsou videa a GIFy zajímavým a užitečným prvkem. Pokud má vaše společnost stylovou příručku, váš návrh by se jí měl řídit; v opačném případě, pokud pracujete bez něj, je důležité, aby byla vaše uživatelská příručka konzistentní. Písmo a barevná schémata použitá v celém dokumentu a ideálně ve všech vašich uživatelských příručkách by měla být konzistentní. - Komentáře od skutečných zákazníků nebo beta testerů
Nebudete schopni určit, zda jsou uživatelské příručky, které jste připravili, co nejúspěšnější, dokud si nevyhledáte a neposlechnete zpětnou vazbu od lidí, kteří budou váš produkt skutečně používat. Uživatelské příručky, které pro svůj produkt vytvoříte, by měly zohledňovat problémy, které s ním lidé mají. Můžete se naučit něco, co se zdá být extrémně zřejmé, ale je mnohem větší šance, že se naučíte něco, co vám pomůže porozumět potřebám zákazníků, které se snažíte oslovit.
Jak napíšu uživatelskou příručku?
Vytvoření uživatelské příručky je zásadní úkol, který může mít velký dopad jak na vaši společnost, tak na spotřebitele, kterým chcete sloužit. Zjednodušili jsme proces vývoje uživatelské příručky, abyste ji mohli snadno sledovat, protože může být ohromující.
- Identifikujte uživatele
Nalezení příjemce vaší komunikace je základním počátečním krokem, stejně jako u jakékoli jiné komunikace, kterou generujete. Cílové publikum vaší uživatelské příručky vám pomůže rozhodnout se v otázkách, jako je tón, úroveň podrobností, které je třeba poskytnout, a způsob doručení obsahu. Psaní uživatelské příručky pro koncového uživatele vašeho produktu se výrazně liší od psaní uživatelské příručky pro technického inženýra. Úplně prvním krokem je určit své publikum. - Zaměřte se na problém
Uživatelské příručky jsou vytvořeny tak, aby pomohly s řešením problémů nebo daly někomu pokyn, jak udělat něco nového. Musíte přesně určit, k čemu je vaše uživatelská příručka určena, a ujistit se, že toto zaměření udržíte.
Může být lákavé téma rozšířit a diskutovat o mnoha funkcích nebo aplikacích pro váš produkt. To může uživatele frustrovat a vést k volání na vaši linku zákaznické podpory tím, že zamlží skutečnou odpověď, kterou požadují.
Pokud je vaším zákazníkem spotřebitel, který se učí produkt používat, nebo technik, který jej potřebuje opravit, soustřeďte se na přesné řešení, které bude vyžadovat. - Použijte sekvenční přístup
Pokyny v uživatelské příručce by měly být uspořádány v sekvenčním pořadí nezbytném k dokončení práce, kterou máte k dispozici. Uveďte každý krok, abyste mohli začít. Poté se snažte provést úkol a přitom dodržet přesné kroky, které jste nastínili v daném pořadí. Když procházíte svůj původní seznam, je možné, možná dokonce pravděpodobné, že najdete nějaké stagkteré chybí. Kromě toho můžete zjistit, že něco, o čem jste dříve věřili, že je to jediný úkol, musí být kvůli přehlednosti rozděleno do několika činností.
Než přejdete k další fázi psaní uživatelské příručky, ujistěte se, že jste určili jasný výsledek pro každý postupný krok, který jste přidělili. Před přechodem na další úroveň by čtenářům mělo být zcela jasné, čeho chtějí dosáhnout a jak by to mělo vypadat. - Cesta uživatele mapy
Cílem vytvoření uživatelské příručky je pochopit, jak vaši zákazníci plánují používat váš produkt, a usnadnit jim to. Musíte se snažit pochopit problém, který se spotřebitel snaží vyřešit, nebo cíl, kterého se snaží dosáhnout využitím vašeho řešení, a také to, jak se zapojuje do vašeho podnikání. Pomocí těchto podrobností můžete naplánovat kroky nezbytné k tomu, abyste provedli zákazníka celým procesem, abyste si vizualizovali jeho cestu od problému k řešení. - Vyberte šablonu
Úkol psaní a vývoje uživatelských příruček může být mnohem jednodušší, než byste čekali, vytvořením řady šablon. Váš postup se může zjednodušit a konzistence by se stala mnohem realističtějším cílem.
V šabloně uživatelské příručky byste kromě definování podrobností, jako jsou písma (typ a velikost), požadavky na kontrast a barevná schémata, měli zahrnout také následující:- Oblast vyhrazená pro úvod
- Odlišné podsekce a sekce
- Vámi zvolený formát pro předávání řady akcí
- Varovné poznámky a varování
- Oblast vyhrazená pro závěr
- Pište jednoduchý a snadno sledovatelný obsah
Materiál vaší uživatelské příručky by měl být co nejjednodušší a srozumitelný. Je důležité promyslet a analyzovat formát a obsah pro jasnost a pohodlí.
Ujistěte se, že každá fáze procesu nastiňuje pouze jeden úkol a používá tak jasný a krátký jazyk, jak je to jen možné. Ujistěte se, že jste správně upravovali svůj text, dokud nebudete mít uživatelskou příručku obsahující pouze informace, které jsou skutečně nezbytné. - Přistupujte ke každému uživateli jako nováček
Předpokládejme, že čtenář vaší uživatelské příručky nemá žádné předchozí znalosti o vašem produktu při jeho vytváření. Pište, jako byste mluvili s laikem.
Je třeba se vyhnout jakémukoli použití žargonu nebo technického jazyka. Přirozeně nastanou chvíle, kdy je třeba se tomu vyhnout, ale toto by měla být absolutní výjimka. - Vyzkoušejte pokyny k produktu se začínajícími uživateli
Testovací fáze procesu vytváření uživatelské příručky je klíčová. Předmět experimentu má významný vliv na výsledek.
Testování by mělo být v ideálním případě prováděno na lidech, kteří váš produkt nikdy nepoužili ani neviděli dokumentaci. Při procházení uživatelské příručky je sledujte, jak dokončí proces, a zaznamenejte si, kde uvíznou. Poté by měly být informace náležitě aktualizovány.
Pro obsluhu produktu by vašim testerům měla být nezbytná pouze pomoc z uživatelské příručky. Neměli by žádat o další pomoc. Průvodce SSSR by měl mít všechny informace, které požadují. - Vytvářejte obsah pomocí praktického přístupu
Mělo by být vynaloženo veškeré úsilí nabídnout konkrétní exampsoubory a podrobné popisy jakýchkoli výsledků, které mohou uživatelé zaznamenat po provedení každého kroku v uživatelské příručce. Uživatel by si měl být vědom jakékoli zpětné vazby, kterou by mohl od produktu získat, a také všech potenciálních památek nebo zvuků, se kterými se může na cestě setkat. - Vysvětlete symboly, ikony a kódy včas
Možná budete muset při psaní uživatelské příručky použít ikony, symboly nebo kódy, které vám pomohou poskytnout potřebné pokyny. Aby se předešlo zmatení nebo frustraci čtenářů, je důležité, abyste je co nejdříve identifikovali ve své uživatelské příručce.
Často kladené dotazy k uživatelské příručce
Co přesně jsou uživatelské příručky?
Uživatelská dokumentace je informace poskytovaná ve formě uživatelských příruček nebo uživatelských příruček a má pomoci koncovým uživatelům při úspěšné interakci s produktem.
- Jaké druhy uživatelské dokumentace existují?
Fyzická dokumentace, jako jsou brožury nebo manuály, se tradičně používá k nabídce uživatelské dokumentace. V dnešní době jsou uživatelské příručky vyráběny a distribuovány častěji digitálně. - Co je obsaženo v uživatelských příručkách?
Návod k použití nebo uživatelská příručka má dobrý design, srozumitelné psaní a zaměření na řešení problémů. Musím mít obsah, dodržovat logickou hierarchii a tok a nabízet obsah, který je přístupný. Kromě toho bude dobrá uživatelská příručka prohledávatelná a zohlední uživatelskou reviews. - Jak se vytváří uživatelský dokument?
K vývoji uživatelských příruček lze použít jednoduché kroky. Nejprve musí být stanoveny cíle uživatelské příručky a musí být vytvořena strategie, která umožní jejich dosažení. Uživatelská příručka musí být před zveřejněním otestována a podle potřeby aktualizována. Nakonec je důležité udržovat uživatelskou příručku aktualizovanou a provádět změny, když jsou přidávány nové aktualizace nebo edice.