Ako vytvoriť užívateľskú príručku?
Ak chcete písať používateľské príručky, začnite tým, že väčšinu obsahu rozdelíte do kapitol alebo sekcií, ktoré zodpovedajú použitiu produktu, a potom príručku začnite obsahom a slovníkom. Ďalej vytvorte bezpečnostné varovania a napíšte popis zariadenia. Potom zahrňte pokyny na nastavenie, vysvetlite základné operácie a vytvorte súhrn produktu, ktorý nájdete na konci príručky. Môžete tiež zahrnúť časť o starostlivosti o výrobok, ktorá obsahuje informácie o čistení, základnej údržbe, skladovaní a odstraňovaní problémov. Ak sa chcete dozvedieť viac o ideálnom štýle písania pre používateľské príručky, čítajte ďalej!
Používateľská príručka by mala byť napísaná pre publikum - tých, ktorí si kúpia váš produkt alebo službu, a prečítať si používateľskú príručku.
Softvér, počítače, hry a zariadenia vyžadujú používateľské príručky, príručky, ktoré vysvetľujú, ako výrobok používať (a ako nie). Používateľská príručka je formálny písomný dokument so špecifickou štruktúrou a mal by ho napísať niekto, kto je s výrobkom dôverne oboznámený, napríklad technický spisovateľ alebo produktový dizajnér. Napísanie efektívnej používateľskej príručky vyžaduje vedieť, kto bude výrobok používať, a potom ho napísať s ohľadom na týchto používateľov. Udržujte svoje písanie jasné, presné a jednoduché, aby bola zaistená bezproblémová používateľská skúsenosť.
Časť 1 zo 4: Plánovanie vašej používateľskej príručky
- 1Vykonajte analýzu publika. Používateľská príručka by mala byť napísaná pre publikum - tých, ktorí si kúpia váš produkt alebo službu, a prečítať si používateľskú príručku. Analýza publikum vám povie, kto je váš hlavný alebo cieľové publikum bude a bude riadiť vaše písanie.
- Porozprávajte sa s ľuďmi, ktorí budú používať vaše zariadenie. Za kontrolovaných podmienok ponúknite testovacím používateľom prototypy zariadenia a návrh používateľskej príručky. Vyžiadajte si od týchto testovacích používateľov spätnú väzbu na veci, ktoré nie sú zrejmé alebo mätúce v používateľských pokynoch, a začleňte zmeny do svojej používateľskej príručky na základe tejto spätnej väzby.
- Nikdy nemôžete potešiť celé svoje publikum; napíšte manuál tak, aby vyhovoval cieľovému alebo najväčšiemu publiku.
- Zamyslite sa nad vekom, zdravotným stavom publika (trpia chorobami, poruchami učenia alebo postihnutím?) A úrovňou vzdelania, aby ste určili najlepší prístup k napísaniu používateľskej príručky.
- 2Koordinujte návrh používateľskej príručky. Ak ste boli súčasťou tímu, ktorý pomáhal navrhovať a vyvíjať zariadenie alebo produkt, mohlo by byť ťažké pozrieť sa na produkt objektívne a vysvetliť jeho fungovanie. Preto by ste mohli chcieť požiadať o radu spisovateľa (najlepšie takého, ktorý má skúsenosti s písaním pokynov) a grafického dizajnéra, aby vám pomohol s vypracovaním používateľskej príručky. Tieto osoby si môžete vybrať z externého poradenstva alebo z vlastnej spoločnosti alebo organizácie.
- 3Vykonajte analýzu úlohy. Analýza úloh je proces identifikácie a organizácie krokov potrebných na používanie zariadenia. Dôkladná analýza úloh identifikuje materiály a vybavenie (ako sú batérie, lieky alebo iné produkty poskytované užívateľom) potrebné pre každý krok, ako aj činnosti, chyby a rady týkajúce sa riešenia problémov, ktoré môže každý krok vyžadovať.
- Ak máte produkt, ktorý môže vykonávať mnoho rôznych úloh alebo čiastkových úloh, budete musieť vykonať analýzu úlohy pre každú úlohu. Napríklad v aute môžete zatrúbiť, pripútať sa a zapnúť alebo vypnúť svetlomety. Podľa potreby vytvorte analýzu úloh pre každú z nich.
- 4Zaistite, aby bol váš výrobok v súlade s požiadavkami na označovanie a marketingové schválenie. Tieto požiadavky zaisťujú, že výrobky sú vyrábané s ohľadom na bezpečnosť používateľa, a obmedzia vystavenie užívateľa nebezpečným podmienkam, ako je žiarenie a zásah elektrickým prúdom. Reklamy musia jasne demonštrovať účel a základné prevádzkové pokyny výrobku. Tieto zdroje by ste mali používať pri písaní používateľskej príručky.
- Aby bola používateľská príručka výrobku účinná, musí byť napísaná v zhode s etiketami umiestnenými priamo na výrobku.
- Pred napísaním návodu na obsluhu sa uistite, že je váš prístroj legálne licencovaný na predaj.
Používateľská príručka by mala postupovať takým spôsobom, ktorý bude pre používateľa najvhodnejší. - 5Rozhodnite o rozložení vašej príručky. Existuje niekoľko dôležitých spôsobov, ako môžete príručku zefektívniť. Na začiatku každej sekcie by ste každé slovo mali písať veľkým písmom. Napríklad „Nastavenie zariadenia“, „Prevádzka zariadenia“ a „Riešenie problémov“ môžu byť tučné nadpisy sekcií.
- Ďalším spôsobom, ako zefektívniť vašu príručku, je použiť dva stĺpce, jeden vpravo s textom a druhý iba vľavo od textu s odrážkami, číslicami alebo malými ikonami, ako sú výstražné značky alebo červené výkričníky.
- Vaša príručka môže byť väčšinou obrázky s textom pod každým obrázkom na vysvetlenie zariadenia, alebo to môže byť predovšetkým text s iba niekoľkými sprievodnými obrázkami. Môžete tiež použiť vývojový diagram a poskytnúť používateľovi pokyny. Pri písaní používateľskej príručky sa zamyslite nad svojim výrobkom a nad tým, ako môžu byť jednotlivé metódy užitočné. Vyhnite sa však miešaniu rôznych rozložení v príručke. Vyberte si jeden a držte sa ho.
Časť 2 zo 4: vrátane základných informácií
- 1Usporiadajte manuál logicky. Používateľská príručka by mala postupovať takým spôsobom, ktorý bude pre používateľa najvhodnejší. Rozdeľte príručku do kapitol alebo sekcií, ktoré zodpovedajú použitiu produktu, a zahrňte obsah na začiatku príručky, aby ste každú časť rýchlo našli.
- Obsah je obzvlášť potrebný pri dlhších príručkách.
- Slovník alebo register je potrebný, ak existuje veľa výrazov, ktoré vysvetľujú, že vaše publikum nemusí byť oboznámené. Glosáre sa však neodporúčajú; najlepšou voľbou je vysvetliť mätúce pojmy v samotnom texte príručky. Ak sa rozhodnete zahrnúť glosár, umiestnite ho pred príručku hneď za obsah.
- Zoznam tabuliek alebo obrázkov je potrebný len vtedy, ak je v príručke viac ako niekoľko tabuliek alebo obrázkov.
- Príloha je potrebná k veciam, ktoré by mali byť vysvetlené, ale nemožno ich vysvetliť v inom bode manuálu, pretože by to narušilo tok a sústredenie.
- 2Zahrňte potrebné varovania. Všeobecné výstražné alebo výstražné informácie by mali poskytnúť informácie o potenciálnych hrozbách, ktoré by mohlo spôsobiť nesprávne používanie výrobku vrátane smrti alebo vážneho zranenia. Tieto varovania by mali byť umiestnené úplne na začiatku príručky za titulnou stranou, aby ich používateľ videl ako prvé. Špecifické upozornenia by mali byť tiež zahrnuté v texte používateľskej príručky bezprostredne po alebo tesne pred navrhnutím potenciálne nebezpečného kroku.
- Všeobecným upozornením na elektrické zariadenie môže byť napríklad to, že sa vyhnete jeho používaniu počas dažďa.
- Konkrétnym smerom môže byť zaistenie suchých rúk a zariadenia pred zapojením zariadenia.
- Zahrňte grafiku (napríklad lebku a skrížené kosti) alebo rôznofarebný text (napríklad červený text), aby ste varovanie odlíšili od ostatných smerov v používateľskej príručke a upozornili naň používateľov.
- 3Popíšte zariadenie. Váš popis by mal obsahovať písomné vysvetlenie účelu zariadenia a malú grafiku znázorňujúcu, ako zariadenie vyzerá. Grafika by mala správne označiť a pomenovať všetky prepínače, gombíky a pripojiteľné časti, ktoré zariadenie obsahuje.
- 4Zahrňte pokyny na nastavenie. Časť nastavenia by mala obsahovať základné informácie o tom, ako sa pripraviť na používanie produktu alebo zariadenia. Ak zariadenie nemôže zostrojiť alebo nastaviť domáci používateľ, uveďte túto skutočnosť jasne v tučnej hlavičke v hornej časti sekcie nastavenia. Mali by ste tiež zahrnúť:
- Zoznam dielov
- Pokyny na vybalenie
- Varovania súvisiace s nastavením
- Výsledky nesprávneho nastavenia
- Na koho sa obrátiť v prípade problémov s nastavením
- 5Poskytnite informácie o prevádzke. Táto časť je hlavnou časťou používateľskej príručky a mala by poskytovať konkrétne a podrobné informácie o tom, ako používať zariadenie. Začnite základnou prípravou na používanie zariadenia, ako je zapojenie do zásuvky alebo umývanie rúk. Prejdite na logické, očíslované kroky, ktoré opisujú, ako by sa zariadenie malo používať, a tiež na spätnú väzbu (napríklad „Budete počuť kliknutie...“), ktorú môže používateľ očakávať pri správnom používaní zariadenia.
- Na konci tejto časti by mali byť používatelia presmerovaní do sekcie na riešenie problémov, aby vyriešili problémy, ktoré nemožno rýchlo vysvetliť.
- V prípade potreby zahrňte grafiku. Niektoré kroky je najlepšie vysvetliť obrázkami aj slovami. Zamyslite sa nad použitím fotografií alebo ilustrácií v používateľskej príručke.
- V tejto časti, ako v každej, nezabudnite zahrnúť príslušné bezpečnostné upozornenia o nesprávnom použití alebo prevádzke. Môžete napríklad varovať používateľov motorovej píly, aby počas používania určitých liekov nepili alkohol ani nepoužívali reťazovú pílu.
- Ak si myslíte, že by to používateľom prospelo, zvážte zahrnutie odkazov na videá online, ktoré ukazujú správne používanie a prevádzku zariadenia. Tieto videá môžete zaradiť buď na začiatok tejto sekcie, alebo (v prípade videí, ktoré znázorňujú iba jeden krok) na konci každého kroku.
Používateľská príručka by v prípade potreby mala vysvetliť, ako správne skladovať výrobok alebo zariadenie. - 6Na konci zahrňte zhrnutie produktu. Zhrnutie by malo byť na konci manuálu, tesne pred indexom, aby poskytlo základné operačné kroky. Toto by mala byť zjednodušená a orezaná verzia sekcie prevádzkových informácií a nemala by mať viac ako jednu stránku. Zhrňte, ako používať zariadenie alebo produkt. Zahrňte základné upozornenia, číslovaný krok vysvetľujúci používanie produktu a telefónne čísla alebo e -mailové adresy, ktoré používateľov nasmerujú na pomoc.
- Ak očakávate, že používateľ odstráni súhrnný list alebo ho potrebuje často konzultovať, môžete si ho vytlačiť na vyberateľnú laminovanú kartu alebo hrubý kartón, aby ste užívateľovi uľahčili nosenie so sebou a referencie.
- Prípadne zahrňte súhrnný list priamo k produktu, aby ho používatelia mohli rýchlo a jednoducho odkázať.
Časť 3 zo 4: opis starostlivosti o výrobok
- 1Vysvetlite, ako čistiť zariadenie. Ak vaše zariadenie alebo produkt vyžaduje čistenie, vysvetlite, ako to urobiť. Nezabudnite vymenovať potrebné čistiace prostriedky. Informujte čitateľa o tom, ako často by mali čistiť. Potom, rovnako ako v akejkoľvek inej časti používateľskej príručky, zahrňte očíslované podrobné pokyny, ako by malo čistenie pokračovať.
- Ak čistenie vyžaduje určitú demontáž produktu alebo odstránenie určitej časti alebo častí, nezabudnite uviesť podrobnosti o spôsobe demontáže.
- Zahrňte upozornenie na výsledky zlyhania čistenia zariadenia. Môžete napríklad povedať: „Neschopnosť vyčistiť bude mať za následok nižší ako optimálny výkon.“
- 2Povedzte používateľovi, ako má vykonávať základnú údržbu. Ak môže používateľ alebo používateľ opravovať produkt alebo zariadenie, aby opravil problémy s výkonom, zahrňte očíslované pokyny, ako to môže používateľ urobiť. Ak je napríklad potrebné vymeniť batérie po každých 300 hodinách používania, uveďte návod, ako skontrolovať, či je potrebné batérie vymeniť, ako vybrať vybité batérie a ako vložiť nové batérie.
- Ak existujú niektoré úlohy údržby, ktoré môže vykonávať iba certifikovaný technik, rozdeľte časť údržby tohto manuálu na dve časti.
- 3Diskutujte o možnostiach ukladania. Používateľská príručka by v prípade potreby mala vysvetliť, ako správne skladovať výrobok alebo zariadenie. Mali by ste tiež zahrnúť informácie o tom, prečo je ukladanie nevyhnutné a aké sú výsledky nesprávneho skladovania. Môžete napríklad napísať:
- "Výrobok skladujte na chladnom a suchom mieste. Nesprávne skladovanie by mohlo skrátiť životnosť vášho produktu v dôsledku nahromadenia vlhkosti."
- "Nevystavujte výrobok teplu ani neskladujte pri teplotách nad 49°C. Mohlo by to viesť k spáleniu."
- 4Zahrňte informácie o riešení problémov. Túto časť môžete usporiadať ako zoznam bežných problémov a ich riešení. Zoskupte podobné problémy pod logický nadpis. Užívatelia tak môžu rýchlo nájsť konkrétne problémy.
- Napríklad, ak existuje niekoľko problémov s počítačom zobrazujúci sa modrá obrazovka, zoznam ich dohromady v podkapitole ako "bežných problémov obrazovky."
- Do tejto sekcie by ste mali zahrnúť aj telefónne číslo a/alebo e -mail na zákaznícky servis.
Časť 4 zo 4: napísanie čitateľného manuálu
- 1Prečítajte si ďalšie používateľské príručky. Predtým, ako napíšete príručku pre svoj vlastný výrobok, pozrite sa na ďalšie účinné používateľské príručky. Dávajte pozor na štruktúru, výber slov a štýl viet. Veľké značky ako Apple, Google a Microsoft vyrábajú silné a efektívne používateľské príručky, ktoré vám môžu pomôcť vytvoriť premyslenejšie napísanú používateľskú príručku.
- Nečítajte iba žiadne používateľské príručky. Prečítajte si návody pre podobné výrobky, ktoré predávate. Ak napríklad predávate výrobky pre deti, prečítajte si návody na použitie pre deti, nie technológie.
Ak je vo vašom publiku zastúpených viac jazykových skupín, priložte preklady používateľskej príručky do každého relevantného jazyka. - 2Vyberte svoje štandardy. Vďaka štandardizácii pravopisu, výberu slov a frázovania bude používateľská príručka užívateľsky príjemnejšia. Príručka štýlu Chicago a príručka štýlu Microsoft môžu byť tiež užitočnými sprievodcami štýlom pri písaní vašej používateľskej príručky; poraďte sa s oboma, aby ste zistili, či jeden bude pre vašu príručku fungovať.
- Napríklad namiesto toho, aby ste vo svojej používateľskej príručke používali „vypínač/vypínač“ aj „vypínač“, zvoľte jeden alebo druhý výraz a držte sa ho.
- 3Používajte aktívny hlas. Aktívny hlas je perspektíva v písaní, ktorá vysvetľuje veci z pohľadu užívateľa. Je to zrozumiteľnejšie ako jeho alternatívny, pasívny hlas, v ktorom predmet nie je definovaný.
- Vyskúšajte aplikáciu Hemingway (www.hemmingwayapp.com) na identifikáciu pasívnych pasáží vo vašom písaní.
- Pozrite sa na tieto dve vety, prvú aktívnu a druhú pasívnu, a ukážte si každú z nich:
- Balíček by ste mali otvárať pomaly a opatrne.
- Balenie by sa malo otvárať pomaly a opatrne.
- 4Napíšte očíslované pokyny. Číselne usporiadané pokyny pomôžu čitateľovi lepšie sa sústrediť na proces použitia, pripojenia alebo výroby predmetného produktu. Namiesto toho, aby ste písali dlhý, chaotický odsek alebo sériu nečíslovaných odsekov, napíšte svoju používateľskú príručku jednoduchými a jasnými krokmi, pričom všetky sú očíslované jasne.
- 5Začnite každý krok imperatívom. Imperatív je sloveso zamerané na akciu. Začínaním každého kroku so slovesom čitateľa navediete na akciu potrebnú na dokončenie kroku. V závislosti od produktu, o ktorom píšete, môžete napríklad začať s imperatívmi, ako sú „Pripojiť“, „Pripojiť“ alebo „Snímka“. Nezačínajte však kroky s odpoveďou systému.
- Ak napríklad obrazovka zmodrie a začne blikať, nezačínajte krokom: „Obrazovka bude blikať a modrať.“ Skúste: „Stlačte a podržte tlačidlo Domov. Obrazovka začne blikať a zmení sa na modrú.“
- 6Rozhodnite sa, akú slovnú zásobu budete používať. Ak píšete jojo používateľskú príručku, vaše publikum budú väčšinou malé deti. Pomocou jednoduchých slov a slovnej zásoby vysvetlite, ako funguje jojo. Ak píšete používateľskú príručku k skenovaciemu elektrónovému mikroskopu, vašim publikom budú vysoko kvalifikovaní vedci, ktorí dokážu porozumieť veľmi podrobným informáciám, takže sa neobmedzujte od používania špecializovanej slovnej zásoby alebo podrobných vysvetlení.
- Vo všeobecnosti sa snažte vyhnúť žargónu a odbornému jazyku.
- Ak chcete byť efektívny pre čo najširší okruh používateľov, snažte sa písať na úrovni čítania od šiesteho do siedmeho ročníka.
- 7Ak zasielate produkt do zahraničia, zaistite správnosť svojich prekladov. Najmite si prekladateľa, ktorý preloží vašu používateľskú príručku do materinského jazyka krajiny, do ktorej zasielate produkt. Prípadne použite online prekladateľskú aplikáciu, ale požiadajte rodeného hovorcu, aby si prečítal a upravil preklad, aby neobsahoval chyby.
- Ak je vo vašom publiku zastúpených viac jazykových skupín, priložte preklady používateľskej príručky do každého relevantného jazyka.
- Prekladateľ by mal byť s výrobkom oboznámený, pretože v cieľovom jazyku môžu existovať rôzne slová pre konkrétne výrazy, ktoré nie sú prekladmi od slova do slova.
Pri písaní používateľskej príručky sa zamyslite nad svojim výrobkom a nad tým, ako môžu byť jednotlivé metódy užitočné. - 8Pokračujte v písaní. Namiesto niekoľkých dlhých odsekov použite veľa krátkych odsekov. V každej sekcii hľadajte logické prestávky a do kúskov s jednou alebo dvoma vetami vložte užitočné informácie. To isté platí na úrovni vety. Udržujte svoje vety krátke a jednoduché, a nie dlhé a neporiadne.
- Ak krok začína byť príliš dlhý, rozdeľte ho na menšie kroky. Nespôsobí to zníženie počtu slov, ale zalomenie riadkov uľahčí čítanie.
- 9Korektúra manuálu. Príručka môže stratiť dôveryhodnosť kvôli gramatickým a pravopisným chybám. Nechajte spolupracovníka alebo technického spisovateľa, aby tiež upravili a skontrolovali príručku. Korektor by mal okrem pravopisu a gramatiky hľadať aj:
- Pasívny hlas
- Nejasný alebo mätúci jazyk
- Zložitá vetná štruktúra
- Príliš dlhé odseky
- Ľudia sa učia rôznymi spôsobmi; ak je to možné a vhodné, zahrňte do príručky vizuálnych pomocníkov alebo odkazy na online videá, aby ste pomohli vizuálnym študentom.
Prečítajte si tiež: Ako nájsť pútavý názov pre svoju prácu/esej?
Komentáre (7)
- Veľmi sa mi páčia ilustrácie a rozloženie pokynov, dalo mi to niekoľko nápadov, ako vyčistiť môj projekt. Vďaka!
- Tak užitočné pre mňa. Ukázalo mi to pokrok a bolo to také jasné.
- Prečítal som len niekoľko častí a prišlo mi to zaujímavé, a preto som si to pridal do záložiek, keď relaxujem a môžem tráviť čas jeho trávením. Páči sa mi koncept.
- Logicky to dalo dohromady, čo by som chcel robiť.
- Bolo to podrobné. Hlasovú sekciu „pasívny/aktívny“ považujem za mimoriadne informatívnu. Ďakujem za vašu tvrdú prácu.
- Úžasné! Na svojom bielom papieri som dostal náskok!
- Pomôže mi to efektívne napísať používateľskú príručku.
