a műszaki írás a dokumentumok és a látvány, a verbális információk és az oktatási képzési anyagok bemutatásának gyakorlata. A műszaki írás célja olyan anyag biztosítása, amely elmagyarázza a folyamatot, vagy megkönnyíti az összetett koncepció megértését egy adott közönség számára. A hatékony és hatékony műszaki írás révén az író képes lesz megmagyarázni és segíteni az olvasót az információk megértésében és konkrét feladatok elvégzésében. A műszaki írásnak öt egyetemes etikai alapelve van. Az alapelvek a minőségi tartalom, a közönség és a cél, a hozzáférhetőség, a nyelvtan és az írási stílus.
minőségi tartalom
minőségi tartalom szubjektív. A MATC meghatározása a kiváló minőségű tartalomról olyan termék, amely megfelel az ügyfél szabványainak, vagy túlmutat a projekt kezdeti hatókörén. Kiváló minőségű projekt elkészítéséhez a tervezett közönséget szem előtt tartva kell írnia. Az írónak a dokumentum vagy anyag elkészítése előtt további ismereteket kell kutatnia. Az írónak tudnia kell, hogy milyen formátumot vagy platformot fog használni az információk ábrázolására. Az írónak meg kell határoznia azokat a konkrét információkat, amelyek a határidők ismeretétől kezdve az információk megírásáig terjednek.
közönség és cél
az írónak meg kell értenie mind a célt, mind a közönséget ahhoz, hogy kiemelkedő technikai darabot hozzon létre. A műszaki írás közönség változik az ipar és az adott ügyfél. Például egy körjelentés közönsége a termékgyártás lenne, aki íróként alkalmazott minket. Az eLearning képzési modul közönsége lehet egy bank vagy jelzálog-szolgáltató, akinek megfelelőségi képzésre van szüksége. Az írónak tudnia kell, hogy az olvasók mennyit fognak tudni, és milyen feladatokat kell teljesítenie az írónak, amikor az olvasókkal kommunikál.
Kisegítő lehetőségek
elengedhetetlen, hogy a közönség könnyedén hozzáférhessen az író által létrehozott információkhoz. A Kisegítő lehetőségek közé tartozik minden, ami egy dokumentumban található, például fejlécek és láblécek, vagy számítógépes iLearn modulok, amelyek javítják a Kisegítő lehetőségek formázását, hogy univerzálisabbak és világosabbak legyenek. A műszaki írónak ki kell találnia a legjobb módszert, amellyel az olvasók navigálhatnak a dokumentációban a bibliográfiától az oldalszámokig a tartalomjegyzékig. Az író még képeket is hozzáadhat, például diagramokat és ábrákat, hogy tovább magyarázza az információkat.
Grammar
írásban világos, tömör, és egyértelmű a helyes használata nyelvtan elengedhetetlen írásban bármilyen technikai darab. Az írónak lektorálnia és szerkesztenie kell az írott technikai darabokat is, hogy kijavítsa a nyelvtan, a stílus és az elrendezés hibáit vagy ellentmondásait. A műszaki írónak mindig jelen időben kell írnia, kivéve, ha az ügyfél másként jelzi preferenciáját. A műszaki cikk olvasójának pontosan azt kell tennie, amire utasításokat ad. Az írónak mindig egyszerű mondatokban kell írnia, amelyek nemi semleges főneveket tartalmaznak. Az egyszerű mondatok segítenek az olvasóknak világosan és hatékonyan megérteni azokat a feladatokat, amelyeket el kell vállalniuk céljaik eléréséhez.
írási stílus
az írási stílus minden technikai darab esetében különbözik, mert nagymértékben függ attól, hogy ki a közönség és a forgatókönyv, amelyre a technikai darabot írják. A technikai írás hangja elengedhetetlen, mert segít az olvasónak megérteni, hogy milyen hangra van szükség a feladat elvégzéséhez. A szóválasztás szintén elengedhetetlen része a stílusnak a közönség igényeinek kielégítésében, mert összekapcsolódik azzal, aki a közönsége. Az információs szakaszokra vagy a webhelyekre való hivatkozáskor elengedhetetlen, hogy világos és látható módon hozzáférjen az információkhoz olyan eszközök segítségével, mint például ábrák és táblázatok.
egyéb műszaki írási tippek
végezzen Extra kutatást és Tudjon meg többet
a minimum ismerete nem biztos, hogy a legjobb technikai darabot kapja meg, amely segít a közönségnek megérteni az információkat. Lehet, hogy sok olyan terminológia létezik, amelyet mind az író, mind az olvasó nem érthet. Ökölszabályként, ha Ön, mint olvasó, nem ért egy fogalmat vagy kifejezést, határozza meg azt. A túl sok információt mindig le lehet vágni a későbbi áttekintésekben. Ezt az információt meg kell vizsgálni annak érdekében, hogy megértsük, hogyan működik az író egészével. Kutasson egy kis apát, és derítse ki, milyen egyéb információkat lehetne felhasználni az írott technikai darab javítására.
legyél a közönség és becsüld alá a közönséget
képzeld magad a közönség cipőjébe. Meg tudja érteni és követni a közönségnek írt utasításokat vagy információkat? Ha igen, további információkat adhat meg, ha úgy gondolja, hogy egy kicsit több segítségre van szüksége. Ha nem, akkor meg kell találnia azokat a részeket, amelyek nem egyértelműek, és meg kell találnia a módját az információk megfelelő megadására. A műszaki írók nagy problémája gyakran az, hogy túlbecsülik közönségük tudását. A közönség több ember lehet, különböző szintű ismeretekkel. Teljesen elfogadható, ha röviden olyan információkat adunk meg, amelyek feltételezhetők vagy már kijelenthetők a közönség frissítőjeként.
kérjen második és harmadik véleményt és szakértői értékelést
a műszaki írók találékonyak. A legnagyobb erőforrás van a téma szakértők. Győződjön meg róla, hogy kérdezze meg KKV-ját, hogy lát-e valamilyen tudásbeli hiányosságot vagy hibát. Az írók ellenőrzik ügyfeleiket, hogy vannak-e olyan tudásbeli hiányosságok vagy hibák, amelyeket az író figyelmen kívül hagyhat. Ha egy felügyelő vagy kolléga átnézi és véleményt ad, az szintén segíthet egy technikai darab javításában. A szakértői értékelés az, amikor egy embercsoport találkozik, hogy elolvassa, kommentálja és javasolja egymás munkájának javítását. Több vakfoltot fedeznek fel, amikor több ember átnézi a dokumentumot, ami pontos és tömör információkat biztosít.
a műszaki írók új információkat tanulnak meg minden projektről, amelyen dolgoznak. Az írók jobban megértik, hogy mire van szükségük az ügyfeleknek, mert az olvasók tudásszintje alatt kezdődnek, mielőtt minden kutatást és megbeszélést folytatnának a téma szakértőivel. Ez nagy előnyt jelent a vállalatok számára, mivel kevesebb feltételezés nyílik a hatékonyabb képzésre. Az anyagot tanuló írók és a műszaki írási szabványok etikai elveinek kombinációja magabiztosabb és hatékonyabb alkalmazottakat eredményez.