Technické psaní pro techniky

Jedním z nejčastějších a nejdůležitějších způsobů využití technického psaní je psaní návodů – tedy vysvětlení krok za krokem, jak něco udělat: něco sestavit, obsluhovat, opravit nebo vysvětlit nějaký osobní postup (například zápis na vysokou školu), aby ho čtenáři lépe pochopili a případně sami použili.

Postupové texty jsou ve školách a profesích velmi rozšířené. Ve škole učitelé často zadávají procesní úkoly. Například profesoři humanitních věd mohou požadovat popis vývoje určitého uměleckého nebo literárního období, profesoři dějepisu přínos vůdců určité kultury v průběhu času, profesoři společenských věd chronologii vynálezů, profesoři technických věd vysvětlení, jak se zvuk mění na elektrické signály, profesoři obchodních věd, jak funguje Federální rezervní systém nebo jak prodat nějaký výrobek.

Na denní bázi čteme popisné procesy, včetně receptů, uživatelských příruček k novému softwaru nebo sloupků s radami, jak zhubnout nebo jak uspět ve škole či v profesi. Tyto texty se zaměřují na zodpovězení jedné z následujících otázek:

• „Jak se to dělá?“
• „Jak to mohu udělat?“

Přestože se témata zpráv o procesech nebo návodů mohou lišit, mnohé z nich mají společné rysy: většina z nich je napsána tak, aby vysvětlila, jak něco funguje, většina je strukturována chronologicky pomocí očíslovaných kroků a většina se ve velké míře opírá o vizuální stránku. Například při psaní návodu pro učení se novému softwarovému programu mohou autoři použít snímky obrazovky a/nebo videa, aby uživatele provedli návodem.

Všeobecně je dobré, aby návod obsahoval jak text, tak vizuální prvky, protože vaše publikum se pravděpodobně skládá z lidí s různými styly učení. Použití vizuálních prvků se však může lišit v závislosti na vašem publiku a zamýšleném použití návodu. Vizualizace pomáhají objasnit koncept, který je obtížné vysvětlit pouze pomocí slov. Grafika může být použita k tomu, aby ukázala, jak něco vypadá, jak by něco mělo vypadat po dokončení daného kroku, jak se něco dělá nebo konstruuje, ukázala trendy nebo vztahy, dodala projektu živost nebo jednoduše pomohla uspořádat informace. Grafika je užitečná, protože téměř každý (včetně dětí a dalších cizojazyčných osob) rozumí vizuálním pokynům a přesně vidí, co má dokončit.

Typy pokynů

Existují tři hlavní typy procesních textů:

• • • Popisné procesy: odpovídají na otázku „Jak se to dělá?“. Tyto texty popisují, jak proces probíhá, aby mu čtenáři lépe porozuměli. Například napsání popisného procesu o tom, jak jste se přihlásili na kurz online, a ne osobně, může být užitečné pro někoho, kdo nikdy online registraci neprováděl.

• • • Preskriptivní procesy: mají vysvětlující charakter; předepisují, jak se něco dělá (nebo by se mělo dělat), aby to čtenáři mohli udělat sami. Jedná se o nejběžnější typ instrukčních dokumentů. Můžete například napsat průvodce preskriptivním procesem pro uživatele, který vysvětluje, jak provádět základní údržbu svého automobilu, například výměnu oleje, kontrolu zapalovacích svíček nebo výměnu brzdových destiček. *Níže uvedené ukázky jsou příklady preskriptivních procesů.

• • • Smíšené deskriptivní a preskriptivní procesy tvoří hlavní náplň dokumentu popisný proces a zároveň mají několik částí shrnujících, jak mohou čtenáři proces provést. Jinými slovy, pisatelé se mohou v různých částech jednoho textu zabývat jak otázkou „Jak to mohu udělat?“, tak otázkou „Jak se to dělá?“. Případně mohou vytvořit různé verze téhož dokumentu pro dvě publika – pro publikum uživatelů a pro publikum zainteresovaných stran.

Začínáme

Na začátku projektu nebo úkolu psaní návodu je důležité zvážit své publikum a určit charakteristiky (počet úkolů a kroků) konkrétního postupu, o kterém hodláte psát.

Publikum a situace: Na začátku procesu definujte publikum a situaci vašeho návodu. Nezapomeňte, že definovat publikum znamená určit jeho úroveň znalostí a obeznámenosti s tématem. Někdy je užitečné popsat publikum nejprve sobě, a pak na základě toho na konci zhodnotit své sdělení, abyste si byli jisti, že je pro vaše publikum vhodné.

Počet úkolů: Důležitým hlediskem je, kolik úkolů obsahuje postup, pro který píšete návod. Termín postup lze použít pro označení celého souboru činností, o kterých váš návod pojednává, zatímco úkol lze použít pro vymezení částečně nezávislé skupiny činností v rámci postupu. Například nastavení modemu je jedním úkolem v celkovém postupu připojení počítače k internetu.

Jiným příkladem je jednoduchý postup, jako je výměna oleje v autě, který obsahuje pouze jeden úkol; neexistují žádné polonezávislé skupiny dalších činností. Složitější postup, jako je použití mikrovlnné trouby, obsahuje spoustu polonezávislých úkonů, jako je nastavení hodin, nastavení úrovně výkonu, použití časovače, čištění a údržba mikrovlnné trouby a další.

Některé instrukce mají pouze jeden úkol, ale v rámci tohoto jednoho úkolu mají mnoho kroků. Představte si například soubor pokynů pro sestavení dětské houpačky. Jedním z efektivních přístupů by bylo seskupit podobné a související kroky do fází a v každé nové fázi kroky přečíslovat. Fáze je skupina podobných kroků v rámci postupu jednoho úkolu. V příkladu s houpačkovou soupravou by jednou fází bylo sestavení rámu, další fází ukotvení věci do země a další fází sestavení skříňové houpačky.

Zaměření pokynů

Dalším hlediskem, které možná nedokážete určit na začátku, je způsob zaměření pokynů. U většiny návodů se můžete zaměřit na příslušné úkoly, nebo se můžete zaměřit na potřebné nástroje.

• • • Při úkolovém přístupu k návodu na používání telefonního automatu byste měli oddíly o nahrávání pozdravu, přehrávání zpráv, ukládání zpráv, přeposílání zpráv a mazání zpráv. To jsou úkoly – typické věci, které by uživatelé chtěli s přístrojem dělat.

• • • Na druhé straně, v přístupu nástrojů k pokynům k používání kopírky by byly oddíly o tlačítku kopírování, tlačítku zrušení, tlačítku zvětšení/zmenšení, tlačítku sbalení/slepení, zásobníku papíru, tlačítku velikosti kopie atd. Pokud byste na tomto plánu navrhli sadu pokynů, pravděpodobně byste napsali kroky pro použití každého tlačítka nebo funkce kopírky.

Obsah pokynů

Před vytvořením pokynů si nezapomeňte přečíst část „Návrh dokumentu“. Zahrňte následující položky:

Úvod: Při pečlivém plánování úvodu návodu nezapomeňte:

• • • • Uveďte konkrétní úkoly nebo postup, který má být vysvětlen.
      • Uveďte, jaké znalosti a zázemí potřebuje publikum k pochopení návodu.
      • Uveďte obecnou představu o postupu a o tom, čeho se jím dosáhne.
      • Uveďte podmínky, kdy by se tyto pokyny měly (nebo neměly) použít.
      • Uveďte přehled obsahu pokynů.

Všeobecná varování, upozornění, upozornění na nebezpečí: Návod musí také upozornit čtenáře na možnost, že si zničí vybavení, pokazí postup a/nebo si ublíží. Také pokyny musí zdůrazňovat klíčové body nebo výjimky. Pro tyto situace byste měli použít zvláštní upozornění, jako je Poznámka, Varování, Upozornění a/nebo Nebezpečí.

Technické podklady nebo teorie: Na začátku některých pokynů (obvykle po úvodu) se může hodit pojednání o pozadí souvisejícím s daným postupem. U některých pokynů je toto pozadí velmi důležité – jinak by kroky v postupu nedávaly smysl. V některých případech mohou autoři návodů potřebovat strávit značný čas vysvětlováním čtenářům, než přejdou k samotným krokům, které jsou součástí postupu.

Vybavení a pomůcky: Většina návodů obsahuje seznam věcí, které je třeba před zahájením postupu shromáždit. Patří sem vybavení, tedy nástroje, které při postupu používáte (například míchací misky, lžíce, chlebníky, kladiva, vrtačky a pily), a zásoby, tedy věci, které se při postupu spotřebovávají (například dřevo, barva, olej, mouka a hřebíky). V návodech jsou obvykle uvedeny buď v jednoduchém svislém seznamu, nebo ve dvousloupcovém seznamu na začátku návodu. Dvousloupcový seznam použijte v případě, že potřebujete doplnit specifikace k některým nebo všem položkám – například názvy značek, velikosti, množství, typy, čísla modelů atd.

Diskuse o krocích: Až se dostanete k samotnému psaní kroků, určitě pečlivě zvažte strukturu a formát těchto kroků, případné doplňující informace a úhel pohledu a celkový styl psaní pokynů. Jedním z úhlů pohledu používaných v technickém psaní je druhá osoba, která oslovuje publikum jako vy.

* Obecně řečeno, autoři návodů by měli usilovat o následující:

• • • Pokud je to možné, používejte jasné a jednoduché psaní.

• • • Mít důkladnou znalost procesu ve všech jeho technických detailech.

• • • Snažte se vžít do situace čtenáře, který bude váš návod používat.

Ukázky návodů pro studenty

• Ukázka návodu ke svařování (ukázka pro studenty)

• Ukázka návodu k mechatronice – testování diod. & Tranzistory (ukázka pro studenty)

• Auto/Diesel Návod – Jak vyměnit zadní kyvnou tyč na Toyotě Corolla (ukázka pro studenty)

• Postel Návod na přenášení (ukázka pro studenty)

• Jak vyměnit kytarové struny (ukázka pro studenty)

Ukázky profesionálních návodů

• Svařování Ukázka návodu 1 (odborná ukázka)

• Barbie Dreamhouse (odborná ukázka)

• Montáž trampolíny (odborná ukázka)