3.2. A dokumentációkészítés folyamata

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

A műszaki tartalom tervezése és fejlesztése több lépésből álló folyamat. Czinkóczki és Fehér hat részre osztja a műszaki szakszöveg készítésének folyamatát (Czinkóczki & Fehér, 2019): (I) tervezés, (II) információgyűjtés, (III) tartalomkészítés, (IV) ellenőrzés, (V) fordítás és (VI) kiadás. Az IEC/IEEE 82079-1:2019 szabvány alapján a használati utasítások készítésének folyamatába olyan lépések tartoznak bele, mint például (1) az információ elrendezésének megtervezése, (2) információgyűjtés, (3) a tartalom szerkezetének kiválasztása, (4) az információ elrendezésének felhasználásával a grafikai és írott tartalom létrehozása, (5) az információ felvitele a meghatározott adathordozóra, (6) a tartalom szerkesztése, (7) lektorálása és (8) a használati utasítás termékkel közös értékelése.

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

Az áttekinthetőség érdekében a műszaki dokumentáció készítésének legfontosabb lépéseit a 2. táblázat összegzi.
 

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

2. táblázat. A dokumentációkészítés legfontosabb lépései (Faludi, 2020, 84)
A dokumentációkészítés folyamata
Műszaki szakszöveg készítése Czinkóczki & Fehér, 2019 alapján
Használati utasítások készítése
az IEC/IEEE 82079-1:2019 szabvány alapján
(I)
tervezés
(1)
az információ elrendezésének megtervezése
(II)
információgyűjtés
(2)
információgyűjtés
(III)
tartalomkészítés
(3)
a tartalom szerkezetének kiválasztása
(4)
a grafikai és írott tartalom létrehozása
(5)
az információ felvitele a meghatározott adathordozóra
(6)
a tartalom szerkesztése
(IV)
ellenőrzés
(7)
lektorálás
(8)
a használati utasítás termékkel közös értékelése
(V)
fordítás
(VI)
kiadás
 

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

Czinkóczki és Fehér felosztása átfogóbb, általánosabb leírást kíván adni a műszaki szakszövegek készítéséről (Czinkóczki & Fehér, 2019). Mint a 2. táblázatban látható, az általuk tartalomkészítési szakasznak nevezett fázisba (III) sorolható a használati utasítások esetében a tartalom szerkezetének kiválasztása (3), az információ elrendezésének felhasználásával a grafikai és írott tartalom létrehozása (4), az információ felvitele a meghatározott adathordozóra (5) és a tartalom szerkesztése (6). Ellenőrzésből használati utasítások esetén kétféle is ajánlott: a lektorálás (7) és a termékkel közös értékelés (8). Az IEC/IEEE 82079-1:2019 szabványban nagyobb hangsúlyt kapnak továbbá a grafikai és írott tartalom létrehozásának, az információ felvitelének és szerkesztésének technikai jellegű fázisai (4, 5, 6).

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

A továbbiakban Czinkóczki és Fehér tanulmánya (Czinkóczki & Fehér, 2019), valamint a felsorolt szabványok alapján mutatjuk be röviden a dokumentáció készítésének legfontosabb lépéseit. A Czinkóczki és Fehér által felvázolt folyamatban két olyan részfolyamat – a fordítás (V) és a kiadás (VI) – is a szakszövegírás részeként jelenik meg, amelyeket ebben a fejezetben, a szoros értelemben vett dokumentáció készítésének keretei között nem tárgyalunk. (A fordítással a 4.2. fejezetben, a fordítási projektfolyamatról szóló részben foglalkozunk.)
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