IT-documentation framework for an Engineering and Service Company

Abstract

This thesis focuses on developing an IT-documentation framework for the IT-organisation of an engineering and service company, KONE Oyj. The case company’s IT-organisation has received feedback from previous external and corporate quality audits that the quality of the IT documentation does not fully comply with the ISO9001 standard requirement and document controls should be more clearly determined and identified. The case company was also facing challenges in terms of traceability of solutions and decisions as there was no unified documentation framework for IT-services in place in the beginning of this thesis. Therefore, the objective of this study is to develop an IT-documentation framework that supports the KONE way of working and aims to improve the traceability of IT-solutions and decisions.

This thesis was carried out as a case study, collecting data in the form of interviews with experts from various departments of the case company and by studying internal documents in addition to finding out what relevant literature suggests as solutions to found issues.

Key findings of the research were that documentation is carried out in various ways and quality is lacking in many areas because no unified practices have been constructed.

The final outcome of this thesis was constructed in three parts: the visual representation of the IT-documentation framework, a table consisting of the minimum viable documentation with the purpose, associated owner, and audience of each document, and a table consisting of the baseline documents and of which documents they are compiled of, their associated owner, audience and purpose.

The framework will act as a starting point on developing IT-documentation practices and promoting the importance of quality and documentation.

Opinnäytetyö keskittyy kehittämään IT-dokumentointikehyksen tekniikan- ja palvelualan yrityksen KONE Oyj:n IT-organisaatiolle. Tapausyrityksen IT-organisaatio oli saanut palautetta aikaisemmissa ulkoisissa ja sisäisissä laatuauditoinneissa, ettei IT-dokumentoinnin laatu täysin vastaa ISO9001-standardin vaatimuksia ja että dokumenttienhallinta olisi määritettävä selkeämmin ja yksilöitävä. Tapausyrityksellä oli myös haasteita ratkaisujen ja päätösten jäljitettävyyden suhteen, koska opinnäytetyön alussa yrityksellä ei ollut olemassa yhtenäistä näkymää IT-palveluiden dokumentaation tasosta. Tämän tutkimuksen tavoitteena onkin kehittää IT-dokumentointikehys, joka tukee KONEen työskentelytapaa ja jonka tavoitteena on parantaa IT-ratkaisujen jäljitettävyyttä.

Tämä opinnäytetyö tehtiin tapaustutkimuksena, missä kerättiin tietoja tapausyhtiön eri osastojen asiantuntijoilta haastattelujen muodossa ja tutkimalla sisäisiä asiakirjoja sen lisäksi, että selvitettiin, mitä asiaan liittyvä kirjallisuus ehdottaa ratkaisuksi löydettyihin haasteisiin.

Tutkimuksen tärkeimpiä tuloksia oli, että yrityksen sisällä eri osastot dokumentoivat eri tavoin, mikä aiheuttaa laadun heikkenemisen useille alueilla, koska yhtenäisiä dokumentointikäytäntöjä ei ole.

Opinnäytetyön lopputulos koostuu kolmesta osasta: IT-dokumentaatiokehyksen visuaalinen esitys, taulukko, johon on kerätty niin sanottu minimidokumentaatio sisältäen jokaisesta dokumentista vastuussa olevan henkilön, dokumentin tarkoituksen sekä kenelle se on tarkoitettu, sekä taulukko, johon on kerätty ”baseline”-dokumenttien sisältö ja tarkoitus, mistä asiakirjoista ne koostuvat, niistä vastuussa olevat henkilöt sekä dokumentin yleisö.

Lopputulos toimii lähtökohtana IT-dokumentointikäytäntöjen kehittämiselle ja laadun ja dokumentoinnin merkityksen edistämiselle.