Technické písanie poskytuje čitateľom technické informácie o zručnosti alebo produkte. Bežne sa používa v technických a pracovných oblastiach. Ako technický autor často píšete dokumenty, ako sú používateľské príručky, dokumentácia aplikačného programovacieho rozhrania (API) a príručky na opravy a produkty.
Rovnako ako iné oblasti písania, aj technické písanie má pokyny špecifické pre túto oblasť. Dodržiavanie týchto pokynov vám pomôže písať dobre štruktúrované dokumenty a optimalizovať spôsob, akým čitatelia chápu vašu prácu. Tu je niekoľko pravidiel, ktoré treba dodržiavať, aby ste sa stali dobrým technickým spisovateľom.
1. Definujte svoje publikum
Analýza publika je nevyhnutným faktorom dobrého technického dokumentu. Poznanie svojho publika vám pomôže určiť druh informácií, o ktorých budete písať, ako by ste ich mali štruktúrovať a technickú stránku vášho jazyka. Existujú štyri hlavné cieľové skupiny pre technické písanie: vedúci pracovníci, odborníci, technici a laici.
Vedúci pracovníci sú jednotlivci, ktorí financujú produkt a robia politické, administratívne a ekonomické rozhodnutia, ktorými sa riadi. Technici sú ľudia, ktorí vyrábajú, prevádzkujú a opravujú tieto produkty. Odborníci navrhujú, testujú a vedia všetko o produkte, zatiaľ čo nešpecialisti sú konečnými používateľmi produktov. Pri určovaní najlepšieho tónu a štýlu písania musíte zvážiť svoje publikum.
2. Identifikujte potreby svojho publika
Okrem poznania a definovania svojho publika je dôležité, aby ste pochopili jeho ciele, záujmy a potreby. Dokončenie analýzy publika je kľúčové pri príprave dokumentu, pretože je menej pravdepodobné, že budete písať bez problémov a dobre poznáte potreby svojho publika.
Ak chcete vykonať komplexnú analýzu publika, musíte vziať do úvahy zázemie svojho publika a existujúce znalosti produkt, skúsenosti, potreby, záujmy, demografické charakteristiky, kultúrne a komunikačné preferencie a Ciele. Tieto informácie vám pomôžu čo najefektívnejšie a najefektívnejšie prezentovať vaše nápady.
3. Spoznajte hranice vedomostí svojho publika
Ako techniku analýzy publika môžete využiť prieskumy a dotazníky, aby ste poznali hranice vedomostí svojho publika. Môžete tiež získať populárne názory a stereotypy, osobné skúsenosti, brainstorming a spätnú väzbu publika z marketingového oddelenia.
Ak správne využijete vyššie uvedené nástroje, budete vedieť, do akej miery vaša cieľová skupina rozumie informáciám, ktoré chcete sprostredkovať. Tieto informácie vo veľkej miere určia štruktúru, limity a rozsah vášho dokumentu, čo vám poskytne zmysel pre smer.
4. Udržujte svoj jazyk jednoduchý
Technické písanie má predstavovať príliš komplikovanú tému. Robí to pomocou jednoduchého sprievodcu štýlom písania. Mali by ste zabezpečiť, aby priemerný čitateľ ľahko porozumel vášmu písaniu.
Musíte si však uvedomiť, že porozumenie publiku je tiež kľúčové pre jazykový štýl, ktorý si vyberiete. Napríklad odborný žargón v dokumente o aplikačné programovacie rozhrania (API) môže byť vhodné pre technikov, ale nie pre koncových používateľov. V dôsledku toho musíte používať ľahko zrozumiteľný jazyk, ktorý pomôže publiku porozumieť. Môžete sa tiež chcieť naučiť ako používať nástroj ako Microsoft Editor aby ste skontrolovali svoju prácu a ubezpečili sa, že písmo je správne.
5. Použite obrysy
Obrysy poskytujú vašim čitateľom predstavu o tom, čo môžu od dokumentu očakávať. Dokument bez osnovy zahlcuje čitateľov, pretože ich núti čítať celý text, keď im ide len o získanie konkrétnych vedomostí.
Ako technickému autorovi vám načrtnutie dokumentu tiež dáva zmysel pre smer pri písaní. Udržuje vás na správnej ceste a zaisťuje, že vám neuniknú alebo podceníte relevantné body. Okrem toho vylepšuje štruktúru vášho dokumentu a slúži ako spätná väzba k tomu, čo chcete pokryť.
6. Použite grafiku tam, kde je to potrebné
Pozornosť väčšiny čitateľov prirodzene priťahuje grafika v porovnaní s textom. V technických dokumentoch môže vhodná grafika zlepšiť čitateľom porozumenie textu tým, že informácie prezentuje jasne a dôrazne.
Ako technický spisovateľ by ste si však mali dávať pozor, aby ste nepoužívali grafiku na zdobenie dokumentov. Tabuľky, grafy, tabuľky, fotografie a ilustrácie sú bežne používanou grafikou a môžu zlepšiť celkovú štruktúru dokumentu a osloviť čitateľov. To znamená, že ak ste novým používateľom Dokumentov Google, tu je ako vytvárať a upravovať tabuľky v Dokumentoch Google.
7. Zapojte svojich čitateľov
Aj keď sa možno snažíte sprostredkovať svojim čitateľom technické informácie, je dôležité, aby ste ich aj zaujali. Každý technický dokument je zameraný na čitateľa a mal by byť napísaný podľa vkusu čitateľa a nie autora. Aby bol váš dokument užitočný, musí byť uspokojená intelektuálna zvedavosť vášho čitateľa.
Svojho čitateľa môžete aktívne zaujať písaním, aby ste vyjadrili, nie zapôsobili a prešli priamo k veci. Vyhnite sa skratkám a žargónu, použite veľa bieleho miesta na zlepšenie vizuálnej prezentácie a použite nadpisy na usmernenie svojho čitateľa.
8. Neuvádzajte informácie citlivé na čas
Vždy je lepšie vyhnúť sa odkazom na časovo citlivé informácie, najmä tie z porovnateľného obdobia. Bezpečnejšie a rozumnejšie je použiť analýzu, ktorá obstála v skúške času, vďaka čomu je stále zelená a vhodná pre tých, ktorí budú čítať váš dokument v budúcnosti.
Musíte tiež poznamenať, že pripojenie konkrétnych rokov, napríklad „2019“, na zdôraznenie vášho názoru, môže časom znížiť užitočnosť vášho dokumentu, s výnimkou špecifických prípadov. Môžete tomu zabrániť tak, že použijete širší časový rámec, napríklad „Za posledných sedem rokov“, čím dodáte svojej práci úroveň dôveryhodnosti.
9. Použite príslušné príklady
Pri písaní technického dokumentu používajte živé inštancie na zdôraznenie svojich bodov. Keďže vaše publikum číta vaše písanie, aby získalo zručnosť, vyriešilo problém alebo sa naučilo nejaké pokyny, musíte im poskytnúť praktické a relevantné príklady.
Tieto príklady zlepšujú čitateľnosť vašej práce a komunikujú komplexné informácie vášmu čitateľovi, čím poskytujú kontext k produktom a procesom. Týmto spôsobom je pravdepodobnejšie, že budú používať produkty úmyselne a bezpečne.
10. Pred zverejnením získajte recenziu od tretej strany
Technický dokument by mal vždy prejsť procesom spolupráce, ktorý zahŕňa autora a recenzenta. Recenzia od tretej strany pomáha vytvárať dokument zameraný na publikum, bezchybný a pôsobivý.
Ako pôvodný autor dokumentu ste pred vytvorením konečného dokumentu mohli napísať veľa konceptov. Napriek tomu, bez ohľadu na to, aký dobrý bude váš dokument, nespoliehajte sa len na svoj um.
Staňte sa profesionálnym technickým spisovateľom ešte dnes
Pochopenie základných pravidiel, ktorými sa riadi technické písanie, vás urobí skúsenejšími a veľmi vyhľadávanými. Mnohé organizácie vedia, aké dôležité je, aby sa ich produkty alebo služby dobre predávali koncovým používateľom, a vaším cieľom ako technického autora je pomôcť im to dosiahnuť.
