A műszaki írás tanfolyamok bevezetnek a tudomány, technológia és üzlet világában írás legfontosabb aspektusaiba, más szavakkal, olyan írásmódokba, amelyeket tudósok, ápolók, orvosok, számítástechnikai szakértők, kormányzati tisztviselők, mérnökök és hasonló szakmák dolgozói végeznek rendszeres munkájuk részeként.

Ahhoz, hogy megtanulj hatékonyan írni a munka világában, olyan gyakori jelentéstípusokat fogsz tanulmányozni, mint a bevezetők és címek különleges formátumú elemei, egyszerű technikák a grafikai elemek jelentésekbe való beillesztésére, valamint néhány technika a professzionális megjelenésű végső szöveg elkészítéséhez.

A műszaki írás kurzusok arra építenek, amit más írási kurzusok során tanultál. De sok új dolgot is meg kell tanulni! Ha jelenleg van olyan munkád, ahol írsz, felfedezed, hogy azokat a dolgokat, amiket a műszaki írás kurzuson tanulsz, azonnal hasznosíthatod.

A technikai írásról

Valószínűleg azon gondolkodsz, mi ez a "műszaki írás dolog". Valaki talán azt is mondta neked, "ez egy kurzus, ahol rakétatudományról és agyi műtétekről kell írnod." Nos, nem igazán, ahogy mindjárt látni fogod. Valójában a műszaki kommunikáció területe elengedhetetlen sokféle szakterületen és foglalkozásban. Ez egy teljesen professzionális terület, amelynek vannak diplomás programjai, tanúsítványai, és—igen!—még elmélete is. Ez egy jó terület, sok növekedési és jövedelmezőségi potenciállal; és egy bevezető műszaki írás kurzus, amelyhez ez a könyv készült, jó módja annak, hogy elkezdj, ha érdekel egy karrier ezen a területen.

Munkahelyi írás. azonban a technikai írás kurzusok fókusza nem feltétlenül a technikai írói karrier, hanem egy bevezetés az írási készségekbe, amelyekre szinte bármely technikai orientációjú szakmai munkához szüksége van. Akármilyen szakmai munkát is végez, valószínűleg rengeteget írsz, és ennek nagy része technikai jellegű. Minél többet tudsz néhány alapvető technikai írási készségről, amelyeket ebben az útmutatóban és a technikai írás kurzusokban ismertetnek, annál jobb író leszel. És ez jónak fog bizonyulni a projekteken, amelyeken dolgozol, a szervezeteknél, ahol dolgozol, és ami a legfontosabb, jónak fog lenni számodra és a karriered számára.

A "technikai" jelentése. A technikai kommunikáció—vagy technikai írás, ahogyan ezt a kurzust gyakran nevezik—nem egy konkrét technikai témáról szól, mint például a számítógépekről, hanem bármilyen technikai témáról. A "technikai" kifejezés olyan tudásra utal, amely nem széles körben elterjedt, inkább a szakértők és a szakemberek területe. Bármi is legyen a szakterületed, te egy szakértelmet fejlesztesz—specialistává válsz egy adott technikai területen. És valahányszor írsz vagy mondasz bármit a szakterületedről, technikai kommunikációval foglalkozol.

A közönség fontossága. A műszaki kommunikáció meghatározásának másik kulcsfontosságú része az információ címzettje—a közönség. A műszaki kommunikáció a műszaki információk átadása az olvasóknak (vagy hallgatóknak, vagy nézőknek) olyan módon, amely alkalmazkodik igényeikhez, megértési szintjükhöz és háttérükhöz. Valójában ez a közönség elem annyira fontos, hogy ez a tanfolyam egyik alappillére: arra kaptok kihívást, hogy rendkívül műszaki témákról írjatok, de úgy, hogy egy kezdő—egy nem szakértő—érthesse. Az a képesség, hogy a műszaki információt "lefordítsuk" a nem szakértők számára, kulcsfontosságú készség bármely műszaki kommunikatőr számára. A gyors technológiai fejlődés világában az emberek folyamatosan lemaradnak és technológiai analfabétákká válnak. A technológiai cégek folyamatosan küzdenek, hogy hatékony módokat találjanak arra, hogy segítsenek a vásárlóknak vagy a potenciális vásárlóknak megérteni új termékeik előnyeit vagy működését.

Szóval lazíts! Nem kell számítógépekről vagy rakétatudományról írnod—írj arról a technikai szakterületről, amit ismersz vagy tanulsz. És tervezd meg, hogy úgy írsz róla, hogy még Nagyapa is megérthesse!

Valóban technikai írás. Tartsd magad laza, de tudnod kell, hogy a szakmai műszaki írók valójában igen technikai témákról írnak— olyan információkról, amelyeket csak akkor kezdhetnek el elsajátítani, ha visszamennek doktorálni. De várjunk egy percet! A műszaki dokumentumokat kevesebb mint kilenc hónapon belül el kell küldeni a termékkel! Hogyan kezelik ezt? A szakmai műszaki írók ezekre a stratégiákra támaszkodnak, hogy biztosítsák munkájuk műszaki pontosságát:

Természetesen a tapasztalt műszaki írók elmondják, hogy a termékfejlesztés olyan gyorsan halad, hogy a specifikációk nem mindig lehetségesek, és a termék működő modelljei ritkán állnak rendelkezésre. Ezért a szakterületi szakértők átnézése gyakran a legfontosabb.

A technikai írás kurzusokról

A technikai írás tanfolyamok fő fókusza jellemzően a műszaki jelentés, amely a félév vége felé esedékes. Szinte minden, amit a kurzus során csinálsz, az a jelentés elkészítéséhez szükséges készségek fejlesztésére irányul. Természetesen néhány technikai írás tanfolyam önéletrajzzal és pályázati levéllel (amelyet gyakran kísérő levélként ismernek) kezdődik, de ezt követően megtervezed a műszaki jelentést, majd írsz egy javaslatot, amelyben azt javaslod, hogy készítsd el azt a jelentést. Ezután rövid műszaki tanulmányokat írsz, ahol hozzászoksz olyan dolgok használatához, mint a címsorok, bevezetés, grafika és különleges értesítések, hogy ne is beszéljünk arról, hogy a technikai témákról világosan, tömören és érthetően írjunk, ami egy adott közönség számára megfelelő.

Óvatosan: Tudnod kell, hogy a műszaki írás tanfolyamok írásintenzívek. Valószínűleg többet fogsz írni a műszaki írás tanfolyamon, mint bármely más tanfolyamon, amit valaha is vettél. Ha fizikai, kalkulus és középszintű számvitel tantárgyakat tanulsz, és babát vársz ebben a szemeszterben—nos, lehet, hogy ez nem pontosan a megfelelő szemeszter a műszaki írás számára.

Erről a ingyenes online műszaki írás tankönyvről

Ez a szöveg az 1980-as évek közepén készült, miközben az IBM-nél dolgoztam __(ENTITY_0)__ Austinban, Texasban, és óraadóként tanítottam az Austin Community College-ban. Egy Interleaf nevű asztali kiadási rendszer segítségével írtam ezt egy olyan időszakban, amikor a legtöbb diák még mindig írógépeket használt. Ezekben az oldalakban talán még találhatóak ennek az időszaknak a nyomai. 1994-ben felfedeztem a webet, és őrült tempóban kezdtem el az ebédidőmben az Interleaf fájlokat HTML-re konvertálni, sok makróval, amelyet az Emacsban készítettem. 2014-ben elkezdtem jelentősen átalakítani ezt a dolgot és megpróbáltam modernizálni. Néhány példa az 1980-as évek elején, a Texas Egyetemen folytatott technikai írási tanítási napjaimból származik. Ezek elavultak, de jó példák. Az olvasókat arra bátorítják, hogy küldjenek nekem frissítéseket! __(ENTITY_1)__ Dávid

A szerzőről

Olvass a következőről a szerző e könyv online változata.