- Ez a fejezet, valamint a Műszaki ▒~Mrás teljes tankönyve, a műszaki írás készségeire összpp ontosít.
- Az itt található műszaki tartalom sikeressége, pontossága vagy id▒~Qszerűsége nem garantált.
- Az oldalon található képekben lév▒~Q szöveg fordítása a lehet▒~Q leghamarabb elkészül.
- Kattintson ide, hogy segítsen David McMurrey webtárhelyének költségeit fedezni: Adományozzon bármii lyen összeget! Az Online Technical Writing továbbra is ingyenes marad.
Kérjük, kattintson ide, hogy segítsen. Dávid McMurrey fizesse ki a webtárhely-számláját:
Adományozzon bármilyen kis összeget, amennyit csak tud!
Az online műszaki írás továbbra is ingyenes marad.
Cím megfogalmazása
A hosszabb dokumentumok, például formális műszaki dokumentációk, használati útmutatók és fehér könyvek címei néha túl rövidek. Például ha egy műszaki dokumentum címe "Jelentés a műanyagszennyezésről" lenne, a dokumentum akár több mint 300 oldal is lehet. Ha viszont "A műanyagok újrahasznosítási módszereinek értékelése" lenne, a dokumentum könnyebben kezelhető lehetne.
Természetesen nem szeretnéd, hogy egy dokumentumnak ugyanaz legyen a címe, amit John Milton, az angol költő 1641-ben alkotott: Az egyházi fegyelem reformjáról Angliában: és az okokról, amelyek eddig akadályozták azt. Két könyv, egy barátnak írva..
Gondolj csak arra, mennyi mindent elmondhatnál mindegyik témáról! Fontos az a tény is, hogy az olvasók az ilyen címekből egyszerűen nem fogják tudni, mit fogsz valójában tárgyalni.
A cím megfogalmazásának elemei
Amikor címet készítesz a dokumentumodhoz, érdemes feltüntetni ezeket az elemeket, de anélkül, hogy a cím egy egész bekezdés hosszú lenne:
- Téma: A dokumentumod témája hasonló lehet a fenti példákéhoz. De ne állj meg ott—még több munkád van hátra.
- Hatály: A hatókör arra utal, hogy milyen széles vagy milyen szűk lesz a fókuszod a témában. A hatókör és az áttekintés nem mindig könnyen megkülönböztethetők. Az elem áttekintés A téma valamely aspektusának általános áttekintését jelzi.
- Áttekintés: Ahogyan a kifejezést itt használják, az áttekintés a tárgyalandó fő altémák tételes felsorolására utal. Igaz, ez ellentmond annak, hogy a kifejezést a hatókör meghatározására használják. Ne aggódj—ez nem tudomány. Erre a kifejezés használatára jó példa a következő: Ebola: Átvitel, tünetek, kezelés. Az utolsó három szó a tételes felsorolás.
Vegye figyelembe, hogy egy konkrét, fókuszált cím létrehozásának folyamata hasonló a folyamatához egy téma leszűkítése, másutt tárgyalva.
Cím megfogalmazási példák
Fontolja meg ezt a címet: Nanotechnológia: Az orvosi alkalmazások áttekintése. A hatalmas téma nanotechnológia valóban ki van mondva, de vedd észre, hogy ez arra szűkült le, hogy orvosi alkalmazások és egy hatókört meghatározó elem van alkalmazva—áttekintés.
Figyelje meg a kettőspont használatát a megelőző példában. Ez lehetővé teszi, hogy kevesebb szót használjon. Egy másik lehetőség: A nanotechnológia orvosi alkalmazásai: áttekintés.
A probléma címének megfogalmazása
A műszaki dokumentumoknál gyakori probléma a túlságosan általános, homályos címek, például:
Jelentés a nanotechnológiáról
Jelentés az eboláról
Jelentés az okostelefonokról
Jelentés a napenergiáról
Jelentés a grafénről
Címlap tervezése és formátuma
A fejezet a műszaki dokumentáció tervezése egészen puritán elképzelést ad a címlapról, itt balra látható. Azonban sok technikai dokumentáció címlapján gyönyörű képek szerepelnek, ahogy itt jobbra látható:
 |
 |
Értékelném a gondolatait, reakcióit és kritikáját e fejezettel kapcsolatban: a válaszod—David McMurrey.
