Technické psaní jako specifický způsob použití jazyka

Abstract

Rychlý rozvoj počítačových technologii ve dvacátém století vyústil v rostoucí potřebu technické dokumentace, která by popsala používání těchto nových technologií. Tato dokumentace se píše ve speciálním stylu,, lišícím se od stylu publicistického nebo akademického. Zatímco jiné styly psané pro širokou veřejnost používají metafory, alegorie, a jiné řečnické obraty, které mají na čtenáře zapůsobit, technické psaní používá jasný přímý jazyk, který jednoznačně popisuje fakta. Tento jednoduchý jazyk umožňuje aby byl obsah čitelný a pochopitelný i pro čtenáře kteří nejsou experty v oblasti, kterou text popisuje, a pro které angličtina není rodným jazykem. Tato bakalářská práce uvádí hlavní postupy používané v technickém psaní pro dosažení jednoduchosti a čitelnosti textu, a také různé druhy technické dokumentace a jejich popis. Jako ilustrace toho, jak jsou tyto postupy používané ve skutečné práci, tato bakalářská práce uvádí analýzu třech manuálů popisujících stejnou funkci: 1. Dokumentace konkrétní funkcionality open source projektu Foreman, která inspiruje obdobnou funkci Red Hat Satellite. 2. Přepracované instrukce, vytvořené jako návrh pro publikaci v oficiální dokumentaci Red Hat Satellite, ve stavu před kontrolou. 3. Zkontrolovaná a opravená verze, publikovaná v oficiální dokumentaci pro Red Hat Satellite.

The rapid development of computer technologies in the 21st century has resulted in the growth of needs for technical documentation describing how to use these new inventions. Documentation written in a style of technical writing differs enormously from texts in journalism, academic writing, or marketing styles. While other genres are written for the wide audience and they tend to be written in a lush language, using metaphors, allegories, and other tropes in order to impress the reader, technical writing uses a strict clear and straightforward language to express the idea unambiguously. Technical writing uses simple language in order to make the content readable and easily understandable even for those readers who study English as their second language and may not be experts in the field the text describes. This bachelor thesis describes the main tactics used in technical writing to write simply and clearly, as well as different types of technical writing and their description. As an illustration of how these tactics are used in a real working environment, the bachelor thesis outlines an analysis of three manuals describing the same feature: 1. A manual of the feature from documentation of a product Foreman that was taken as a basis for the Red Hat Satellite feature. 2. A reworked manual that was written as a preparation to be published to the official documentation of Red Hat Satellite. 3. The reviewed and approved document that now resides in Red Hat Satellite official documentation.