Prosím, kliknite sem, aby ste pomohli David McMurrey zaplaťte jeho účet za webhosting:
Darujte akúkoľvek malú sumu, ktorú môžete!
Online technické písanie zostane zadarmo.
Formulácia názvu
Názvy dlhších dokumentov, ako sú formálne technické dokumenty, používateľské príručky a biele knihy, sú niekedy príliš stručné. Napríklad, ak by bol názov technického dokumentu "Správa o plastovom znečistení," dokument by mohol mať viac ako 300 strán. Ak by bol názov "Hodnotenie metód recyklácie plastu," dokument by mohol byť ľahšie spracovateľný.
Samozrejme, nechcete, aby dokument mal názov toho, ktorý vytvoril John Milton, anglický básnik, v roku 1641: O reformácii cirkevnej disciplíny v Anglicku: A dôvody, ktoré doteraz bránili jej uskutočneniu. Dve knihy, napísané priateľovi.
Len si predstav všetky veci, ktoré by si mohol povedať o každom z týchto tém! Dôležité je aj to, že čitatelia jednoducho nebudú vedieť z takýchto titulov, čo vlastne pokryješ.
Prvky formulácie názvu
Keď vytvárate názov pre svoj dokument, zohľadnite tieto prvky, ale bez toho, aby ste vytvorili názov, ktorý je dlhý ako odsek:
- Téma: Téma vášho dokumentu môže byť podobná týmto príkladom vyššie. Ale nezastavujte sa tam—máte ešte veľa práce pred sebou.
- Rozsah: Rozsah sa týka toho, aký široký alebo úzky bude váš zameranie na tému. Rozsah a prehľad nie sú vždy ľahko rozlíšiteľné. Prvok prehľad naznačuje všeobecnú recenziu niektorého aspektu témy.
- Prehľad: Ako sa termín používa tu, prehľad sa týka výpočtu hlavných podtém, ktoré sa majú pokryť. Je pravda, že je to protirečivé s tým, ako sa termín používa na definovanie rozsahu. Nebojte sa—nie je to veda. Dobrým príkladom tohto použitia termínu je toto: Ebola: Prenos, Príznaky, Liečba. Posledné tri slová sú vymenovanie.
Všimnite si, že proces vytvárania konkrétneho, zameraného titulu je podobný procesu zužovanie témy, pokryté inde.
Príklady formulácie titulov
Zvážte tento titul: Nanotechnológia: Prehľad medicínskych aplikácií. Obrovská téma nanotechnológia je skutočne uvedené, ale všimnite si, že je to zúžené na lekárske aplikácie a aplikuje sa prvok rozsahu—prehľad.
Všimnite si použitie dvojbodky v predchádzajúcom príklade. Umožňuje vám to znížiť počet slov. Ďalšou možnosťou je Medicínske aplikácie nanotechnológie: Prehľad.
Formulácia názvu problému
Bežným problémom technických dokumentov sú príliš všeobecné, nejasné názvy, napríklad:
Správa o nanotechnológii
Správa o Ebolu
Správa o smartfónoch
Správa o solárnej energii
Správa o graféne
Návrh a formát titulnej strany
Kapitola o návrh technickej dokumentácie predstavuje dosť spartánsku predstavu o titulnej stránke, zobrazenej tu vľavo. Avšak množstvo technických dokumentov má na titulnej stránke krásne obrázky, ako je zobrazené vpravo:
 |
 |
Bolo by mi potešením počuť vaše myšlienky, reakcie, kritiku týkajúcu sa tejto kapitoly: vaša odpoveď—David McMurrey.
