Faludi Andrea, Fóris Ágota: A terminológiai munka a komplex dokumentációs és fordítási projektfolyamatban
›
3. A műszaki dokumentáció készítése
›
3.2. A dokumentációkészítés folyamata
›
3.2.1. Tervezés

3.2.1. Tervezés

Jegyzet elhelyezéséhez, kérjük, lépj be.!

A dokumentáció készítésének tervezésekor érdemes alapos projekttervet készíteni, amelyben – a legtöbb projekthez hasonlóan – a következő szempontok is szerepelnek: a rendelkezésre álló kommunikációs és kapcsolati háló, leszállítandó dokumentációs elemek, elvégzendő feladatok, a munka ütemezése a kitűzött határidők szerint, felhasználásra kerülő munka- és állapotkövető sablonok, szükséges erőforrások, szállítási célnyelvek, szállítási csatornák (Czinkóczki & Fehér, 2019).

Jegyzet elhelyezéséhez, kérjük, lépj be.!

Magának a dokumentáció írásának tervezésekor a következőket kell figyelembe venni: a célközönséget, a dokumentum célját és a dokumentum felhasználásának kontextusát. A tervezés során nemcsak a dokumentációt felhasználó szakemberek, illetve laikusok körét kell meghatároznunk, de jó néhány más szempontot is figyelembe kell venni, amelyek közül csak néhányat sorolunk fel, a teljesség igénye nélkül: az érintett ágazatokkal kapcsolatos háttér, készségek, tapasztalatok, képzések; a célközönség számára ismerős nyelv; feladatok; munkakörnyezet (például éghajlati viszonyok, fényviszonyok, csapatban vagy önállóan végzett munka); az információhoz való hozzáférés céljából rendelkezésre álló eszközök (például internet-hozzáférés, audioszolgáltatások, a támogatáshoz szükséges távoli telefonos vagy videoszolgáltatások, engedélyek az információkhoz való hozzáféréshez, megfelelő eszköz az elektronikus információk megjelenítéséhez stb.) (Czinkóczki & Fehér, 2021; IEC/IEEE 82079-1:2019).

Jegyzet elhelyezéséhez, kérjük, lépj be.!

Szintén már a tervezésnél ügyelnünk kell az információ minőségének hat alapelvére. Az IEC/IEEE 82079-1:2019 szabvány alapján a műszaki dokumentációban ezek a teljesség (’completeness’), minimalizmus (’minimalism’), helyesség (’correctness’), tömörség (’conciseness’), konzisztencia (’consistency’), közérthetőség (’comprehensibility’), hozzáférhetőség (’accessibility’).

Jegyzet elhelyezéséhez, kérjük, lépj be.!

A teljesség a használati utasítások esetében azt jelenti, hogy az információ a teljes felhasználásra kiterjed. Tehát tartalmazza a termék felhasználásának kockázatait; tartalmazza azokat a feladatokat, amelyeket a célközönségnek el kell végeznie, vagy amelyek megengedettek a termék teljes életciklusa alatt; tartalmaz minden információt, amelyre a célközönségnek szüksége van; továbbá tartalmazza a jogi és szerződéses követelményeket.

Jegyzet elhelyezéséhez, kérjük, lépj be.!

Az információra vonatkozó minimalizmus a használati útmutató készítésének azon szemléletmódja, hogy az útmutató tartalmazza a kritikus információkat, ugyanakkor a teljességhez szükséges legkevesebb információt használja fel. A kritikus – például biztonsággal kapcsolatos – információk sok esetben megismétlendők.

Jegyzet elhelyezéséhez, kérjük, lépj be.!

Részben ehhez kapcsolódó követelmény a tömörség, miszerint a használati utasításnak tömörnek kell lennie, mind formátumát, mind az adathordozót tekintve. Az információk tartalmának és megjelenítésének tömörsége pedig elsősorban három dolgot jelent: tömör megfogalmazást (például többszörösen összetett mondatok helyett tőmondatok használata), a szöveg és az illusztráció felesleges részletek nélkül való közlését, illetve a lehető legrövidebb videók közzétételét.

Jegyzet elhelyezéséhez, kérjük, lépj be.!

A konzisztencia nemcsak a fordításban, de már a tartalomkészítés során is hangsúlyos szempont. A tartalommal szembeni konzisztencia például azt jelenti, hogy az információ egyértelmű és helyes (például összhangban áll a támogatott termékkel). A formátumok és az adathordozó közeg közötti konzisztencia például a következetes terminológia, mértékegységek, szerkezetek, jelzések (azaz címsor, címek), szimbólumok, figyelmeztető üzenetek és a színek használatát jelenti. A konzisztencia elérése érdekében az egységes formázás céljából használt rendszereket el kell választani a következetes tartalomkészítés céljából használt rendszerektől. Ez a tartalom és a forma szétválasztásának elve. Az IEC/IEEE 82079-1:2019-ben megjegyzésként szerepel, hogy a jelölőnyelvek hozzájárulhatnak a következetesség eléréséhez. Továbbá, hogy a használati utasításnak összhangban kell lennie a támogatott termékkel kapcsolatos egyéb információkkal, például a terméken vagy annak csomagolásán, a címkén, az oktatási anyagokon, az ügyfélszolgálati és felhasználói segítségnyújtási anyagokon, valamint a promóciós anyagokon megjelenő infomációkkal.

Jegyzet elhelyezéséhez, kérjük, lépj be.!

Az információ közérthetősége arra vonatkozik, hogy a használati utasításnak a célközönség számára érthetőnek kell lennie. Ehhez közérthető szövegre és terminushasználatra van szükség, továbbá közérthető illusztrációkra, biztonsági jelzésekre és grafikus szimbólumokra, valamint közérhetőségére a tájékozódási módszerek és az adathordozó használatában. A közérthetőség magában foglalja a világosságot és az érthetőséget. A szabvány megjegyzi, hogy a közérthetőség a felhasználási körülményektől függ, illetve, hogy a közérthetőség követelménye vészhelyzet esetén különösen fontos.

Jegyzet elhelyezéséhez, kérjük, lépj be.!

Szintén fontos szempont a hozzáférhetőség. Ez azt jelenti, hogy a használati utasításnak hozzáférhetőnek kell lennie – például technikai szempontból elérhetőnek és támogatottnak – a célközönség számára az adott termék felhasználása során és annak tervezett élettartama alatt (IEC/IEEE 82079-1:2019).

Jegyzet elhelyezéséhez, kérjük, lépj be.!

A 3. ábra forrása ugyan a közösségi média, mégis közzétesszük, mert kissé szarkasztikusan, de szemléletesen mutatja be, miben különbözik egymástól egy mindennapi szöveg és egy szakszövegíró által készített szöveg.
 

Jegyzet elhelyezéséhez, kérjük, lépj be.!

3. ábra. A szakszövegírás jellemzői tömören (reddit.com)
chevron_left
chevron_right
Tartalomjegyzék navigate_next
Keresés a kiadványban navigate_next
A kereséshez, kérjük, lépj be!
Könyvjelzőim navigate_next
A könyvjelzők használatához
be kell jelentkezned.
Jegyzeteim navigate_next
Jegyzetek létrehozásához
be kell jelentkezned.
    Kiemeléseim navigate_next
    Mutasd a szövegben:
    Szűrés:
    Kiemelések létrehozásához
    MeRSZ+ előfizetés szükséges.
      Útmutató elindítása
      delete
      Kivonat
      fullscreenclose
      printsave