Jak vytvořit uživatelskou příručku: 12 kroků

Uživatelská příručka je papírnice na papíře nebo digitální média (ve formátu PDF nebo XPS), ve které pokyny pro použití něčeho nebo popisuje správný postup pro provedení procesu. Ačkoli když člověk slyší frázi "Uživatelská příručka", obvykle představuje průvodce používáním specifického programu, návodu k obsluze počítačových a domácích spotřebičů (televizory, stereo systémy, telefony, mp3 přehrávače, zahradní vybavení a t.D.). Dobrá uživatelská příručka vypráví o základních funkcích zařízení nebo programu a vysvětluje, jak je používat správně, a informace jsou obvykle dobře strukturované. Tento článek bude říct o tom, co je důležité zapamatovat při vytváření a provedení uživatelské příručky.

Kroky

Část 1 z 3:

Vytvoření dokumentace

jeden. Určete, kdo váš čtenáře. Chcete-li vytvořit dobrou uživatelskou příručku, musíte pochopit, který člověk bude kupovat zařízení, ke kterému vytvoříte pokyny. Můžete nahrát své myšlenky, ale můžete si to představit tuto osobu. Je užitečné udělat, pokud pracujete jako tým k vytvoření dokumentace, a pokud se podílíte na vývoji produktů od samého počátku až do konce. Přemýšlejte o následujících:

Tam, kde osoba bude používat návod k obsluze: doma, v práci, v autě, na internetu? To určí nejen obsah, ale také styl dokumentace.
Jako člověk použije pokyny? Pokud člověk potřebuje pouze občas, podívejte se do uživatelské příručky, znamená to, že instrukce musí být zarámována ve stlačeném formuláři. Pokud je manuál často používán, zejména na samém počátku, měli byste obsahovat celou sekci, jak začít používat zařízení nebo softwarový produkt, a popsat všechny nejdůležitější funkce.
Kolik zkušeností by mělo mít osobu? Pokud je váš produkt relativně nový nebo výrazně odlišný od podobných produktů, budete muset zahrnout informace o tom, jak se tento produkt liší od analogů a poskytne uživateli podrobné pokyny. Pokud je zboží spojeno s častými problémy (například s velkým počtem programů), popište, co by mělo být provedeno, když nastane problém.

Obrázek s názvem Vytvořit uživatelskou příručku Krok 2

2. Napište, aby vám čtenář pochopil. Pokud pouze váš výrobek neznamená úzké znalosti uživatele, je lepší vyhnout se technickým termínům a popsat vše jednoduchý, srozumitelný jazyk. Textová struktura musí dodržovat posloupnost otázek, které mohou vyskytnout uživatelem. Je správnější skupinovat funkce zařízení v závislosti na úkolech, které provádí a opustí myšlenku sjednocení v jedné skupině nejoblíbenějších funkcí.

Někdy je nemožné zcela vyloučit technické termíny (například, pokud provedete pokyny k programu pro vytváření grafů a diagramů, kde kromě standardních fondů jsou také použity grafické nástroje Fibonaccicci). V tomto případě je užitečné definovat termín a stručný popis (to znamená, co je to fibonacci grafika a jak se používají při analýze finančních ukazatelů).

Obrázek s názvem Vytvořit uživatelskou příručku Krok 3

3. Popište problém, se kterým se uživatel může setkat, a pak nabídnout řešení. Když inzerujete nějaký druh výrobku, fráze o tom, jak může vyřešit určitý problém, bude nepochybně přitahovat hodně pozornosti. Ale když uživatel koupí tento výrobek, musí vysvětlit, co s tím dělat. Popište, s jakými problémy se uživatel může během provozu setkat a zahrnout do ručního pokyny pro probíhající problémy.

Pokud je problém komplikovaný, rozbijte jej do několika částí. Vytvořte seznam a provází každou položku pokyny. To se nazývá bloky.

Část 2 z 3:

Kompozitní části uživatelské příručky

jeden. Zvažte kryt a design prvních stran sekcí. Budete muset vytvořit kryt, pokud instrukce trvá několik stránek. Bude také nutné umístit stránky s názvem sekcí pokyny, kde celková částka informací trvá více než 4 stránky.

Pokud je uživatelská příručka chráněna autorským právem, musí být odpovídající indikace na obálce a na stránkách přepážky.
Pokud uživatelský manuál poskytuje určité podmínky pro použití výrobku a pokynů, umístěte tyto informace zevnitř krytu.

Obrázek s názvem Vytvořit uživatelskou příručku Krok 5

2. Odkazy na další místo dokumentace v úvodu. Pokud se manuál skládá z několika brožur, zadejte všechny brožury na začátku. Kromě toho byste měli také umístit sekci "Jak používat tento návod k obsluze", pokud se rozhodnete, že taková sekce je potřeba.

Obrázek s názvem Vytvořit uživatelskou příručku Krok 6

3. Pokud počet stránek přesahuje 10 kusů, budete potřebovat obsah.

Obrázek s názvem Vytvořit uživatelskou příručku Krok 7

4. Základem návodu k použití by mělo být pokyny a informace o složkách zboží. Pokyny jsou zpravidla rozděleny do bloků, a v každém bloku můžete určit, ve kterých by měl být uživatel hledat, nebo tyto informace. Takže uživatel bude snazší a rychlejší najít informace, které potřebují.

Procesy by měly být jasně a důsledně popsány. Začněte s obecným popisem úkolu, vysvětlete, že uživatel bude muset udělat a jaký výsledek bude muset dostat. Všechny kroky musí být očíslovány a návrhy by měly začít slovesem.

Referenční materiály by měly obsahovat seznam funkcí, metod pro diagnostiku chyb a často kladených otázek. Na konci uživatelské příručky můžete umístit stručný slovník pojmů a abecedního ukazatele, i když hlavní pojmy jsou často prováděny na začátku. Abecední ukazatel se doporučuje pro pokyny, jejichž hlasitost přesahuje 20 stran.

Obrázek s názvem Vytvořit uživatelskou příručku Krok 8

Pět. Použijte obrázky a schémata. Kresby a snímky obrazovky mohou popsat určité procesy lepší než text, zejména pokud pochází z komplexních procesů, kde potřebujete mít vizuální potvrzení, že osoba dělá vše v pořádku. Grafické snímky mohou být vytvořeny ve speciálních programech: v systémech dvou a trojrozměrných výkresů, v grafických editérech, v aplikacích pro zpracování fotografií atd.D. Pokud je třeba provést screenshoty, lze získat pomocí personálu soutěží a grafického programu se schopností ukládat screenshoty.

Po získání grafického obrázku jej uložte do komprimovaného formátu. Můžete také snížit velikost obrazu tak, aby byla umístěna na stránce, ale velikost by neměla být příliš malá, protože jinak uživatel nebude schopen zvážit, jak a co by mělo být provedeno. V případě potřeby můžete obraz rozbít do několika částí a popsat každý z nich.

Pokud používáte více snímků, musí mít stejnou velikost, poměr a rozlišení. Takové snímky budou srozumitelnější a příjemnější pro čtenáře. Při vytváření screenshotů se ujistěte, že používáte standardní barevné schéma (pro případy, kdy je návod k vytištěnu v barvě).

Ačkoli grafické editory (například Photoshop a Paint Shop Pro) jsou vhodné vytvořit screenshoty, je lepší používat speciální programy (například Snagit), protože jim umožňují okamžitě rychle a snadno upravovat, ukládat a podepsat všechny snímky.

Část 3 z 3:

Registrace příručky

jeden. Vyberte čitelné písmo. Ačkoli počítače podporují různá písma, uživatelská příručka musí být dobře čitelná, takže dejte přednost nejjednodušší. Nejlepší je vybrat pár písem, které vypadají dobře. Existují dva typy písma: se Serifs a žádné tenisky.

Fonty s SERIFS mají malé pomlčky podél okrajů řádků. Taková fonty zahrnují časy New Roman, Baskerville a kniha Antiqua. Taková písma budou vyhovovat velkým objemům textu vytištěného 10 nebo 12 velikostí a součástí uživatelské příručky.
Fonty bez tenisky mají jednoduché linky bez dekorací. Jedná se o fonty, jako je arial, kalibri a století gotika. FONTS bez SERIFS jsou lepší při pohledu do textů vytištěných 8 nebo 10 písem v příručkách PDF nebo webových dokumentů. Čím větší je písmo, tím těžší je to přečíst bez tenisky. Tyto písma však mohou být použity pro velký text - například pro sadu záhlaví. Zdroj písma jsou vhodná pro digitální nábor v tabulkách a sloupcích.
Měli byste si vybrat jednoduchá písma jako Arial nebo Times New Roman, i když některé složitější písmo je vhodný pro cenovou nabídku. Pokud napíšete uživatelskou příručku pro hru fantazie, můžete zvýraznit s titulním titulem sirotčince. Je také dovoleno SEW Quote v kurzívách.
Po výběru písem vytvořte zkušební stránku, abyste se ujistili, že tato písma jsou v kombinaci s ostatními na papíře. Zobrazte tuto stránku osobě, která schvaluje rozvržení dříve, než zadáte uživatelskou příručku k tisku.

Obrázek s názvem Vytvořit uživatelskou příručku Krok 10

2. Přemýšlet o schématu informačních bloků. V této fázi musíte rozhodnout, jaké informace objednávky jsou umístěny.

Název uživatelské příručky a názvy kapitol se zpravidla umístí na horní nebo dolní části stránky spolu s číslovacími stránkami. Obrázky mohou být umístěny na vnější straně (pro horní a dolní část stránky) nebo uprostřed (pro NIZA). První stránka každé sekce se může lišit od zbytku, takže můžete umístit svůj počet stránek do středu dna a čísla všech ostatních stránek - zvenčí.

Samostatné textové fragmenty mohou být izolovány podle barvy umístěním do speciálních bloků. Je důležité si vybrat takový stín, který by text nemohl skóre.

Nechte poměrně velké odrážky ze všech stran. Z vazby odsazení musí být širší.

Obrázek s názvem Vytvořit uživatelskou příručku Krok 11

3. Přemýšlejte o typu vazby. Pokud je v uživatelské příručce více než 4 stránky, budete potřebovat vazbu. Dokumenty pro vnitřní použití jsou obvykle upevňují sešívačka v rohu, ale pokud investujete svůj průvodce do krabice s komoditou, budete muset přistupovat k tomuto problému odpovědnějšímu. Existují tři typy vazby:

Lepení držáku. Tento typ je vhodný pro brožury s rozměry 21x 27.5 cm, 21x35 cm nebo 11 x 27.5x42.5 cm. Nejdůležitější pokyny pro použití, které se skládají z 48 stran a méně propletené tímto způsobem.

Vazba vnakidka. Takže prolínají většinu obvyklých pokynů pro použití, nepočítá pokyny pro automobily, i když některé dlouhé vůdci jsou také propleteni tímto způsobem. Paint Shop Pro byl původně dodáván s takovou uživatelskou příručkou.)

Vazba s drátovou spirálou. Tímto způsobem jsou příručky, které se používají ve závažnějších podmínkách, jsou propleteny například na ulici, kde se sponky mohou snadno rozbít nebo rozptýlit. V některých pokynech pro použití s takovou vazbou jsou také nalezeny laminované stránky, které nemají mokré a nečistoty v nečistotách.

Obrázek s názvem Vytvořit uživatelskou příručku Krok 12

4. Vezměte dokument. Většina textových editorů a programů pro publikování textu na internetu je příležitost pro rozvržení. Jak psáte text, bude automaticky zobrazen ve vybraném písmu. (Tento článek byl původně napsán pomocí šablony v aplikaci Microsoft Word.) Tyto programy mají také hotové šablony, které můžete změnit, s přihlédnutím k vašim potřebám, místo aby vytvořil vzor od nuly.

V textových editorech a programech pro publikování textu na internetu je také funkce vytváření "Styly", ukládání písem a úloh pro tabulky, zápatí a základní text. Můžete si vybrat z již existujících stylů ("title11", "normální", "Quote") nebo si vytvořit svůj vlastní styl a dát jej své jméno. Doporučuje se volat styly ve stejném systému, jak je uvedeno v programu. (Například Microsoft Word vytvoří taková jména jako "Title1", "Title2" - navíc existují ještě titulky.) Konfigurace programu předem, abyste se k němu nemuseli vrátit, když budete psát psaní textu.

Tipy

Pokud je to možné, použijte kódy polí nebo textových proměnných. Můžete změnit své hodnoty (například název produktu, název hlavy uživatelské příručky) a vložte je do dokumentu v místě, kde se obvykle přesunete na slova ručně. Když provedete náhled dokumentu nebo jej připravit na tisk, požadovaný text se nastaví do proměnných. Pokud se název Změna zboží nebo pokud se rozhodnete změnit název kapitoly, budete jednodušší změnit text nahrazením hodnoty proměnné.

Co potřebuješ

Textový editor nebo program pro publikování textu na internetu
Grafický editor nebo program pro vytváření screenshotů