Používateľská príručka je manuál v papierovej alebo elektronickej forme (PDF alebo XPS), ktorý poskytuje pokyny k postupu alebo použitiu niečoho. Napriek tomu, že „používateľské príručky“sú často spojené s príručkami k počítačovým aplikáciám, používateľské príručky sa dodávajú aj s počítačmi a inými elektronickými zariadeniami, ako sú televízory, stereosystémy, telefónne systémy, prehrávače MP3 a domáce a záhradné zariadenia. Dobrá používateľská príručka poučí používateľov o funkciách produktu a naučí ich, ako tieto funkcie efektívne používať. Užívateľská príručka je štruktúrovaná tak, aby sa dala ľahko čítať a odkazovať. Tu je niekoľko krokov, ktoré musíte zvážiť pri vývoji efektívneho obsahu a navrhovaní rozložení používateľskej príručky.
Krok
Časť 1 z 3: Vytvorenie vhodnej používateľskej príručky
Krok 1. Rozhodnite, kto bude sprievodcu používať
Ak chcete napísať dobrú používateľskú príručku, musíte si vytvoriť užívateľský profil, a to buď formálne vytvorením písomného profilu, alebo neformálne tým, že si urobíte čas na primerané predpoklady o charakteristikách používateľa. Takéto profily sú užitočné, keď ste súčasťou tímu tvoriaceho používateľskú príručku a keď pracujete na zamýšľanom produkte od konceptu po konečnú podobu. Pri vytváraní používateľského profilu zvážte nasledujúce faktory:
- Poloha používateľa bude sprievodcu používať napríklad doma, v kancelárii, na vzdialenom pracovisku alebo v aute. Tento faktor určuje nielen obsah, ale aj štýl písania, ktorý si sprievodca osvojí.
- Ako bude používateľ príručku používať. Ak ho používajú len zriedka alebo ho potrebujú iba na nájdenie informácií, je najlepšie, ak je sprievodca vytvorený vo forme referenčného dokumentu. Na druhej strane, ak ho používateľ bude na začiatku pravidelne používať, k referenčnej sekcii by mala byť časť „Ako začať“a pokyny k najbežnejším funkciám, ktoré bude produkt vykonávať.
- Koľko skúseností má používateľ s výrobkom alebo podobnou položkou. Ak je výrobok nový alebo sa veľmi líši od podobných výrobkov, musíte priložiť vysvetlenie, čím sa líši od ostatných, a pokyny, ako ho používať. Ak sa výrobok zaoberá niečím, čo je pre používateľov často ťažké, napríklad počítačová aplikácia, musíte poskytnúť zodpovedajúce informácie a podrobnosti zrozumiteľným spôsobom.
Krok 2. Vytvorte sprievodcu, ktorý porozumie potrebám používateľa
Ak používatelia nie sú technicky zdatnými ľuďmi, je pravdepodobne najlepšie vyhnúť sa vysoko odbornému jazyku a poskytnúť jasné a jednoduché vysvetlenia. Text by mal byť tiež usporiadaný spôsobom, ktorý pripomína spôsob, akým používateľ myslí. Zoznam funkcií produktu zoskupených podľa funkcií často dáva väčší zmysel ako najčastejšie používané funkcie.
Niekedy je použitie technických výrazov nevyhnutné, napríklad pri vytváraní grafov v aplikáciách, ktoré obsahujú Fibonacciho diagramy spolu s koláčovými grafmi a bežnejšími stĺpcovými grafmi. V takom prípade by bolo lepšie definovať pojmy a poskytnúť informácie, napríklad vysvetlenie, čo je to Fibonacciho diagram a ako sa používa vo finančnej analýze
Krok 3. Popíšte problém, ktorý sa používateľ pokúša vyriešiť, a potom poskytnite riešenie tohto problému
Ponúkanie funkcií ako riešení bežných problémov je pri reklame produktu v poriadku, ale akonáhle zákazník produkt vlastní, musí porozumieť tomu, ako ho používať. Identifikujte problém, s ktorým sa používateľ stretne, popíšte ho v používateľskej príručke a potom postupujte podľa pokynov na jeho riešenie.
Ak je problém zložitý, rozdelte ho na menšie kúsky. Zapíšte si každú časť s pokynmi, ako ju vyriešiť alebo sa s ňou vysporiadať, a potom sa v poradí navzájom sledujte. Členenie informácií týmto spôsobom je známe ako metóda klastrovania alebo rozdeľovania
Časť 2 z 3: Súčasti používateľskej príručky
Krok 1. Vytvorte vhodnú titulnú a titulnú stránku
Budete potrebovať obal pre každú používateľskú príručku, ktorá je viac než referenčnou kartou, a titulnú stranu pre sprievodcu, ktorý obsahuje viac ako preložený list papiera (dĺžka 4 strany alebo viac).
- Ak je sprievodca chránený autorskými právami, musí byť upozornenie o autorských právach uvedené na prednom a zadnom kryte, ako aj na titulnej strane.
- Ak existujú podmienky používania sprievodcu a produktov s ním spojených, uveďte ich prosím na vnútornej strane predného krytu.
Krok 2. V úvode dajte odkaz na súvisiaci dokument
Ak existuje viac ako jedna používateľská príručka, odkážte tu na iný dokument vrátane správneho čísla verzie. Predslov je tiež miestom, kde je možné umiestniť časť „Ako používať túto príručku“, ak existuje.
Krok 3. Ak je príručka dlhšia ako 10 strán, zahrňte obsah
Krok 4. Umiestnite pokyny/postupy a referenčné materiály na telo príručky
Vo väčšine prípadov by mal mať postup aj referenčný materiál vlastnú sekciu. Používateľom však môžete povedať, aby odkazovali na konkrétny obsah v jednej sekcii a odlišovali ho od ostatných sekcií. Užívateľ tak môže rýchlo nájsť informácie, ktoré hľadá.
- Postupy by mali byť napísané v konzistentnej štruktúre v rámci všetkých pokynov v príručke. Začnite s prehľadom funkčnosti produktu a potom vysvetlite, čo by mal používateľ urobiť a aké výsledky dosiahne alebo uvidí. Kroky by mali byť očíslované a začať akčným slovesom, rovnako ako sú kroky napísané v každej časti tohto článku.
- Referenčný materiál môže obsahovať kontrolné zoznamy, tipy na riešenie problémov a často kladené otázky. Na konci príručky je možné pridať glosár a register, aj keď na začiatku môže byť poskytnutý glosár často používaných výrazov. Register môže byť vynechaný, ak má príručka menej ako 20 strán.
Krok 5. Na podporu textu použite podľa potreby grafické obrázky
Grafické obrázky alebo snímky obrazovky môžu lepšie ilustrovať určité body v sprievodcovi ako text, obzvlášť v zložitých postupoch, kde používatelia potrebujú vizuálne potvrdenie, aby sa ubezpečili, že postupujú správne. Grafické kresby je možné vytvárať pomocou počítačom podporovaných kresieb (CAD) alebo aplikácií na úpravu grafiky, aplikácií pre digitálne fotoaparáty a spracovanie fotografií, alebo ak chcete používať snímky obrazovky, použite funkcie snímok obrazovky zabudované vo vašom počítači alebo grafický program s funkciami snímania obrazovky.
- Keď vytvoríte grafický obrázok, uložte ho v komprimovanom formáte, aby ste ho mohli použiť v aplikácii na spracovanie textu alebo na publikovanie na počítači. Musíte tiež zmenšiť veľkosť obrázka, aby lepšie zodpovedal stránke, ale napriek tomu používateľovi poskytoval úplné detaily. (V prípade potreby môžete pôvodný obrázok orezať na časti a zobraziť príslušné sekcie spolu s podporným textom).
- Ak v postupe použijete viacero grafických obrázkov, uistite sa, že sú obrázky vytvorené v konzistentnej veľkosti, buď v rozmeroch rovnakej dĺžky a šírky, alebo v pomere k veľkosti pôvodného obrázka. Vďaka tomu bude obrázok pre používateľov atraktívnejší. To isté platí pri vytváraní snímok obrazovky z počítača; uistite sa, že počítač pri fotografovaní zobrazuje štandardnú farebnú schému, inak sprievodca zobrazí farebnú snímku obrazovky.
- Aj keď aplikácie na úpravu obrázkov, ako sú Photoshop a Paint Shop Pro, majú dobré možnosti snímania obrázkov, programy určené na vytváranie snímok obrazovky, ako napríklad Snagit, ponúkajú aj možnosť jednoduchej úpravy, katalogizácie a pridávania poznámok k snímkam.
Časť 3 z 3: Navrhnutie ľahko použiteľnej používateľskej príručky
Krok 1. Vyberte si ľahko čitateľné písma
Napriek tomu, že počítač podporuje množstvo písem, účel vytvorenia používateľskej príručky je ľahko čitateľný. Výber viacerých zodpovedajúcich písiem je najlepší spôsob, ako dosiahnuť tento cieľ. Písma možno rozdeliť do dvoch typov: pätkové a bez pätkové.
- Pätkové písma majú na okrajích hlavných riadkov, ktoré tvoria písmená, malé ozdobné čiary. Medzi pätkové písma patria Times New Roman, Baskerville a Book Antiqua. Pätkové písma sú ideálne pre väčšinu textu zobrazeného vo veľkostiach 10-12 v hlavnom tele tlačových sprievodcov.
- Bezpatkové písma obsahujú iba riadky, ktoré tvoria písmená, bez príkras. Medzi písma bez pätky patria písma Arial, Calibri a Century Gothic. Bezpatkové písma je možné použiť pre väčšinu textových veľkostí 8 až 10 v súboroch PDF alebo v online príručkách, aj keď nie sú ozdobené, ale vety zobrazené v písmach 12 alebo väčších sú ťažšie čitateľné. Písma však možno efektívne použiť vo väčších veľkostiach na zobrazenie nadpisov a nadpisov a v menších veľkostiach sa perfektne hodia k poznámkam pod čiarou a číslam v stĺpcoch a tabuľkách.
- Vo všeobecnosti je pre sprievodcu najlepšie zvoliť jednoduché písmo, ako je Arial alebo Times New Roman, aj keď na úvodzovky alebo názvy môžete použiť ozdobné písmo, ak píšete sprievodcu pre videohru odohrávajúcu sa v prostredí fantasy alebo sci -fi.. (V prípade citácií môžete často použiť jednoduché písmo a celú citáciu zobraziť kurzívou).
- Potom, čo sa rozhodnete, ktoré písma chcete použiť, vytvorte vzorové stránky a overte, či vyzerajú dobre na papieri. Túto ukážkovú stránku by ste mali ukázať aj osobe zodpovednej za poskytnutie súhlasu so zobrazením príručky, než budete pokračovať v procese písania.
Krok 2. Zamyslite sa nad rozložením
Keď si vyberiete sprievodcu, budete sa musieť rozhodnúť, ako štruktúrovať obsah v hornej časti stránky.
- Vo všeobecnosti by ste pravdepodobne mali vložiť názov dokumentu alebo názov kapitoly do hlavičky alebo päty, možno pomocou nadpisov sprievodcu na ľavej strane stránky a nadpisov kapitol na pravej strane stránky. Číslo stránky musíte umiestniť do hlavičky alebo päty, buď mimo (hlavička alebo päta), alebo do stredu (iba v päte). Tiež budete možno musieť odlíšiť prvú stranu každej sekcie alebo kapitoly od ostatných strán tak, že číslo strany umiestnite do stredu päty a ďalšiu stránku do vonkajšieho rohu hlavičky.
- Možno bude potrebné vložiť text do farebného poľa alebo bloku, aby sa odlíšil od zvyšku textu. Dbajte na to, aby ste vybrali úroveň farby alebo blokovania, aby nebol text ťažko čitateľný.
- Ponechajte na všetkých stranách dostatočne široký okraj, pričom na okrajoch je dostatok miesta na zviazanie.
Krok 3. Zvážte typ zväzku v používateľskej príručke
Ak je príručka dlhšia ako 4 strany, strany musia byť zviazané určitým spôsobom. Aj keď je možné vnútorné dokumenty zošívať zošívačkou v rohu stránky, externá používateľská príručka dodaná s výrobkom sa zvyčajne zošíva jednou z nasledujúcich troch metód:
- Metóda bočného zošívania (pripevnená k bokom stránky zošívačkou) pre vodítka vytlačené na skladanom papieri 21 x 27,5 cm, 21 x 35 cm alebo 27,5 x 42,5 cm. Týmto spôsobom sú viazané väčšinou lacné návody na 48 alebo menej strán.
- Metóda zošívania v sedle (zošitá na bočnú stranu stránky) sa častejšie používa pre referenčné príručky tretích strán než pre príručky dodávané s výrobkami inými ako automobily, aj keď niektoré dlhšie príručky sú týmto spôsobom viazané. (Sprievodca Paint Shop Pro pôvodne obsahoval sprievodcu zošitím sedla, pričom ho stále vyrába JASC Software).
- Špirálová väzba je najvhodnejšia pre vodítka používané v drsnejších prostrediach, ako napríklad vonku (v takom prípade metódy zošívania zo strany a zošívania v sedle nie sú dostatočne silné, aby spôsobovali skĺznutie stránok). Niektoré sprievodcovia viazané na špirálu môžu mať aj stránky laminované plastom, aby sa zabránilo poškodeniu, keď sú mokré alebo vystavené bahnu.
Krok 4. Vytvorte vzorový dokument pre usmernenie
Mnoho aplikácií na spracovanie textu a publikovanie na počítači ponúka možnosť vytvárania šablónových dokumentov pre používateľské príručky. Pri písaní sa teda text automaticky zobrazí s písmom, ktoré ste vybrali pre časť sprievodcu, na ktorom pracujete. (Tento článok bol pôvodne napísaný pomocou šablóny programu Microsoft Word). Väčšina týchto programov obsahuje aj štandardnú sadu šablón, ktoré môžete podľa potreby upravovať, aby ste si nemuseli vytvárať vlastné od začiatku.
