Arkkitehtuurin dokumentointi kehittäjän ja ylläpidon näkökulmasta : case: Kanta-palvelut

Abstract

Tietojärjestelmäkehityksessä arkkitehtuurin dokumentoinnilla on suuri merkitys. Merkitys korostuu kehityksen eri vaiheissa, niin uuden työntekijän perehdytyksessä kuin ylläpidossa tuotannon ongelman selvittelyssä. Alan kirjallisuudessa dokumentaation merkitys korostuu erityisesti, kun dokumentaatio ei ole ajan tasalla tai helposti löydettävissä ja sidosryhmien välisessä kommunikaatiossa. Myös ketterä kehitys antaa oman näkökulman dokumentaation merkitykselle. Tällä pro gradu -tutkimuksella pyrittiin etsimään vastauksia siihen, mikä on Kanta-palveluiden arkkitehtuurin dokumentaation nykytila, millaiselle arkkitehtuurin dokumentaatiolle on tarvetta ja miten arkkitehtuuria tulisi mallintaa, jotta se voisi palvella mahdollisimman laajaa joukkoa henkilöstöstä yli organisaatiorajojen. Tutkimuksen empiirinen osuus toteutettiin teemahaastatteluilla, johon osallistui 13 asiantuntijaa Kanta-palveluista. Tutkimuksen motivaationa oli tutkijan oma mielenkiinto arkkitehtuurin dokumentaatioon sekä tarve kehittää dokumentaatiota Kanta-palveluissa. Tutkimustulokset analysoitiin sisällönanalyysillä. Teemahaastatteluiden perusteella havaittiin, että dokumentaatio on kirjavaa ja ne ovat hajautuneet moneen eri paikkaan. Tämä johtaa siihen, että dokumentaatiot eivät ole ajan tasalla tai helposti löydettävissä. Puutteellisesta dokumentaatiosta on enemmän haittaa kuin hyötyä. Dokumentaation merkitys myös korostui sidosryhmien välisessä kommunikaatiossa ja yhteisten mallien puutteena. Haasteet johtavat siihen, että dokumentaatiota ei tuoteta kirjoitettuun muotoon riittävällä tavalla tai dokumentaatio jopa sivuutetaan ja tehdään, kun siihen on aikaa. Haasteet voidaan voittaa sillä, että dokumentaatio on osa jatkuvaa kehittämistä ja siihen on varattu riittävästi aikaa. Kehityksessä täytyy ottaa selkeitä askeleita dokumentaation selkeyttämiseen kehityksen alkuvaiheesta asti. Tähän voi auttaa myös työpajojen järjestäminen aiheen tiimoilta. Ohjeistusta täytyy päivittää ja työkaluja ottaa käyttöön aktiivisemmin.

In information system development, the documentation of architecture is of the great importance. The importance is emphasized at different stages of development, both in the orientation of a new employee and in the maintenance when dealing with the issue from the production. In the literature, the importance of documentation is especially emphasized when the documentation is not up-to-date or easy to find and in communication between stakeholders. Agile development also gives its own perspective on the importance of documentation. The aim of this master's study was to find answers to the current state of the architecture documentation for Kanta services, what kind of architectural documentation is needed and how the architecture should be modeled in order to serve the widest possible number of personnel across organizational boundaries. The empirical part of the study was carried out through thematic interviews with 13 experts from Kanta services. The motivation for the research was the researcher's own interest in the documentation of architecture and the need to develop documentation in Kanta services. The study results were analyzed by content analysis. Based on the thematic interviews, it was found that the documentation is diverse and scattered in many different places. This results in the documentation not being up-to-date or easy to find. Incomplete documentation does more harm than good. The importance of documentation was also emphasized in the communication between stakeholders and in the absence of common models. Challenges result in the documentation not being produced in a written form adequately, or the documentation is even ignored and done when time allows. Challenges can be overcome by ensuring that documentation is part of continuous development and that sufficient time is set aside for it. Clear steps must be taken early on in the development to clarify the documentation. Organizing workshops on the topic can also help with this. The instructions need to be updated and the tools must be taken into use more actively.