A technikai írás technikai információkat közöl egy készségről vagy termékről az olvasókkal. Általában a műszaki és a foglalkozási területeken használják. Műszaki íróként gyakran ír olyan dokumentumokat, mint a felhasználói útmutatók, az alkalmazásprogramozási felület (API) dokumentációja, valamint a javítási és termékkézikönyvek.
A többi írási réshez hasonlóan a technikai írásnak is megvannak a niche-specifikus irányelvei. Ezen irányelvek követése segít jól strukturált dokumentumok megírásában, és optimalizálhatja az olvasók munkáját. Íme néhány szabály, amelyeket be kell tartani ahhoz, hogy jó műszaki íróvá váljon.
1. Határozza meg közönségét
A közönségelemzés nélkülözhetetlen tényező egy jó műszaki dokumentumban. A közönség ismerete segít meghatározni, hogy milyen információkról írjon, hogyan kell felépíteni azt, és milyen technikai jellegű a nyelve. A műszaki írásoknak négy fő közönsége van: vezetők, szakértők, technikusok és nem szakemberek.
A vezetők olyan személyek, akik finanszírozzák a terméket, és meghozzák az azt irányító politikai, adminisztratív és gazdasági döntéseket. A technikusok azok az emberek, akik ezeket a termékeket építik, üzemeltetik és javítják. A szakértők tervezik, tesztelik és mindent tudnak a termékről, míg a nem szakemberek a termékek végfelhasználói. Figyelembe kell vennie a közönségét, hogy meghatározza a legjobb hangszínt és írásmódot.
2. Azonosítsa közönsége igényeit
A közönség megismerése és meghatározása mellett kulcsfontosságú, hogy megértse céljaikat, érdeklődési körét és igényeit. A közönségelemzés elvégzése kulcsfontosságú a dokumentumok előkészítésében, mivel kevésbé valószínű, hogy akadozás nélkül ír, és jól ismeri a közönség igényeit.
Egy átfogó közönségelemzés elvégzéséhez figyelembe kell vennie közönsége hátterét, meglévő tudását a termék, a tapasztalat, az igények, az érdeklődési körök, a demográfiai jellemzők, a kultúra és a kommunikációs preferenciák, ill célokat. Ezek az információk segítenek abban, hogy ötleteit a leghatékonyabban és legeredményesebben mutassa be.
3. Ismerje meg közönsége tudásának határát
Közönségelemzési technikaként felméréseket és kérdőíveket használhat, hogy megismerje közönsége tudásának határait. A marketing osztálytól népszerű véleményeket és sztereotípiákat, személyes tapasztalatokat, ötletelést és közönség visszajelzéseket is szerezhet.
Ha megfelelően használja a fent felsorolt eszközöket, akkor tudni fogja, hogy célközönsége mennyire érti az Ön által közölni kívánt információkat. Ezek az információk nagymértékben meghatározzák a dokumentum szerkezetét, korlátait és terjedelmét, így irányérzéket adnak.
4. Legyen egyszerű a nyelve
A műszaki írásnak túlságosan bonyolult témát kell bemutatnia. Ezt egy egyszerű írási stílus útmutató segítségével teszi. Gondoskodnia kell arról, hogy az átlagos olvasó könnyen megértse írását.
Meg kell azonban jegyezni, hogy a hallgatóság megértése is kulcsfontosságú a választott nyelvi stílusban. Például a szakmai zsargon egy dokumentumban arról alkalmazás programozási felületek (API) megfelelő lehet a technikusok számára, de nem a végfelhasználók számára. Következésképpen könnyen érthető nyelvezetet kell használnia, hogy segítse a közönség megértését. Érdemes lehet tanulni is hogyan kell használni egy olyan eszközt, mint a Microsoft Editor hogy ellenőrizze a munkáját, és győződjön meg arról, hogy az írás pontos.
5. Használja a körvonalakat
A vázlatok képet adnak olvasóinak arról, hogy mire számíthatnak a dokumentumban. A vázlat nélküli dokumentum túlterheli az olvasót, mert arra kényszeríti őket, hogy elolvassák a teljes szöveget, amikor csak konkrét ismeretek megszerzése érdekli őket.
Műszaki íróként a dokumentum felvázolása is irányt ad az írás során. A pályán tart, és biztosítja, hogy ne hagyja ki vagy értékelje le a releváns pontokat. Ezenkívül javítja a dokumentum szerkezetét, és visszajelzést ad arról, hogy mit kíván lefedni.
6. Használjon grafikát, ahol szükséges
A legtöbb olvasó figyelmét a szöveghez képest természetesen a grafika köti le. A műszaki dokumentumokban a megfelelő grafikák az információk világos és hangsúlyos bemutatásával javíthatják az olvasók szövegértését.
Műszaki íróként azonban ügyeljen arra, hogy ne használjon grafikát dokumentumok díszítésére. A táblázatok, grafikonok, diagramok, fényképek és illusztrációk gyakran használt grafikák, amelyek javíthatják a dokumentum általános szerkezetét, és vonzóak az olvasók számára. Ez azt jelenti, hogy ha még nem ismeri a Google Dokumentumokat, itt van hogyan hozhat létre és szerkeszthet táblázatokat a Google Dokumentumokban.
7. Vonja be olvasóit
Bár lehet, hogy technikai információkat próbál közvetíteni olvasóinak, fontos, hogy bevonja őket is. Minden műszaki dokumentum olvasóközpontú, és nem az író, hanem az olvasó ízlése szerint kell megírni. Olvasója szellemi kíváncsiságának ki kell elégítenie, hogy dokumentuma hasznos legyen.
Aktívan bevonhatja olvasóját azáltal, hogy kifejezi, nem pedig lenyűgözi, és egyenesen a lényegre tér. Kerülje a rövidítéseket és a szakzsargont, használjon sok szóközt a vizuális megjelenítés javítása érdekében, és használjon címsorokat az olvasó eligazítására.
8. Ne hivatkozzon időérzékeny információkra
Mindig célszerű elkerülni az időérzékeny információkra, különösen az összehasonlítható időszakra vonatkozó hivatkozásokat. Biztonságosabb és bölcsebb olyan elemzést használni, amely kiállta az idő próbáját, ami örökzöldté és alkalmassá teszi azok számára, akik a jövőben olvassák dokumentumát.
Azt is meg kell jegyeznie, hogy konkrét évszámok, például „2019” csatolása az álláspontja hangsúlyozására idővel csökkentheti a dokumentum hasznosságát, kivéve bizonyos eseteket. Megelőzheti ezt, ha szélesebb időkeretet használ, például „Az elmúlt hét évben”, így a munkáját hitelessé teszi.
9. Használjon releváns példákat
Műszaki dokumentum írásakor használjon élő példányokat a szempontok hangsúlyozására. Mivel a közönség azért olvassa el az Ön írását, hogy készségeket szerezzen, megoldjon egy problémát, vagy tanuljon néhány iránymutatást, gyakorlati és összehasonlítható példákkal kell ellátnia őket.
Ezek a példák javítják munkája olvashatóságát, és összetett információkat közölnek olvasójával, kontextust biztosítva a termékekhez és folyamatokhoz. Így nagyobb valószínűséggel használják a termékeket szándékosan és biztonságosan.
10. A közzététel előtt kérjen véleményt harmadik féltől
A műszaki dokumentumnak mindig olyan együttműködési folyamaton kell keresztülmennie, amelyben az író és a bíráló is részt vesz. A harmadik fél által végzett felülvizsgálat segít közönségközpontú, hibamentes és hatásos dokumentum létrehozásában.
A dokumentum eredeti szerzőjeként előfordulhat, hogy sok vázlatot írt a végleges dokumentum létrehozása előtt. Mindazonáltal, bármilyen jónak tűnik is a dokumentuma, ne csak az eszén múljon.
Legyen professzionális műszaki író még ma
Ha megérti a műszaki írást meghatározó alapvető szabályokat, akkor gyakorlottabbá és keresettebbé válik. Sok szervezet tudja, mennyire fontos, hogy termékei vagy szolgáltatásai jól értékesítettek legyenek a végfelhasználók számára, és ennek elérésében az Ön célja műszaki íróként.
