Obsah

• Na krok
• Časť 1 zo 4: Plánovanie príručky používateľa
• Časť 2 zo 4: Vložte základné informácie
• Časť 3 zo 4: Popis údržby produktu
• Časť 4 zo 4: Napíšte čitateľný manuál
• Tipy

Softvér, počítače, hry a zariadenia si vyžadujú užívateľské príručky; príručky vysvetľujúce, ako produkt používať (a ako nie). Používateľská príručka je formálny dokument so špecifickou štruktúrou a musí ju napísať niekto, kto produkt pozná naruby, napríklad technický autor alebo dizajnér produktu. Vypracovanie účinnej príručky používateľa vyžaduje, aby ste vedeli, kto bude produkt používať, a aby ste príručku napísali s ohľadom na týchto používateľov. Písanie udržiavajte jasné, presné a jednoduché, aby ste zabezpečili bezproblémový používateľský zážitok.

Na krok

Časť 1 zo 4: Plánovanie príručky používateľa

1. Vykonajte užívateľskú analýzu. Návod na použitie by mal byť napísaný pre používateľov - tých, ktorí si kúpia váš produkt alebo službu a prečítajú si návod na obsluhu. Analýza používateľov vám povie, kto bude vašim hlavným alebo cieľovým publikom, a prevedie vás písaním textu.
   • Porozprávajte sa s ľuďmi, ktorí budú používať vaše zariadenie. Ponúknite testovacím používateľom prototypy zariadenia a navrhnite používateľskú príručku za kontrolovaných podmienok. Požiadajte týchto testovacích používateľov o spätnú väzbu k veciam, ktoré sú v používateľskej príručke nejasné alebo mätúce, a na základe tejto spätnej väzby urobte zmeny vo svojej používateľskej príručke.
   • Nikdy nemôžete uspokojiť celé svoje publikum; napíšte príručku šitú na mieru cieľovej skupine alebo najväčšiemu publiku.
   • Zvážte vek, zdravie (majú nejaké choroby, poruchy učenia alebo postihnutia?) A úroveň vzdelania publika, aby bolo možné určiť najlepší prístup k písaniu používateľskej príručky.
2. Koordinujte dizajn používateľskej príručky. Ak ste boli súčasťou tímu, ktorý pomáhal s navrhovaním a vývojom zariadenia alebo produktu, môže byť ťažké objektívne sa pozrieť na produkt a vysvetliť jeho fungovanie. Mali by ste preto vyhľadať radu od spisovateľa (najlepšie niekoho, kto má skúsenosti s písaním) a grafického dizajnéra, ktorý vám pomôže s prípravou užívateľskej príručky. Týchto ľudí si môžete zvoliť prostredníctvom externej konzultácie alebo od svojej spoločnosti alebo organizácie.
3. Vykonajte analýzu úloh. Analýza úloh je proces identifikácie a organizovania krokov potrebných na používanie zariadenia. Dôkladná analýza úloh identifikuje materiály a vybavenie (ako sú batérie, lieky alebo iné výrobky dodané používateľom) potrebné pre každý krok, ako aj kroky, chyby a rady pri riešení problémov, ktoré môžu vyžadovať.
   • Ak máte produkt, ktorý dokáže vykonávať mnoho rôznych úloh alebo čiastkových úloh, musíte pre každú úlohu vykonať analýzu úloh. Napríklad: v aute môžete trúbiť, pripútať sa a zapnúť alebo vypnúť svetlomety. Ak je to potrebné, urobte pre každú z nich analýzu práce.
4. Zaistite, aby váš výrobok spĺňal požiadavky na označovanie a povolenie na uvedenie na trh. Tieto požiadavky zabezpečujú, že produkty sú vyrábané s ohľadom na bezpečnosť používateľa a že vystavenie používateľa nebezpečným podmienkam, ako je žiarenie a elektrický prúd, je obmedzené. Reklamy by mali jasne uvádzať účel a základné prevádzkové pokyny produktu. Tieto zdroje by ste mali použiť pri písaní príručky majiteľa.
   • Aby bola používateľská príručka k produktu účinná, musí byť napísaná v súlade so štítkami pripevnenými priamo k produktu.
   • Pred napísaním používateľskej príručky sa uistite, že má vaše zariadenie oficiálne licenciu na predaj.
5. Rozhodnite sa o usporiadaní príručky. Existuje niekoľko dôležitých spôsobov, ako môžete usmerniť svoju príručku. Na začiatok každej časti musíte vložiť tučný nadpis, pričom každé slovo musí byť veľké. Napríklad „Nastaviť zariadenie“, „Ovládať zariadenie“ a „Riešiť problémy“ môžu byť všetky nadpisy tučných častí.
   • Ďalším spôsobom, ako sprievodcu zjednodušiť, je použiť dva stĺpce, jeden napravo s textom a druhý naľavo od textu s odrážkami, číslami alebo malými ikonami, ako sú výstražné značky alebo červené výkričníky.
   • Príručka môže pozostávať hlavne z obrázkov s textom pod každým obrázkom, ktorý slúži na vysvetlenie prístroja, alebo môže ísť hlavne o text s iba niekoľkými sprievodnými obrázkami. Na usmernenie používateľa môžete použiť aj vývojový diagram. Zamyslite sa nad svojím produktom a nad tým, ako vám jednotlivé metódy môžu pomôcť pri písaní príručky. Vyvarujte sa však toho, aby ste v rámci jedného manuálu kombinovali rôzne usporiadania. Vyberte si jeden a držte sa ho.

Časť 2 zo 4: Vložte základné informácie

1. Usporiadajte príručku logicky. Príručka by mala byť štruktúrovaná tak, aby z nej mal užívateľ najväčší úžitok. Príručku rozdeľte na kapitoly alebo časti, ktoré majú zmysel pre použitie produktu, a na začiatku príručky zahrňte obsah, aby ste každú časť našli rýchlo.
   • Obsah je zvlášť potrebný pre dlhšie príručky.
   • Ak existuje veľa výrazov, ktoré vysvetľujú, že vaše publikum nemusí byť oboznámené, je potrebný slovník alebo index. Glosár sa však neodporúča; najlepšou voľbou je vysvetliť mätúce pojmy v texte samotnej príručky. Ak sa rozhodnete zahrnúť slovník, vložte ho do prednej časti manuálu, hneď za obsah.
   • Zoznam tabuliek alebo obrázkov je nevyhnutný, iba ak je v príručke viac ako niekoľko tabuliek alebo obrázkov.
   • K veciam, ktoré je potrebné vysvetliť, je potrebný dodatok, ktorý sa však nedá vysvetliť inde v príručke, pretože by to narušilo plynulosť a zameranie.
2. Uveďte potrebné varovania. Všeobecné varovania alebo preventívne informácie by mali poskytovať informácie o potenciálnych rizikách spôsobených nesprávnym používaním produktu vrátane smrti alebo vážneho zranenia. Tieto varovania by mali byť umiestnené na samom začiatku manuálu, po titulnej stránke, aby ich používateľ videl ako prvé. Tesne po alebo tesne pred navrhnutím potenciálne nebezpečného kroku by mali byť do textu príručky zahrnuté aj konkrétne varovania.
   • Všeobecným varovaním pre elektrický spotrebič môže byť napríklad to, aby ste ho nepoužívali, keď prší.
   • Konkrétnym pokynom by mohlo byť ubezpečenie sa, že máte ruky aj zariadenie pred pripojením zariadenia k elektrickej zásuvke suché.
   • Poskytnite obrázky (napríklad lebku a skrížené kosti) alebo text inej farby (napríklad červený text), aby ste odlíšili varovanie od ostatných smerov v IFU a upozornili na ne používateľov.
3. Popíšte zariadenie. Váš popis by mal obsahovať písomné vysvetlenie účelu zariadenia a malé grafické znázornenie toho, ako zariadenie vyzerá. Obrázok by mal označiť a pomenovať všetky prepínače, tlačidlá a pripojiteľné časti obsiahnuté v zariadení.
4. Poskytnite pokyny na inštaláciu. Inštalačná časť by mala obsahovať základné informácie o tom, ako sa pripraviť na používanie produktu alebo zariadenia. Ak spotrebič nemôže zostaviť alebo nastaviť domáci užívateľ, uveďte to zreteľne tučným záhlavím v hornej časti inštalačnej časti. Mali by ste zahrnúť aj nasledujúce položky:
   • Zoznam dielov
   • Pokyny na vybalenie
   • Varovania týkajúce sa inštalácie
   • Dôsledky nesprávnej inštalácie
   • Komu zavolať v prípade ťažkostí počas inštalácie
5. Poskytnite informácie o operácii. Táto časť je najdôležitejšou súčasťou používateľskej príručky a mala by obsahovať konkrétne, podrobné informácie o tom, ako používať zariadenie. Začnite so základnou prípravou na používanie jednotky, napríklad pripojením napájacieho kábla alebo umývaním rúk. Pokračujte v logických, očíslovaných krokoch, ktoré popisujú, ako používať zariadenie, ako aj v akejkoľvek spätnej väzbe (napríklad „Budete počuť kliknutie ...“), ktorú môže používateľ pri správnom používaní zariadenia očakávať.
   • Na konci tejto kapitoly by sa malo používateľom odkázať na kapitolu Riešenie problémov, ktorá slúži na riešenie problémov, ktoré sa nedajú rýchlo vysvetliť.
   • Podľa potreby umiestnite obrázky. Niektoré kroky je najlepšie vysvetliť obrázkami aj slovami. Zvážte použitie fotografií alebo ilustrácií vo vašej príručke.
   • V tejto časti, ako v každej časti, by ste mali zahrnúť príslušné bezpečnostné varovania týkajúce sa nesprávneho použitia alebo obsluhy. Môžete napríklad varovať používateľov motorovej píly, aby pri niektorých liekoch nepili alkohol alebo nepoužívali motorovú pílu.
   • Ak si myslíte, že to používateľom prinesie úžitok, zvážte zahrnutie odkazov na online videá demonštrujúce správne používanie a fungovanie zariadenia. Tieto videá môžete nahrávať buď na začiatku tejto časti, alebo (v prípade videí, ktoré zobrazujú iba jeden krok) na konci každého kroku.
6. Na konci priložte súhrn produktu. Súhrn by sa mal zobraziť na konci príručky, tesne pred indexom, aby poskytol základné kroky pri obsluhe. Toto by mala byť zjednodušená, orezaná verzia operačných informácií a nemala by obsahovať viac ako jednu stránku. Zhrňte, ako sa má zariadenie alebo produkt používať. Zahrňte základné výstrahy, očíslované kroky, ktoré vysvetľujú, ako používať produkt, a telefónne čísla alebo e-mailové adresy, ktoré nasmerujú používateľov na pomoc.
   • Ak očakávate, že používateľ bude súhrnný hárok často odstraňovať alebo sa na ne odvolávať, môžete ho vytlačiť na odnímateľnú laminovanú kartu alebo hrubú lepenku, aby sa tak používateľovi ľahšie nosilo a odkazovalo sa na neho.
   • Prípadne môžete použiť súhrn priamo na produkt, aby ho používateľ mohol rýchlo a ľahko vyhľadať.

Časť 3 zo 4: Popis údržby produktu

1. Vysvetlite, ako čistiť zariadenie. Ak je potrebné zariadenie alebo produkt vyčistiť, vysvetlite, ako na to. Uveďte zoznam požadovaných čistiacich prostriedkov. Povedzte čitateľovi, ako často čistiť. Potom, ako v ktorejkoľvek inej časti príručky, zahrňte očíslované podrobné pokyny, ako ju vyčistiť.
   • Ak čistenie vyžaduje demontáž produktu alebo odstránenie konkrétnej časti alebo častí, uveďte, ako by sa mal výrobok demontovať.
   • Poskytnite varovanie o výsledkoch nevyčistenia zariadenia. Môžete napríklad povedať: „Ak zariadenie nie je vyčistené, výkon bude menej ako optimálny.“
2. Spočítajte užívateľa, ako vykonávať základnú údržbu. Ak je produkt alebo zariadenie opraviteľné používateľom s cieľom napraviť problémy s výkonom, poskytnite očíslované pokyny, ako to používateľovi urobiť. Napríklad ak je potrebné batérie vymeniť po každých 300 hodinách používania, poskytnite pokyny, ako skontrolovať, či je potrebné batérie vymeniť, ako vybité batérie vybiť a ako vložiť nové.
   • Ak existujú určité úlohy údržby, ktoré môže vykonávať iba certifikovaný technik, rozdeľte časť manuálu na údržbu na dve časti.
3. Diskutujte o možnostiach úložiska. V prípade potreby by mala príručka vysvetliť, ako správne skladovať výrobok alebo zariadenie. mali by ste uviesť aj informácie o tom, prečo je skladovanie nevyhnutné a aké sú dôsledky nesprávneho skladovania. Napríklad: môžete napísať:
   • Produkt skladujte na chladnom a suchom mieste. Nesprávne skladovanie môže skrátiť životnosť vášho produktu kvôli hromadeniu vlhkosti. “
   • „Výrobok nevystavujte pôsobeniu tepla a neskladujte ho pri teplotách nad 50 stupňov Celzia.Ak to urobíte, môže to viesť k horeniu. ““
4. Poskytnite informácie o riešení problémov. Túto časť by ste mohli usporiadať ako zoznam bežných problémov a ich riešení. Zoskupte podobné problémy do logickej časti. Týmto spôsobom môžu používatelia rýchlo nájsť konkrétne problémy.
   • Napríklad ak existuje niekoľko problémov s počítačom zobrazujúcim modrú obrazovku, zoskupte ich do podnadpisu, napríklad „Bežné problémy s obrazovkou“.
   • V tejto časti musíte tiež uviesť telefónne číslo alebo e-mail na zákaznícke služby.

Časť 4 zo 4: Napíšte čitateľný manuál

1. Prečítajte si ďalšie používateľské príručky. Pred napísaním príručky pre svoj vlastný produkt si prečítajte ďalšie efektívne používateľské príručky. Venujte pozornosť štruktúre, výberu slov a štruktúre viet. Hlavné značky ako Apple, Google a Microsoft vytvárajú silné a efektívne používateľské príručky, ktoré vám pomôžu vytvoriť premyslenejšie napísanú používateľskú príručku.
   • Nie len čítať všetko užívateľské príručky. Prečítajte si príručky k podobným produktom, ktoré predávate. Ak napríklad predávate výrobky pre deti, prečítajte si príručky pre deti, nie technické.
2. Vyberte svoje štandardy. Vďaka štandardizácii pravopisu, výberu slova a znenia bude používateľská príručka užívateľsky príjemnejšia. Chicagská príručka štýlu a príručka štýlu spoločnosti Microsoft môžu byť tiež užitočnými sprievodcami štýlmi pri písaní príručky používateľa; Skontrolujte obidve, či je vhodný pre váš manuál.
   • Napríklad namiesto toho, aby ste v príručke používali „vypínač“ aj „vypínač“, zvoľte jeden z dvoch výrazov a držte sa ho.
3. Použite aktívny hlas. Aktívny hlas je spôsob písania, ktorý vysvetľuje veci z pohľadu používateľa. Je ľahšie pochopiteľné ako alternatíva, pasívny hlas, v ktorom je nedefinovaný predmet.
   • Vyskúšajte aplikáciu Hemingway (www.hemmingwayapp.com), pomocou ktorej môžete vo svojom písaní identifikovať pasívne pasáže.
   • Naštudujte si tieto dve ukážkové vety - prvá je aktívna a druhá pasívna:
     • Balenie musíte otvárať pomaly a opatrne.
     • Balenie by sa malo otvárať pomaly a opatrne.
4. Napíš očíslované pokyny. Číselne usporiadané pokyny pomáhajú čitateľovi lepšie sa sústrediť na proces používania, pripojenia alebo výroby príslušného produktu. Namiesto toho, aby ste písali dlhý a podrobný odsek alebo sériu nečíslovaných odsekov, napíšte svoju užívateľskú príručku jednoduchými, explicitnými krokmi, každý zreteľne očíslovaný.
5. Každý krok začnite imperatívom. Imperatív je sloveso zamerané na činnosť. Začatím každého kroku slovesom dáte čitateľovi tip na akciu potrebnú na dokončenie kroku. Napríklad v závislosti od produktu, o ktorom píšete, môžete svoje kroky začať príkazom ako „Pripojiť“, „Potvrdiť“ alebo „Snímka“. Nezačínajte svoje kroky reakciou systému.
   • Napríklad ak sa obrazovka zmení na modrú a začne blikať, nezačínajte tento krok: „Obrazovka bude blikať a zmodrie.“ Skúste: „Stlačte a podržte tlačidlo Domov. Obrazovka bude blikať a zmodrie. ““
6. Určte, ktorý slovník budete používať. Ak píšete jo-jo príručku, vašim publikom budú väčšinou malé deti. Pomocou jednoduchých slov a slovnej zásoby vysvetlite, ako jojo funguje. Keď píšete príručku o skenovacom elektrónovom mikroskope, vaše publikum je tvorené vysoko kvalifikovanými vedcami, ktorí rozumejú veľmi podrobným informáciám, takže sa nevyhýbajte použitiu špecializovanej slovnej zásoby alebo podrobných vysvetlení.
   • Spravidla sa snažíte vyhnúť žargónu a technickému jazyku.
   • Aby bola práca pre čo najširšiu užívateľskú základňu efektívna, skúste písať na úrovni od šiesteho do siedmeho ročníka základnej školy.
7. Pri preprave produktu do zahraničia sa uistite, či sú vaše preklady presné. Najmite si prekladateľa, ktorý preloží vašu používateľskú príručku do rodného jazyka krajiny, do ktorej produkt dodávate. Môžete tiež použiť online prekladový program, ale požiadajte rodeného hovorcu, aby si prečítal preklad a skontroloval chyby.
   • Ak je vo vašom publiku zastúpených viac jazykových skupín, uveďte preklady používateľskej príručky v každom príslušnom jazyku.
   • Prekladateľ musí byť s produktom oboznámený, pretože v cieľovom jazyku môžu byť rôzne slová pre konkrétne výrazy, ktoré nie sú prekladmi od slova do slova.
8. Píšte krátkymi vetami. Namiesto niekoľkých dlhých odsekov použijete veľa krátkych odsekov. V každej časti hľadajte logické zlomy a užitočné informácie strávte v jedno- alebo dvojvetových blokoch. To isté platí na úrovni vety. Udržujte svoje vety krátke a jednoduché, než dlhé a podrobné.
   • Ak je krok príliš dlhý, rozdeľte ho na menšie kroky. Počet slov sa tým nezníži, ale zalomenie riadkov uľahčí čítanie.
9. Skontrolujte príručku, či neobsahuje chyby. Príručka môže stratiť dôveryhodnosť kvôli gramatickým a pravopisným chybám. Nechajte tiež editovať a korigovať príručku kolegom alebo technickým spisovateľom. Okrem pravopisu a gramatiky by mal korektor venovať pozornosť nasledujúcim skutočnostiam:
   • Pasívny hlas
   • Nejasný alebo mätúci jazyk
   • Zbalená štruktúra vety
   • Príliš dlhé odseky

Tipy

• Ľudia sa učia rôznymi spôsobmi; Ak je to možné a vhodné, zahrňte do príručky vizuálne pomôcky alebo odkazy na online videá, aby vyhovovali vizuálne orientovaným čitateľom.