Ako vytvoriť technické písanie titulkov?
Vytváranie titulkov technického písania si vyžaduje určité zamyslenie a porozumenie materiálu i publika, ktoré ho budú čítať; kroky na vytvorenie nadpisov sú popísané nižšie.
Účelom technického písania je vysvetliť veci jasným, stručným a úplným spôsobom, aby čitateľ rýchlo porozumel predloženým informáciám. Na dosiahnutie tohto cieľa je často potrebné rozdeliť veľký blok informácií na menšie časti a každý kus označiť identifikačným nadpisom. Tieto titulky alebo nadpisy oboznamujú čitateľa s odsekmi, ktoré nasledujú, a zároveň zodpovedajú celkovému účelu dokumentu, ktorého sú súčasťou. Vytváranie titulkov technického písania si vyžaduje určité zamyslenie a porozumenie materiálu i publika, ktoré ho budú čítať; kroky na vytvorenie nadpisov sú popísané nižšie.
Metóda 1 z 2: Plánovanie vášho technického dokumentu
- 1Zistite, kto je váš čitateľ. Publikum pre váš dokument a titulky, ktoré vytvoríte, aby ho pomohli pri jeho prezentácii, určia, aké informácie budete prezentovať a ako ich budete štruktúrovať. Napríklad príručka pre rýchly štart pre softvérové aplikácie vyžaduje jednoduchšie jazyk, stručnejšia vety a menej cudzí materiál, než má papier na vedeckom časopise.
- V mnohých prípadoch, ak píšete pre internú „diskurzívnu komunitu “, ako je škola, nemocnica alebo vládna agentúra, dostanete sprievodcu štýlom spoločnosti alebo agentúry, ktorý podrobne popisuje formátovanie dokumentov pre ľudí, ktorí budú čítať váš práca.
- 2Zistite, čo váš čitateľ potrebuje vedieť. Aj keď ste pri príprave dokumentu urobili veľké množstvo výskumu, nie všetky informácie je potrebné predložiť vopred. Niekto, kto potrebuje vedieť, ako vymeniť sviečku, nemusí poznať úplnú históriu spaľovacieho motora. Potrebuje však poznať správny typ náhradnej zástrčky, kam zástrčka smeruje, a správny nástroj, ktorý treba použiť na vybratie starej zástrčky a jej výmenu za novú.
- 3Usporiadajte dokument tak, aby vyhovoval potrebám vášho čitateľa. Väčšina čitateľov číta technické dokumenty a hľadá riešenia svojich problémov, napríklad ako obsluhovať kosačku na trávu, ako používať funkciu Sledovať zmeny v programe Microsoft Word, čo robiť, keď sa na ich aute rozsvieti kontrolka „Check Engine “. Dokumenty, ktoré odpovedajú na tieto otázky (používateľské príručky, používateľské príručky, súbory pomocníka), sú usporiadané tak, že definujú problém čitateľa a predložia tieto riešenia. Budete chcieť vytvoriť pre svoj dokument obrys, aby ste sa rozhodli, kam pôjde každá základná informácia, a z toho vytvoriť nadpis, ktorý ho predstaví. Nasleduje vzorová štruktúra s označenými miestami pre nadpisy.
- Definícia problému s vhodným pozadím a kontextom. Mali by ste nadpis pre túto sekciu; samotná časť môže byť krátka ako jedna veta alebo až 3 odseky.
- Odporúčania na riešenie problému. Túto sekciu by ste predstavili titulkom; odporúčaniami môžu byť jednoduché vety alebo pododdiely 1 až 2 odsekov zavedené podnadpismi.
- Zdôvodnenie ponúkaných riešení. V používateľskej príručke bude podpora pre každé odporúčanie pravdepodobne nasledovať samotné odporúčanie. Vo výskumnej práci by bol výskumný postup jeho vlastnou časťou s vlastným titulkom.
- Implementácia riešenia. Túto sekciu by ste predstavili nadpisom. Časť môže byť zoznamom krokov s jednou vetou alebo môže ísť o sériu odsekov s prvou vetou definujúcou krok a následnými vetami vysvetľujúcimi dôvod jeho vykonania.
- Prílohy. Váš dokument by mal obsahovať prílohu, ak potrebujete zahrnúť rozsiahle vysvetlenie toho, ako ste zhromaždili informácie, na ktorých je založené vaše riešenie, alebo pre údaje, z ktorých ste vychádzali, akékoľvek grafy alebo grafy v hlavnom dokumente, skrátka všetko, čo by narušilo tok vášho hlavného dokumentu. V tejto časti by ste použili nadpis a ak máte niekoľko dodatkov, nadpis pre každú prílohu.
Existuje niekoľko spôsobov, ktorými môžete v technickom dokumente používať veľké písmená. - 4Vyberte vhodný tón pre dokument. Pri väčšine technického písania bude váš tón seriózny a obchodný. Články pre vedecký časopis budú zvyčajne odbornejšie, zatiaľ čo marketingové materiály môžu mať pútavejší a optimistickejší tón, ktorý povzbudí ľudí k nákupu produktu alebo služby po predstavení výhod, ktoré produkt alebo služba ponúka.
- Ak vám bol poskytnutý sprievodca štýlmi, zvyčajne definuje vhodný tón pre publikum, s ktorým si píšete, najmä pre webové stránky, najmä ak je potenciálna obecenstvo veľké.
Metóda 2 z 2: Písanie nadpisov pre váš dokument
- 1Priraďte tón nadpisu k textu, ktorý za ním nasleduje. Vážny dokument by mal mať vážne znejúci nadpis, aby ho predstavil; optimistický dokument by mal mať optimálny nadpis.
- 2Nechajte nadpis popísať, čo za ním nasleduje. Môže to byť jednoduché ako slová „Úvod“, „Odporúčania“, „Implementácia“, „Záver“ a „Príloha“ alebo niečo kreatívnejšie, ako napríklad „O probléme“, „Odporúčame“, „Ako to urobiť, “„Súhrnne “a„Na ďalšie čítanie “. (Presné znenie by bolo určené tónom článku, vašim publikom a akýmkoľvek sprievodcom štýlom, do ktorého si píšete.)
- 3Nechajte dĺžku primeranú. Nadpisy nemusia mať 3 slová alebo menej, ale kratšie nadpisy zvyčajne upútajú pozornosť vašich čitateľov lepšie ako dlhšie nadpisy. Dajte najdôležitejšie slová na začiatok, aby si ich ľudia ľahšie všimli a lepšie si ich zapamätali.
- Jedným zo spôsobov usporiadania nadpisu je hlavný bod, za ktorým nasleduje dvojbodka a potom zapamätateľný podtitul, napríklad „Súbory pomocníka: Ako ich napísať, aby ich používatelia skutočne použili“.
Nemusíte mať nadpisy na 3 slová alebo menej, ale kratšie nadpisy zvyčajne upútajú pozornosť vašich čitateľov lepšie ako dlhšie nadpisy. - 4V prípade potreby použite podpoložky. Niekedy informácie v dokumente alebo sekcii dokumentu pokrývajú viac ako jeden nadpis, ktorý je možné rozumne uviesť. V týchto prípadoch môžete mať hlavný nadpis ako prehľad sekcie, pričom podpoložky predstavia každý významný pojem v sekcii. (V tomto článku podnadpisy „Plánovanie technického dokumentu“ a „Písanie nadpisov pre váš dokument“ v prvom rade informujú o dôležitosti plánovania samotného dokumentu, než naň napíšete nadpisy, a potom o procese písania týchto nadpisov.)
- 5Prijmite konzistentný štýl používania veľkých písmen. Existuje niekoľko spôsobov, ako môžete v technickom dokumente používať veľké písmená v titulkoch. Pre podnadpis môžete použiť iný štýl veľkých písmen ako pre hlavný nadpis, ale pre každý nadpis a pre každý podnadpis v dokumente by ste mali používať rovnaký štýl použitia veľkých písmen.
- Začnite veľkým písmenom prvého písmena každého slova v nadpise. (Toto je v programe Microsoft Word známe ako „veľké a malé písmená“.)
- Veľké písmeno prvého písmena prvého slova a posledného slova.
- Začnite veľkým písmenom prvého písmena prvého slova, posledného slova a každého významného slova. (Slová, ktoré nie sú napísané veľkými písmenami, sú článkami „a, an“, spojkami a predložkami s 2 alebo 3 písmenami, pokiaľ nie sú posledným slovom v nadpise.)
- Veľké prvé písmeno prvého slova a všetky podstatné mená alebo prídavné mená, ktoré môžu byť v názve, uveďte veľké písmená. (V programe Microsoft Word je to známe ako „Rozsudok“.) Ak tento štýl skombinujete s jedným z ostatných, použite tento štýl pre podnadpisy a druhý pre nadpisy.
- 6Ak je to možné, používajte v nadpisoch paralelnú konštrukciu. „Paralelná konštrukcia“ znamená štruktúrovať frázy rovnakým spôsobom: ak jeden nadpis začína slovesom, všetky nadpisy by mali začínať slovesom. (Podnadpisy v tomto článku „Plánovanie technického dokumentu“ a „Písanie nadpisov pre váš dokument“ sú príkladom paralelnej konštrukcie.) Hoci sa paralelná konštrukcia častejšie používa pri písaní odrážok, je účinná aj v nadpisoch, ktoré čitateľovi ukážu. podobnosti v obsahu, ktoré nasledujú za každým podobne formulovaným nadpisom.
- Súbežná konštrukcia je náročnejšia na údržbu, keď máte k dispozícii veľký počet nadpisov alebo podnadpisov.
Účelom technického písania je vysvetliť veci jasným, stručným a úplným spôsobom, aby čitateľ rýchlo porozumel predloženým informáciám. - 7Zvážte použitie systému číslovania pre nadpisy a podnadpisy sekcií. Svoj technický dokument môžete ďalej štruktúrovať začlenením systému číslovania do svojich nadpisov a podpoložiek. V tomto systéme začínajú nadpisy sekcií arabskou číslicou, za ktorou nasleduje bodka (1., 2., 3.), potom text nadpisu. Podnadpisy pod nadpisom sekcie začínajú arabskými číslicami s jedným desatinným miestom, za ktorými nasleduje bodka (1,1., 1,2., 1,3.) A sú odsadené tak, že číselný štítok padá pod prvým slovom nadpisu. Ďalšia úroveň podpoložiek začína arabskou číslicou, bodkou, ďalšou arabskou číslicou, ďalšou bodkou a ďalšou arabskou číslicou a bodkou (1,1.1., 1,1.2., 1,1.3.) A je odsadená tak, že štítok spadá pod prvé slovo podnadpisu nad ním.
- Táto metóda sa častejšie používa pre technické dokumenty pre interného publika, ako sú napríklad inžinierske postupy. Málokedy sa používa na dokumenty pre externé publikum, ako sú napríklad príručky používateľa softvéru alebo súbory pomocníka.
- Vzhľad nadpisov a podnadpisov môžete vylepšiť špeciálnym formátovaním, ako je napríklad tučné písmo, kurzíva alebo podčiarknutie. Aby ste zaistili konzistentný vzhľad pre každú úroveň nadpisu v technickom dokumente, pomocou funkcie Štýly v programe na spracovanie textu určte písmo, veľkosť bodu a formát pre každú úroveň nadpisu.
Prečítajte si tiež: Ako napísať knihu ako tínedžer?
