Tulorekisterin julkisen teknisen dokumentaation kehittäminen

Abstract

Tämän opinnäytetyön tavoitteena oli tutkia tulorekisterin julkisen teknisen dokumentaation ymmärrettävyyttä ja kattavuutta. Työn tavoitteena oli muodostaa havaintoihin perustuva kuva dokumentaation nykytilasta. Havaintoja käytettiin dokumentaatiota koskevien kehittämisehdotusten muodostamisessa toimeksiantajana toimineelle Verohallinnon Tulorekisteriyksikölle. Opinnäytetyön tuotoksena muodostettiin yhteenveto dokumentaation nykytilasta ja kooste sen kehittämiseen tähtäävistä kehittämisehdotuksista.

Tutkimusmenetelmänä käytettiin aktiivista osallistuvaa havainnointia, joka on yksi laadullisen analyysin menetelmä. Menetelmää käytettiin erityisesti dokumentaation ymmärrettävyyden ja selkeyden arviointiin. Havainnoinnin kohteena oli tulorekisterin julkisesti saatavilla oleva tekninen dokumentaatio erikseen määritellyin rajauksin.

Työ on rajattu käsittelemään tulorekisterin julkista teknistä dokumentaatiota. Työn ulkopuolelle on rajattu tulorekisterin varmennepalvelun dokumentaatio, tulorekisterin ilmoittamisen substanssiohjeet ja verkkosivujen kehittäminen. Sanomaesimerkkejä käsitellään rajauksen mukaisesti kokonaisuutena. Tietoperusta on rajattu käsittelemään tiedon ymmärrettävyyteen ja selkeyteen liittyviä saavutettavuuden osa-alueita ymmärrettävyyttä, mukautettavuutta ja erottuvuutta. Tietoperustassa käsitellään lisäksi lyhyesti dokumentoinnin tarkoitusta ja tiedostomuotojen vaikutusta dokumenttien ymmärrettävyyteen ja selkeyteen.

Tulorekisterin julkista teknistä dokumentaatiota tutkittiin ja arvioitiin tietoperustan pohjalta. Dokumentaatiota käsiteltiin kokonaisuuksina, jotka oli johdettu yksittäisten dokumenttien sisällöistä ja käyttötarkoituksista. Kokonaisuuksien jakoon vaikutti myös se, miten dokumentit oli jäsennelty nykyisessä dokumentaatiossa. Joitain dokumentteja arvioitiin myös tarkemmin niihin liittyvien havaintojen vuoksi.

Työn havaintojen perusteella tulorekisterin julkisessa teknisessä dokumentaatiossa on ymmärrettävyyden kannalta joitain ongelmallisia rakenteita ja puutteita. Sisällön kattavuudessa on myös raportteihin ja koodistoihin liittyviä puutteita. Havaintojen pohjalta muodostetut tuotokset pyrkivät ratkaisemaan havaittuja ongelmia ja puutteita. Tuotoksia tullaan käyttämään Tulorekisteriyksikön järjestämien ohjelmistokehittäjille suunnattujen haastatteluiden pohjamateriaalina. Tuotosten muusta käytöstä ja kehittämisehdotusten mahdollisesta toteuttamisesta päätetään erillisen arviointiprosessin myötä.