3. A műszaki dokumentáció készítése

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

A műszaki dokumentáció tartalmát, tagolását, formai felépítését, megjelenítését Magyarországon is bevezetett, de magyar nyelven sajnos nem elérhető szabványok rögzítik; például a következők:

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

  • MSZ EN 62023:2001 Műszaki tájékoztató és dokumentáció felépítése
  • MSZ EN 82079-1:2013 Használati utasítások készítése. Tagolás, tartalom, megjelenítés. 1. rész: Általános elvek és részletes követelmények (ennek újabb változatát Magyarországon még nem vezették be; ez az IEC/IEEE 82079-1:2019 Preparation of information for use (instructions for use) of products – Part 1: Principles and general requirements)
  • MSZ EN ISO 10209:2022 Termékek műszaki dokumentációja. Szakszótár. Műszaki rajzokra, termékmeghatározásra és a kapcsolódó dokumentációra vonatkozó szakkifejezések
  • MSZ EN ISO 11442:2006 Termékek műszaki dokumentációja. Dokumentumkezelés
  • MSZ EN ISO 3098-1:2015 Termékek műszaki dokumentációja. Feliratok. 1. rész: Általános követelmények
 

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

Elsősorban a rendszer- és szoftverfejlesztés területére fókuszáló, de a használati utasítások készítését és kezelését érintő további mérvadó, Magyarországon még nem bevezetett szabvány például:

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

  • ISO/IEC/IEEE 26531:2015 Software and system engineering – Content management for product life-cycle, user, and service management documentation
 

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

Az ISO/IEC/IEEE 26511, 26512, 26513, 26514 és 26515-ös szabványcsalád szintén a rendszer- és szoftverfejlesztés területén foglalkozik a használati utasítások készítésének folyamatával. Ebből a szabványcsaládból a következőket emeljük ki:

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

  • ISO/IEC/IEEE 26511:2018 Systems and software engineering – Requirements for managers of information for users of systems, software, and services
  • ISO/IEC/IEEE 26513:2017 Systems and software engineering – Requirements for testers and reviewers of information for users
  • ISO/IEC/IEEE 26514:2022 Systems and software engineering – Design and development of information for users
 

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

A műszaki dokumentációra vonatkozó szabványokról lásd Bölcskei (2021) tanulmányát; a szabványosítás folyamatáról, a terminológiai, valamint a fordításra és a tolmácsolásra vonatkozó szabványokról lásd Fóris & Bölcskei (2019c) és Sermann (2021) könyveit.

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

A műszaki dokumentáció több mindenben különbözik a többi fajta dokumentációtól. Az egyik, műszaki megoldásokkal foglalkozó vállalat weboldalán fedeztük fel az alábbi jellemzők felsorolását (Ovitas weboldala, n. d.):

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

  • a dokumentumok gyakran nagy méretűek;
  • a dokumentált termék folyamatos fejlesztése miatt a dokumentáció változik, de a változás gyakran csak kis részét érinti a dokumentumnak;
  • a dokumentáció gyakran több dokumentumból áll (dokumentációegység);
  • a módosított dokumentációegység új revíziója akkor válik érvényessé, ha minden hozzá tartozó dokumentumverzió jóváhagyásra került;
  • a dokumentációs folyamatra általában szigorú minőségirányítási előírások vonatkoznak;
  • a módosításnak és jóváhagyásnak szigorúan szabályozott menete van;
  • a dokumentumok megtekintése különböző eszközökkel történik: papíron, számítógépen vagy egy a terepen dolgozó mérnök esetében mobileszközön;
  • a dokumentáció – különösen a felhasználói – sok esetben több nyelven készül.
 

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

A továbbiakban részletesen foglalkozunk a műszaki dokumentáció készítésének minőségügyi vonatkozásaival (3.1.), a dokumentáció készítésének lépéseivel (3.2.), a fordítási céllal létrehozott dokumentáció követelményeivel (3.3.), a terminológiai munkára vonatkozó előírásokkal (3.4.), valamint a nyelven belüli fordítás kérdéseivel (3.5.).
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