Technické psaní sděluje čtenářům technické informace o dovednosti nebo produktu. Běžně se používá v technických a profesních oborech. Jako technický autor často píšete dokumenty, jako jsou uživatelské příručky, dokumentace aplikačního programovacího rozhraní (API) a příručky pro opravy a produkty.
Stejně jako ostatní oblasti psaní má technické psaní pokyny specifické pro tuto oblast. Dodržování těchto pokynů vám pomůže psát dobře strukturované dokumenty a optimalizovat způsob, jakým čtenáři rozumí vaší práci. Zde je několik pravidel, která je třeba dodržovat, abyste se stali dobrým technickým spisovatelem.
1. Definujte své publikum
Analýza publika je nepostradatelným faktorem dobrého technického dokumentu. Znát své publikum vám pomůže určit druh informací, o kterých chcete psát, jak byste je měli strukturovat a jak technicky je váš jazyk. Pro technické psaní existují čtyři hlavní cílové skupiny: vedoucí pracovníci, odborníci, technici a laici.
Vedoucí pracovníci jsou jednotlivci, kteří financují produkt a činí politická, administrativní a ekonomická rozhodnutí, která jej řídí. Technici jsou lidé, kteří tyto produkty vyrábějí, provozují a opravují. Odborníci navrhují, testují a vědí vše o produktu, zatímco nespecialisté jsou konečnými uživateli produktů. Musíte zvážit své publikum, abyste určili nejlepší tón a styl psaní, který použijete.
2. Identifikujte potřeby svého publika
Kromě znalosti a definování svého publika je důležité, abyste porozuměli jeho cílům, zájmům a potřebám. Dokončení analýzy publika je klíčové při přípravě dokumentu, protože je méně pravděpodobné, že budete psát bez škytavky a dobře znáte potřeby svého publika.
Chcete-li provést komplexní analýzu publika, musíte vzít v úvahu pozadí svého publika a stávající znalosti produkt, zkušenosti, potřeby, zájmy, demografické charakteristiky, kultura a komunikační preference a cíle. Tyto informace vám pomohou prezentovat vaše nápady co nejefektivněji a nejefektivněji.
3. Poznejte hranice znalostí svého publika
Jako techniku analýzy publika můžete využít průzkumy a dotazníky, abyste poznali hranice znalostí svého publika. Můžete také získat oblíbené názory a stereotypy, osobní zkušenosti, brainstorming a zpětnou vazbu od publika z marketingového oddělení.
Pokud správně využijete výše uvedené nástroje, budete vědět, jak moc vaše cílové publikum rozumí informacím, které hodláte sdělit. Tyto informace do značné míry určují strukturu, limity a rozsah vašeho dokumentu a dají vám představu o směru.
4. Udržujte svůj jazyk jednoduchý
Technické psaní má představovat příliš komplikované téma. Dělá to pomocí jednoduchého průvodce stylem psaní. Měli byste zajistit, aby průměrný čtenář snadno porozuměl vašemu psaní.
Musíte si však uvědomit, že porozumění publiku je také klíčové pro jazykový styl, který si zvolíte. Například odborný žargon v dokumentu o rozhraní pro programování aplikací (API) může být vhodné pro techniky, ale ne pro koncové uživatele. V důsledku toho musíte používat snadno srozumitelný jazyk, aby publikum lépe porozumělo. Můžete se také chtít učit jak používat nástroj, jako je Microsoft Editor zkontrolovat svou práci a ujistit se, že psaní je na místě.
5. Použijte obrysy
Obrysy dávají čtenářům představu o tom, co mohou v dokumentu očekávat. Dokument bez osnovy zahlcuje čtenáře, protože je nutí číst celý text, když mají zájem pouze o získání konkrétních znalostí.
Jako technickému spisovateli vám nastínění dokumentu také dává pocit směru při psaní. Udržuje vás na správné cestě a zajišťuje, že vám neuniknou nebo podceňujete relevantní body. Navíc vylepšuje strukturu vašeho dokumentu a slouží jako zpětná vazba k tomu, co máte v úmyslu pokrýt.
6. Používejte grafiku tam, kde je to nutné
Pozornost většiny čtenářů přirozeně přitahuje grafika ve srovnání s textem. V technických dokumentech může vhodná grafika zlepšit čtenářům porozumění textu tím, že informace podává jasně a důrazně.
Jako technický spisovatel byste si však měli dávat pozor, abyste nepoužívali grafiku ke zdobení dokumentů. Tabulky, grafy, tabulky, fotografie a ilustrace jsou běžně používanou grafikou a mohou zlepšit celkovou strukturu dokumentu a zaujmout čtenáře. To znamená, že pokud s Dokumenty Google začínáte, zde je jak vytvářet a upravovat tabulky v Dokumentech Google.
7. Zapojte své čtenáře
I když se možná snažíte svým čtenářům předat technické informace, je důležité, abyste je také zaujali. Každý technický dokument je zaměřen na čtenáře a měl by být napsán podle vkusu čtenáře, nikoli autora. Aby byl váš dokument užitečný, musí být uspokojena intelektuální zvědavost vašeho čtenáře.
Svého čtenáře můžete aktivně zapojit tím, že budete psát, abyste vyjádřili, nikoli zapůsobili, a přešli rovnou k věci. Vyhněte se zkratkám a žargonu, použijte hodně bílého místa ke zlepšení vizuální prezentace a používejte nadpisy jako vodítko pro čtenáře.
8. Neuvádějte odkazy na časově citlivé informace
Vždy je lepší se vyhnout odkazům na časově citlivé informace, zejména ze srovnatelného období. Je bezpečnější a moudřejší používat analýzu, která obstála ve zkoušce času, díky čemuž je stále zelená a vhodná pro ty, kteří budou váš dokument číst v budoucnu.
Musíte si také uvědomit, že připojení konkrétních let, jako je „2019“, ke zdůraznění vašeho názoru, může časem snížit užitečnost vašeho dokumentu, s výjimkou specifických případů. Tomu můžete zabránit použitím širšího časového rámce, jako je „V posledních sedmi letech“, čímž své práci dodáte úroveň důvěryhodnosti.
9. Použijte příslušné příklady
Při psaní technického dokumentu používejte živé instance ke zdůraznění svých bodů. Vzhledem k tomu, že vaše publikum čte vaše psaní, aby získalo dovednost, vyřešilo problém nebo se naučilo nějaké pokyny, musíte jim poskytnout praktické a použitelné příklady.
Tyto příklady zvyšují čitelnost vaší práce a sdělují vašemu čtenáři komplexní informace a poskytují kontext produktům a procesům. Tímto způsobem je pravděpodobnější, že budou používat produkty záměrně a bezpečně.
10. Před publikováním získejte recenzi třetí strany
Technický dokument by měl vždy projít procesem spolupráce, který zahrnuje autor a recenzenta. Recenze třetí strany pomáhá vytvářet dokument zaměřený na publikum, bezchybný a působivý.
Jako původní autor dokumentu jste možná před vytvořením konečného dokumentu napsali mnoho konceptů. Nicméně bez ohledu na to, jak dobrý váš dokument vypadá, nespoléhejte pouze na svůj důvtip.
Staňte se profesionálním technickým spisovatelem ještě dnes
Porozumění základním pravidlům, kterými se řídí technické psaní, vás učiní zdatnějšími a vysoce žádanými. Mnoho organizací ví, jak důležité je, aby jejich produkty nebo služby byly dobře propagovány koncovým uživatelům, a vaším cílem jako technického autora je pomoci jim toho dosáhnout.
