Ako vykonať používateľskú príručku: 12 krokov

Používateľská príručka je papierňa na papieri alebo digitálnych médiách (vo formáte PDF alebo XPS), v ktorom pokyny na použitie niečoho alebo opisuje správny postup na vykonávanie procesu. Aj keď keď človek počuje frázu "návod na obsluhu", Zvyčajne predstavuje návod na použitie špecifického programu, návod na obsluhu počítačových a domácich spotrebičov (TV, stereo systémy, telefóny, MP3 prehrávače, záhradné vybavenie a t.D.). Dobrá návod na použitie rozpráva o základných funkciách zariadenia alebo programu a vysvetľuje, ako ich používať správne, a informácie sú zvyčajne dobre štruktúrované. Tento článok povie o tom, čo je dôležité zapamätať si pri vytváraní a vykonávaní používateľskej príručky.

Kroky

Časť 1 z 3:

Vytvorenie dokumentácie

jeden. Určite, kto váš čitateľ. Ak chcete vytvoriť dobrú používateľskú príručku, musíte pochopiť, ktorá osoba si kúpi zariadenie, ku ktorému vytvoríte pokyny. Môžete nahrávať svoje myšlienky, ale môžete si predstaviť túto osobu. Je užitočné robiť, ak pracujete ako tím, aby ste vytvorili dokumentáciu a ak sa zúčastníte vývoja produktu od samého začiatku až do konca. Premýšľajte o nasledujúcom texte:

Tam, kde človek použije návod na obsluhu: doma, v práci, v aute, na internete? To určí nielen obsah, ale aj štýl dokumentácie.
Ako človek použije pokyny? Ak osoba potrebuje len príležitostne pozrieť sa do návodu na občas, znamená to, že inštrukcia musí byť zarámovaná v komprimovanej forme. Ak sa manuál často používa, najmä na samom začiatku, mali by ste obsahovať celú časť o tom, ako začať používať zariadenie alebo softvérový produkt a opísať všetky najdôležitejšie funkcie.
Koľko skúseností by malo mať osobu? Ak je váš produkt relatívne nový alebo výrazne odlišný od podobných produktov, budete musieť zahrnúť informácie o tom, ako sa tento produkt líši od analógov a poskytne užívateľovi podrobné pokyny. Ak je tovar spojený s častými problémami (napríklad s veľkým počtom programov), opíšte, čo by sa malo urobiť, keď vznikne problém.

Obrázok s názvom Vytvorenie návodu na použitie KROKU 2

2. Napíšte tak, že čitateľ vám rozumie. Ak len váš produkt neznamená úzke znalosti užívateľa, je lepšie vyhnúť sa technickým podmienkam a popísať všetko jednoduchý, zrozumiteľný jazyk. Textová štruktúra musí spĺňať postupnosť otázok, ktoré sa môžu vyskytnúť používateľom. Je vhodnejšie zoskupiť funkcie zariadenia v závislosti na úlohách, ktoré vykonáva a opustí myšlienku zjednotenia v jednej skupine najobľúbenejších funkcií.

Niekedy nie je možné úplne vylúčiť technické podmienky (napríklad, ak vykonáte pokyny k programu na vytváranie grafov a diagramov, kde sa okrem štandardných fondov, používajú sa aj grafické nástroje Fibonacci). V tomto prípade je užitočné definovať termín a stručný opis (to znamená, čo je grafika Fibonacci a ako sa používajú pri analýze finančných ukazovateľov).

Obrázok s názvom Vytvorenie návodu na používanie Krok 3

3. Popíšte problém, s ktorým sa užívateľ môže stretnúť, a potom ponúknuť riešenie. Keď inzerujete nejaký druh produktu, frázy o tom, ako môže vyriešiť určitý problém, nepochybne priťahuje veľa pozornosti. Ale keď užívateľ nakupuje tento produkt, potrebuje vysvetliť, čo s tým robiť. Popíšte, s akými problémami sa užívateľ môže počas prevádzky stretnúť a zahrnúť do manuálnych pokynov pre prebiehajúce problémy.

Ak je problém komplikovaný, rozbiť ho do niekoľkých častí. Urobte zoznam a sprevádzajte všetky pokyny na položku. Toto sa nazýva bloky.

Časť 2 z 3:

Kompozitné časti používateľskej príručky

jeden. Zvážte kryt a dizajn prvých stránok sekcií. Budete musieť vytvoriť kryt, ak inštrukcia trvá niekoľko stránok. Bude tiež potrebné umiestniť stránky s názvom sekcií pre pokyny, kde celkové množstvo informácií trvá viac ako 4 strany.

Ak je používateľská príručka chránená autorským právom, zodpovedajúca indikácia musí byť na kryte a na stránkach oddielu.
Ak používateľská príručka poskytuje určité podmienky na používanie produktu a inštrukcií, umiestnite tieto informácie z vnútra obalu.

Obrázok s názvom Vytvoriť návod na používanie Krok 5

2. Odkazy na dodatočnú dokumentáciu miesto v úvode. Ak sa manuál skladá z niekoľkých brožúr, zadajte na začiatku všetok počet brožúr. Okrem toho by mal tiež umiestniť časť "Ako používať tento návod na obsluhu", Ak sa rozhodnete, že je potrebná takáto sekcia.

Obrázok s názvom Vytvorenie návodu na používanie Krok 6

3. Ak počet strán presahuje 10 kusov, budete potrebovať obsah.

Obrázok s názvom Vytvoriť návod na obsluhu Krok 7

4. Základom návodu na použitie by mal byť pokyny a informácie o zložkách tovaru. Pokyny sú spravidla rozdelené do blokov a v každom bloku môžete zadať, v ktorých sekciách by mal užívateľ hľadať, alebo tieto informácie. Takže užívateľ bude jednoduchšie a rýchlejšie nájsť informácie, ktoré potrebujú.

Procesy by mali byť opísané jasne a dôsledne. Začnite so všeobecným popisom úlohy, potom vysvetlite, že užívateľ bude musieť urobiť a aký výsledok sa bude musieť dostať. Všetky kroky musia byť očíslované a návrhy by mali začať s slovesami.

Referenčné materiály by mali obsahovať zoznam funkcií, metódy diagnostikovania porúch a často kladené otázky. Na konci užívateľskej príručky môžete umiestniť stručný slovník termínov a abecedného ukazovateľa, hoci hlavné termíny sa často vykonávajú na začiatku. Abecedný ukazovateľ sa odporúča pre pokyny, ktorých objem presahuje 20 strán.

Obrázok s názvom Vytvoriť návod na používanie Krok 8

päť. Použite obrázky a schémy. Kresby a screenshoty môžu opísať určité procesy lepšie ako text, najmä pokiaľ ide o komplexné procesy, kde potrebujete mať vizuálne potvrdenie, že osoba robí všetko správne. Grafické obrázky môžu byť vytvorené v špeciálnych programoch: v systémoch dvoch a trojrozmerných výkresov, v grafických editoroch, pri aplikáciách na spracovanie fotografií atď.D. Ak je potrebné vykonať screenshoty, môžu byť získané pomocou zamestnancov Competeer a grafického programu s možnosťou ukladania screenshots.

Po získaní grafického obrázka ho uložte do komprimovaného formátu. Môžete tiež potrebovať znížiť veľkosť obrazu tak, že je umiestnená na stránke, ale veľkosť by nemala byť príliš malá, pretože inak nebude užívateľ schopný zvážiť, ako a čo by sa malo vykonať. V prípade potreby môžete obrázok zlomiť na niekoľko častí a opísať každý z nich.

Ak používate viac obrázkov, musia mať rovnakú veľkosť, podiel a rozlíšenie. Takéto obrázky budú pochopiteľnejšie a príjemné pre čitateľa. Pri vytváraní screenshotov sa uistite, že používate štandardnú farebnú schému (pre prípady, keď je príručka vytlačená farbou).

Hoci grafické editory (napríklad Photoshop a Paint Shop Pro) sú vhodné na vytvorenie screenshots, je lepšie použiť špeciálne programy (napríklad Snagit), pretože im umožnia byť okamžite rýchle a ľahko upravovať, uložiť a podpísať všetko snímky.

Časť 3 z 3:

Registrácia manuálu

jeden. Vyberte Čitateľné písmo. Hoci počítače podporujú rôzne fonty, používateľská príručka musí byť dobre čitateľná, takže uprednostňuje najjednoduchšie. Najlepšie je vybrať si pár fontov, ktoré vyzerajú dobre. Existujú dva typy fontov: s serify a žiadne tenisky.

Fonty s serify majú malé pomlčky pozdĺž okrajov riadkov. Takéto fonty zahŕňajú časy New Roman, Baskerville a kniha Antiqua. Takéto fonty budú vyhovovať veľkým množstvom textu vytlačené o 10 alebo 12 veľkosti a komponent používateľskej príručky.
Fonty bez tenisiek majú jednoduché riadky bez dekorácií. Sú to fonty ako ARIAL, CALIBRI A GOTHIC GOTHIC. Fonty bez serify sú lepšie hľadáte v textoch vytlačených 8 alebo 10 fontov v príručkách PDF alebo Web Document. Čím väčšie písmo, tým ťažšie je to čítať bez tenisiek. Tieto fonty však môžu byť použité pre veľký text - napríklad pre súbor hlavičiek. Sourlingové fonty sú vhodné pre číslice prijímanie do tabuliek a stĺpcov.
Mali by ste si vybrať jednoduché fonty ako Arial alebo Times New Roman, hoci niektoré komplexnejšie písmo je vhodné pre citáciu. Ak píšete používateľskú príručku pre fantasy hru, môžete zvýrazniť s názvom titulu spoločnosti Orphanage. Je tiež povolené šiť citáciu kurzívou.
Po výbere fontov vytvorte testovaciu stránku, aby ste sa uistili, že tieto fonty sú navzájom kombinované na papieri. Ukážte túto stránku osobu, ktorá schvaľuje rozloženie pred udávaním používateľskej príručky na tlač.

Obrázok s názvom Vytvorenie návodu na používanie Krok 10

2. Myslite na položku Schéma informačných blokov. V tomto štádiu musíte rozhodnúť, akú objednávku sú umiestnené v.

Spravidla sa menom užívateľskej príručky a názvy kapitol umiestni na hornej alebo dolnej časti stránky spolu s číslovacími stránkami. Obrázky môžu byť umiestnené na vonkajšej strane (pre hornú a spodnú časť stránky) alebo v strede (pre Niza). Prvá strana každého úseku sa môže líšiť od zvyšku, takže môžete umiestniť svoj počet svojich stránok do stredu dna a čísla všetkých ostatných stránok - zvonku.

Samostatné textové fragmenty môžu byť izolované podľa farby umiestnením do špeciálnych blokov. Je dôležité si vybrať takýto tieň, ktorý by nezhromažďoval text.

Nechajte dosť veľké zarážky zo všetkých strán. Z väzby zarážky musí byť širšia.

Obrázok s názvom Vytvorenie návodu na použitie KROK 11

3. Premýšľajte o type väzby. Ak máte v používateľskej príručke viac ako 4 stránky, budete potrebovať záväznú. Dokumenty na interné použitie sú zvyčajne upevnenie zošívačky v rohu, ale ak investujete svoj sprievodca k boxu s komoditou, budete musieť túto otázku pristupovať zodpovedne. Existujú tri typy väzieb:

Spojovací držiak. Tento typ je vhodný pre brožúry s rozmermi 21x 27.5 cm, 21x35 cm alebo 11 x 27.5x42.5 cm. Najvýhodnejšie návod na použitie, ktoré sa skladajú z 48 strán a menej preplávaných týmto spôsobom.

Viazanie vnakidka. Takže intertwine väčšinu obvyklých inštrukcií na použitie, nepočítajúc pokyny pre automobily, hoci týmto spôsobom sú aj niektorí dlhé lídri. Paint Shop Pro bol pôvodne dodávaný s takýmto návodom používateľskej príručky.)

Väzba s drôtenou špirálovou. Týmto spôsobom sú príručky, ktoré sa používajú v ťažkých podmienkach, sú prepojené, napríklad na ulici, kde sa sponky môžu ľahko rozbiť alebo rozptýliť. V niektorých pokynoch na použitie s takýmito väzbou sa nachádzajú aj laminované stránky, ktoré nie sú vlhké a nečistoty v špine.

Obrázok s názvom Vytvorenie používateľskej príručky Krok 12

4. Dokument. Väčšina textových editorov a programov na publikovanie textu na internete je príležitosť na rozloženie. Ako napíšete text, automaticky sa zobrazí vo zvolenom písme. (Tento článok bol pôvodne napísaný pomocou šablóny v programe Microsoft Word.) Tieto programy majú tiež hotové šablóny, ktoré sa môžete zmeniť, berúc do úvahy vaše potreby, namiesto vytvorenia vzoru od nuly.

V textových editoroch a programoch na publikovanie textu na internete je tiež funkcia vytvárania "štýly", Úlohy a úlohy úloh pre tabuľky a päty a základný text. Môžete si vybrať z už existujúcich štýlov ("HLAVA1", "Obvyklý", "Citovať") Alebo vytvorte svoj vlastný štýl a dajte mu svoje meno. Odporúča sa zavolať štýly pozdĺž toho istého systému, ako je uvedené v programe. (Napríklad Microsoft Word vytvorí takéto mená ako "HLAVA1", "Title2"- Okrem toho existujú stále titulky.) Nakonfigurujte program vopred tak, aby ste sa k nemu nemuseli vrátiť, keď budete písať textové písanie textu.

Tipy

Ak je to možné, použite kódy polí alebo textových premenných. Môžete zmeniť svoje hodnoty (napríklad názov produktu, názov hlavy užívateľskej príručky) a dať ich do dokumentu v mieste, kde sa zvyčajne presuniete na slová manuálne. Keď urobíte náhľad dokumentu alebo ho pripravíte na tlač, požadovaný text sa nastaví do premenných. Ak sa zmení názov tovaru alebo ak sa rozhodnete zmeniť názov kapitoly, budete jednoduchšie zmeniť text nahradením hodnoty premennej.

Čo potrebuješ

Textový editor alebo program pre publikovanie textu na internete
Grafický editor alebo program pre vytváranie screenshots