Toto je, Jak Vytvořit Nejlepší Uživatelská Dokumentace

Šance jsou, pokud vaše výrobky jsou složitější než role papírové ručníky, vytvořit nějaké uživatelské dokumentaci, aby pomohl lidem naučit, jak je používat.

dobře vytvořený, uživatelsky přívětivý návod k použití nebo uživatelská příručka může znamenat rozdíl mezi fantastickým zákaznickým zážitkem a hrozným.

a uživatelská dokumentace není jen pro nové uživatele.,

Zkušené zákazníky může také se odkazovat na uživatelské příručky nebo příručky produktů osvěžit své vzpomínky na funkci nemají používá často nebo, jak vyřešit konkrétní problém mohou mít.

pro tento příspěvek se zaměříme hlavně na osvědčené postupy pro vytváření uživatelské dokumentace pro nefyzikální produkty, jako je software, ale většina, ne-li téměř všechny tyto tipy, platí také pro oblast fyzického produktu.

zde se dozvíte:

• co je uživatelská dokumentace a proč je důležitá?
• jak je dokumentace koncového uživatele součástí zákaznické zkušenosti.,
• jak dobrá uživatelská dokumentace může pomoci odstranit zátěž z vašeho týmu zákaznické podpory.
• proč je vizuální obsah tajnou složkou nejlepší dokumentace.
• základní prvky, které zajišťují nejlepší uživatelskou dokumentaci.
• čtyři kroky k vytvoření dokumentace, která potěší vaše zákazníky a obstojí ve zkoušce času.

co je uživatelská dokumentace?

uživatelská dokumentace (nazývaná také příručky pro koncové uživatele, příručky pro koncové uživatele, návody k obsluze atd.)) je obsah, který poskytujete koncovým uživatelům, aby jim pomohl být úspěšnější s vaším produktem nebo službou.

jedná se o výukové materiály, které jdou s vaším produktem na pomoc někdo naučit správně používat, nebo — v případě fyzických produktů — ještě to dát dohromady.,

Pokud jste někdy sestavili kus nábytku Ikea, použili jste dokumentaci koncového uživatele.

ale uživatelská dokumentace má mnoho podob.

videohry přicházejí s manuály, které vám řeknou, která tlačítka chcete stisknout, abyste stříleli padouchy. Softwarová dokumentace vám ukáže, co váš nákup může udělat a jak na to.,

daňové formuláře obsahují návody, jak je správně vyplnit.

Sekačky na trávu a sněhové frézy mají výrobku průvodci vám ukázat, jak začít motory a kde doplnit palivo.

přeskočit na to, jak vytvořit uživatelskou dokumentaci

proč je důležitá uživatelská dokumentace?

víte, že váš produkt je skvělý. Chcete, aby to věděli i Vaši zákazníci. Uživatelská dokumentace pomáhá zajistit, aby vaši zákazníci nebo uživatelé skutečně naučit, jak získat co nejvíce z vašeho produktu.,

ať už jde o to, jak uložit dokument, spustit motor, použít konkrétní nástroj nebo důležité bezpečnostní informace, vaše dokumentace koncového uživatele je důležitou součástí vašeho vztahu se zákazníky.

může potěšit vaše zákazníky

uživatelská dokumentace je snadná, že? Chci říct, stačí napsat nějaké věci o tom, jak používat svůj produkt a máte dobré jít!

není to tak jednoduché.

je to víc než jen“ jak na “ materiál. Je to součást zákaznické zkušenosti., A to znamená, že je to také marketingový materiál.

jako spotřebitel sám jsem zažil skvělé i hrozné uživatelské příručky. Vsadím se, že většina z vás měla podobné zkušenosti.

skvělý uživatelský manuál nebo produktu průvodce ukazuje vaše zákazníky, že vám záleží nejen o tom, zda koupit váš produkt, ale to, zda mají opravdu skvělý zážitek skutečně používat.

a zákazníci, kteří mají pocit, že vám na nich záleží mimo jejich peněženku, se k vám budou vracet.,

Pokud chcete křičet do světa o tom, jak moc milují své výrobky a služby, které poskytují úžasné uživatelské dokumentace je nezbytnou součástí post-nákup zkušenosti.

Jak uživatelská dokumentace podporuje váš tým podpory

obraťte se na tým podpory, když něco nefunguje, ale oni také volat, když se prostě nemůžu na něco přijít. Mít skvělou uživatelskou dokumentaci pomáhá vašemu týmu podpory dvěma hlavními způsoby.

1., Dává jim snadnou referenční příručku

Skvělá uživatelská dokumentace nemusí být jen pro zákazníky. Váš tým podpory produktů může použít dokumentaci, která pomůže lépe podporovat vaše zákazníky při volání. Když zahrnete základní kousky, jako je obsah nebo index, mohou rychle najít informace, které potřebují. A pokud je to prohledávatelný elektronický dokument, je to ještě lepší! Více se o tom dozvíme později v článku.

2. Snižuje volání

jak je uvedeno výše, lidé často volají podporu, když nemohou něco zjistit., Ale, pokud zákazníci mohou přijít na to sami, že jsou mnohem méně pravděpodobné, že potřebují pomoc. Ve skutečnosti více než 70 procent lidí raději používá webové stránky společnosti o pomoc, než aby používalo telefon nebo e-mail.

Nyní, i ten nejlepší dokumentace nebude eliminovat všechny tyto hovory, ale vytvoření uživatelské příručky a manuály, které jsou komplexní, snadno pochopitelné, jasné a stručné bude jít dlouhou cestu ke snížení celkového objemu hovorů, e-mailů, chatů, atd.

jaké jsou základní prvky skvělé uživatelské dokumentace?,

I když každý produkt je jedinečný a bude vyžadovat různé prvky k vytvoření opravdu velké uživatelské docs, tam jsou některé koncové uživatele dokumentace osvědčené postupy dodržovat bez ohledu na to, co.,

Skvělá uživatelská dokumentace by měla zahrnovat:

• jednoduchý jazyk
• Jednoduchost
• Vizualizace
• zaměření na problém
• logické hierarchie a toku
• obsah
• Vyhledávat obsah
• Přístupné obsahu
• Dobrý design
• Zpětná vazba od reálných uživatelů
• Odkazy na další zdroje

Běžný jazyk

Nic se zmařit zákazníka více, než číst něco, co nemůžou pochopit. Nikdo se nechce cítit hloupě., To, aby se váš zákazník cítil tímto způsobem, rozhodně není způsob, jak podpořit skvělý zážitek.

používejte jednoduchý, prostý jazyk, kdykoli je to možné, abyste svým zákazníkům pomohli pochopit i ty nejsložitější koncepty.

Zapamatujte si, napište pro uživatele, ne pro vývojáře.

Zní to jako ne-nasnadě, ale psaní v prostém jazyce o produktu nebo službě, kterou znáte zepředu dozadu, je mnohem obtížnější, než si myslíte. Znáte všechny druhy žargonu, zkratek a dalších „zasvěcených“ informací, které zákazníci pravděpodobně ne. je přirozené, že je používáte.,

ale to je místo, kde můžete narazit na nějaké vážné potíže.

nepředpokládejte, že váš zákazník o vašem produktu něco ví. Nepředpokládejte, že znají všechny technické a / nebo průmyslové buzzwords, které pravděpodobně používáte každý den ve vaší kanceláři. Napište jim to.

nepište, jako by to byly děti, ale pochopte, že mohou potřebovat další pomoc, aby je skutečně urychlily. Napište dokumentaci snadno čitelným způsobem.

jednoduchost

udržujte ji co nejjednodušší k dosažení svého cíle. To platí jak pro obsah dokumentu, tak pro jeho design., Dlouhé bloky textu a stránky, pevně zabalené s písemný a grafický obsah můžete vytvořit uživatelské příručky nebo manuály pocit, hrozivě a nepřátelsky.

zákazníci, kteří jsou zastrašováni vašimi uživatelskými materiály, jsou mnohem pravděpodobnější, že zavolají váš tým podpory o pomoc, než aby se pokusili vyřešit své otázky sami. A, oni jsou mnohem méně pravděpodobné, že mají dobré zkušenosti zákazníků.

vizuální, vizuální, vizuální

nejlepší uživatelská dokumentace dokonale ilustruje pořekadlo, „show, don‘ t tell.,“

vizuální obsah, včetně obrázků, komentovaných screenshotů, grafiky a videí, rychle ukazuje někomu, jak váš produkt funguje. Nemusí o tom číst, vidí to!

nedávný výzkum společnosti TechSmith ukazuje, že lidé skutečně absorbují vizuální informace rychleji a lépe plní úkoly, když jsou pokyny opatřeny vizuálním nebo video obsahem.,

Vizuální obsah také pomáhá rozbít dlouhé bloky textu a může pomoci odstranit mnoho textu, který může udělat mnoho uživatelské příručky nebo manuály cítit zastrašující a nepříjemný.

populární způsoby zahrnutí vizuálního obsahu do uživatelské dokumentace zahrnují screenshoty, nahrávky na obrazovce, výuková videa a další.

slyšeli jste o zjednodušené grafice?, Někdy se nazývá zjednodušené uživatelské rozhraní (nebo SUI), zjednodušená grafika pořizovat snímky uživatelského rozhraní nebo jiným grafickým a — stejně jako název napovídá — zjednodušuje. Tato základní verze zvýrazněte nejdůležitější informace a zároveň snižuje text a grafiku, které nejsou důležité pro jednodušší tvary.,

, něco co vypadá jako toto:

Nyní vypadá takto:

Když jsem se snažila ukázat, někdo, jak vybrat Připojit Mobilní Zařízení položka menu, druhý obrázek odstraní všechny nepořádek a umožňuje zákazníkovi, oči zaměřit se tam, kde potřebují být.

je pravděpodobné, že jste se již setkali se zjednodušenou grafikou a ani si to neuvědomili.,

Jako je tento od G Apartmá Learning Center:

Existuje mnoho nástrojů tam, ale pokud hledáte pro výkonné a snadné způsoby, jak vytvářet screenshoty a nahrávky obrazovky, Velmi doporučuji stažení bezplatné zkušební verze Snagit.

zaměřte se na problém, který má být vyřešen

každý produkt řeší problém., Ale příliš často jsme tak zamilovaní do našich skvělých funkcí produktu, vše, co chceme udělat, je zdůraznit, co může udělat, spíše proto to naši zákazníci potřebují.

ujistěte se, že uživatelům ukážete, jak provádět úkoly s vaším produktem.

samozřejmě to bude zahrnovat funkce produktu, ale to v souvislosti s tím, že uživateli pomůžete dostat se k důvodu, proč si váš produkt zakoupili — k vyřešení konkrétního problému.,

například, naše Camtasia a Snagit návody (ano, výuková videa může být forma dokumentace) zvýraznění určité funkce, ale v kontextu toho, proč někdo může používat tuto funkci. Je to o tom, proč, nejen jak.

Tady je skvělý příklad.

Logické hierarchie a toku

Dobrá dokumentace potřebuje hierarchii položek a podpoložek, který umožňuje uživateli vědět, co každá sekce bude jim ukázat., A tato hierarchie by měla následovat logický tok, který pomáhá uživateli naučit se používat váš produkt nejužitečnějším způsobem.

například pravděpodobně nechcete zahájit dokumentaci tím, že ukážete svým zákazníkům, jak používat pokročilejší funkce, aniž byste jim nejprve ukázali základy fungování vašeho produktu. Nejprve začněte s jednoduchými věcmi a poté, jak si uživatelé budují své znalosti, ukažte jim pokročilé funkce.,

obsah

obsah poskytuje vašim zákazníkům jednoduchý, efektivní a známý způsob, jak rychle najít řešení jejich otázky nebo problému. Je to hned na začátku dokumentu, takže nemusí procházet stránkami textu, aby našli to, co hledají. Mělo by zahrnovat všechny hlavní nadpisy a podpoložky, jak je popsáno výše.

vyhledávání

bývaly doby, kdy většina uživatelská dokumentace byla vytištěna., Nyní, v době, kdy téměř každý má přístup k smartphonu, má větší smysl vytvářet elektronickou dokumentaci. To neznamená, že nemůžete vytvářet tiskové verze, také, ale elektronická verze nabízí řadu výhod budeme podrobněji níže.

stejně jako obsah, prohledávatelný obsah poskytuje uživatelům snadnější přístup k vašemu obsahu a pomáhá jim najít řešení Samostatně.

Přístupnost

vytvořit přístupný obsah., To znamená zajistit, aby elektronická dokumentace dodržovala standardy dostupnosti pro osoby, které mohou být slepé nebo zrakově postižené, hluché nebo nedoslýchavé nebo mohou mít kognitivní postižení.

pamatujte, že mnoho vašich zákazníků to potřebuje k pochopení a úplnému přístupu k uživatelské dokumentaci. Nenechávejte je tu!

dobrý design

Dejte svým uživatelům dokument, na který se chtějí podívat, a bude s větší pravděpodobností používat.

designové materiály s ohledem na vaše zákazníky. Aby bylo použitelné a přátelské., Vyhněte se dlouhým odstavcům textu nebo stránek, které jsou příliš plné obsahu. Nechte bílý prostor, který pomůže rozbít monotónnost a učinit vyhlídky na učení nového produktu méně skličující.

zahrnout grafiku a obrázky co nejvíce ukázat, spíše než říct svým zákazníkům, jak používat svůj produkt. Pro elektronickou dokumentaci použijte video a GIF.

používejte konzistentní písma a doplňkové barvy ve více dokumentech. Pokud má vaše organizace průvodce stylem (což vřele doporučuji), ujistěte se, že se k němu vaše dokumentace drží.,

Snagit templates umožňuje neuvěřitelně snadné vytvářet profesionálně vypadající uživatelskou dokumentaci ze série screenshotů nebo jiných obrázků. Jednoduše shromážděte obrázky, které potřebujete, vyberte Vytvořit a obrázek ze šablony a jste na cestě.

Snagit přichází s partou bezplatných, profesionálně navržených šablon a s TechSmith Assets pro Snagit získáte přístup k tuně více!

Zpětná vazba od reálných uživatelů a/nebo beta testerů

nemůžete vytvořit opravdu skvělé uživatelské dokumentaci, dokud jste poslouchali lidé mimo vaší organizaci, kteří skutečně využívají produkty.,

Naučte se jejich body bolesti a pokuste se je řešit co nejlépe. Zjistěte, co vám řeknou, že potřebují vědět, abyste co nejlépe používali vaše produkty. I když některé z nich mohou být zřejmé, zaručuji vám, že se naučíte věci, které jste nikdy ani neuvažovali.

odkazy na další dokumentaci

ujistěte se, že vaši zákazníci mají přístup k více zdrojům vaší organizace o tom, jak být s vašimi produkty úspěšní. Pro elektronickou uživatelskou dokumentaci to může být stejně jednoduché jako poskytování odkazů na Návody, Časté dotazy, uživatelská fóra a další.,

ale i tisková dokumentace může obsahovat věci, jako jsou adresy webových stránek a telefonní čísla pro další podporu.

Bonus! Přidat Krok-za-krokem instrukce

Krok-za-krokem průvodce pomoci vyhnout se dlouhé bloky textu a poskytnout mnohem jasnější způsob, jak ukázat proces, než se snaží vysvětlit, že přes text sám. Jsou snadněji sledovat, snadněji pochopitelné, a nabízejí mnohem uživatelsky přívětivější zážitek, než jednoduše říct někomu, jak dokončit úkol.,

a nezapomeňte, včetně vizuálního obsahu ve vašich podrobných pokynech je ještě lepší.

Snagit poskytuje velmi snadno použitelný krok nástroj, který vám pomůže vytvořit skvělou dokumentaci krok za krokem. Navíc nástroj Combine Images umožňuje kombinovat jednotlivé snímky obrazovky a další obrázky do jednoho obrázku pro snadnější úpravy a označování.

Jak vytvořit skvělé uživatelská dokumentace

Krok 1: Plán

Každý velkou sadu uživatelských dokumentů začíná s plánem., Zde je několik tipů, jak se dostat tam, kam jdete.

vědět, kde začít

mnoho lidí předpokládá, že pokud znáte svůj produkt,můžete začít vytvářet dokumentaci, ale je toho mnohem víc. Místo toho začněte s plánem, abyste zajistili, že skutečně pomáháte svým uživatelům.

než vytvoříte dokumentaci, je třeba zvážit několik věcí:

• co byste měli zahrnout? Co byste měli vynechat? (Tip: zde může být zpětná vazba uživatelů opravdu užitečná!)
• v jakém pořadí bychom měli tyto informace prezentovat?, (Pamatujete si esejové obrysy ze střední školy? Použij je!)
• jaké další zdroje budou k dispozici? Jak budeme poskytovat přístup / odkazy na ty?
• kdo je zodpovědný za vytvoření dokumentu? Kdo je zodpovědný za zpětnou vazbu k dokumentu? Kdo má konečné schválení?
• bude to nutné přeložit nebo lokalizovat?

odpovědi na tyto otázky formují, jak vytvoříte dokumentaci. Plánování zajišťuje hladký proces a lepší uživatelský dokument.

znáte svůj produkt

ujistěte se, že znáte svůj produkt.,

to neznamená, že musíte být absolutním odborníkem na všechno, ale každý, kdo vytváří uživatelskou příručku nebo Uživatelskou příručku, by měl mít s produktem praktické zkušenosti.

Spolehněte se na své odborníky na předmět pro podrobnější znalosti, určitě, ale měli byste vědět, jak je používat sami, než se pokusíte naučit někoho jiného.

Vybrat formát

kromě toho, dokument je konečného formátu je stejně důležité. Bude to jen pro tisk? Bude to elektronické? Pokud ano, kde bude žít?,

není to tak dávno, co téměř veškerá uživatelská dokumentace byla pouze tištěná. Pokud však nemáte velmi dobrý důvod, doporučuji alespoň mít na svém webu k dispozici elektronickou verzi.

Většina uživatelů mají 24-hodinový přístup k chytré telefony, počítače nebo tablety, a jsou používány k nalezení, co chtějí vědět, kdykoli budou chtít vědět. Uvedení uživatelských zdrojů online jim umožňuje přístup kdekoli, což znamená, že nemusí procházet zásuvkami nebo kartotékami, aby našli uživatelskou příručku, kterou neviděli roky.,

také je jednodušší zpřístupnit elektronickou dokumentaci osobám se zdravotním postižením. Verze pouze pro tisk bude fungovat pro většinu lidí, ale jste připraveni vytvořit braillovu verzi pro uživatele, kteří mohou být slepí nebo zrakově postižení? A co uživatelé, kteří mají fyzické postižení, kde je pro ně obtížné manipulovat s objekty rukama?

nástroje existují pro usnadnění přístupu k elektronické dokumentaci pro všechny, ale verze pouze pro tisk poskytují mnohem obtížnější problém s přístupností.,

Plus, elektronická dokumentace je mnohem jednodušší aktualizovat, protože žije na webu.

Pokud chcete nabídnout stažitelnou verzi PDF vaší dokumentace, je to v pořádku. Ale ujistěte se, že je k dispozici na vašich webových stránkách v non-PDF formátu, jakož.,

Krok 2: Vytvořte si uživatelský dokument

jakmile odpovíte na všechny otázky a učiníte všechna výše uvedená rozhodnutí, je čas vytvořit uživatelskou dokumentaci. Nebudu předpokládat, že vám řeknu, jak přesně vytvořit dokumentaci pro váš konkrétní produkt, ale je třeba mít na paměti některé klíčové věci.

• Vyhněte se žargonu a vysoce technickým podmínkám, s výjimkou případů, kdy je to nezbytně nutné(a pak je nezapomeňte definovat).
• Vyhněte se zkratkám, pokud nevysvětlíte, co znamenají.
• používejte běžně uznávaný styl psaní, jako je AP nebo Chicago, kdykoli je to možné., Pokud má vaše organizace průvodce stylem společnosti, použijte jej.
• nepředpokládejte, že uživatel ví něco o vašem produktu nebo o tom, co dělá. Ukažte jim, co potřebují vědět, aby byli úspěšní.
• nezapomeňte používat prostý jazyk. Napište na úroveň osmé třídy. I pro pokročilé čtenáře vede jednoduchý jazyk k rychlejšímu zpracování a lepšímu porozumění.
• design by měl být příjemný, non-zastrašující, a čerpat uživatele. Ať chtějí používat vaši dokumentaci.,

Krok 3: Vyzkoušejte to

uživatelská příručka je skvělá, pouze pokud pomáhá vašim zákazníkům používat váš produkt podle svých nejlepších schopností. A to nemůžeš vědět, dokud to někdo nepoužije. Než vaše nová tvorba vyjde do světa jako celku, chcete ji vyzkoušet. Zde je několik tipů!

• Best practice: dejte ji skupině skutečných uživatelů nebo beta testerů a uvidíte, jak to dělají. Začlenit jejich zpětnou vazbu do hotového dokumentu.
• Pokud nemáte zpětnou vazbu uživatelů beta testování, otestujte ji interně, nejlépe se zaměstnanci, kteří jsou s produktem nejméně obeznámeni.,
• získejte zpětnou vazbu od vývojářů a inženýrů. Znají produkt lépe než kdokoli jiný a mohou poukázat na věci, které jste možná zmeškali.

Krok 4: Udržujte svou dokumentaci aktuální

když se váš produkt změní, budete potřebovat vše aktuální. Jak bylo uvedeno výše, poskytuje elektronická dokumentace obrovskou výhodu oproti tisku. Nicméně i dokumenty pouze pro tisk mohou být aktualizovány a zpřístupněny ke stažení na vašem webu.

pamatujte, že váš obsah je skvělý, pouze pokud je přesný. Ujistěte se, že to, co dáte svým zákazníkům, jim skutečně pomáhá používat váš produkt.,

shrnutí

Pokud si nepamatujete nic jiného, mějte na paměti, že skvělá uživatelská dokumentace by měla být vytvořena, navržena a prezentována způsobem, který je pro vaše uživatele nejužitečnější.

dejte jim dokumentaci, která je nadále potěší a poskytuje druh zákaznického zážitku, který byste chtěli mít.

zpřístupněte dokumentaci, udělejte ji vizuální.

Časté dotazy

Poznámka: Tento příspěvek byl původně publikován v srpnu 2019, ale byl aktualizován v září roku 2020 pro přehlednost a zahrnout nové informace.