testaus
Dokumentointi on tärkeää – projektista riippumatta

Tietojärjestelmien päivittäminen tai uusiminen vaatii monenlaisia taitoja ja näkemystä sekä ymmärrystä siitä, mihin suuntaan yrityksen liiketoiminta on menossa. Vaikka joskus olisikin helpointa lähteä liikkeelle puhtaalta pöydältä, on kuitenkin hyvä analysoida tulevien tarpeiden lisäksi myös nykyinen tilanne: mikä siinä on hyvää ja toimivaa. Toisaalta on pohdittava, mitkä asiat taas vaativat muutosta joko heti tai lähitulevaisuudessa.

Otetaanpa esimerkki vastaavasta tilanteesta hieman toisenlaisesta maailmasta. Vapaa-ajallani harrastan vanhoja amerikkalaisia autoja ja erityisenä kiinnostuksen kohteenani niissä ovat verhoilutyöt. Tämänhetkinen projektini on Pontiac Bonneville vm. 1958, jonka verhoilut ovat parhaat päivänsä nähneet. Haastetta siis piisaa, kun pelkästä reiästä, joka joskus on ollut istuin, on vaikea saada edes kaavaa.

Laadunvarmistus

Ennen kuin ompelukone alkaa laulaa, on tehtävä rutkasti tutkimus- ja suunnittelutyötä projektin pohjalle. Penkit ja verhoilut on kuvattava ja dokumentoitava riittävän kattavasti. Tämän jälkeen alkavat purkutyöt ja vanhojen verhoilujen osien merkitseminen ja ratkominen.

Tämän auton penkkien pehmusteetkin olivat joissakin kohdin vain kasa murusia. Uudet pehmusteet pitää tehdä mahdollisimman hyvin vanhoja mukaillen, mutta kuitenkin samalla niitä parantaen. Uusissa verhoiluissa on näin ollen tehtävä myös jonkin verran soveltamista ja muokkaamista, jotta ne istuvat uusiin pehmusteisiin. Ja jos vanhoissa verhoiluissa on tehty jotain kummallisesti, ei samaa kannata enää toistaa, jos sen hyödyt eivät ole selkeästi nähtävissä.

Huolellisella dokumentoinnilla seuraava projekti on aina vähän helpompi

Koko prosessi vaatii siis hyvää suunnittelua, kokeilemista ja virheistä oppimista. Uutta tehdessä pitää muistaa kuvata jatkuvasti eri työvaiheet ja dokumentoida riittävästi, jotta seuraava projekti olisi sitten taas vähän helpompi.

Näen vanhan auton verhoilujen entisöinnissä paljon yhtäläisyyksiä tietojärjestelmien kehittämiseen ja uudistamiseen. Vanhat järjestelmät on dokumentoitava, jotta jatkokehittäminen ja uudistaminen on mahdollista. Uuden kehittämisessä pitää aina osata soveltaa ja miettiä, mitä voisi tehdä toisin ja ehkäpä paremmin kuin ennen. Ihan samalla tavalla myös järjestelmäkehityksessä joudutaan joskus ”ratkomaan ja ompelemaan” uudelleen. Molemmissa hyvä suunnittelu ja dokumentointi auttavat niin sen hetkistä toteutusta, kuin tuleviakin projekteja.

Alla on viisi asiaa, jotka ovat mielestäni tärkeitä dokumentoinnissa.

Dokumentoidaan:

  • Oikeita asioita, oikeaan tarpeeseen
    Keskitytään olennaiseen ja siihen, mikä oikeasti on dokumentoinnin kohteena. Tehdään dokumentointia vain tarpeen ja käyttötarkoituksen mukaisesti.
  • Riittävällä tasolla
    Ei ole tarpeen tehdä kerralla kaikkea viimeisen päälle valmiiksi. Tehdään myös dokumentointia iteroiden.
  • Selkeästi
    Dokumentaatio pitää olla tehtynä niin selkeästi, että sen ymmärtävät muutkin kuin kirjoittaja itse. Jos dokumentoinnissa on tulkinnan varaa, kasvaa virheiden mahdollisuudetkin.  
  • Oikea-aikaisesti
    Dokumentaation pitää olla saatavilla silloin, kun sitä tarvitaan.
  • Ylläpidettävästi
    Dokumentaation pitää olla myös ylläpidettävissä ja ylläpidetty, jotta siitä on hyötyä myös myöhemmin niin liiketoiminnalle kuin tuleville kehitysprojekteillekin.

Dokumentointi on tärkeä osa kehittämistä. Ja kun hiukan katsoo laatikon ulkopuolelta, huomaa, että samat dokumentoinnin lainalaisuudet pätevät järjestelmäkehityksen lisäksi yllättävän moneen osa-alueeseen, kuten esimerkiksi auton penkkien verhoiluun.

hankepäällikkö

Tarja Kunnasvuo

Tarja on ISTQB-sertifioitu testauksen ammattilainen, joka pitää testauksen langat käsissä yli kymmenen vuoden kokemuksella. Tarjalla on monipuolista osaamista testaukseen, testauksen koordinointiin sekä testauksen toimintatapojen kehittämiseen liittyen.

LinkedIn

Reflector on ICT-talo, jonka ykköstehtävä on auttaa asiakkaitamme liiketoiminnan isoissa ja pienissä muutoshankkeissa. Ketterästi ja riippumattomasti.

Jaa artikkeli

Yritysarkkitehtuuri konsultti

Datan hyötykäytön anatomiaa

Miten dataa pitäisi hyödyntää? Mikä osa datasta on relevanttia ja mikä voidaan sivuuttaa? Miten ihmiset liittyvät datan hyödyntämiseen? Näihin kysymyksiin nykypäivän dataintensiivisessä ympäristössä

Lue lisää
Kokonaisarkkitehtuuri Reflector

Ota yhteyttä, mietitään yhdessä juuri teille parhaat ratkaisut

Täytä tiedot ja siirry lataamaan tutkimus

Kokonaisarkkitehtuuri Reflector

Get in touch!