Technické psaní

Tato kapitola se zaměřuje na návrh – druh dokumentu, který vám nebo vaší organizaci zajistí schválení nebo najmutí na realizaci projektu.

V kurzu technického psaní je úkol návrhu příležitostí, abyste konkrétnímu, jmenovitě určenému publiku představili svůj nápad, který má zlepšit určitý aspekt dané společnosti, organizace, střediska nebo jiné činnosti. Ať už si zvolíte jakékoli téma, musíte být schopni provést důkladný odborný výzkum, který zapracujete do závěrečné zprávy.

Pro začátek plánování návrhu si připomeňte základní definici: návrh je nabídka nebo nabídka na realizaci projektu pro někoho. Návrhy mohou obsahovat další prvky – technické podklady, doporučení, výsledky průzkumů, informace o proveditelnosti atd. Co však dělá návrh návrhem, je to, že žádá publikum o schválení, financování nebo udělení povolení k provedení navrhovaného projektu.

Návrh by měl obsahovat informace, které by publiku tohoto návrhu umožnily rozhodnout, zda projekt schválí, zda vás schválí nebo najme k provedení práce, případně obojí. Chcete-li napsat úspěšný návrh, vžijte se do role svého publika – příjemce návrhu – a zamyslete se nad tím, jaké druhy informací by tato osoba potřebovala, aby se cítila jistá, že vás nechá projekt realizovat.

Je snadné se v návrzích, nebo alespoň v typech návrhů, které budete v této třídě psát, ztratit. Představte si, že máte úžasný nápad na instalaci nějaké nové technologie v místě, kde pracujete, a sepíšete dokument, ve kterém vysvětlíte, jak funguje, ukážete její výhody a pak budete naléhat na vedení, aby ji nainstalovalo. Je to návrh? Sám o sobě by to nebyl úplný návrh. Byla by to spíše zpráva o proveditelnosti, která zkoumá výhody projektu a pak doporučuje pro nebo proti. Nicméně k tomu, aby se tento dokument stal návrhem, by stačilo přidat prvky, které žádají vedení o schválení, abyste mohli v projektu pokračovat. Pro tuto třídu je navíc jedním z těchto prvků vědecký výzkum. Jistě, někteří pisatelé návrhů musí prodat projekty, které navrhují, ale ve všech případech musí návrhy prodat pisatele (nebo jeho organizaci) jako toho, kdo projekt dokončí.

Typy návrhů

Přemýšlejte o situacích, ve kterých se návrhy vyskytují. Společnost může rozeslat veřejné oznámení s žádostí o návrhy na konkrétní projekt. Toto veřejné oznámení – tzv. žádost o návrhy (RFP) – může být zveřejněno prostřednictvím webových stránek, e-mailů, sociálních médií, novin nebo odborných časopisů. Firmy nebo jednotlivci, kteří mají o projekt zájem, by pak napsali návrhy, v nichž by shrnuli svou kvalifikaci, harmonogramy a náklady projektu a diskutovali o svém přístupu k projektu. Příjemce všech těchto návrhů by je pak vyhodnotil, vybral nejlepšího kandidáta a následně vypracoval smlouvu.

Návrhy však vznikají i mnohem méně formálně. Představte si, že máte zájem o realizaci nějakého projektu v práci (například zkoumání výhodnosti zavedení nějaké nové technologie pro zvýšení produktivity). Představte si, že jste se sešli se svou nadřízenou a snažili se ji o tom přesvědčit. Možná zareaguje slovy: „Napište mi návrh a já ho předložím vyššímu vedení“. To je spíše typ návrhu, který budete psát v kurzu technického psaní.

Většinu návrhů lze rozdělit do několika kategorií:

• Interní, externí: Návrh určený někomu uvnitř vaší organizace (podniku, vládní agentuře atd.) je interní návrh. U interních návrhů se může stát, že v nich nebudete muset uvádět některé části (např. kvalifikaci) nebo tolik informací. Externí návrh je návrh psaný od jedné samostatné, nezávislé organizace nebo jednotlivce jinému takovému subjektu. Typickým příkladem je návrh nezávislého konzultanta na provedení projektu pro jinou firmu. Je pravděpodobné, že v této třídě budete psát jeden z těchto dvou druhů návrhů, a to vyžádaný nebo nevyžádaný, jak je vysvětleno níže.
• Vyžádaný, nevyžádaný: Vyžádaný návrh je takový, u kterého si příjemce návrh vyžádal. Obvykle společnost rozesílá žádosti o návrhy (RFP) poštou nebo je zveřejňuje v některém zpravodajském zdroji. Návrhy však mohou být vyžádané i na velmi lokální úrovni: můžete například svému šéfovi vysvětlovat, jak skvělá věc by byla instalace nové technologie v kanceláři; šéfa to může zaujmout a požádat vás o sepsání návrhu, který nabídne provedení formální studie tohoto nápadu. Nevyžádané návrhy jsou takové, u nichž příjemce o návrhy nepožádal. U nevyžádaných návrhů musíte někdy příjemce přesvědčit, že problém nebo potřeba existuje, než můžete začít s hlavní částí návrhu. Většina projektů technického psaní, se kterými jsme se v této třídě setkali, byly nevyžádané návrhy.

Typické scénáře návrhu

Mnozí z vás možná nikdy nepřemýšleli o tom, že by vytvořili technickou zprávu na základě životaschopného návrhu. Na zadávacím listu je uvedeno několik vzorových námětů; zde je několik dalších nápadů:

• Představte si, že nějaká společnost má problém nebo chce provést nějaké zlepšení. Společnost rozešle žádost o návrh; vy ji obdržíte a odpovíte na ni návrhem. Nabídnete se, že přijdete, provedete šetření, rozhovor, vypracujete doporučení – a to vše předložíte ve formě zprávy.
• Organizace chce seminář s vašimi odbornými znalostmi. Napíšete návrh na uspořádání semináře – součástí nabídky je průvodce nebo příručka, kterou obdrží účastníci semináře.
• Agentura právě začala používat nový online datový systém, ale uživatelská příručka je technicky složitá a obtížně čitelná. Od této agentury obdržíte žádost o vypracování zjednodušené příručky nebo průvodce pro spuštění.
• Představte si, že nezisková organizace zaměřená na určitou problematiku chce konzultanta, který by napsal příručku nebo průvodce pro její členy. Tento dokument bude podávat informace o dané problematice způsobem, který bude členům srozumitelný.

Ne všechna výzkumná témata jsou vhodná pro technické psaní. Témata, která vycházejí z hodnot a přesvědčení, nespadají do kategorie technických. Historická a literární témata do této kategorie nepatří. Před zahájením práce na projektu se vždy poraďte se svým vyučujícím o všech nápadech na téma, které máte.

Kromě toho mějte na paměti, že do závěrečné zprávy musíte začlenit odborný výzkum, vyberte si téma, ke kterému můžete snadno najít takové materiály. Rozhovory a jiné zdroje z první ruky jsou sice pro zprávu často cenné, ale zpráva, která se na tyto zdroje ve velké míře spoléhá, nebude splňovat výstupy tohoto kurzu.

Obvyklé části návrhů

Následující text poskytuje přehled částí, které se běžně vyskytují v návrzích, předkládaných v této třídě ve formátu memoranda. Nepředpokládejte, že každá z nich musí být ve skutečném návrhu, který píšete, ani že musí být v pořadí, v jakém jsou zde uvedeny. Podívejte se do zadávacího listu a zvažte další druhy informací, které jsou pro vaše téma jedinečné a které by měly být ve vašem konkrétním návrhu obsaženy.

Při čtení této kapitoly o návrzích si prohlédněte vzorový memo návrh, který sdílíme ve složce naší jednotky v aktuálním týdnu. Opět mějte na paměti, že ne všechny zde probírané části se v příkladech objeví, ale většina ano.

Úvod. Úvod svého návrhu pečlivě naplánujte. Ujistěte se, že obsahuje všechny následující věci (ale ne nutně v tomto pořadí), které se týkají vašeho konkrétního návrhu:

• Uveďte, že obsahem memoranda je návrh konkrétního projektu.
• Vypracujte alespoň jednu stručnou motivační větu, která příjemce povzbudí, aby četl dál a zvážil schválení projektu (zejména pokud se jedná o nevyžádaný nebo konkurenční návrh).
• Uveďte přehled obsahu návrhu.

Odůvodnění problému, příležitosti nebo situace. Část o pozadí, která se často vyskytuje hned po úvodu, pojednává o tom, co vyvolalo potřebu projektu – jaký problém, jaká příležitost existuje pro zlepšení věcí, jaká je základní situace. Například vedení řetězce center denní péče může potřebovat zajistit, aby všichni zaměstnanci uměli resuscitovat, protože to vyžadují nové státní předpisy, nebo majitel pozemků s borovicovým dřevem ve východním Oregonu může chtít, aby pozemky produkovaly prodejné dřevo, aniž by ničily životní prostředí.

Ačkoli jmenované publikum návrhu může znát problém velmi dobře, napsání oddílu o pozadí je užitečné pro demonstraci vašeho konkrétního pohledu na problém. Také pokud je návrh nevyžádaný, je oddíl o pozadí téměř povinný – pravděpodobně budete muset přesvědčit publikum, že problém nebo příležitost existují a že by se měly řešit.

Přínosy a proveditelnost navrhovaného projektu. Většina návrhů stručně pojednává o výhodách nebo přínosech realizace navrhovaného projektu. Působí to jako určitý druh argumentu ve prospěch schválení projektu. Některé návrhy také pojednávají o pravděpodobnosti úspěchu projektu. V nevyžádaném návrhu je tato část obzvláště důležitá – snažíte se posluchačům projekt „prodat“.

Popis navrhované práce (výsledky projektu). Většina návrhů musí popisovat konečný produkt navrhovaného projektu. V kurzu technického psaní to znamená popsat písemný dokument, který navrhujete napsat, jeho publikum a účel; poskytnout osnovu a probrat takové věci, jako je jeho délka, grafika, vazba atd. Ve vámi definovaném scénáři může jít o další práci, jako je vedení školicích seminářů nebo poskytování průběžné služby. V této rané fázi možná nevíte, co všechno bude k dokončení projektu potřeba, ale měli byste mít alespoň představu o některých potřebných krocích.

Metoda, postup, teorie. V některých návrzích budete muset vysvětlit, jak budete postupovat při dokončení navrhované práce. To působí jako další přesvědčovací prvek; ukazuje to publiku, že máte k projektu rozumný a promyšlený přístup. Slouží také k prokázání toho, že máte dostatečné znalosti v dané oblasti, abyste mohli projekt dokončit.

Rozvrh. Většina návrhů obsahuje část, která uvádí nejen předpokládané datum dokončení, ale také klíčové milníky projektu. Pokud děláte rozsáhlý projekt rozložený do mnoha měsíců, časový plán by měl také uvádět data, kdy budete dodávat zprávy o postupu prací. Pokud nemůžete uvést konkrétní data, uveďte časové částky pro jednotlivé fáze projektu.

Náklady, potřebné zdroje. Většina návrhů obsahuje také oddíl s podrobným popisem nákladů na projekt, ať už interních, nebo externích. U externích projektů může být nutné uvést hodinové sazby, předpokládané hodiny, náklady na vybavení a spotřební materiál atd. a poté vypočítat celkové náklady na celý projekt. Interní projekty samozřejmě nejsou zadarmo, takže byste i tak měli uvést náklady na projekt: hodiny, které budete potřebovat k dokončení projektu, vybavení a zásoby, které budete používat, pomoc dalších lidí v organizaci atd.

Závěry. Závěrečný odstavec nebo oddíl návrhu by měl čtenáře opět přivést k zaměření na pozitivní aspekty projektu. V závěrečné části je můžete vyzvat, aby se s vámi spojili a dořešili podrobnosti projektu, připomenout jim výhody realizace projektu a možná uvést poslední argument pro vás nebo vaši organizaci jako správnou volbu pro projekt.

Speciální části týkající se projektu. Nezapomeňte, že předchozí oddíly jsou typické nebo běžné v písemných návrzích, nikoli absolutní požadavky. Vždy si položte otázku, co dalšího může vaše publikum potřebovat, aby pochopilo projekt, jeho potřebu, přínosy z něj plynoucí, vaši roli v něm a vaši kvalifikaci pro jeho realizaci. Co ještě potřebují vidět, aby projekt schválili a aby vás schválili k jeho realizaci?“

Speciální požadavky na zadání

V závislosti na situaci psaní může být nutné, aby váš návrh obsahoval i další specializované prvky. Některé z nich jsou popsány níže. Poznámka: některé z těchto prvků budou skutečně vyžadovány ve vaší průběžné zprávě pro tuto třídu; v reálné situaci technického psaní vás však váš nadřízený může požádat, abyste do svého návrhu zahrnuli některý z následujících prvků:

Audience: Popište publikum závěrečné zprávy (které se může lišit od publika návrhu). Možná budete muset probrat, pro koho je zpráva určena, jejich tituly a pracovní pozice, jejich technické zázemí a jejich schopnost porozumět zprávě.

Zdroje informací: Uveďte seznam informačních zdrojů; ujistěte se, že máte k dispozici dostatečné množství informací k vašemu tématu; uveďte citace konkrétních knih, článků, referenčních děl, jiných druhů zdrojů, o kterých si myslíte, že přispějí k vaší zprávě.

Grafika: Vyjmenujte grafické prvky, o kterých si myslíte, že je vaše zpráva bude potřebovat, podle jejich typu a obsahu. (Pokud vás nenapadá žádná, kterou by vaše zpráva potřebovala, možná nemáte dobré téma – proveďte brainstorming s vyučujícím). Pro tuto třídu budete muset vytvořit a zahrnout grafiku do své závěrečné zprávy.

Outline: Připojte osnovu témat a podtémat, o kterých si myslíte, že se jimi budete ve své zprávě zabývat.

Návrhy a publikum

Pamatujte, že v kurzu technického psaní slouží zadání návrhu k několika účelům: (1) dává vám určité zkušenosti s psaním návrhu; (2) umožňuje vám začít plánovat semestrální zprávu; (3) dává vašemu vyučujícímu možnost pracovat s vámi na vašem projektu, aby se ujistil, že máte životaschopné téma. Z druhého a třetího důvodu musíte do svého návrhu zahrnout specifické prvky (jak je uvedeno v zadání), z nichž některé se v reálném návrhu nemusí zdát vhodné.

V tomto kurzu technického psaní je návrh začátkem několikatýdenního procesu výzkumu a psaní, který prochází mnoha fázemi, až se dostane do konečného bodu: technické zprávy. Během tohoto procesu předkládáte návrh pouze jednou. Poté budete psát a předkládat různé typy dokumentů: zprávu o postupu prací, osnovu, anotovanou bibliografii, grafický návrh, návrh zprávy a závěrečnou zprávu. Dávejte pozor, abyste termín „návrh“ používali pouze v případě, že máte na mysli konkrétně počáteční fázi projektu.

Další bod, který je třeba mít na paměti, se týká publika pro návrhy oproti publiku pro zprávy, které přicházejí později v procesu psaní. Publikum pro váš návrh je osoba, která může schválit, podpořit a případně financovat váš výzkum a psaní. Závěrečná zpráva, kterou vypracujete, může být určena jinému publiku. Vezměme si příklad návrhu napsaného nadřízenému ve společnosti zabývající se solární energií, který navrhuje vytvoření příručky zásad pro montážníky solárních panelů v domácnostech. Publikem návrhu může být vedoucí pracovník, jehož znalosti technických aspektů mohou být velmi široké. Na druhou stranu publikem závěrečné zprávy jsou technici, kteří mohou mít specializovanější znalosti než vedoucí pracovník. Obsah a jazyk použitý pro tato dvě různá publika bude třeba upravit tak, aby odpovídal situaci při psaní. (Více informací o této problematice najdete v kapitole Analýza publika.)

Kontrolní seznam pro revizi návrhů

Při revizi a revizi návrhu mějte na paměti následující:

• Používejte správný formát. Nezapomeňte, že pro tuto třídu píšete tento návrh ve formátu poznámky.
• Napište jasné shrnutí (nebo úvod k) tématu vašeho návrhu.
• Určete, co přesně navrhujete udělat.
• Ujistěte se, že zpráva – písemný dokument – je nějakým způsobem zapojena do projektu, který navrhujete udělat. Nezapomeňte, že v tomto kurzu technického psaní si jednak procvičujeme psaní návrhů, jaké se dělají v reálném světě, jednak dokončujeme výzkumný projekt na vysokoškolské úrovni.
• Ujistěte se, že oddíly vašeho návrhu jsou v logickém, přirozeném pořadí a že správně používáte mezititulky a odrážky (a případné další styly formátování).
• Aresetujte návrh svému jmenovanému publiku – ne svému vyučujícímu.

Informace o připsání kapitoly

.