Ako zvládnuť technické písanie?

Zamerajte sa vo svojich dokumentoch na rétorické znalosti a dizajn zameraný na používateľa. Okrem jednoduchého písania dokumentov, ktoré vysvetľujú proces alebo produkt, budú skúsení spisovatelia znalí rétoriky. To znamená, že môžete písať presvedčivo a výrečne o procese alebo produkte. Namiesto reprodukovania šablón alebo pokynov by ste mali zvážiť ciele a situácie okolo dokumentu. To vám umožní efektívnejšie komunikovať s cieľovým publikom a užívateľsky prívetivejším spôsobom vysvetliť proces alebo produkt. Bez ohľadu na to, aký typ technického dokumentu vytvárate, vždy by ste mali zvážiť svoje určené publikum a vytvoriť dokument zameraný na používateľa. Váš dokument tak bude pre čitateľa prístupný a zrozumiteľný. Ak chcete písať rétoricky, musíte dobre porozumieť rétorickej situácii dokumentu:

• Určte očakávania publika. Položte si otázku: aké informácie očakávajú moji čitatelia z tohto dokumentu? Aké informácie potrebujem poskytnúť čitateľom?
• Zamyslite sa nad charakteristikami publika. Zvážte, kto dokument číta. Je vaše publikum súčasťou rozhodovacieho procesu, pokiaľ ide o štýl a organizáciu dokumentov, akými sú zainteresované strany a manažment? Je obecenstvo široká verejnosť alebo priemerný čitateľ? Ako vlastnosti publika ovplyvňujú očakávania dokumentu? Písanie dokumentu pre publikum, ktoré je oboznámené s informáciami, vytvorí iný tón ako písanie dokumentu pre publikum, ktoré nie je špecializovaným ani bežným používateľom. Mali by ste tiež vziať do úvahy úroveň čítania vášho publika. Váš klient môže určiť úroveň čítania a vy by ste mali písať na túto úroveň čítania.
• Zvážte ciele publika. Čo plánuje váš čitateľ dosiahnuť? Čo by sa mal váš čitateľ z dokumentu naučiť? Mali by ste zaistiť, aby dokument obsahoval všetky potrebné informácie, ktoré umožnia čitateľovi dosiahnuť svoj cieľ alebo ciele.

Skúste usporiadať informácie na základe prístupu založeného na úlohách. Organizácia je kľúčovým prvkom silného technického spisovateľa a jedným z najjednoduchších spôsobov, ako organizovať prvotné informácie alebo údaje, je ich rozdelenie na niekoľko úloh, po ktorých nasledujú pokyny pre každú úlohu.

• Zvážte, koľko úloh obsahuje postup, o ktorom píšete. Úloha je polonezávislá skupina akcií v rámci postupu. Napríklad nastavenie hodín na rúre je jednou z úloh pri obsluhe rúry. Niektoré postupy neobsahujú viac ako jednu úlohu, napríklad výmenu žiarovky. Zložitejšie postupy, ako je prevádzka rúry alebo hľadanie žiarovky pre určité svietidlo, však obsahujú niekoľko úloh.
• Ak chcete zorganizovať dlhý zoznam úloh, zoskupte podobné alebo súvisiace úlohy dohromady do krokov. Potom zoskupte tieto kroky do fáz alebo fáz. Každý krok vo fáze alebo fáze očíslujte. Napríklad pre prevádzkovanie rúry, môžete mať jednu fázu s názvom zriadenie rúru, s krokmi na zasunutie do rúry k zdroju napájania, nastavenie hodín, potvrdenie nastavenie teploty, a skontrolujte, či je ventilátor a osvetlenie rúry správne fungovať, akonáhle rúra je zapojená.
• Informácie môžete tiež organizovať podľa nástrojov, a nie podľa úloh. Zvážte nástroje, ktoré má k dispozícii používateľ výrobku, napríklad používateľ rúry. Pri prístupe k nástroju môžete vytvoriť sekciu pre zdroj energie v rúre, hodiny rúry, nastavenie teploty, ventilátor a svetlo rúry. Použitie technického prístupu k technickému písaniu, ktoré nezahŕňa produkt alebo položku, však môže byť náročné. V technickom písaní často budete používať prístup k úlohám, najmä ak píšete o procese.

Používajte slovesá s aktívnym hlasom a akciou. Posilnite svoje používanie jazyka v dokumente tým, že použijete aktívny, nie pasívny hlas. Popis procesu aktívnym hlasom s akčnými slovesami dodá vášmu písmu bezprostrednosť a jasnosť.

• Napríklad, namiesto toho, aby ste začínali dokument o tom, ako ovládať rúru: „Zapojte rúru do zdroja napájania“, použite silnejšie sloveso ako „zástrčka“ alebo „pripojenie“. V aktívnych vetách môžete použiť aj iné akčné slovesá ako „Nastaviť hodiny rúry“, „Stanovte si ideálne nastavenie teploty“ a „Uistite sa, že ventilátor a osvetlenie rúry správne fungujú“.
• Tiež by ste mali zabezpečiť, aby vaše vety používali aktívny hlas čo najviac. Môžete mať vetu, ktorá používa pasívny hlas, napríklad: „Na dvere rúry by ste mali vyvinúť mierny tlak, aby ste sa presvedčili, že sú správne zatvorené.“ Upravte to na aktívny hlas, kde predmet vety vykoná akciu vo vete: „Ľahkým zatlačením na dvere rúry skontrolujte, či sú správne zatvorené.“

Pokiaľ je to možné, zjednodušte akékoľvek výrazy alebo frázy. Ak vo svojich dokumentoch používate žargón alebo slang, mali by ste zvážiť, či vaše publikum tomuto žargónu porozumie. Ak im žargón nie je známy, musíte tieto neznáme výrazy definovať alebo ich nahradiť zjednodušeným jazykom. Dobrou zásadou je nikdy nepoužívať dve slová, ak na to stačí jedno slovo. Zamerajte sa na zredukovanie jazyka na minimum, aby bol čitateľovi jasný podstatný význam a jeho význam nebol preplnený zbytočnými informáciami alebo výrazmi.

• Vyhnite sa zbytočnej zložitosti, ku ktorej dochádza pri použití formálnych výrazov, ktoré môžu čitateľa zmiasť alebo odhodiť. Napríklad namiesto zápisu „použiť“ môžete napísať „použiť“, namiesto „dokončiť“ môžete napísať „koniec“, namiesto „funkčnosti“ môžete napísať „funkciu“.
• Odborné termíny budú v dokumentoch často skrátené. Skratky by ste mali vždy vysvetliť, keď sú prvýkrát spomenuté v sekcii, a potom použiť skratku vo zvyšku sekcie, aby ste sa vyhli nadbytočnosti.

Integrujte grafické a vizuálne pomôcky. Mnoho dokumentov z technického písania je možné vylepšiť použitím grafiky alebo vizuálnych pomôcok, aby bol váš čitateľ zapojený a poskytol vizuálny príklad postupu. Je ťažké vysvetliť zložitý proces slovami a používanie ilustrácie môže vášmu čitateľovi pomôcť porozumieť tomuto procesu oveľa viac.

• Váš klient môže poskytnúť vizuálne pomôcky alebo grafiku, ktoré je potrebné integrovať do dokumentu s technickým písaním, alebo budete musieť tieto grafiky zadať externe ilustrátorovi. Ak váš klient ešte nevie o ich použití, navrhnite vizuálne pomôcky. Biely priestor za predpokladu, grafikou môžu rozbiť písomné pokyny a dať svojich čitateľov šancu stráviť informácií.

Dokumenty naformátujte podľa sprievodcu štýlom klienta. Väčšina klientov poskytne sprievodcu štýlom, ktorý načrtne ich očakávania od dokumentu z hľadiska jazyka, gramatiky, interpunkcie, syntaxe a štýlu. Pri formátovaní dokumentu s technickým písaním by ste mali vždy dodržiavať pokyny klienta. Vyhnite sa odosielaniu dokumentov, ktoré neboli správne naformátované alebo ktoré nedodržiavajú klientovu príručku štýlov. Bude to pôsobiť neprofesionálne a nedbalo.

Buďte pripravení na revízie a prepisy. Technické písomnosti často prechádzajú niekoľkými revíziami a prepismi, kým ich klient nepovažuje za konečné. So svojimi klientmi musíte udržiavať otvorenú komunikáciu, aby ste získali konečný dokument, s ktorým sú spokojní. Vyhnite sa osobným úpravám alebo revíziám. Pracujete pre klienta a píšete pre potreby klienta.

• Mnoho technických spisovateľov vytvára viacero verzií dokumentov, aby sledovali všetky revízie alebo úpravy. Možno pracujete na niekoľkých projektoch naraz, najmä ak ste technický spisovateľ na voľnej nohe, takže si svoje dokumenty usporiadajte, aby boli revízie jednoduché a rýchle.

Absolvujte kurz technického písania pre ďalšie vzdelávanie. Zlepšite svoje spisovateľské schopnosti v kurze ďalšieho vzdelávania o technickom písaní a získajte lepší prehľad o tom, ako ovládať technické písanie. Mnoho kurzov sa zameriava na konkrétne prvky technického písania, ako je informovanosť publika, organizácia informácií, používanie vizuálnych pomôcok a zjednodušenie jazyka podľa úrovne čítania publika.

• Zvážte, v ktorých oblastiach technického písania by ste sa chceli zlepšiť a ktorý kurz by bol najprínosnejší pri rozšírení vašej kvalifikácie technického spisovateľa.

Zúčastnite sa konferencie technického písania. Konferencie technického písania môžu byť dobrým miestom na stretnutie s inými spisovateľmi z tohto odvetvia a na nájdenie možného mentora, ktorý by vás sprevádzal vo vašej kariére. Buďte pripravení nadviazať kontakty na týchto konferenciách a nehanbite sa pred svojimi rovesníkmi. Mnoho konferencií tiež organizuje panely a semináre, ktoré vám pomôžu zlepšiť vaše existujúce technické znalosti v oblasti písania.