Ako písať jasné a stručné používateľské príručky
Čo je používateľská príručka?
Návod na použitie má rôzne názvy. Technické dokumenty, návody na údržbu a návody na použitie sú všetky názvy, ktoré odkazujú na rovnakú položku. Používateľská príručka je vytvorená s cieľom pomôcť zákazníkom správne používať váš produkt alebo službu alebo vyriešiť problémy, ktoré sa vyskytnú počas používania. Môžu byť k dispozícii v tlačenej, digitálnej alebo oboch formách.
Návody na používanie poskytujú koncovému používateľovi komplexné pokyny krok za krokom a určitú podporu pri problémoch. Obsah by mal byť prítomný v každej používateľskej príručke, pretože ide skôr o referenčné materiály ako o knihy, ktoré by ste si mali prečítať od začiatku do konca. Do používateľskej príručky by ste mali pridať návod na rýchly štart alebo spustenie, aby používatelia mohli ľahko začať produkt používať.
druhy užívateľských príručiek
Pre rôzne témy a ciele je možné vytvoriť používateľské príručky. Tu sú niektoré z vašich možností, tak sa na ne pozrime.
- Návod na použitie
Návod na používanie je typ používateľskej príručky, ktorá ponúka jednoduché pokyny na používanie produktu spôsobom, na ktorý bol určený. - Školiaca príručka
Tento druh používateľskej príručky ponúka zoznam pokynov na dokončenie určitej úlohy, projektu alebo úlohy. - Servisná príručka
Servisné príručky sú používateľské príručky, ktoré popisujú, ako sa starať a udržiavať stroj alebo zariadenie v rôznych stages jeho životnosti. - Používateľská príručka
Používateľské príručky sú technické publikácie, ktoré vysvetľujú, ako správne používať alebo obsluhovať produkt. - Návod na obsluhu
Úlohy, povinnosti a postupy špecifické pre podnik alebo organizáciu sú opísané v prevádzkových príručkách. - Manuál organizačnej politiky
Manuál organizačnej politiky je dokumentácia, ktorá definuje zásady, postupy a osvedčené postupy spoločnosti. - Príručka štandardných prevádzkových postupov (SOP).
Používatelia ťažia z podrobných pokynov štandardnej príručky o prevádzkových postupoch na vykonávanie zavedených postupov.
Prečo vaša firma potrebuje používateľské príručky?
Ľudia sú lepšie pripravení zvládnuť problémy sami s podporou používateľskej príručky. Slušná používateľská príručka môže poskytnúť vašim zákazníkom nástroje, ktoré potrebujú na rýchle a efektívne dosiahnutie hodnoty, ktorú od vášho produktu alebo služby požadujú v dnešnej kultúre okamžitého uspokojenia.
Vynikajúci zákaznícky servis je potrebné doplniť používateľskými manuálmi. Napísanie vynikajúcich používateľských príručiek poskytne nasledujúce výhodytages pre vašu spoločnosť:
- Aby bol nástup a školenie jednoduchšie
Dobre napísané používateľské príručky môžu zjednodušiť postupy registrácie a školenia. To je pravda, vytvorením a implementáciou špičkových používateľských príručiek môžu získať vaši zamestnanci aj vaši spotrebitelia.
Vaša spoločnosť môže použiť používateľské príručky, aby pomohla novým zamestnancom prejsť niektorými procesmi a systémami, ktoré sú súčasťou ich nových úloh, a nie len organizovať náročné osobné školenia, ktoré si vyžadujú značné časové a finančné náklady. Pretože sa zamestnanci môžu učiť pri plnení povinností súvisiacich s ich pozíciou vďaka užívateľským príručkám, môže dôjsť k zníženiu straty hodín počas onboardingu. - Na zníženie nákladov na podporu
Používateľské príručky sú skvelým doplnkom k vášmu úsiliu v oblasti služieb zákazníkom pre spotrebiteľa, ale tiež slúžia majiteľovi podniku ako súčasť systému podpory zákazníkov.
Zákazníci s väčšou pravdepodobnosťou nájdu riešenia hneď a je menej pravdepodobné, že budú musieť kontaktovať technika alebo zástupcu so špecializovanou podporou, keď im poskytnete rýchly prístup k používateľskej príručke s možnosťou vyhľadávania. - Aby sa šetril čas
Vaši zákazníci aj vaši zamestnanci, od zamestnancov na základnej úrovni až po manažment, môžu ušetriť čas používaním používateľských príručiek. Keď budú mať vaši klienti k dispozícii používateľské príručky, nebudú musieť strácať čas hľadaním informácií o tom, ako používať produkt, pretože k týmto informáciám budú mať okamžitý priamy prístup.
Keď sú vaši zamestnanci vybavení užitočnými používateľskými príručkami, nemusia strácať čas nezávislým hľadaním riešení alebo monopolizovaním pozornosti svojich spolupracovníkov a manažérov otázkami, pretože majú prístup k riešeniam priamo vo svojej používateľskej príručke! - Minimalizácia zodpovednosti
Jedným zo spôsobov, ako preukázať, že ste svoj produkt dôkladne otestovali a viete, ako ho bezpečne používať, je napísať a distribuovať používateľské príručky. To môže výrazne znížiť všetky povinnosti spojené s výrobou niečoho pre širokú verejnosť.
Zapísať si varovania a bezpečnostné opatrenia a sprístupniť ich používateľom prostredníctvom používateľskej príručky je účinný (aj keď nie úplne spoľahlivý) spôsob, ako sa vyhnúť právnym problémom súvisiacim so zraneniami alebo inými škodami spôsobenými nesprávnym používaním, ak by výrobok, ktorý predávate, mohol byť pre používateľov nebezpečný (napríklad ohrievače priestoru, elektrické náradie atď.).
Aké komponenty tvoria najlepšie používateľské príručky?
Existuje niekoľko osvedčených postupov dokumentácie pre koncových používateľov, ktoré je potrebné dodržiavať bez ohľadu na to, čo je potrebné, aj keď je každý produkt jedinečný a na vytvorenie skutočne vynikajúcej používateľskej dokumentácie bude potrebovať odlišné komponenty.
- Obyčajný jazyk
Nič nebude dráždiť vašich zákazníkov viac – okrem toho, že ho neponúkate – ako objavenie ich používateľskej príručky, ktorá je plná žargónu a ťažko zrozumiteľného jazyka. Vaše používateľské pokyny sa ťažko používajú kvôli týmto výberom jazyka, ktoré tiež nepodporujú vynikajúce služby zákazníkom. Zabezpečenie, že píšete pre používateľa, nie pre vývojára, je kľúčovou súčasťou vytvárania skvelých používateľských príručiek. Nepredpokladajte, že váš koncový používateľ niečo pozná alebo pozná. Skratky, žargón a kancelárska terminológia spôsobia, že vaši klienti sa budú cítiť dezinformovaní, frustrovaní a nepripravení. Sladkým bodom pre vytvorenie používateľskej príručky je nájsť rovnováhu medzi tým, že nebudete písať, akoby vaši spotrebitelia boli deti (pokiaľ, samozrejme, nie sú!) a poskytnúť im ďalšiu pomoc, ktorú potrebujú, aby úplne pochopili, ako produkt používať, jednoducho Jazyk. - Jednoduchosť
Napísanie používateľskej príručky si vyžaduje jednoduchosť. Tento koncept by sa mal premietnuť do obsahu aj dizajnu. Ak svoju dokumentáciu preplníte zložitými obrázkami a dlhými pasážami textu, bude sa zdať príliš sofistikovaná a ťažko pochopiteľná. Tento druh používateľskej príručky pravdepodobne zastraší vášho používateľa a privedie ho k tomu, aby radšej zavolal na vašu linku pomoci, než aby sa pokúsil vyriešiť svoj problém sám. - Vizuály
Zásada „Ukáž, nehovor“ je základným kameňom písania používateľskej príručky. Komentované snímky obrazovky, filmy a iný vizuálny obsah sú mimoriadne užitočné pri pochopení pojmov. Často je oveľa užitočnejšie vidieť niečo v akcii, ako o tom čítať. Vizuály nielenže rozbíjajú dlhé pasáže textu, ale znižujú aj množstvo textu v používateľských príručkách, ktoré môže byť strašidelné. Ukázalo sa, že ľudia si uchovajú vizuálne informácie o 7 % rýchlejšie ako písané. V štúdii Techsmith sa tiež ukázalo, že 67 % ľudí vykonávalo úlohy efektívnejšie, keď dostali pokyny, ktoré obsahovali anotované snímky obrazovky, a nie samotné slová na sprostredkovanie informácií. - Zamerajte sa na problém, ktorý sa má vyriešiť
Je dosť pravdepodobné, že si niekto kúpil váš produkt, aby vyriešil problém. Pri zostavovaní návodu na použitie, ktorý bude priložený k produktu, je nevyhnutné zamerať sa na tento problém. Namiesto vymenovania a diskusie o všetkých funkciách, ktoré váš produkt ponúka, alebo o zaujímavých dizajnových prvkoch, ktoré ste začlenili, o nich informujte svojich používateľov spôsobom, ktorý uľahčí používanie produktu. Pri popise dajte riešený problém do kontextu funkcií a výhod vášho produktu. - Logický tok a hierarchia
Aby bolo používateľovi jasné, čo sa dozvie z každej časti vašej používateľskej príručky, použite hlavičky a podnadpisy, ktoré majú jasnú hierarchickú štruktúru. Aby ste svojich zákazníkov bez námahy previedli všetkým, čo potrebujú vedieť od začiatku do konca, hierarchia, ktorú si zvolíte, by mala nasledovať logický tok. Uistite sa, že začínate so základmi a začleňte logický postup smerom k sofistikovanejším funkciám vášho produktu. - Zoznam obsahu
Vaša používateľská príručka bude pre čitateľov najužitočnejšia, ak sa začne obsahom. Bez toho, aby ste sa museli prehrabávať mnohými stránkami informácií, ktoré nesúvisia s aktuálnym problémom, ktorému čelia, je pre niekoho známy prístup rýchlo a jednoducho preskúmať dokument. - Spravte ho vyhľadávateľným
Aj keď si vytlačíte používateľské príručky, je pravdepodobné, že digitálna dokumentácia bude vašou hlavnou prioritou. Je dosť pravdepodobné, že vaše používateľské príručky budú najčastejšie využívané v digitálnom formáte vo svete, kde má väčšina ľudí neustále pri sebe smartfón. Pridanie funkcie vyhľadávania do vašich digitálnych používateľských príručiek podporí príjemnú jednoduchosť používania pre používateľov, ktorí chcú vyriešiť problém prístupom k nemu, podobne ako obsah slúži na nasmerovanie používateľov na správne miesto v tlačenom dokumente. - Prístupnosť
Je možné, že niektorí ľudia, ktorí vyžadujú vašu používateľskú príručku, by mohli využiť ďalšiu pomoc, aby sa zaistilo jej správne fungovanie. Bez ohľadu na to, či to vyžaduje zákon, požiadavky na prístupnosť sú vo všeobecnosti dobrou praxou. Dodržiavanie požiadaviek na prístupnosť vo vašich používateľských príručkách je len vynikajúca obchodná prax. Rozhodujúce je navrhovanie používateľských príručiek s obsahom, ktorý je dostupný pre používateľov, ktorí by mohli mať vizuálne, zvukové alebo kognitívne problémy. - Dobre navrhnutý
Pri vytváraní používateľských príručiek zvážte svoje publikum. Oveľa viac budú ochotní to využiť efektívne, ak vytvoríte niečo, na čo sa radi pozerajú! Vyhnite sa používaniu dlhých textových blokov a poskytnite dostatok voľného miesta. Kombinácia týchto dvoch charakteristík môže pomôcť spotrebiteľom zdať sa menej desivým a učenie sa čohokoľvek nového sa môže zdať skôr vzrušujúce ako hrozivé. Aj tu platí prístup „ukáž, nehovor“, ktorý sme opísali vyššie. Pre tlačové aj digitálne používateľské príručky je pridávanie vizuálov a fotografií k textu skvelou alternatívou. V prípade digitálnych používateľských príručiek sú videá a súbory GIF zaujímavé a užitočný prvok. Ak má vaša spoločnosť sprievodcu štýlom, mal by sa ním riadiť váš návrh; v opačnom prípade, ak pracujete bez neho, je dôležité, aby bola vaša používateľská príručka konzistentná. Písmo a farebné schémy použité v celom papieri a ideálne vo všetkých vašich používateľských príručkách by mali byť konzistentné. - Komentáre skutočných zákazníkov alebo beta testerov
Nebudete môcť určiť, či sú alebo nie sú používateľské príručky, ktoré ste pripravili, čo najúspešnejšie, kým si nevyhľadáte a nevypočujete spätnú väzbu od ľudí, ktorí budú váš produkt skutočne používať. Používateľské príručky, ktoré vytvoríte pre svoj produkt, by mali zohľadňovať problémy, ktoré s ním ľudia majú. Môžete sa naučiť niečo, čo sa zdá byť mimoriadne zrejmé, ale je oveľa väčšia šanca, že sa naučíte niečo, čo vám pomôže pochopiť potreby zákazníkov, ktorých sa snažíte osloviť.
Ako napíšem používateľskú príručku?
Vytvorenie používateľskej príručky je kľúčovou úlohou, ktorá môže mať veľký vplyv na vašu spoločnosť aj na spotrebiteľov, ktorým chcete slúžiť. Zjednodušili sme proces vývoja používateľskej príručky, aby ste ju mohli jednoducho sledovať, pretože môže byť zdrvujúca.
- Identifikujte používateľov
Vyhľadanie príjemcu vašej komunikácie je základným počiatočným krokom, rovnako ako pri akejkoľvek inej komunikácii, ktorú vytvoríte. Zamýšľané publikum vašej používateľskej príručky vám pomôže rozhodnúť sa o problémoch, ako je tón, úroveň podrobností, ktoré je potrebné poskytnúť, a spôsob doručenia obsahu. Písanie používateľskej príručky pre koncového používateľa vášho produktu sa výrazne líši od písania príručky pre technického inžiniera. Prvým krokom je určiť si publikum. - Sústreďte sa na problém
Používateľské príručky slúžia na pomoc pri riešení problémov alebo na to, aby niekoho inštruovali, ako urobiť niečo nové. Musíte presne určiť, na čo je vaša používateľská príručka určená, a uistiť sa, že toto zameranie udržíte.
Môže byť lákavé rozšíriť tému a diskutovať o mnohých funkciách alebo aplikáciách pre váš produkt. To môže frustrovať používateľov a viesť k volaniam na vašu linku zákazníckej podpory tým, že zakryjete skutočnú odpoveď, ktorú požadujú.
Ak je váš zákazník spotrebiteľ, ktorý sa učí používať produkt alebo technik, ktorý ho potrebuje opraviť, sústreďte sa na presné riešenie, ktoré bude vyžadovať. - Použite sekvenčný prístup
Pokyny vo vašej používateľskej príručke by mali byť usporiadané v postupnom poradí, ktoré je potrebné na dokončenie danej práce. Uveďte každý krok, aby ste mohli začať. Potom sa snažte vykonať zadanie pri dodržaní presných krokov, ktoré ste načrtli v danom poradí. Keď prechádzate pôvodným zoznamom, je možné, možno dokonca pravdepodobné, že nájdete nejaké stagktoré chýbajú. Okrem toho možno zistíte, že niečo, o čom ste kedysi verili, že je to jediná úloha, sa v skutočnosti musí rozdeliť na niekoľko činností, aby to bolo jasné.
Pred prechodom na ďalšiu fázu písania používateľskej príručky sa uistite, že ste zadali jasný výsledok pre každý sekvenčný krok, ktorý ste pridelili. Pred prechodom na ďalšiu úroveň by čitatelia mali mať úplne jasno v tom, čo chcú dosiahnuť a ako by to malo vyzerať. - Cesta používateľa mapy
Cieľom vytvorenia používateľskej príručky je pochopiť, ako vaši spotrebitelia plánujú používať váš produkt, a uľahčiť im to. Musíte vynaložiť úsilie, aby ste pochopili problém, ktorý sa spotrebiteľ snaží vyriešiť, alebo cieľ, ktorý sa snaží dosiahnuť využitím vášho riešenia, ako aj to, ako sa zapája do vášho podnikania. Pomocou týchto podrobností si môžete naplánovať kroky potrebné na to, aby ste zákazníka previedli procesom, aby ste si vizualizovali jeho cestu od problému k riešeniu. - Vyberte šablónu
Úloha písania a vývoja používateľských príručiek môže byť oveľa jednoduchšia, než by ste očakávali, vytvorením série šablón. Váš postup môže byť zjednodušený a konzistentnosť by sa stala oveľa realistickejším cieľom.
Vo vašej šablóne používateľskej príručky by ste okrem definovania podrobností, ako sú písma (typ a veľkosť), požiadavky na kontrast a farebné schémy, mali zahrnúť aj nasledujúce:- Oblasť pridelená na úvod
- Odlišné podsekcie a sekcie
- Vami zvolený formát na sprostredkovanie série akcií
- Výstražné poznámky a varovania
- Oblasť pridelená na záver
- Napíšte jednoduchý a ľahko sledovateľný obsah
Materiál vašej používateľskej príručky by mal byť čo najjednoduchší a najjednoduchší na pochopenie. Je dôležité premýšľať a analyzovať formát a obsah kvôli prehľadnosti a pohodliu.
Uistite sa, že každá fáza procesu obsahuje iba jednu úlohu a používa tak jasný a krátky jazyk, ako je to možné. Dbajte na to, aby ste svoj text správne upravovali, kým nebudete mať používateľskú príručku, ktorá bude obsahovať iba informácie, ktoré sú skutočne potrebné. - Pristupujte ku každému používateľovi ako nováčik
Predpokladajme, že čitateľ vašej používateľskej príručky nemá žiadne predchádzajúce znalosti o vašom produkte pri jeho vytváraní. Píšte, ako keby ste hovorili s laikom.
Mali by ste sa vyhnúť akémukoľvek použitiu žargónu alebo technického jazyka. Prirodzene, niekedy sa vyskytnú prípady, keď sa tomu treba vyhnúť, ale toto by mala byť absolútna výnimka. - Otestujte pokyny k produktu s začínajúcimi používateľmi
Testovacia fáza procesu vytvárania používateľskej príručky je kľúčová. Predmet experimentu má významný vplyv na výsledok.
Testovanie by sa malo v ideálnom prípade vykonávať na ľuďoch, ktorí nikdy nepoužili váš produkt ani nevideli dokumentáciu. Keď budete prechádzať používateľskou príručkou, sledujte ich, ako dokončia proces, a zaznamenajte si, kde uviaznu. Potom by sa informácie mali primerane aktualizovať.
Na to, aby váš tester fungoval s produktom, by mala byť potrebná iba pomoc z používateľskej príručky. Nemali by musieť žiadať o ďalšiu pomoc. Sprievodca ZSSR by mal mať všetky informácie, ktoré požadujú. - Vytvárajte obsah pomocou praktického prístupu
Malo by sa vynaložiť maximálne úsilie na to, aby sme ponúkli konkrétne exampa podrobné popisy akýchkoľvek výsledkov, ktoré môžu používatelia zažiť po vykonaní každého kroku v používateľskej príručke. Používateľ by si mal byť vedomý akejkoľvek spätnej väzby, ktorú by mohol získať od produktu, ako aj akýchkoľvek potenciálnych pamiatok alebo zvukov, s ktorými sa môže počas cesty stretnúť. - Vysvetlite symboly, ikony a kódy včas
Pri písaní používateľskej príručky možno budete musieť použiť ikony, symboly alebo kódy, ktoré vám pomôžu poskytnúť potrebné pokyny. Aby ste predišli zmätku alebo frustrácii čitateľov, je dôležité, aby ste ich čo najskôr identifikovali vo svojej používateľskej príručke.
Často kladené otázky o používateľskej príručke
Čo sú to vlastne používateľské príručky?
Používateľská dokumentácia je informácia poskytovaná vo forme používateľských príručiek alebo používateľských príručiek a je určená na pomoc koncovým používateľom pri úspešnej interakcii s produktom.
- Aké druhy používateľskej dokumentácie existujú?
Fyzická dokumentácia, ako sú brožúry alebo manuály, sa tradične používa na poskytovanie používateľskej dokumentácie. V súčasnosti sa užívateľské príručky vyrábajú a distribuujú častejšie digitálne. - Čo je obsiahnuté v používateľských príručkách?
Návod na použitie alebo používateľská príručka používa dobrý dizajn, jasné písanie a zameranie na riešenie problémov. Musím mať obsah, dodržiavať logickú hierarchiu a tok a ponúkať obsah, ktorý je prístupný. Okrem toho sa v dobrej používateľskej príručke bude dať vyhľadávať a zohľadní používateľská reviews. - Ako sa vytvára užívateľský dokument?
Na vývoj používateľských príručiek možno použiť jednoduché kroky. Najprv sa musia určiť ciele používateľskej príručky a musí sa vypracovať stratégia, ktorá umožní ich dosiahnutie. Používateľská príručka musí byť pred zverejnením otestovaná a podľa potreby aktualizovaná. Nakoniec je dôležité udržiavať používateľskú príručku aktualizovanú a vykonávať zmeny pri pridávaní nových aktualizácií alebo vydaní.