Mit csinál egy technical writer, és hogyan épülnek fel a munkafolyamatai?- Szakszerűen a műszaki szakszövegírásról

Ti mondtátok Olvasási idő:5 perc

szövegírás

A szövegírás és annak különböző fajtái egyre nagyobb teret nyernek a magyar üzleti szférában is. A reklámozással és hír- valamint információközléssel foglalkozó cégek egyre nagyobb arányban használják ki az ebben lévő potenciált, ezáltal pedig az elmúlt években nemcsak az ebben rejlő potenciált kihasználó vállalatok, de a szövegírói szakma is rohamos fejlődésnek indult Magyarországon. Aktuális cikkünkben a Sigma Technology – a magyar piac legrégebbi cégének – munkatársával, Helli Ritával a szövegírás egy specifikus ága, a műszaki szakszövegírás kérdéseit tisztázzuk.

IThon.info: Pontosan mit jelöl a műszaki szakszövegírás jelző?

Helli Rita: Amikor műszaki szakszövegírásról beszélünk, akkor lényegében a copywriting egy válfajáról van szó, amely során olyan műszaki jellegű dokumentáció készül, amely segíti egy adott termék vagy szolgáltatás használatát és alkalmazását.

Szakmai körökben több megnevezése is ismert ennek a szövegírói ágazatnak, a teljesség igénye nélkül felsorolva néhányat: műszaki szakszövegírás, technical writing, info design, információmenedzsment vagy épp műszakitervezés-írás.

A folyamat lényegében arról szól, hogy egy kvázi külsős szakmai csapat csatlakozik egy fejlesztői csoporthoz, akik adott terméken vagy szolgáltatáson dolgoznak – ez a Sigma esetében lehet valamilyen telekommunikációs, mezőgazdasági, autóipari, esetleg egyéb területről származó termék vagy szolgáltatás is. Egy műszaki szövegíró feladata tulajdonképpen az, hogy ezzel a fejlesztői csapattal kooperálva olyan műszaki leírásokat alkosson, amelyek aztán a végfelhasználó kezébe kerülnek.

Ez többféleképpen is működhet. Előfordul, hogy konkrét boltban kapható termékekhez is gyártanak műszaki leírást, melyet a vásárlók hasznosítanak majd, de számos esetben fordul elő az is a szakmában, hogy mérnökök munkáját segítő guide-okat írnak.

A műszaki szakszövegírás egyik alapköve tehát a mély, alapos és pontos műszaki tudás vagy affinitás – valamint az erős nyelvismeret, de erről majd később.

IThon.info: Hogyan zajlik a műszaki szakszövegírás?

H.R.: A legtöbb esetben a szövegírói csapat kap egy összetett belső dokumentációt a fejlesztőktől, ami az adott termék vagy szolgáltatás összességét írja le. Ebből az anyagból kell egy olyan felhasználóbarát leírást készíteni, amelynek segítségével a végfelhasználók megismerik a terméket, és ki tudják aknázni a benne rejlő lehetőségeket.

A folyamat összetettsége miatt a szakszövegírók számára különösen fontos, hogy már a folyamat legelején bevonódjanak a munkába. Ez általában egy kick-off meeting, vagy egy, az új funkciót bemutató prezentáció formájában valósul meg.

Egy ilyen meetingen szó szerint mindenki megjelenik, aki a terméken dolgozik: pénzügyesek, marketingesek, sales-esek, termékfejlesztők, projektmenedzserek, illetve azok a fejlesztési csoportvezetők, akik a termék egyes funkcióinak kidolgozásában vesznek részt. Így garantálható, hogy a végfelhasználó – legyen az vásárló vagy mérnök –, biztosan megkapja azokat az információkat, amelyekre szüksége lehet.

Egy-egy ilyen meetingen tehát közgazdasági, műszaki, pénzügyi és bölcsész végzettségű emberek is megjelennek, ugyanis kizárólag így biztosíthatjuk a megfelelő mértékű  információáramlást. Ez a sokszínűség azért elemi fontosságú, mert így kellő szakmaisággal és műszaki pontossággal készülhet el az adott dokumentáció, amely ráadásul maximálisan érthető és feldolgozható lesz. Enélkül nincs eredmény – vagy csak minimális.

IThon.info: Milyen célt szolgálhatnak a műszaki szakszövegek?

H.R.: Az ilyen anyagok több célt is szolgálhatnak. Az, hogy az adott szöveg milyen céllal készül, a vonatkozó projekt függvénye. Bizonyos munkacsoportok többségében termékdokumentációt készítenek, de az sem ritka jelenség, hogy az egyes szövegírói csapatok az ügyfél számára belső dokumentációt készítenek, amelyekből később más szakszövegírók vagy éppen fejlesztőmérnökök dolgoznak.

Ezenkívül számos marketing célú megrendelés is érkezhet egy szakszövegírással foglalkozó céghez. Ezek jellemzően publikációk vagy prezentációk formájában valósulnak meg, de nem ritka az e-learning-anyagok, illetve brosúrák készítése sem.

Mit csinál egy technical writer, és hogyan épülnek fel a munkafolyamatai?

IThon.info: Hogyan zajlik a konkrét írói munka?

H.R.: A Sigmánál alapvetően kétféle metódusról beszélhetünk. Az egyik a fejlesztői írás, a másik a karbantartói feladatokra irányuló munka.

Az előbbivel kapcsolatban már elhangzott, hogy ebben az esetben a szövegírói csapat a fejlesztőkkel dolgozik együtt, tőlük kapnak belső leírásokat és egyéb anyagokat az új termékekről, illetve funkciókról, amelyekről aztán megszületnek a fent már részletezett anyagok.

A karbantartói oldal azonban teljesen más gondolkodást igényel. Ezzel kapcsolatban jellemzően a már meglévő dokumentumok frissítése, javítása, és kiegészítése a feladat – ez jellemzően új funkciók beépítése esetén fordul elő.

A fejlesztői projektekhez tehát inkább rugalmasságra van szükség, illetve empátiára, hogy az író bele tudja magát képzelni egy adott szituációba, illetve képes legyen a végfelhasználó fejével gondolkodni, ráadásul folyamatosan változó határidőknek és igényeknek kell megfelelni, amíg a projekt le nem zárul.

A karbantartói munkákhoz pedig jó rendszerlátás és rendszerezési készség szükségeltetik. Át kell látni a különböző szegmensek közötti különbségeket, illetve az is előfordul, hogy az írók hívják fel a mérnökök figyelmét, hogy az adott javítások egyéb funkciókra is kiterjedhetnek, így ezek frissítése is szükséges lehet. Mivel előfordulhat, hogy az ilyen projekteken dolgozó íróknak egy másik szakszövegíró munkáját kell folytatniuk, nagyon fontos, hogy mindenki kövesse a folyamatleírásokat és az ügyfél által előírt stíluskatalógust, hogy a szöveg egységes tudjon maradni.

Amikor a projekt alapjai tisztázódnak, elkezdődhet a konkrét munka. Fontos kiemelni, hogy a szövegek általában nem Word-ben vagy egyéb szövegszerkesztőben készülnek. A Sigmánál a műszaki szakszövegírók az anyagokat általában HTML és XML alapon készítik el, hiszen elsősorban nem nyomdai publikációk készülnek, hanem online felületeken megjelenő anyagok.

A HTML és XML-alapú dokumentumokhoz tartozik egy, az ügyfél által készített CSS vagy DTD file, amely tartalmazza mindazokat a formázási beállításokat és stílusjegyeket, amelyek szükségesek ahhoz, hogy az adott cég minden online, vagy nyomtatásban megjelenő dokumentuma egységes képet mutasson. Ezeknek a file-oknak köszönhetően nem lesznek problémák eltérő színkódokkal, kiemelésekkel, méretezéssel és egyéb formai, valamint tartalmi alkotóelemmel – ez ugyanis a műszaki dokumentációk esetében éppen olyan fontos, mint az egyéb jellegű írásos anyagok megjelenésével kapcsolatban.

Ez valamilyen szinten nehezíti a munkát, hiszen előre meg van határozva, hogy milyen szerkezeti elemek követhetik egymást, illetve mik azok a szegmensek, amelyek nem épülhetnek egymásra, az egységes, tudatos és letisztult megjelenés tekintetében azonban tényleg elemi fontosságú procedúráról van szó. Persze ez nem jelenti azt, hogy az így készült dokumentumok ne kerülhetnének nyomtatásba.

A Sigmánál jelenleg a műszaki szakszövegírók jellemzően az úgynevezett DITA módszert követik a munkájuk során. Ez lényegében azt jelenti, hogy nem a komplett szövegen dolgoznak, hanem egyes szövegmodulokon, amelyek egymástól elszeparálva vannak tárolva egy tartalomkezelő rendszerben. Ezt hívjuk moduláris fájldokumentációnak.

IThon.info: Milyen készségek szükségesek ahhoz, hogy valakiből műszaki szakszövegíró váljon?

H.R.: Ez a kérdés több irányból is megközelíthető. Az ügyfelek jellemzően azt az alapfeltételt fogalmazzák meg, hogy az illető műszaki előképzettségű legyen, ez ugyanis elengedhetetlen ahhoz, hogy átlássa az adott termék vagy szolgáltatás működését.

A másik alapvető kompetencia a nyelvtudás. A partnercégekből adódóan a Sigmánál a műszaki szakszövegírás nyelve ugyanis az angol. A dokumentációk jelentős része angolul íródik, majd a világ egyéb nyelveire fordítják le őket. A műszaki szaktudás mellett tehát egy nagyon erős angol nyelvtudás szükségeltetik. Ezek képezik a műszaki szakszövegírói projektcsapatok felépítésének alapjait.

Ezek tehát azok az információk, amelyek feltétlenül szükségesek ahhoz, hogy megértsük, hogyan dolgozik egy műszaki szakszövegíró, és milyen kompetenciák szükségesek ahhoz, hogy valakiből jó technical writer lehessen.