Tietojärjestelmien dokumentointi

Abstract

Opinnäytetyö perustuu Paikallispankkien PP-Laskenta Oy:n tietojärjestelmän dokumentointiin. Työssä kerrotaan yleisesti tietojärjestelmien ylläpidosta sekä tarkemmin miten tietojärjestelmiä pystytään dokumentoimaan. Esittelyssä on kaksi eri lähestymistapaa, rakenteellinen sekä oliolähestymistapa. Tavoitteena oli luoda käytäntö, joka määrittelee miten tietojärjestelmää tulisi dokumentoida ja ylläpitostrategia, joka määrittelee miten kyseisiä kuvauksia tulisi ylläpitää. Kuvauksien tarkoitus on muun muassa helpottaa tietojärjestelmän ylläpitoa. Tehtävänä oli myös vertailla dokumentointityökaluja, jotta olisi perusta jonka pohjalta voitaisiin todeta minkälainen työkalu olisi tilaajalle sopivin. Työn käytännön osuus perustuu käytännön luomiseen, joka pohjautuu kuvaustavan valitaan, sekä ylläpitostrategian kehittämiseen. Teoriaosuuden tarkoitus on luoda vahva alusta käytännön ja ylläpitostrategian luomiseen, tämän vuoksi teoria perustuu juuri tietojärjestelmien ylläpitoon sekä tietomallintamiseen.

Työ aloitettiin ottamalla selvää minkälaisia kuvauksia oli jo olemassa tietojärjestelmästä, tämän jälkeen määriteltiin vaatimukset uusille kuvauksille. Vaatimusten perusteella luotiin käytäntö, ja tämän jälkeen kehitettiin ylläpitostrategia jotta voidaan aina taata että kuvaukset ovat ajan tasalla. Työn aikana vertailtiin myös eri työkaluja, tarkoituksena on että Paikallispankkien PP-Laskenta Oy valitsisi dokumentointityökalunsa tämän vertailun pohjalta.

Examensarbetet är ett beställningsarbete gällande dokumenteringen av Paikallispankkien PP-Laskenta Oy:s informationssystem. Arbetet består av tre delar, den första delen behandlar teorin bakom underhåll och dokumentering av informationssystem. Den andra delen är en jämförelse mellan olika dokumenteringsverktyg, i den tredje delen beskrivs det praktiska arbetet.

Målet med arbetet var att beskriva och skapa en praxis, som definierar vilka dokumenteringsmetoder som skall användas när informationssystemet avbildas hos uppdragsgivaren. Dessutom skapades en underhållsstrategi som definierar hur informationssystemet dokumentation skall underhållas. Dokumentationens uppgift är bland annat att att stöda underhåll av informationssystemet. Utöver detta gjordes en jämförelse mellan olika dokumenteringsverktyg, denna jämförelse skall fungera som grund då uppdragsgivaren skall välja ett verktyg att arbeta med.

Arbetet påbörjades med att ta reda på hurudan dokumentering det redan finns om informationssystemet. När detta var klart definierades kraven på vad som krävs av dokumentationen. På basen av kraven skapades en praxis och därefter utvecklades underhållsstrategin, vars uppgift är att garantera att dokumenteringen alltid motsvarar systemet rådande tillstånd.

The base of this thesis was the documentation process of Paikallispakkien PP-Laskenta Oy’s information system. The thesis is divided into three main parts, the first part being the theory. The theory is based on the maintenance of information systems and also on how to document them. The theory about documentation is mostly based on data modeling. The second part is a comparison between different documentation tools. The third part is about the practical work.

The goal of this thesis was to create a best practice, regarding how the information system should be documented, and a strategy, regarding the maintenance of these documents. The documents role is, among other things, to support the maintenance of the information system. Another task was the comparison of tool for documenting purposes, based on this comparison the commissioner will select a tool to use for their documentation.

The work began with resolving what kind of documentation about the information system already existed. Based on these findings requirements regarding what the commissioner needed from the documentation were made. Based on these requirements the best practice was defined, after this the maintenance strategy was created. The purpose of the maintenance strategy for the documents is to ensure that documents regarding the system always are up to date.