Skip to main content

Melyek a különböző műszaki írási szabványok?

A műszaki írás a konkrét közönség, általában olyan személyek számára szól, akiknek nagy a ismerete a tervezett témáról.Mint ilyen, a műszaki írási darabok általában formális jellegűek, és szabványosított formátumot követnek.Az írónak egyértelműen meg kell ismernie a dokumentum formátumát és célját, és ezt az információt egyértelműen a darab elején kell megadnia.A legtöbb műszaki dokumentum hasonló strukturális formátumot követ, beleértve a következő összetevőket: absztrakt vagy összefoglaló, tartalomjegyzék, bevezető információk, háttérinformációk, a módszertan magyarázata, az eredmények és az analitikai információk és a függelék.A speciális formázási problémák magukban foglalhatják a betűtípus -használat, az oldalszámozás, valamint a címsorok és alcímek használatát is.A szóválasztást általában a tervezett közönség diktálja, de az egyértelműség döntő jelentőségű minden műszaki írásban.

Az előkészítő munka javíthatja a műszaki írási szabványokat.Számos különféle műszaki írás létezik, kezdve a laboratóriumi jelentésektől a javaslatokig.A műszaki írónak meg kell határoznia, hogy melyik típus megfelel a legjobban a céljainak.Ezenkívül az írónak egyértelmű céllal vagy célkitűzésével kell rendelkeznie a darabhoz, és ezt az információt a lehető legkorábban meg kell adnia, a konkrét szóválasztást, a hangot és a formalitás szintjét nagymértékben az írás tervezett közönsége határozza meg.Dokumentumok írása, a tényleges szöveghez sok előzetes információra lehet szükség.A teljes dokumentumot általában egy rövid szövegben foglalják össze, amelyet absztrakt vagy végrehajtó összefoglaló néven ismertek.Ezt a darabot a dokumentum elejére helyezik, valamint egy tartalomjegyzéket, amely a fedett tárgyat tartalmazza.Az információkat különböző szakaszokra osztják, és az egyes szakaszok címsorokat és lehetséges alcímeket tartalmaznak.Egy tipikus műszaki írási dokumentum a következő szakaszokat tartalmazhatja: Bevezetés, irodalmi áttekintés vagy háttér, módszertan, eredmények és következmények vagy javaslatok.Az összes szakasz általában a harmadik személyben és a jelenlegi időtartamban van írva.Például a diagramok és grafikonok támogatást nyújthatnak egy ponthoz, és jobban tisztázhatják a komplex információkat.Általában ezt az információt a dokumentum végére helyezik függelék formájában.A referencia -utasításokat zárójelben helyezik el a szövegben.Ha külső forrásokat használnak, ezeket meg kell jegyezni és be kell helyezni egy referencia szakaszba.

A műszaki írók bizonyos technikákat használnak az információk kiemelésére vagy elkülönítésére.A szó vagy a kifejezés megjelenésének megváltoztatása az egyik lehetőség, például amikor a műszaki írási szabványok azt diktálják, hogy az elektronikus dokumentumokban a menüparancsok elsötétülnek és félkövérednek.Más konkrét információk speciális betűkészleteket is használnak.Például a könyvcímeket gyakran dőlt betűbe helyezik, és a rövidítéseket általában minden nagybetűben írják.A betűtípusméretek szintén megváltoztathatók, hogy felhívják a figyelmet bizonyos szavakra vagy címsorokra.és az írási szabványok általában.A nyelvi szint ellenére minden információnak világosnak és könnyen érthetőnek kell lennie.Mivel a közönség valószínűleg ismeri a műszaki kifejezéseket, ezeknek a kifejezéseknek a magyarázata általában nem szükséges.A dokumentumnak megfelelően kell áramolnia, megfelelő átmeneti mondatokkal, amelyek együtt tartják az információkat.Ezenkívül az oldalakat egyértelműen meg kell számozni és címmel, ha szükséges.Például a rövidítéseket mindig teljes mértékben meg kell határozni az olvasó számára, amikor a rövidített kifejezést először használják.Ha a dokumentum használjaAz S listák, majd a lista egyes részeiben a golyópontok és a hasonló mondatszerkezetek jellemzőek.Általánosságban csak a 10 -nél alacsonyabb számokat kell kiírni, míg a mérési egységet általában numerikusan írják.Míg a műszaki írásbeli közönség különbözik, a szleng vagy a túlságosan informális írás kerülni kell.

A műszaki írási szabványok széles körben elfogadhatják a közös használat és a szakmai jóváhagyás révén.A műszaki írásnak szentelt tankönyvek és folyóiratok általában végrehajtják és felvázolják az elfogadott regionális szabványokat.A szakmai műszaki írási programok szintén megtanítják a szükséges irányelveket.