Co je technické psaní? Kompletní průvodce

Když si nevíte rady s novým přístrojem, sáhnete po návodu.

Když se při nastavování softwaru zaseknete, podívejte se na stránky nápovědy.

Když vaše auto vydává podivné zvuky, prolistujete příručku v přihrádce.

To vše jsou příklady technické psaní - něco, na co se spoléháme každý den, ale málokdy o tom přemýšlíme.

Podle portálu Glassdoor si technický spisovatel ve společnosti SpaceX vydělá od $88,000 až $138,000 ročně. 

Přesto většina lidí stále nechápe, co to vlastně technické psaní je.

Není to jen psaní na stroji pokyny.

Není to jen překlad inženýrské řeči do srozumitelné angličtiny.

A není to jen vytvoření uživatelské příručky nebo dokumenty nápovědy. 

Co je to technické psaní? Jak se liší od jiných typů psaní? Jaké jsou jeho různé formy? Jak se můžete stát technickým spisovatelem? A jak vám na této cestě může pomoci umělá inteligence? 

O tom všem - a o mnoha dalších věcech - se dočtete v tomto blogu. Pojďme se do toho ponořit! 

Co je technické psaní?

Laicky řečeno, technické psaní znamená vzít složitá a podrobná témata a vysvětlit je tak, aby je dokázal pochopit každý (se správnými znalostmi). 

Například, to zahrnuje:

• Uživatelské příručky - Ta brožura, která byla přiložena k telefonu? To je technické psaní.
• Dokumentace API - Devs potřebují také instrukce. Rozhraní API se nevysvětlují sama.
• Technické zprávy - Inženýři a vědci se na ně spoléhají při sdílení výzkumu a výsledků.

Technické psaní není jen to, co píšete, ale i to. jak ji napíšete. Používá:

• Imperativní nálada - Místo toho, aby "Měl bys kliknout na tlačítko," je to jen "Klikněte na tlačítko." 

• Pasivní hlas (v případě potřeby) - Pokud nezáleží na tom, kdo akci provedl, pomáhá pasivní hlas. "Soubor byl smazán" funguje lépe než "Někdo soubor smazal" pokud je na souboru zaostřeno.

Někteří lidé si myslí, že technické psaní je pouze psaní pro produkty SaaS nebo technické blogy. 

Nejde však o marketing nebo vyprávění příběhů. 

Technické psaní má velmi rozdílné typy (o nich bude řeč za chvíli) - všechny mají stejný účel: prezentovat informace přesným, jasným a funkčním způsobem. 

Jak se technické psaní liší od jiných stylů psaní

Pochopme šest aspektů, kterými se technické psaní liší od ostatních stylů psaní.

Tvůrčí spisovatelé používají dvojznačnost nebo metafory, aby do textu vnesli poutavý faktor pro publikum. 

Techničtí autoři se nesnaží o žádnou dvojznačnost. 

Chtějí upřednostnit srozumitelnost před tvůrčím vyjádřením, ale taková je povaha této práce. 

Proč je technické psaní v různých odvětvích nezbytné

Představte si, že pilot čte tuto příručku uprostřed letu, když potřebuje něco naléhavě pochopit:

"Upravte vektorování tahu tak, aby kompenzovalo asymetrickou anomálii pohonu zavedením protokolu standardní odchylky 5.3b s přihlédnutím k proměnným hustoty atmosféry."

Nebo si představte chirurga, který si chvíli před kritickou operací prohlíží pokyny k postupu: 

"Incizi provádějte rovnoběžně s fasciálními rovinami s ohledem na nervově-cévní struktury pod nimi, přičemž udržujte hemostázu v celé sekvenci disekce." 

I kdyby to byli lékaři nebo piloti, kteří to studovali celou svou kariéru, nechtěli by to v případě nouze číst. 

To vyvolává zmatek a frustraci, které by se každý rád vyhnul, ať už je situace jakákoli.

Podívejme se na pět hlavních důvodů, proč je technické psaní naprostou nezbytností: 

1. Snižování rizik a dodržování předpisů - V odvětvích, jako je zdravotnictví, finančnictví a letectví, jsou chyby nejen nákladné - mohou být i smrtelné. 
   • Například, Co když sestra špatně interpretuje pokyny k dávkování kvůli nejasné formulaci? Správná dokumentace těmto chybám předchází. 

2. Uchovávání a přenos znalostí - Lidé opouštějí zaměstnání, povyšují nebo odcházejí do důchodu. Co se ale stane se všemi znalostmi, které mají v hlavě? Jsou řádně zdokumentovány pomocí technického psaní. Dobře zdokumentovaný proces znamená, že další člověk může nastoupit, aniž by musel začínat od nuly.

3. Spokojenost zákazníků a snížení nákladů na podporu - Zkoušeli jste někdy nastavit nové zařízení a nakonec jste se podívali na náhodný návod na YouTube, protože návod nedával smysl? Špatná dokumentace frustruje zákazníky a zatěžuje týmy podpory zbytečnými hovory. Dobře napsaná příručka toto všechno ušetří. 

4. Právní ochrana - Smlouvy, zásady a bezpečnostní pokyny slouží jako důkazy ve sporech.
   • Například, pokud je společnost žalována za vadný výrobek, první, co právníci kontrolují, je dokumentace. Upozorňoval návod na rizika? Byly jasně popsány bezpečnostní postupy? Pokud ne, má společnost problémy.

5. Zvýšení efektivity díky standardizaci - Představte si společnost, kde každé oddělení používá pro stejný úkol jiný systém. Jeden tým sleduje data v tabulkách, druhý používá vlastní software a třetí si prostě "pamatuje věci". Je to nepořádek. Technické psaní zajišťuje, že procesy jsou standardizované, opakovatelné a škálovatelné.

Technické psaní ve své podstatě pomáhá předcházet zmatkům, šetří čas a zajišťuje bezpečnost lidí. 

Typy technického psaní (s příklady)

Mnoho lidí slyší "technické psaní" a okamžitě si vybavíte suché, robotické uživatelské příručky - takové, které nikdo nečte, pokud není úplně zaseknutý. 

Ale technické psaní je mnohem víc než to. 

Ve skutečnosti se vyskytuje téměř v každém odvětví a má mnoho různých forem, z nichž každá slouží jinému účelu.

Zde je šest nejdůležitějších typů technického psaní (s příklady):

1. Technická dokumentace - Jedná se o klasický typ. Obsahuje uživatelské příručky, návody k produktům a pokyny k řešení problémů.  
   • Například, Právě jste si koupili zbrusu nový kávovar a jste zmateni množstvím tlačítek. Místo hádání otevřete uživatelskou příručku a podle návodu krok za krokem připravíte svůj první šálek.
     
2. Procesní dokumentace - Každá společnost má pracovní postupy, ale pokud tyto pracovní postupy existují pouze v něčí hlavě, je to katastrofa, která se může stát. Tyto postupy se nazývají SOP. 
   • Například, Musíte udělat kvásek, který je charakteristický pro pekárny. Bez SOP by byl každý bochník jiný. Naštěstí SOP podrobně popisuje každý krok - přesné míry, dobu kynutí, teplotu pečení - pokaždé.
     
3. Dokumentace API - Pokud je software mozkem, Rozhraní API (Application Programming Interfaces) jsou nervovým systémem. 
   • Například, Aplikace pro sdílení jízd chce získat dopravní data v reálném čase, a proto integruje rozhraní API Map Google. Bez jasné dokumentace API by se potýkali s nekonečnými pokusy a omyly.
     
4. Vědecké/výzkumné práce - Píší je výzkumní pracovníci, ale musí být čitelné pro celý svět.  
   • Například, Nová léčba rakoviny vypadá slibně, ale před jejím použitím musí vědci zveřejnit výzkum o tom, jak funguje, jaké má vedlejší účinky a jaká je míra přežití. Ostatní tyto údaje přezkoumávají, aby je ověřili.
     
5. Bílé knihy a případové studie - Bílé knihy jsou "přesvědčivé argumenty" technického světa. Případové studie jdou ještě dál a ukazují úspěšné příběhy z reálného světa se skutečnými výsledky. 
   • Například, Firma zabývající se kybernetickou bezpečností varuje ve své bílé knize před novou bankovní hrozbou. O měsíc později sdílí případovou studii o tom, jak jejich nástroj zastavil útok. Banky začínají dávat pozor.
     
6. Dokumentace týkající se předpisů/splnění požadavků - Zdravotnictví, finančnictví a výroba se opírají o předpisy. Dokumenty o dodržování předpisů pomáhají společnostem dodržovat zákony a vyhnout se tak pokutám, žalobám a veřejným katastrofám.
   • Například, Farmaceutická společnost musí před prodejem nového léku proti bolesti prokázat, že je bezpečný. Aby se vyhnula jakýmkoli právním problémům, předkládá dokumenty, v nichž jsou uvedeny složky, dávkování a nežádoucí účinky.

Klíčové dovednosti potřebné pro technické psaní

Pokud jste někdy učili své prarodiče používat chytrý telefon, aniž by si připadali hloupě, pak se můžete stát technickým spisovatelem, protože to je základní dovednost.

Každou jinou dovednost se lze naučit. Zde je seznam dovedností, které musí mít technický spisovatel:

• Výzkumné schopnosti - Nemusíte vědět všechno, ale musíte vědět, jak najít přesné a spolehlivé informace.
  
• Analýza publika - To, že víte, kdo jsou vaši čtenáři, co už vědí a čeho potřebují dosáhnout, je to, co dělá vaše psaní užitečným. Protože způsob, jakým vysvětlíte aktualizaci softwaru vývojáři, není stejný jako způsob, jakým byste ji vysvětlili zákazníkovi.
  
• Jasná komunikace/jednoduché jazykové dovednosti - Technické psaní není o tom, abyste působili chytře, ale o tom, aby se ostatní cítili chytře. To znamená, že se zbavíte žargonu, budete používat jednoduchý jazyk a psát tak srozumitelně, aby čtenář nemusel hádat, co máte na mysli.
  
• Informační architektura - Čtenáři nečtou vždy od začátku do konce, ale skenují. Musíte pochopit, jak uspořádat obsah pomocí nadpisů, odrážek a logického toku, abyste informace snadno našli a strávili.
  
• Vizuální komunikace - Někdy obrázek vysvětlí něco rychleji než odstavec. Vývojové diagramy, komentované snímky obrazovky a infografiky mohou zjednodušit i ty nejzmatenější koncepty. Dobrý autor technických textů ví, kdy má psát a kdy ukázat.
  
• Znalost nástrojů - Znalost správných nástrojů tento proces urychluje. Mezi dokumentační softwary patří například MadCap Flare nebo Confluence a mezi návrhové nástroje Snagit nebo Figma.

• Dovednosti v oblasti editace a revize-První návrh není nikdy dokonalý. Techničtí autoři musí svou práci zdokonalovat, aby byla jasná, přesná a úplná, a zajistit, aby každé slovo sloužilo svému účelu. Jde o to, aby byl dokument co nejsnadněji použitelný.

Kdo používá technické psaní? (Odvětví, která ho potřebují)

Zde jsou čtyři hlavní odvětví, která vyžadují technické psaní nejvíce.

Jak se stát technickým spisovatelem 

Zde je průvodce krok za krokem, jak se dostat do tohoto oboru:

Krok # 1 - Naučte se základy

K tomu, abyste mohli začít, nepotřebujete mít vzdělání v oboru komunikace nebo angličtiny.

V této profesi se můžete uplatnit, i když jste učitel, novinář, inženýr nebo dokonce lékař.

Absolvujte kurzy a certifikace pro začátečníky Coursera, Udemy, nebo Kurz technického psaní Google. 

Sledujte oborové blogy, jako je  Psaní dokumentů a STC (Společnost pro technickou komunikaci).

Krok # 2 - Vytvoření portfolia

Vyberte si produkt, který denně používáte (např. kávovar, fitness aplikaci nebo chytrý reproduktor), a napište uživatelskou příručku nebo návod k řešení problémů. 

Bylo by to dokonalé? Ne. 

Mohli byste tak ukázat něco konkrétního? Určitě. 

Komunita open-source, jako je GitHub je otevřena novým technickým spisovatelům. 

Mnoho projektů zoufale potřebuje pomoc s dokumentací a nezáleží jim na tom, jestli jste nováček. 

Krok # 3 - Získejte pozici na základní úrovni

Zaměřte se na pozice s označením "junior" nebo "associate" v názvu na platformách, jako je např. LinkedIn, Vskutkua Pracujeme na dálku. 

Nepřehlížejte ani smluvní pozice - často je snazší je získat a mohou vést ke stálým pozicím.

Krok # 4 - Kariérní postup

Jakmile získáte důvěru a zkušenosti, usilujte o pozici senior technical writer, API writer nebo UX writer.

Seznamte se s nástroji, jako je MadCap Flarea Kyslík XML pro strukturované psaní nebo Markdown a Git pokud chcete spolupracovat s vývojáři. Nemusíte však zvládnout vše najednou.

Krok # 5 - Příprava na pohovor

• Mezi nejčastější otázky patří:
  • Jak zjednodušit složité téma? → Ukažte ukázku psaní před a po.
  • Jaké nástroje jste použili? Uveďte všechny.
  • Jak se vypořádáváte se zpětnou vazbou od inženýrů? → Uveďte skutečný nebo hypotetický příklad. 

Krok # 6 - Učte se dál a zvyšujte svou úroveň

Tento obor se neustále vyvíjí. Jeden rok všichni mluví o wiki, další rok o dokumentech jako kódu. 

Daří se lidem, kteří se dále vzdělávají. 

Sledujte TechWhirl a Cherryleaf pro trendy.

Začněte ještě dnes. Napište znovu návod k obsluze produktu, sdílejte ho na LinkedIn a požádejte o zpětnou vazbu.

Nástroje a software pro technické psaní

Nástroje umělé inteligence usnadňují a zefektivňují vaše úkoly - a v případě technického psaní tomu není jinak.

Zde jsou uvedeny nástroje pro technické psaní, které používají profesionálové:

1. Pro přípravu a úpravu obsahu:

1. MS Word umožňuje vytvářet profesionálně formátované dokumenty s přesnou kontrolou stylů, záhlaví a křížových odkazů. 
2. Dokumenty Google umožňuje více členům týmu pracovat na stejném dokumentu současně. 

2. Pro strukturovanou dokumentaci a publikování: 

1. MadCap Flare umožňuje udržovat jediný zdroj obsahu, který se automaticky publikuje do různých formátů. 
2. Adobe FrameMaker zpracovává vaši 500stránkovou technickou specifikaci se složitými tabulkami, specializovanými diagramy a křížovými odkazy. 

3. Pro týmovou dokumentaci:

1. Confluence se stane interní wiki vaší společnosti, kde různá oddělení udržují svou dokumentaci. 
2. Pojem pomáhá vašemu produktovému týmu organizovat dokumentaci společně s řízením projektu. 

4. Pro správu a sledování změn dokumentů:

1. GitHub umožňuje vývojářům aktualizovat dokumentaci současně se změnami kódu.
2. BitBucket se integruje s vaším CI/CD pipeline, takže se dokumentace automaticky sestavuje a nasazuje s každou verzí.

5. Pro výzkum, strukturu obsahu a lepší čitelnost:

1. Esej Writer vám pomůže zdokumentovat složitý algoritmus do příslušných souvislostí, vysvětlení a příkladů. 
2. SEO Writer zajistí, aby dokumentace pro veřejnost používala konzistentní terminologii a dodržovala osvědčené postupy pro srozumitelnost. 
3. AI Chat pomáhá vašemu technickému spisovateli zjednodušit složité koncepty. Navrhuje alternativní vysvětlení a identifikuje oblasti, kde by uživatelé mohli potřebovat další souvislosti. 

Jak může umělá inteligence zlepšit efektivitu technického psaní

Zde se dozvíte, jak vám může umělá inteligence pomoci v technickém psaní: 

1. Automatizace

Začít od prázdné stránky je těžké. Pro návrh počátečního obsahu na základě strukturovaných dat můžete použít umělou inteligenci.

Zkracuje čas potřebný k vytváření příruček, průvodců a zpráv. 

Jak na to...

Použijte nástroje AI, jako je Chatbot s umělou inteligencí vytvořit základní osnovy nebo dokonce první návrh.

Poté upřesněte jazyk pomocí terminologie specifické pro dané odvětví a zkontrolujte fakta. 

2. Gramatika a srozumitelnost

Pomocí nástrojů umělé inteligence zkontrolujte, zda se v textu nevyskytuje žargon, pasivní hlas a problémy se srozumitelností. 

Zde je návod, jak ji používat...

Projděte návrhy AI Paraphraser. Tento nástroj pomáhá přepisovat složité věty, navrhuje alternativy v jednoduchém jazyce a zlepšuje celkovou srozumitelnost.

3. Strukturování obsahu

Dobře strukturovaný dokument zabraňuje zmatkům.

Umělá inteligence dokáže logicky uspořádat obsah seskupením souvisejících témat, přidáním nadpisů a návrhem rozvržení. 

Zde je návod, jak ji používat.

Použijte náš AI Essay Writer vytvářet zprávy, příručky a dokumentaci.

Závěr

Techničtí spisovatelé překládají "řeč inženýrů" do "lidské řeči".

Díky nim mohou piloti bezpečně přistávat s letadly, aniž by museli za letu číst desetitisícistránkovou příručku, chirurgové se soustředí na záchranu životů, místo aby luštili záhadné pokyny, a vy můžete skutečně používat svůj luxusní kávovar, aniž byste v kuchyni nechtěně vytvořili gejzír. 

V našem složitém světě je jasná komunikace nezbytná.

Dobré technické psaní šetří čas, peníze, frustraci a někdy i životy (v lékařském a bezpečnostním kontextu).

V budoucnu se dočkáme více videí ve formě interaktivních průvodců a dokumentů, které se přizpůsobí vaší úrovni znalostí. 

Pokud si chcete vyzkoušet psaní odborných textů, vyberte si něco složitého, čemu dobře rozumíte - třeba jak funguje fotosyntéza, pravidlo o ofsajdu ve fotbale nebo dokonce jak připravit dokonalé suflé - a vysvětlete to kamarádovi co nejsrozumitelněji a nejjednodušeji. 

Pokud to pochopí namísto toho, aby se tvářili skelně, gratulujeme!

Objevili jste hlavní dovednost technického spisovatele: zjednodušit složité.

Potřebujete další pomoc? Nezjistitelná AI nástroje zdokonalují vaše psaní a udržují ho bezchybné. Vyzkoušejte je hned teď!

Neváhejte a prozkoumejte naše Detektor umělé inteligence a Humanizer ve widgetu níže!