Dokumentaatioprosessin kehittäminen Metropolian tietohallinnon ohjelmointityöryhmässä
Halkola, Helena (2016)
Halkola, Helena
Metropolia Ammattikorkeakoulu
2016
All rights reserved
Julkaisun pysyvä osoite on
https://urn.fi/URN:NBN:fi:amk-201605167957
https://urn.fi/URN:NBN:fi:amk-201605167957
Tiivistelmä
Insinöörityössä oli tavoitteena kehittää Metropolian tietohallinnon ohjelmointityöryhmän dokumentaatioprosessia. Lisäksi tarkoitus oli myös laatia Metropolian käyttäjätietojen hallintajärjestelmästä Ammeesta dokumentaatiota, joka oli aiemmin puutteellista ja vanhentunutta. Työn tarkoituksena olikin kehittää ratkaisuja, joilla voitaisiin ehkäistä dokumentaation vanhentuminen ja huono laatu ja niistä aiheutuvat ongelmat ja riskit.
Työssä käsiteltiin erilaisia dokumentaatiosuosituksia liittyen dokumenttien kirjoittamiseen, laatuun ja tarpeeseen. Suositusten lisäksi esiteltiin lyhyesti erilaisia dokumentointityökaluja, joita voidaan hyödyntää ohjelmistoprojektien eri vaiheissa. Näitä suosituksia ja dokumentointityökaluja käytettiin Amme-järjestelmän dokumentoimiseen.
Työn aikana laaditun Amme-dokumentaation ansiosta uuden järjestelmän pääkehittäjän perehdyttäminen on helpompaa. Lisäksi järjestelmän jatkokehittäminen helpottuu, kun dokumentaatio on ajan tasalla. Laadittua dokumenttia voidaan jatkossa myös käyttää mallina sille, millaista dokumentaatiota eri projekteista tulisi tehdä.
Työn tuloksena työryhmälle luotiin dokumentaatioprosessin kuvaus, joka ohjeistaa tarvittavan dokumentoinnin laatimista projektin alusta aina ylläpitovaiheeseen. Lisäksi määriteltiin, että jatkossa projekteista täytyy laatia vähintään tekninen ja toiminnallinen määrittely.
Työssä käsiteltiin erilaisia dokumentaatiosuosituksia liittyen dokumenttien kirjoittamiseen, laatuun ja tarpeeseen. Suositusten lisäksi esiteltiin lyhyesti erilaisia dokumentointityökaluja, joita voidaan hyödyntää ohjelmistoprojektien eri vaiheissa. Näitä suosituksia ja dokumentointityökaluja käytettiin Amme-järjestelmän dokumentoimiseen.
Työn aikana laaditun Amme-dokumentaation ansiosta uuden järjestelmän pääkehittäjän perehdyttäminen on helpompaa. Lisäksi järjestelmän jatkokehittäminen helpottuu, kun dokumentaatio on ajan tasalla. Laadittua dokumenttia voidaan jatkossa myös käyttää mallina sille, millaista dokumentaatiota eri projekteista tulisi tehdä.
Työn tuloksena työryhmälle luotiin dokumentaatioprosessin kuvaus, joka ohjeistaa tarvittavan dokumentoinnin laatimista projektin alusta aina ylläpitovaiheeseen. Lisäksi määriteltiin, että jatkossa projekteista täytyy laatia vähintään tekninen ja toiminnallinen määrittely.