A vevőszolgálati dokumentációk vagy más néven szervizdokumentációk elengedhetetlenek egy adott termék vagy termékcsoport rendeltetésszerű használatához, karbantartásához és alapszintű javításához, szerelési műveleteihez. A biztonságos üzemeltetésre vonatkozó tudnivalók mellett fontos a garanciális tevékenységet érintő összes információ átadása is a megrendelő részére a későbbi problémák elkerülése, minimalizálása végett.

Nagyon lényeges szempont a naprakészség, a vevőszolgálati dokumentációt érintő változások könnyű átvezethetősége, a megrendelőhöz való gyors eljuttatása. Egy jól megszerkesztett, pontos, átlátható, időben elkészült és nem utolsósorban látványos dokumentáció növeli a vevői elégedettséget és a későbbi újabb megrendelés esélyét.

Vevőszolgálati dokumentációk fajtái

A győri Rába Futómű Kft. viszonylatában a vevőszolgálati dokumentációknak több típusa van, amelyek a megrendelő igényeinek megfelelően készülnek el:

Kezelési és karbantartási utasítás Alapvető információt és általános ismertetőt tartalmaz a termékre vonatkozólag. A biztonságos üzemeltetéshez, rendszeres ellenőrzésekhez, az ahhoz kapcsolódó előírt karbantartásokhoz szükséges. A kenésekkel, olajozásokkal kapcsolatos információ is ebben a dokumentációban található.

Műszaki adatok Rövid táblázatos gyűjtemény a termékre vonatkozó műszaki paraméterek konkrét számértékeivel, adataival. Tartalmazza a termék méreteit, beépülési paramétereit, a kötőelemekre vonatkozó meghúzási nyomatékokat, valamint a szerelésekkor betartandó egyéb beállítási adatokat. Egy termékcsalád több altípusból is állhat, amelyeknél számos műszaki paraméter ugyanaz, viszont lehetnek eltérések, amelyeket a táblázatban szerepeltetni kell az egyes típusokhoz specializáltan.

Alkatrész-katalógus Pontosan tartalmazza a termék minden egyes alkatrészét, azok valamennyi azonosító adatát és a beépülési darabszámot is. Az azonosító adatoknál a következő adatokat kell feltüntetni: cikkszám (a belső rendszerben alkalmazott egyedi azonosító, amely a későbbi esetleges pótalkatrész-rendeléseket is megkönnyíti), rajzszám, megnevezés. Az alkatrész-katalógust fel kell bontani szerelési egységekre a könnyebb áttekinthetőség kedvéért.

A szerelési egységek, funkcionális részegységek igazodnak a termék szerkesztési darabjegyzékéhez. Egy szerelési egységnél az alkatrész-katalógus a tételek listájának táblázatából, valamint egy hozzá tartozó ábrából áll. Ez utóbbi a régebbi dokumentációk esetében tételszámozott 2D-s rajz, metszet, szabadkézi perspektivikus robbantott ábra, vagy az újabbak esetében 3D-s Pro/Engineer terméktervező rendszerben készített sorszámozott, robbantott ábra.

Javítási utasítás Részletes dokumentáció, amely a termék vevő által is elvégezhető javításait, illetve beállításait tartalmazza pontos időrend ben mind a szét-, és mind az összeszerelésre vonatkozólag. A szerelési műveleteknél külön és a megfelelő helyen kell jelezni a Rába által gyártott és a vevő részére biztosított speciális szerszámok listáját, azok felhasználási módját. A dokumentáció tartalmazza az általános szerelési előírásokat, óvintézkedéseket, valamint a Rába által javasolt szerelési segédanyagok felhasználási módját.

Dokumentációkészítési korlátok

Az évek, évtizedek óta használatos dokumentációkészítési módszerek mára elavultak. A dokumentációk régi eljárásokkal való készítése statikus és lassú, megjelenésük nem egységes, a módosítások átvezetése időigényes. Az alkalmazott szövegszerkesztő szabadsága miatt nincs két egyforma stílusú, kinézetű dokumentáció. Sok az ismétlődés, egyes szövegtörzsek, táblázatelemek a különböző dokumentumrészekben többször ismétlődnek, sok helyen kell a dokumentációt módosításkor átnézni.

A másolásokkal karbantartott dokumentum egyes részei sokszor nem a legutolsó állapotot tükrözik. Időhiány miatt sok esetben mérnöki munkaerőt is be kell vonni a szervizdokumentációs munka segítésére. Hátrány például a felhasznált 3D-s adatok esetén, hogy az eredeti modell és az abból készített illusztráció között nincs kapcsolat, így módosítás esetén az átvezetés sok munkával jár, sőt néha teljesen elölről kell kezdeni az illusztráció készítését.

A tavalyi év folyamán a Rábánál is alkalmazott Pro/Engineer 3D-s terméktervező rendszer forgalmazója, az S&T Consulting Kft. lehetőséget biztosított a termékhez szorosan kötődő Arbortext szervizdokumentációs csomag tesztelésére. A később bővíthető csomag három alapkomponensből áll. A Creo Illustrate az illusztrációk könnyű elkészítésében nyújt segítséget, asszociatív kapcsolatot biztosítva a forrás 3D-s testmodellező rendszerrel, a Pro/Engineerrel.

A dokumentáció összeállításában és az elkészült illusztrációk integrálásában fontos szerep jut az Arbortext Editornak, amely nem egy hagyományos értelemben vett szövegszerkesztő, hanem az egyik legkorszerűbb XML technológiát alkalmazó úgynevezett HTML webszerkesztő, amely merőben más filozófiát, módszereket nyújt a dokumentációkészítéshez. A csomag harmadik eleme az Arbortext Styler, amely az előző két elem összefogását, az egységes stíluslapok szerinti formázást és az elkészült forrásanyagok több kimeneti formátumban történő publikálását támogatja.

Illusztrációk készítése könnyedén

A meglévő 3D-s modelleket és összeállításokat importálni lehet a Creo Illustrate illusztrációs szoftverbe, ahol különböző műveleteket lehet végrehajtani rajtuk. Az így kapott modellek könnyedén rendezhetők, beállíthatók különböző helyzetekbe, ezáltal az adott beépítési, szerelési művelethez generálhatók specifikus nézetek. A kapott ábrákat különböző megjegyzéselemekkel, beépített illusztrációs elemekkel és tételsorszámozásokkal tovább lehet alakítani.

Az asszociatív kapcsolat az eredeti modellel megmarad, vagyis az adott modell változása esetén frissülhet az illusztráció is. Az ilyen mértékű automatikus kapcsolathoz az szükséges, hogy mindenképpen az a modell vagy az az összeállítás módosuljon fizikai fájl formájában, amelyre az illusztráció hivatkozik. Ez a legkönnyebben akkor kontrollálható, ha a modell és az illusztráció is egy adatbázisban található. A szoftver egyszerűsített megjelenítést alkalmaz, amellyel a nagy elemszámú összeállítások is könnyebben kezelhetők.

A modelleket a szoftver képes leegyszerűsíteni, olyan nézeteket generálni, ahol a részletes elemek eltűnnek, csak a publikációs célra fontos elemek, vonalak, részletek maradnak meg, akár takart vonalas megjelenítésben, különböző vonalvastagságok alkalmazásával. Az illusztrációs szoftver esetében bevezetésre kerül egy új fogalom, az sBOM (service bill of materials, azaz szervizdarabjegyzék), amely egy nem létező fiktív darabjegyzék, azonban az illusztrációs munkákhoz szükséges összes elemet tartalmazza.

A gyakorlatban a 3D-s összeállítások beolvasása után az illusztrációs szoftverben megjelenik a tételek kapcsolatát leíró, konstrukciós vagy szerkesztési darabjegyzék (eBOM). Ehhez hozzávehetünk további olyan elemeket, amelyek az illusztráció készítéséhez szükségesek, például szerelési segédanyagok, egyéb szereléshez szükséges szerszámok modelljei vagy illusztrációs elemtárból kiemelt előre definiált tételek, vagyis létrejön az sBOM.

Egy illusztrációs fájl több, egymástól független ábrát is tartalmazhat, így egy fájlba össze lehet szervezni a komplett szervizdokumentációhoz tartozó illusztrációs ábrákat. Például készíteni lehet egy ismertetőábrát a kezelési utasításhoz, tételsorszámozott robbantott ábrát az alkatrész-katalógushoz vagy egy másik szerelési segédanyagokkal, sorszámokkal, megnevezésekkel és orientációs nyilakkal „felokosított” robbantott részletábrát a javítási utasításokhoz. Az illusztrációs szoftverrel videókat is könnyedén lehet készíteni.

Az animációs lehetőségeket segíti a számos beépített segédelem, amelyekkel a tételeket könnyedén lehet csoportosítani, külön kiemelni, megjeleníteni, eltüntetni stb. Egyszerűen lehet pozicionálni, forgatni az animáción belül. Az elkészült videóhoz tartozik egy szerkesztési sáv, ahol szerkeszthetők a videók, lehetőség van egyes részeket kivágni, másolni, eltolni, törölni vagy éppen sorrendet változtatni, gyorsítani, lassítani az animációs részeken.

Dinamikus szövegszerkesztés

Egy Arbortext Editorban készült webalapú dokumentáció központi eleme a tartalomjegyzékfájl vagy más néven dokumentumtérkép, amelyben össze lehet állítani a teljes dokumentáció struktúráját akár több szinten is. A struktúra meghatározza a későbbi tartalomjegyzéket. A tartalomjegyzékben lévő tételek helyei rugalmasan alakíthatók, ezzel automatikusan módosulhat a tartalomjegyzék is.

A dokumentumtérképben különböző szinteken lévő bejegyzések, tételek az úgynevezett DITA (Darwin information typing architecture) fájlok, amelyek megtestesíthetnek egy elkülönült részt, tipikusan egy fejezetet, alfejezetet. Egy ilyen elkülönült szövegmodul tartalmazhat címeket, alcímeket, szövegtörzseket és képi, illusztrációs hivatkozásokat, más fejezetekre, elemekre mutató referenciákat.

A struktúra a hagyományos szövegszerkesztőkhöz képest meglehetősen kötött, vagyis a felhasználó számára csak nagyon minimális formázásokat, testre szabást engedélyez. Továbbá bizonyos elemet csak meghatározott helyekre enged beilleszteni. A dokumentációt készítő rákényszerül, hogy csakis a szövegrészletekkel és külső képek, illusztrációk, objektumok beillesztésével foglalkozzon, ne a formázással. Ez a fajta kötöttség kevés szabadságfokot biztosít, de gyorsítja a dokumentációkészítési folyamatot, és az összes dokumentum esetében egységes kimenetet biztosít.

A konkrét képeket, illusztrációkat, objektumokat be lehet illeszteni és megjeleníteni a szövegtörzsben, de a rendszer azoknak csak a hivatkozásait tárolja. A fájlok lehetnek valamilyen helyi könyvtárban, megosztott hálózati könyvtárban, webszerveren vagy éppen egy adatbázisban is. Nagy előny, hogy Arbortext Editorban lehetőség van az úgynevezett profilozás használatára. Ez azt jelenti, hogy minden egyes elhelyezett elemet, legyen az akár egy betű, szó, mondat, bekezdés vagy éppen egy kép, illusztráció megjelölhetünk profiltagekkel, azaz egyéni paraméterekkel.

A profilok segítségével szabályozhatjuk, hogy mi jelenjen meg egy kimenetben, vagyis a publikáló szoftver a forrásszöveget alapul véve mely részeket emelje be a végső kimenetbe, kvázi szűrőként működik. Ezzel a módszerrel lehetőség van arra, hogy minden információt egy dokumentumhalmazba szedjünk össze, és abból más-más kimenetet generáljunk. Profilozási lehetőség például az egyes nyelvi verziók kezelése vagy a különböző szervizdokumentációk fajtái. 

Publikációs folyamat

A szoftvercsomag harmadik része az Arbortext Styler program, ahol lehetőségünk van stíluslapokat definiálni, vagy meglévőket felhasználni, átalakítani. A stíluslapok mindenre kiterjedően leírják az összes alkalmazható elem kinézetét, formázását, viselkedését stb. Ez biztosítja azt, hogy ugyanazon elemek, legyen az címlap, margók, fejezetek, fejezetcímek, bekezdések, képek, illusztrációk stb. ugyanúgy nézzenek ki a teljes dokumentáción belül. Továbbá egy helyen kell csak változtatni ezeket a beállításokat.

A stíluslap az elrendezést is szabályozza. Lehetővé teszi kétoldalas dokumentumok esetén a páros és páratlan oldal megkülönböztetését. Az Arbortext Stylerben automatikus generálófunkciók is vannak. A tartalomjegyzék – amely a címlap után helyezkedik el –, valamint a dokumentum végére kerülő indexlap publikáláskor létrejön. A publikálás egy folyamat, amely a kész forrásszövegből és elhelyezett objektumokból kiválasztott formátumot generál. Arbortext Editorban létrejött a dokumentumtérkép a beépített fejezetekkel, azok megfelelő sorrendjével.

A fejezeteket taglaló dokumentumfájlok tartalmazzák a címeket, a szövegrészleteket, a képi hivatkozásokat is. Creo Illustrate-ben elkészülnek az illusztrációk, de természetesen bármi más formátumú képi vagy videoanyag is integrálható. A publikálási folyamat elindításakor az Arbortext Styler elkészíti a címlapot és a tartalomjegyzéket, a fejezeteket a dokumentumtérkép alapján sorba rendezi és beépített stíluslapok alapján megformázza, az indexlapot a dokumentum végén létrehozza.

Többféle kimenet választható, így a klasszikus pdf vagy a más szövegszerkesztőben használatos rtf kimenet. Lehetőség van html és xml kimenetre is, amely alapja lehet bármely intranetes vagy internetes kiadásnak. Ha a kimenet html, és a kimenet helye valamely webszerveren lévő publikus könyvtár, akkor lehetőség van vállalaton belüli intranetes oldalakra vagy akár külső partnerek részére hozzáférhető internetes felületre publikálni. Ugyancsak mód nyílik CD-re kiírható böngészhető szerkezetű katalógus készítésére. 

Bevezetési előkészületek

Egy ilyen komplex rendszer bevezetésekor körültekintően kell eljárni. A bevezetéskor nagy munkát jelent az első dokumentációk elkészítése, az adattárolási rendszer kigondolása, kiépítése, a Windchill adatbázis-integráció is. Az első időszakban biztosan több időt igényelhet az új rendszerben lévő dokumentáció elkészítése a korábbi módszerekhez képest. Érdemes alaposan átgondolni, hogy milyen kiépítést válasszunk, figyelembe véve a lehetőséget, a feladatra kijelölt kolléga vagy kollégák számát, az alkalmazott munkamódszereket, a konstruktőr és a szervizdokumentáció felelőse közötti munkamegosztás mértékét.

Ehhez mérten kell kiválasztani a licencek számát, típusát, a rendszer kiépítésének terjedelmét. Fontos átnézni az évek vagy akár évtizedek óta alkalmazott munkamódszereket. Célszerű elmozdulni az új rendszer kialakításakor a következőkben felsorolt irányokba:

• Minél kevesebb szöveg, annál több illusztráció. Egy kép sokkal többet jelenthet egy bekezdésnyi szövegnél. Ezzel a módszerrel például a fordítási költségek is csökkenthetők. A módosítások átvezetése is könnyebb a képeken.

• Célszerű – ahol lehet – egységesítésekkel csökkenteni az előforduló változatok számát. Szerencsés például a megnevezések, alkatrész-elnevezések vagy szerelési műveletek szövegezését egységesíteni, ebből „adatbázist” létrehozni, hogy később a hasonló jellegű másik termék dokumentációjában felhasználható legyen.

• Lehetnek olyan ismétlődő szövegek, képek, bekezdések vagy fejezetek, amelyeket csak egyszer kell elkészíteni, és utána több helyen felhasználhatók a későbbi dokumentumokban A körültekintő, jól átgondolt és lépcsőzetes bevezetés megkönnyíti egy egységes rendszer kialakulását a vevőszolgálati dokumentáció készítésének folyamatában.