Základy technického psaní

Popisné technické psaní využívá kombinaci vizuálních prvků a textu, aby čtenáři „ukázalo“ i „řeklo“ sdělované informace. Stejně jako kreativnější popisy, i technické popisy někdy využívají „pěti smyslů“ a metaforických přirovnání (analogií), aby si čtenář mohl plně představit, co je popisováno. Častěji se však opírají o konkrétní, měřitelné deskriptory. Technické popisy mohou mít mnoho podob v závislosti na účelu a publiku. Popisy se mohou pohybovat od krátké věty až po odstavec, celou část zprávy nebo celou příručku. Špatně napsané technické popisy mohou způsobit zmatek, ztrátu času, a dokonce vést ke katastrofě! Technické popisy výrobků jsou často vyžadovány zákonem, aby byla zajištěna bezpečnost a shoda s předpisy. Pozornost věnovaná detailům je rozhodující.

Specifikace výrobků vyžadují podrobné popisy konstrukčních prvků; návody často vyžadují specifické popisné detaily, které čtenáři „ukážou“, co má dělat. K některým obecným kategoriím technických popisů patří následující:

• Popisy mechanismů: poskytují podrobný přehled fyzikálních aspektů nástroje, stroje nebo jiného mechanického zařízení, které má pohyblivé části a je určeno k provádění určité funkce. Mohou to být popisy výrobků pro prodej nebo výrobu, dokumentace konstrukčních specifikací, info-grafika atd. Tato kapitola se podrobně zaměřuje na tento druh popisu.
• Popisy procesů: podrobně popisují řadu událostí (přírodních/biologických/ekologických, mechanických, sociálních nebo psychologických jevů), které se odehrávají v určitém sledu za účelem dosažení určitého výsledku. Lze je rozdělit na neinstrukční procesy (např. procesní analýzy fungování spalovacího motoru nebo přírodních procesů, jako je fotosyntéza) a instrukční procesy (např. doporučené/vyžadované postupy a explicitní pokyny krok za krokem, které je třeba dodržovat). (Podrobné informace o psaní instrukcí naleznete v části 7.7.)
• Definice: objasňují specifický význam, často související s konkrétním kontextem, nebo vyjadřují základní povahu definovaných pojmů. Jejich délka může být různá, od jednoduché vysvětlující věty až po rozsáhlý dokument o několika stranách. Definice budou často obsahovat podrobné popisy a vizuální obrázky pro ilustraci myšlenek. Kliknutím na níže uvedený odkaz si můžete prohlédnout studentskou prezentaci v aplikaci PowerPoint o tom, jak psát efektivní definice pro technické účely. Tato prezentace je zařazena s výslovným souhlasem studenta.

Definitions in Technical Writing – Sample student presentation (.pdf)

Popisy mechanismů by měly poskytnout jasnou představu o popisovaném objektu, včetně

• Všeobecného vzhledu a fyzikálních vlastností
• Celkové funkce/účelu
• Součástí
• Jak na sebe jednotlivé části vzájemně působí, aby vytvořily fungující celek.

Čtenář by měl být schopen si jasně představit, a tedy i pochopit, jaká je podstata popisovaného předmětu, co dělá a jak funguje.

Aby autor dosáhl této srozumitelnosti pro čtenáře, musí vybrat významné detaily a logicky uspořádat informace. Vybírejte detaily, které lze popsat přesně a měřitelně, například

V závislosti na potřebě čtenáře se popis může pohybovat od obecného přehledu vyžadujícího pouze několik vět až po příručku o několika kapitolách, která podrobně popisuje každý aspekt součástí a funkcí mechanismu za účelem řešení technických problémů a dokončení oprav. Zábavným příkladem je Star Trek: Nová generace: Technická příručka (obálka vyobrazená na obrázku 7.4.1), která obsahuje podrobný popis veškerého vybavení a technologií používaných na palubě fiktivního U.S.S. Enterprise-D.

Předtím, než začnete sestavovat popis, musíte zvážit svůj účel a publikum: Proč vaše publikum potřebuje tento popis? K čemu jej budou používat? Popisujete různé typy solárních panelů pro běžné spotřebitele, abyste jim pomohli vybrat ten, který nejlépe vyhovuje jejich potřebám? Poskytujete schémata technikům a instalatérům?“

Pokud máte jasně zaměřený účel a publikum, navrhněte popis, který bude obsahovat následující prvky:

1. Definice:
2. Přehled: Co to je a jaký je jeho hlavní účel?
3. Součásti: Popište celkovou podobu mechanismu („celkový obraz“): Popište hlavní součásti v označených částech; zde pečlivě zvažte pořadí informací. Vytvořte logickou souvislost mezi jednotlivými popisovanými součástmi.
4. Vysvětlení: Jak jednotlivé součásti spolupracují, aby plnily svou funkci? Jaké klíčové principy řídí jeho fungování? Zvažte, kolik podrobností je zde pro zamýšlené publikum nezbytné.
5. Vizualizace: Zahrňte grafiku, která jasně ilustruje mechanismus a/nebo jeho části. Zobrazte zařízení jako celek; zvažte zobrazení konkrétních detailů v rozšířených pohledech, výřezech nebo označených schématech. Můžete dokonce vložit nebo odkázat na videa, která ukazují zařízení v akci.
6. Závěr: V závislosti na účelu můžete uvést přehled historie výrobku, jeho dostupnosti, výroby, nákladů, varování atd.
7. Odkazy: Zdroje, které jste použili v popisu, nebo další dostupné zdroje informací (pokud jsou relevantní).

Můžete zvážit použití šablony, například níže uvedené šablony technického popisu, přičemž mějte na paměti, že šablony sice mohou být užitečným vodítkem, ale neposkytují velkou flexibilitu a nemusí se hodit pro všechny situace.

Příklady popisů

Podívejte se na popis „Pětky nahoře“ na obrázku 7.4.2 (klikněte na obrázek pro větší verzi). Komu by mohl být určen?“

Srovnejte popis na obrázku 7.4.2 s popisem v angličtině.4.2 s informacemi uvedenými na webových stránkách NASA o vozítku Mars Curiosity.

Všimněte si rozdílů v míře podrobnosti, slovní zásobě a celkovém účelu popisů. Pokud byste při vyplňování šablony technického popisu použili informace ze stránek NASA, mohlo by vám nakonec vzniknout něco jako následující tabulka. Cíle

Možná zjistíte, že některé z těchto prvků nejsou nutné; opět zvažte, co vaše cílová skupina již ví. Najděte rovnováhu mezi zbytečným uváděním zřejmých věcí a nesprávným předpokladem, že vaši čtenáři mají znalosti, které jim chybí.

Při upřesňování detailů vašeho popisu a jeho dílčích částí zvažte následující:

• Organizace: Pro uspořádání popisu použijte logický princip
  • Zhora dolů (nebo základem nahoru)
  • Zleva doprava (nebo zprava doleva)
  • Zevnitř ven (nebo zvenčí dovnitř)
  • Nejdůležitější vlastnosti od nejméně důležitých
  • Centrální součást od periferních
  • Vlastnosti materiálu atd.
• Jazyk: Používejte specifické, přesné a konkrétní termíny – vyhněte se vágním nebo příliš obecným termínům
  • Používejte správnou terminologii – definujte termíny podle potřeby publika
  • Používejte analogii k popisu neznámé věci pomocí známé věci
  • Používejte objektivní jazyk – žádné „reklamní řeči“ nebo subjektivní termíny
  • Používejte přítomný čas, aktivní slovesa, abyste popsali, jak zařízení vypadá a co dělá
  • Užívejte slova, která ve čtenářově mysli vytvářejí živé a konkrétní obrazy.

Vyberte si běžný, každodenní předmět (například jeden z předmětů na obrázku 7.4.3) a vypracujte technický popis pro posluchače, kteří tento předmět neznají. Začněte tím, že si představíte cílové publikum a účel, a pak zkuste vyplnit šablonu technického popisu podrobnými informacemi. Na základě informací uvedených v šabloně navrhněte krátký popis v rozsahu 1-2 odstavců a přidejte vhodně označené vizuální prvky.