Dokumentációk

A dokumentációnak tartalmaznia kell a gyártmány, berendezés tervezéséhez, gyártásához és üzemeltetéséhez szükséges információk összességét. Ez alapján beszélhetünk tervezői-, gyártási- és felhasználói dokumentációról.
A tervezői dokumentáció a tervezési fázisban keletkezett kiindulási dokumentáció, ami utasításokat tartalmaz a későbbi gyártási dokumentáció kialakításához, illetve annak tovább fejlesztéséhez.
A gyártási dokumentáció szabványos rajzi és szövegi formában tartalmaz minden olyan információt, amely szükséges az adott gyártmány létrehozásához.
A felhasználói dokumentáció tartalmaz minden olyan leírást és rajzot, amely a zökkenőmentes üzemeltetéshez szükséges, illetve egyes esetekben szerviz célú iratokat is szokás megadni, valamint mellékelni.

A dokumentációk célja

A dokumentáció célja, hogy szabványos ábrázolással és a felhasználó szakképzettségének megfelelő megfogalmazással tartalmazza a gyártmány, berendezés tervezéséhez, gyártásához és üzemeltetéséhez szükséges információk összességét.
A szabványos ábrázolás alatt, a műszaki ábrázolás szabályainak megfelelően elkészített rajzokat értjük. Az ábrázolási szabályok szakmaspecifikusak lehetnek. A villamosipari dokumentációkban például absztrakt ábrázolással, az alkatrészek szimbolikus jelöléseivel találkozhatunk. Ezzel szemben a gépipari rajzokon az alkatrészeket a legtöbb esetben valós formájukban ábrázolják.
A szakképzettségnek megfelelő megfogalmazás arra a tényre utal, hogy a termék útja során a tervezéstől a gyártáson át a felhasználásig különböző műszaki szaktudással rendelkező személyek fogják a dokumentációt olvasni. Ennek megfelelően a munkafolyamat különböző szintjein állók számára eltérő megfogalmazásokat kell használni.

Tájékozódás

Egyes dokumentációk főleg összetett gépek, berendezések esetén nagy terjedelműek lehetnek. A dokumentációban való eligazodás feladat nem is olyan egyszerű, mint gondolnánk.
Ha egy konkrét problémára keresünk megoldást akkor először fogalmazzuk meg magunknak kérdésünket egyértelműen. Gondoljuk végig, hogy a dokumentáció mely részében találhatunk választ kérdésünkre, a keresett információ a tervezésre, a gyártásra, vagy a felhasználásra vonatkozik-e?
Előfordul, hogy a használt berendezés meghibásodik. Ebben az esetben a felhasználói dokumentációban szereplő felhasználói kézikönyvben kideríthetjük a hiba okát. Könyvek általában tartalmaznak hibajavító kulcsokat, melyek a tünetek alapján a hiba okához vezetnek minket.
Ha a technikai rendszer egy konkrét elemének leírására vagyunk kíváncsiak, akkor a dokumentáció tartalomjegyzéke lehet segítségünkre.
Ha a keresett részrendszer nevét nem ismerjük, vagy csak általában szeretnénk ismerkedni a dokumentációval, akkor haladjunk az általánostól az egyedi felé. Keressünk összeállítási rajzot, vagy elvi rajzot, amin az egész rendszert áttekinthetjük, majd így haladjunk a részletek felé.

Nyomdaipari dokumentációk

A nyomdaipari gépekre, mint minden technikai rendszerre a dokumentáció készítés szabályai kötelezően vonatkoznak. A dokumentációnak tartalmaznia kell a gép teljes és részletes leírását.
A leírás történhet írásban és rajzon, ez alapján beszélhetünk a dokumentáció szöveges és rajzos részeiről.
A szöveges rész tartalmazza a műszaki leírásokat, számítások, mérések eredményeit, szabadalmi iratokat.
A rajzi részben találhatók a műhelyrajzok, technológiai és elvi rajzok, egyszóval az eszköz minden szükséges rajza.

Ellenőrző kérdések:

Mit kell tartalmaznia egy dokumentációnak?

Milyen dokumentációk léteznek?

Mi a dokumentációk célja?

Hogy igazodunk el a dokumentációkban?