Tvorba rétoricky účinných návodů k použití

Návody k použití

Mnoho lidí si návody k použití spojuje se spotřebiči, počítačovým příslušenstvím a výrobky, které vyžadují montáž (např. nábytek). Protože je nepoužíváme pravidelně nebo jsme si zvykli je očekávat jen v určitých souvislostech, snadno zapomeneme, jak jsou důležité. Kvalita dobře navrženého návodu k použití může zůstat bez povšimnutí. Když se však setkáme s frustrací při sestavování knihovny nebo hračky nebo při snaze zjistit, jak změnit nebo aktivovat určité nastavení spotřebiče, význam dobře navrženého návodu k použití se jasně ukáže.

Pochopení rétorické situace návodů k použití

Návody k použití jsou stejně jako jiné typy textů utvářeny rétorickou situací. Volby, které autoři technických textů činí, pokud jde o obsah a formu, závisí na účelu návodu k použití, zamýšleném publiku a kontextu, v němž je návod používán. Při psaní vlastního návodu k použití zvažte následující myšlenky a otázky týkající se rétorické situace.

Účel

Obecně je účelem návodu k použití seznámit uživatele s produktem a/nebo ho provést řadou kroků, které vedou k dokončení úkolu. Každý návod k použití však bude mít i konkrétnější výsledek. Určení, jaký je tento konkrétní výsledek, vám pomůže učinit efektivnější rétorická rozhodnutí o obsahu a designu. Položte si otázku:

Jaký je konkrétní zamýšlený výsledek (výsledky) návodu? (např. pečení dortu od základu, instalace klimatizace atd.)
Kromě toho, že návod pomáhá uživatelům dosáhnout hlavního požadovaného výsledku (výsledků), existují i další účely, kterým návod slouží? (např. nabízí rady pro řešení problémů, učí uživatele, jak provést další jednoduché úkoly nezbytné pro dosažení hlavního cíle)

Posluchači

Vytvoření profilu posluchačů (tj. primárního zamýšleného uživatele dokumentu) je nedílnou součástí promyšleného výběru rozsahu, obsahu a designu. Před psaním zvažte tyto otázky týkající se publika:

Jaká je znalost nebo odbornost publika týkající se tématu návodu k použití?
Jaká je obecná úroveň komfortu publika při učení se novým dovednostem souvisejícím se softwarem, aplikacemi, recepty atd.
Jaký je „typický“ přístup vašeho publika k učení? Jak bude váš návod k použití reagovat na styl učení, cíle a potřeby posluchačů související s úkoly?

Kontext

Představte si kontext jako časovou, sociální, technologickou a kulturní situaci, která obklopuje tvorbu a používání návodu k použití. Následující otázky vám pomohou určit kontext:

Kolik času budete mít na dokončení návodu k použití?
Jsou uživatelé nějak časově omezeni?
Jaká technologická omezení musíte při tvorbě návodu k použití zohlednit? Zvažte své dovednosti s technologiemi a úroveň přístupu.
Jakým způsobem získá vaše publikum přístup k návodu? (Např. publikum má přístup k příručce online prostřednictvím webových stránek společnosti)
Jaké další nástroje nebo materiály předpokládáte, že publikum již má? Budou mít přístup k technologiím nebo materiálům potřebným k tomu, aby mohli postupovat podle návodu? (např. k úspěšné stavbě knihovny bude uživatel potřebovat kladivo, šroubovák a otevřený pracovní prostor)
Z jakého kulturního hlediska návod k použití píšete? Bude publikum sdílet stejný kulturní kontext? (např. německý recept, který vyžaduje vanilkový cukr, přísadu, která není ve Spojených státech snadno dostupná, bude možná třeba pro americké uživatele upravit)

Využití znalosti rétorické situace k efektivním rétorickým volbám

Ačkoli většina návodů k použití vychází z určitých standardních konvencí, každý návod k použití by měl být přizpůsoben tak, aby dosáhl konkrétního účelu pro konkrétní publikum v daném kontextu. Následující oddíl představuje některé společné charakteristiky návodů k použití a zároveň bere v úvahu rétorickou situaci a to, jak může vyžadovat odchylky od určitých konvencí.

Rozsah

Rétorická situace pomáhá určit množství podrobností, které je třeba do návodu k použití zahrnout. Například rozsah návodu k sestavení stolu je snadné určit, protože má pouze jeden výsledek: sestavení stolu. Návod k obsluze digitální jednooké zrcadlovky (DSLR) však může být napsán jak pro amatérské, tak pro zkušenější uživatele fotoaparátu a může být třeba, aby obsahoval pokyny pro provedení základních úkonů (např. instalace baterie a paměťové karty) i pokročilejších úkonů (např, úprava nastavení pro konkrétní prostředí fotografování).

Obsah

Některé standardní části návodů k použití zahrnují přední část, úvod, řadu kroků, závěr a zadní část, ačkoli některé návody nemusí používat všechny tyto části nebo je takto označovat. Rozsáhlé přední a zadní části se například často vyskytují v delších a složitějších příručkách. Většina sad návodů však obsahuje úvod, který poskytuje informace nezbytné pro bezpečné a efektivní provedení jednotlivých kroků. Úvod může obsahovat vysvětlení, kdo by měl úkol provádět (možná je třeba, aby uživatel ovládal určitou dovednost), potřebné materiály, případná bezpečnostní opatření, která by měl uživatel přijmout (bezpečnostní rady nebo jiná upozornění), a v některých případech i odhad, jak dlouho bude postup trvat (běžný rys receptů). V některých případech je nutné připojit vysvětlení, proč by se uživatel měl návodem řídit. Například návod na výměnu oleje v automobilu může vysvětlovat, proč je tento úkol nezbytný pro správnou funkci vozidla.

Po tomto úvodním materiálu následuje posloupnost pokynů krok za krokem. O tom, jak navrhnout jasné a účinné kroky, se dočtete v následující části „Jazyk“. Nakonec může návod k použití obsahovat „Průvodce řešením problémů“ nebo oddíl „Tipy“, který uživatelům pomůže řešit běžné problémy, s nimiž se mohou setkat při plnění pokynů nebo po dokončení postupu.

Jazyk

Výše uvedené otázky týkající se „Publikum“ a „Kontext“ vám mohou pomoci při výběru efektivního jazyka. Následující podkapitoly obsahují vysvětlení běžných jazykových rysů návodů spolu s tipy, jak v tomto žánru psát jasně a stručně.

Imperativní způsob

V návodech se podobně jako v příkazech často používá imperativní způsob. Chcete-li psát tímto způsobem, oslovte publikum přímo pomocí aktivního hlasu a konkrétních sloves. Která z následujících vět poskytuje nejjasnější instrukční krok?

„Stiskněte červené tlačítko, abyste začali hrát hru“
„Po stisknutí červeného tlačítka hra začne“
„Obsluha by měla stisknout tlačítko“

Ačkoli by uživatel pravděpodobně dokázal pochopit smysl kterékoli z těchto vět, první z nich poskytuje nejjasnější vysvětlení, jakou akci má uživatel provést. Druhá, pasivní konstrukce nespecifikuje, kdo má tlačítko stisknout. Třetí příklad odkazuje na neurčitý podmět „obsluha“, což může uživatele zmást.

Výběr slov

Při psaní pokynů je důležité pečlivě zvážit výběr slov, protože v některých případech je ohrožena bezpečnost uživatele. Z tohoto důvodu usilujte o jasnost a stručnost. Abyste mohli efektivně rozhodovat o volbě slov, zvažte úroveň odborných znalostí a kulturní zázemí vašeho primárního publika. Možná budete považovat za nutné

definovat složité pojmy.
přepisovat zkratky při jejich prvním uvedení (např, digitální jednooká zrcadlovka, DSLR).
vyhněte se používání přirovnání, metafor, slangu nebo záměn, které mohou uživatele zmást.
používejte srozumitelný jazyk, neboť v některých případech může mít nejasný návod vážné právní důsledky. Více o srozumitelném jazyce viz http://www.plainlanguage.gov/index.cfm
zahrňte překlady pokynů do více jazyků.
používejte stručné a informativní nadpisy a podnadpisy

Konzistence a paralelismus

Paralelní struktura neboli paralelismus znamená použití stejné gramatické struktury k prezentaci informací nebo myšlenek. Paralelismus se často používá pro zlepšení čitelnosti a vytvoření konzistence.

Tento číselný seznam instrukcí obsahuje krok, který porušuje paralelní strukturu. Který z těchto kroků se zdá být odlišný od ostatních?

Odstraňte šroub, abyste otevřeli přihrádku na baterie.
Vložte baterie podle obrázku na přihrádce na baterie.
Teď můžete přihrádku zavřít a zašroubovat.

Třetí krok porušuje paralelní strukturu seznamu, protože nezačíná rozkazovacím způsobovým slovesem.

Používají následující nadpisy paralelní strukturu? Proč nebo proč ne?

„Instalace baterií“
„Vypnutí/zapnutí zařízení“
„Jak nabíjet zařízení“

Design

Design dokumentu se týká způsobu uspořádání a prezentace informací. Protože vizuální zpracování vyžaduje méně času, uživatelé si obvykle všimnou – a reagují na něj – kvality designu dříve než kvality obsahu. I když se rozhodnete nezahrnovat obrázky nebo grafiku, budete muset vzít v úvahu design. Minimálně to zahrnuje volbu rozvržení, pořadí informací, velikosti písma, řezu písma, nadpisů, barvy a bílého prostoru. Prvky designu by měly uživatele plynule provést příručkou. To znamená, že dokument musí být skenovatelný; skenovatelný dokument umožňuje uživatelům procházet obsahem a vyhledávat konkrétní informace. Stejně jako u každého dokumentu by rozhodnutí týkající se designu měla zohlednit publikum, účel a celkovou snadnost použití.

Konzistence/opakování

Použití designového prvku jednotným způsobem v celém dokumentu vede uživatele tím, že jim dává pocit, co mohou očekávat (např. stejný typ a velikost písma pro všechny nadpisy; stejné rozvržení na jednotlivých stránkách).

Kontrast

Použití prvku návrhu ke zvýraznění konkrétních informací nebo vlastností příručky (např. psaní velkých písmen pro zdůraznění slova; umístění rámečku nebo rámečku kolem položky; změna barev pro zdůraznění). Kontrast je účinný především tehdy, když dokument používá celkovou konzistenci. Pokud konzistence chybí, je vytvoření kontrastu obtížnější.

Zarovnání

Uspořádání položek na stránce pomocí horizontálního a/nebo vertikálního zarovnání vytváří hierarchii a strukturu a lze je použít k dosažení vyváženosti, kontrastu nebo konzistence. Například tento dokument používá vertikální zarovnání k vytvoření hierarchie mezi názvem designového prvku, který je zarovnán vlevo, a jeho popisem, který je odsazen.

Vyváženost

Rozložení položek rovnoměrně na daném prostoru. K dosažení tohoto cíle je třeba zohlednit váhu každého prvku – tj. tendenci oka tíhnout k danému prvku. Protože například obrázek váží více než text, mělo by se při rozhodování o umístění obrázku zvážit, jak vyvážit jeho váhu vůči ostatním položkám, aby nedošlo k vizuálnímu zmatení.

Bílý prostor

Používání bílého prostoru k vytvoření profesionálního, vyváženého dokumentu. Spíše než označením barvy prostoru se tento designový prvek vztahuje k absenci obrázků a textu. Bílý prostor pomáhá rozlišit jednotlivé položky a skupiny položek (tj. části příručky) a usnadňuje skenování dokumentů.

Skupování/blízkost

Umístění souvisejících obrázků nebo obsahu blízko sebe. Například seskupení obrázků všech materiálů potřebných k provedení daného úkolu.

Barvy

Volba barev pro vytvoření kontrastu a zdůraznění, pro vedení čtenářů v prostoru a pro návrh vizuálně příjemného dokumentu. Při vytváření konzistentního barevného schématu byste měli brát v úvahu celkový charakter dokumentu. Pokud například chcete v dokumentu použít modrou barvu, je třeba zajistit, aby byla použita konzistentně a doplňovala ostatní barvy dokumentu. To je důležité zejména při začlenění barevné grafiky a/nebo obrázků.

Obrázky

Výběr vhodných obrázků pro daný kontext a účel příručky. Měli byste zvážit, zda jsou obrázky určeny k samostatnému použití nebo k doplnění písemných pokynů. Zvažte typy obrázků, jako jsou nákresy, fotografie a grafické ilustrace, a to, zda jsou zapotřebí dodatečné výzvy nebo poznámky ke zvýraznění konkrétních částí obrázku. Obrázky by měly být vybrány tak, aby doplňovaly ostatní prvky designu příručky.

Závěr

Dobrá příručka s pokyny začíná pečlivým zvážením rétorické situace – účelu, publika a kontextu. Tyto informace jsou klíčové pro vhodnou a efektivní volbu obsahu, jazyka a designu. V ideální časové ose mají autoři technických návodů možnost provádět testy použitelnosti, jejichž cílem je posoudit, jak dobře dokument plní svůj účel. Po otestování návodu k použití zapracujete získanou zpětnou vazbu a dokončíte jeho návrh a obsah.

Cvičení 1 – Seznamte se s návody k použití

Následující webové stránky obsahují několik příkladů návodů k použití s otevřeným zdrojovým kódem. Přejděte na tento odkaz, projděte si seznam a vyberte si jeden návod, který si podrobně prohlédnete. Projděte si příručku zběžně, abyste se seznámili s jejím obsahem a designem. Poté se v poznámce pro instruktora nebo spolužáky věnujte následujícím otázkám:

Identifikujte rétorickou situaci

Kdo je publikum? Jak víte, kdo je publikum? Co můžete o publiku předpokládat na základě volby obsahu a designu příručky?
Jaký je účel dokumentu? Jak víte, že se jedná o primární účel (tj. jaké volby obsahu a designu signalizují tento účel)?
Z jakého kontextu vychází písemný obsah a design této příručky?

Prozkoumejte volby kompozice

Popsat celkový rozsah a organizaci příručky. Jak podrobná je příručka? Čím se zabývá? Jak jsou informace uspořádány?
Jsou v příručce zahrnuty všechny „standardní funkce“ obsahu? Proč nebo proč ne? Existují další funkce? Jaké jsou a jaký je jejich účel(y)?
Uveďte a popište příklady efektivní volby jazyka. Vysvětlete, proč je považujete za účinné.
Najděte a popište příklady efektivního designu. Vysvětlete, proč je považujete za efektivní.
Kdybyste byli autorem tohoto návodu, co byste udělali jinak a proč?

Cvičení 2 – Plánování návodu k použití

Představte si, že píšete návod k použití pro proces nebo výrobek, který znáte, a řešte následující podněty.