Kuvausmenetelmänvalinta ja käyttöönotto ohjelmistotuoteorganisaatiossa

Useiden pitkän kehityskaaren ohjelmistojen ylläpitäminen ja kehittäminen on vaikeaa, sillä niiden dokumentaatio on vajaata tai vanhentunutta. Tässä diplomityössä etsitään ratkaisua tällaisen ohjelmiston ja sen taustalla olevan järjestelmän kuvaukseen. Tavoitteina on tukea nykyisen ohjelmiston ylläpitoa ja uuden työvoiman perehdyttämistä. Tavoitteena on myös pohjustaa uuden korvaavan ohjelmiston suunnittelua kuvaamalla nykyiseen järjestelmään sitoutunutta sovellusalueosaamista. Työssä kehitetään kuvausmenetelmä järjestelmän kuvaamiseen hierarkkisesti laitteistotason yleiskuvauksesta ohjelmiston luokkarakenteeseen sekä toiminnallisuuteen asti. Laite- ja luokkarakennekuvaukset ovat rakenteellisia kuvauksia, joiden tehtävänä on selittää järjestelmän ja sen osien kokoonpano. Toiminnallisuudesta kertovat kuvaukset on toteutettu käyttötapauskuvauksina. Työssä keskityttiin erityisesti kohdejärjestelmän keskeisen ohjelmiston ja tietokannan kuvaamiseen. Ohjelmistosta valittiin tärkeimmät ja eniten sovellusalueen tietotaitoa sisältävät osat, joista työssä luotiin esimerkkikuvaukset. Kuvauksia on kehitettyä menetelmää hyödyntäen helppo laajentaa tarpeiden mukaan paitsi ohjelmiston muihin osiin, myös laitteiston ja järjestelmän kuvaamiseen kokonaisuudessaan syvemmin.

Insufficient or out of date documentation in software engineering can lead to a state where maintaining and developing a software product with long life cycle becomes difficult. Using asoftware product in similar situation as a target, this thesis is trying to find a solution to the problem. The objectives include supporting the maintenance of the current software product and familiarizing new developers with the product. Also, the development of a new software product to replace the existing one should be supported by including the product-enclosed domain knowledge in the documentation models. In this thesis, a redocumentative method of a hierarchical structure is being developed with visual and verbal models of the physical system, the database and the software. The physical structure documentation with software class diagrams forms the structural documentation of the system. The activity of the system is documented with use-case diagrams. The thesis concentrates especially on the central software and database structure of the system. The most significant parts of the software holding the domain knowledge were selected to produce sample models with the method created. The models are easy to expand and deepen as needed to cover the whole system including both its software and hardware.