Ako učiť technické písanie?
Zvážte prepojenie organizácie učiteľov technického písania s inými učiteľmi technického písania.
Technické písanie je písanie, ktoré opisuje alebo vysvetľuje čitateľovi produkt, službu alebo nápad. Aj keď má technické písanie niektoré prvky spoločné s písaním esejí a žurnalistikou, je z oboch charakteristické. Technické písanie sa dá naučiť v práci, ale častejšie sa vyučuje na vysokých školách a seminároch. Výučba technického písania zahŕňa učenie študentov o ich význame, druhoch produkovaných dokumentov a cieľoch, o ktoré sa technickí autori usilujú. Nasledujúce kroky pokrývajú tieto aspekty.
Metóda 1 z 2: Príprava na vyučovanie technického písania
- 1Naučte študentov dôležitosť technického písania. Študenti musia porozumieť tomu, aké dôležité bude písanie v ich kariére, a tiež tomu, ako dôležité je, aby dobre písali.
- Zamestnanci nízkej úrovne môžu očakávať, že strávia až 20 percent svojho času písaním, pričom percento času stráveného písaním sa zvyšuje, keď stúpajú po firemnom rebríčku.
- Ako cituje Janet Van Wicklen v článku „Prečo Dick a Jane nevedia písať o zamestnaní“, európske podniky stratia ročne viac ako 0,70 miliardy EUR kvôli zle napísanej komunikácii.
- 2Oboznámte študentov s rôznymi dokumentmi, ktoré technickí spisovatelia produkujú. Technické písanie možno rozdeliť do niekoľkých podtypov, ako je popísané nižšie. Niektoré dokumenty môžu obsahovať prvky viac ako jedného podtypu, napríklad témy súvisiace s marketingom v súbore pomocníka.
- Inštruktážne písanie: Sem patria učebnice, používateľské a používateľské príručky, súbory pomocníka softvéru, príručky k postupu a články s návodmi. Účelom inštruktážneho písania je informovať, vysvetľovať a vzdelávať.
- Marketingové písanie: Patria sem letáky, brožúry, externé bulletiny, príspevky na sociálnych médiách a biele knihy. Aj keď účelom marketingového písania je predať toľko, koľko znamená informovať, štýl technického písania používaný na marketingové účely je ten, ktorý informuje, predáva sa rozprávaním namiesto zjavného presviedčania.
- Obchodná komunikácia: Patria sem interné bulletiny, listy, správy, podnikové poznámky, podnikový intranet a e -mail. Cieľom obchodnej komunikácie je komunikovať o zásadách, plánoch a pokroku spoločnosti tým, ktorí majú vlastný záujem na úspechu spoločnosti, či už ako zamestnanci alebo investori.
Aj keď má technické písanie niektoré prvky spoločné s písaním esejí a žurnalistikou, je z oboch charakteristické.
Metóda 2 z 2: ciele obsahu technického písania
- 1Snažte sa o prehľadnosť. Technický obsah písaného textu by mal osobe, ktorá ho číta, jasne porozumieť. Zle napísaný obsah môže viesť k rozbitiu zariadenia, nákladom na výmenu a prípadne buď k zraneniu majiteľa alebo k žalobe na spoločnosť - to všetko môže poškodiť vzťahy s verejnosťou.
- Jedným zo spôsobov, ako zaistiť zrozumiteľnosť, je použiť namiesto nejednoznačných výrazov konkrétne množstvá: „tri“ namiesto „niekoľko“, „každé štyri hodiny“ namiesto „často“, „pred týždňom“ namiesto „nedávno“ a podobne.
- Ďalším spôsobom, ako zaistiť zrozumiteľnosť, je použiť dané slovo na reprezentáciu rovnakého pojmu v celom dokumente. V súbore softvérovej pomoci by napríklad „obrazovka“ mala vždy odkazovať na obrazovku počítača, „okno“ by mala vždy odkazovať na hlavný displej softvérovej aplikácie a „dialógové okno“ alebo „dialógové okno“ by malo odkazovať na akúkoľvek plávajúcu časť. displeja, ktorý vyzve používateľa na odpoveď.
- 2Byť stručný. Na rozdiel od iných foriem písania má technické písanie pomôcť čitateľovi dosiahnuť cieľ, často v obmedzenom čase. Z tohto dôvodu technické písanie používa tak málo slov, koľko je potrebné na jeho vyjadrenie.
- Niektoré technické dokumenty sú stručné kvôli tomu, ako sú navrhnuté. Príručka majiteľa automobilu je napísaná stručne, pretože je navrhnutá tak, aby sa zmestila do priehradky v palubnej doske, zatiaľ čo používateľská príručka hodiniek je často navrhnutá tak, aby se vešla do pouzdra na hodinky.
- Technické písanie pre internet musí byť stručné, pretože mnohým čitateľom je ťažšie čítať text na obrazovke ako v tlači. Príchod tabletových počítačov a smartfónov tiež znamená, že mnoho čitateľov číta s obrazovkami menšími, než aké používajú stolné alebo prenosné počítače.
- Jeden zo spôsobov, ako byť stručný, je použiť čo najkratšie slovo, ktoré vyjadruje koncept: „použiť“ namiesto „využiť“, „vyskúšať“ namiesto „snažiť sa“, „to“ namiesto „aby som mohol“. Predložkové frázy môžu byť často nahradené jediným podstatným menom pred podstatným menom alebo úplne odstránené.
- Druhým spôsobom, ako byť stručný, je vynechať zbytočné slová. Niečo je jedinečné; nie je to „niečo jedinečné“, „skôr jedinečné“ alebo „veľmi jedinečné“.
- Tretí spôsob, ako byť stručný, je používať aktívny hlas namiesto pasívneho, kedykoľvek je to možné. Aktívny hlas používa akčné slovesá bez spájania slovies („technické písanie používa tak málo slov, koľko je potrebné“), zatiaľ čo pasívny hlas používa spojovacie slovesá ako „je“ alebo „bol“ s účasťou slovies („príručka majiteľa automobilu je napísaná stručne ").
- 3Rozložte dokument pre ľahké čítanie. Technické písanie kladie väčší dôraz na to, ako je obsah usporiadaný na stránke alebo obrazovke, ako na iné formy písania. Cieľom je predstaviť informácie tak, aby ich bolo možné rýchlo prečítať a porozumieť im. V technických dokumentoch sa môže používať jedna alebo všetky z nasledujúcich pomôcok:
- Obrázky, ako sú ilustrácie, fotografie a tabuľky.
- Biely priestor vo forme veľkorysých okrajov a blokových zárezov na identifikáciu dôležitého textu.
- Nadpisy a podpoložky na identifikáciu pojmov odsekov, ktoré za nimi nasledujú.
- Rôzne veľkosti a typy písma. Nadpisy a podnadpisy zvyčajne používajú väčšiu veľkosť bodu ako hlavný text a môžu mať odlišné písmo ako hlavný text.
- Formátovanie písma, ako je tučné písmo, podčiarknutie a kurzíva. Tieto sa často používajú konzistentným spôsobom na zdôraznenie, napríklad názvy virtuálnych tlačidiel na softvérových používateľských rozhraniach sú napísané tučným písmom.
- Zoznamy s odrážkami a číslované. Zoznamy s odrážkami často zdôrazňujú kľúčové body, zatiaľ čo číslované zoznamy často uvádzajú kroky podľa nasledujúceho postupu.
Na rozdiel od iných foriem písania má technické písanie pomôcť čitateľovi dosiahnuť cieľ, často v obmedzenom čase. - 4Spoznajte svoje publikum. Vedieť, kto bude čítať dokument, ktorý píšete, ovplyvní, ktoré slová si vyberiete kvôli zrozumiteľnosti a výstižnosti, a môže tiež rozhodnúť o tom, ako dokument rozložíte. Publikum je možné všeobecne opísať ako jeden z troch typov:
- High-tech rovesníci/odborníci na predmet. Títo čitatelia spravidla vedia o tejto téme rovnako veľa ako spisovateľ. Niekto, kto píše tomuto publiku, môže použiť žargón na túto tému bez toho, aby to vysvetlil.
- Nízko technologickí rovesníci/znalí ľudia. Títo čitatelia o tejto téme niečo vedia, ale nie toľko, ako autor. Niekto, kto píše tomuto publiku, môže použiť žargón súvisiaci s predmetom, ak je to správne vysvetlené.
- Laickí čitatelia/koncoví užívatelia. Títo čitatelia sú zákazníci, klienti, pacienti alebo ktokoľvek iný mimo podnikania. Niekto, kto píše tomuto publiku, by sa mal vyhnúť žargónu v prospech slov používaných na vysvetlenie tohto žargónu pre ľudí s nízkymi technológiami a možno bude musieť pridať aj ďalšie vysvetlenie.
- 5Buď presný. Technické písanie musí čitateľovi poskytnúť správne informácie, napísané správne. Predložené fakty musia byť správne, každá matematika musí byť správna a použitá gramatika musí byť správna, aby sa čitateľ sústredil na obsah bez toho, aby ho rozptyľovali chyby.
- Väčšina technického písania sa musí skúmať rovnakým spôsobom, akým sa skúmajú eseje na vysokých školách, a to prostredníctvom skúmania údajov, rozhovorov s odborníkmi a hľadania anekdot a príkladov.
- Hľadaj online zdroje, ktoré ti pomôžu s výučbou technického písania. Jeden zdroj je http://writing.engr.psu.edu/handbook/, ktorý organizuje zdroje podľa tém.
Výučba technického písania zahŕňa učenie študentov o ich význame, druhoch produkovaných dokumentov a cieľoch, o ktoré sa technickí autori usilujú. - Zvážte prepojenie organizácie učiteľov technického písania s inými učiteľmi technického písania. Jednou z takýchto skupín je Asociácia učiteľov technického písania (ATTW), ktorá vyrába knihy o výučbe technického písania, ako aj štvrťročný časopis a polročný spravodaj.
Prečítajte si tiež: Ako napísať osnovu príbehu?
