Järjestelmäintegraatioiden dokumentointi

Abstract

Tämän työn toimeksiantajana toimii Mepco Oy. Opinnäytetyöni ja kehittämistehtäväni tavoitteena oli kehittää ja parantaa Mepco Oy:n järjestelmäintegraatioiden määrittely- ja kehitystyötä. Kehittämistehtävänäni oli luoda Mepco Oy:lle järjestelmäintegraatioiden dokumentointipohja.

Tämä opinnäytetyö on toteutettu toimintatutkimuksena. Kirjallisuuden lisäksi materiaalina on käytetty olemassa olevia järjestelmäintegraatioiden dokumentointipohjia, joista on pyritty löytämään parhaita käytäntöjä dokumentoinnin kehittämistä varten.

Järjestelmäintegraatioiden toteuttamisessa dokumentaatio nousee merkittävään osaan, koska dokumentaation pitäisi toimia kivijalkana integraation toteuttamiselle ja toimimiselle koko integraation elinkaaren ajan. Onnistunut dokumentointi onkin edellytys onnistuneeseen järjestelmäintegraatioprojektiin. Tässä opinnäytetyössä keskityttiin nimenomaan järjestelmäintegraatioiden dokumentointiin, jonka avulla voidaan kehittää ja parantaa järjestelmäintegraatioprosessia.

Tässä opinnäytetyössä havainnollistetaan, että mikäli järjestelmäintegraatioiden dokumentoinnista halutaan mahdollisimman yhdenmukaista ja tätä kautta selkeää, tulee integraatioiden dokumentointia varten kehittää dokumentointipohja. Dokumentointipohjan tulee olla niin helppokäyttöinen, ettei erillisiä koulutuksia tai ohjeistuksia sen käyttöön tarvita, vaan dokumentti ohjaa itsenäisesti eri kohtien täyttämistä. Kun dokumentaatio saadaan yhdenmukaistettua dokumentointipohjan avulla, voidaan myös kehitys- ja testaustyötä tehdä saman prosessin mukaisesti projektista riippumatta.

Tämä opinnäytetyö oli taustatyötä Mepco Oy:lle kehitetylle järjestelmäintegraatioiden dokumentointipohjalle eli tässä kuvataan millä tavoin hyvä dokumentointipohja voidaan luoda. Mepco Oy:lle kehitetty dokumentointipohja ei sisälly tähän opinnäytetyöhön.

Järjestelmäintegraatioiden tekniikat ja käytännöt kehittyvät jatkuvasti ja tämän vuoksi myös niiden dokumentoinnin tulee kehittyä. Jatkokehitysideana onkin prosessinomainen dokumentaation kehittäminen sitä mukaa, kun järjestelmäintegraatiot kehittyvät.

This thesis was commissioned by Mepco Oy. This thesis and an associated development project aimed at developing and improving Mepco's application integration process. The development task was to create an application integration documentation template for Mepco.

This thesis was carried out as an operational research. Literary material and existing application integration documentation templates were used as a sources of information.

The application integration documentation is a significant part of all integration projects, because the documentation should serve as a foundation for the implementation of the entire integration lifecycle. Successful documentation is a prerequisite for a successful application integration project. This thesis is focused specifically on documenting application integration, which can be used to develop and improve the application integration process.

Application integration documentation should be as consistent as possible and that is why there should be a documentation template. A documentation template should be so easy to use that no separate training or guidelines to its use is needed. When documentation can be harmonized by a documentation template, also the development and testing can be harmonized regardless of the project.

This thesis functioned as the background work for development of Mepco's application integration documentation. The ways in which a good documentation template is created are described in this thesis. Mepco's documentation template is not included in this thesis.

The ways in which a good documentation template is created are described in this thesis.

Application integration techniques and practices improve constantly and therefore also their documentation should evolve. One further development idea is to improve the documentation template when integration techniques are developing.