Automatikus dokumentáció szintézis modell-vezérelt fejlesztési folyamatokhoz

OData támogatás
Konzulens:
Dr. Hegedüs Ábel
Méréstechnika és Információs Rendszerek Tanszék

Az egyre összetettebb szoftverek tervezése és megvalósítása során a folyamat dokumentálása egy nélkülözhetetlen feladat. A rendszer bonyolultságával arányosan a dokumentáció mérete is növekszik, amelynek az elkészítése és karbantartása jelentős időbefektetést igényel.

Dokumentáció többféle módon is készíthető, akár egyszerű szövegszerkesztőkkel, vagy olyan dokumentációs eszközök használatával, amelyek kapcsolatot teremtenek a dokumentáció szövege és a dokumentált tartalom között. Ez nem csak a karbantartás folyamatában nyújt segítséget, de bizonyos részek automatikusan is előlállíthatók. Azonban ezek az eszközök általában csak egy bizonyos problémakör dokumentációjára vagy egy konkrét fejlesztési módszer használatával alkalmazhatók.

Egy ilyen módszer a modellvezérelt szoftverfejlesztés, ahol a cél a minél teljesebb, helyes modellek megalkotása, az intelligens fejlesztőkörnyezetek pedig a kód egy részének automatikus generálását teszik lehetővé. Különböző fejlesztőkörnyezetek is elérhetőek, azonban egy környezeten belül sem feltétlenül képes együttműködni a dokumentációs szoftver a többi eszközzel. Modellvezérelt fejlesztésben egyik ilyen népszerű modellezési keretrendszer az Eclipse Modeling Framework.

A szakdolgozat keretében egy olyan dokumentáció készítésére alkalmas szoftvert készítettem, ami a fejlesztőkörnyezetbe épül és használatával modellek elemeihez dokumentáció részletek köthetők. A dokumentáció szövegének írását egy egyszerű szerkesztőfelület segíti azzal, hogy a dokumentumban megadható formázások hatása írás közben is ellenőrizhetők. Az alkalmazás számára egy általános struktúrát megadva képes a dokumentáció és modell részletek behelyettesítésével egy struktúrált dokumentum előállítására.

A dolgozatban bemutatom az eszköz elkészítéséhez szükséges technológiákat, az Eclipse Platformot, az EMF-et, mint modellvezérelt fejlesztési eszközt, különböző dokumentum formátumokat és az EMF modellek dokumentálására néhány jelenleg létező megoldást.

Ezután megtervezem és elkészítem az alkalmazást, létrehozok egy példa modellt, amelyen keresztül a szoftver működését kipróbálom.

Letölthető fájlok

A témához tartozó fájlokat csak bejelentkezett felhasználók tölthetik le.