Technical writing by technical experts - Accessibility in the internal documentation of a software development team

Abstract

Tässä tutkimuksessa tarkastellaan ohjelmistokehittäjäryhmän sisäisen dokumentaation saavutettavuutta kohdeyrityksessä. Tutkimuksen tavoitteena on kartoittaa kohdeyrityksen sisäisten dokumenttien käyttäjien ja sisällöntuottajien kokemuksia sisäisten dokumenttien käytöstä, tutkia saavutettavuuteen liittyviä ongelmia sekä kehittää ratkaisuja siinä havaittuihin ongelmiin. Tutkimushypoteesit olivat seuraavat: Sisäisten dokumenttien käyttäjillä ja sisällöntuottajilla on hyvin erilaisia tarpeita ja näkemyksiä sisäisestä dokumentaatiosta, eivätkä käyttäjät ja sisällöntuottajat ole yhtä mieltä sisäisen dokumentaation tarpeellisuudesta. Sisäisten dokumenttien käyttäjät ja sisällöntuottajat eivät ole tietoisia toistensa tarpeista eivätkä ole yhtä mieltä siitä, miten sisäistä dokumentointia pitäisi kehittää.

Tutkimus on aineistolähtöinen, ja tutkimuksen aihe ja tutkimuskysymykset on määritelty aineistosta nousseiden huomioiden perusteella. Tutkimuksessa käytetty pääasiallinen aineisto kerättiin ohjelmistokehittäjäryhmän jäseniltä puolistrukturoituja haastatteluja käyttäen (n=26). Toissijaisena aineistona käytettiin materiaalia, joka kerättiin dokumentoinnista ja informaation suunnittelusta vastaavan henkilökunnan kanssa käydyistä keskusteluista.

Tutkimus nojautuu toimintatutkimuksen metodologiaan ja periaatteisiin. Toimintatutkimuksen periaatteiden mukaisesti informantteja kohdeltiin osallistujina, jotka ovat tutkijan kanssa samanarvoisessa asemassa, ja projektin aikana pyrittiin lisäämään kaikkien tutkimukseen osallistuneiden henkilöiden kokonaisvaltaista ymmärrystä tutkimusaiheesta. Tutkimuksessa pyrittiin luomaan keskustelua sisäisen dokumentaation käyttäjien ja sisällöntuottajien välille sekä edistämään osallistujien mahdollisuuksia vaikuttaa sisäisen dokumentoinnin prosessiin työpaikalla.

Tutkimusaineiston perusteella näyttäisi, että sisäisen dokumentaation käyttäjien ja sisällöntuottajien kokemukset sisäisten dokumenttien käytöstä ja niiden saavutettavuudesta ovat suurelta osin negatiivisia. Sisäisten dokumenttien saavutettavuudessa on ongelmia, jotka liittyvät epätarkasti määriteltyihin dokumentoinnin konventioihin, sisällöntuottajien työtapoihin ja dokumentoinnin taitotasoon, dokumentointityökalun toimivuuteen sekä dokumentoinnin hallintaan ja ohjaukseen ohjelmistokehittäjäryhmässä. Teknisen viestinnän tehtäviä ja niiden merkitystä ei tunneta ohjelmistokehittäjäryhmässä tarpeeksi hyvin, ja ryhmä näyttäisi tarvitsevan teknisen kirjoittajan koordinoimaan sisäistä dokumentointia. Sisäisen dokumentoinnin prosessi, sisällöntuottajien dokumentaatioon liittyvät työtehtävät ja informaation suunnittelu täytyisi määritellä uudelleen sisäisen dokumentaation käyttäjien näkökulmasta, ja dokumentoinnin prosessia täytyisi ohjata huolellisesti määritellyn prosessin mukaisesti. Tämän tutkimuksen tulokset vahvistavat aiemmissa tutkimuksissa todettuja puutteita teknisen viestinnän ammattitaidon arvostuksesta yrityksissä ja tieto-organisaatioissa. Tutkimuksen tulokset ovat hyödyllisiä yrityksille, jotka pyrkivät löytämään mahdollisimman toimivan tavan tuottaa saavutettavaa sisäistä dokumentaatiota.