Tietojärjestelmän dokumentointi case Kajaanin ammattikorkeakoulun tietojärjestelmälaboratorio

Abstract

Työn aiheena on tietojärjestelmälaboratorion tietojärjestelmän dokumentointi. Toimeksiantajana on Kajaanin ammattikorkeakoulu. Työssä kuvataan ympäristön arkkitehtuuri, vertaillaan dokumentointialustoja ja tehdään ohjeistus dokumentoinnin suorittamisesta.

Opinnäytetyön aihe löytyi suorittaessani työharjoittelua Kajaanin ammattikorkeakoulun tietojärjestelmälaboratoriossa. Ympäristössä oli tarve arkkitehtuurin kuvaukselle ja keskitetylle dokumentaatiolle. Laboratoriossa on sekä fyysinen, että virtuaalinen ympäristö ja molemmat täytyy dokumentoida ja hallita. Dokumentoinnille erityisiä haasteita asettaa ympäristön jatkuva muuttuminen. Ympäristön suurimpana muuttuvana tekijänä ovat virtuaaliset koneet. Lisäksi käyttäjät tekevät ympäristöön jatkuvasti muutoksia. Dokumentoinnin on oltava ajan tasalla, että kaikilla käyttäjillä on sama tieto käytettävissään.

Työn teoriatausta koostuu useasta eri tietojenkäsittelyn alueesta, joissa asetetaan vaatimuksia dokumentoinnille. Käytännön osuus koostuu arkkitehtuurin kuvauksesta, dokumentointialustojen vertailusta ja dokumentointiohjeistuksesta. Työn tarkoituksena on helpottaa opettajien ja oppilaiden työskentelyä laboratorioympäristössä.

The topic of this thesis was the documentation of the information system at the Kajaani UAS IT laboratory. The work was commissioned by Kajaani UAS. The goals were to describe the architecture of the IT laboratory environment, compare documentation platforms and make instructions for the documentation.

The idea for making this thesis came during my practical training period at the laboratory. There was a need to describe the architecture and the centralized documentation. There is a physical and a virtualized environment at the laboratory and both of those needed to be documented and managed. Special demands for the documentation are set by the continual change of the environment. Virtual machines are the largest changing factor. Users also make changes to the environment. The documentation must be updated so that all the users have the same information of the environment.

The theory part consists of different areas of information technology. Many of these areas set demands for the documentation. The practical part includes making a description of the laboratory environment, comparing different documentation platforms and making instructions for the documentation. The thesis was made to help the teachers and other users to work in the laboratory environment.