Restructuring information in technical documentation when migrating to XML-based documentation system : a case study for Marioff Corporation Oy
Koppanen, Iida (2018)
2018
Englannin kielen, kirjallisuuden ja kääntämisen tutkinto-ohjelma - DP in English Language, Literature and Translation
Viestintätieteiden tiedekunta - Faculty of Communication Sciences
This publication is copyrighted. You may download, display and print it for Your own personal use. Commercial use is prohibited.
Hyväksymispäivämäärä
2018-05-09
Julkaisun pysyvä osoite on
https://urn.fi/URN:NBN:fi:uta-201805141656
https://urn.fi/URN:NBN:fi:uta-201805141656
Tiivistelmä
Tämä tutkielma käsittelee tiedon uudelleenjärjestämistä teknisessä dokumentaatiossa siirryttäessä XML-pohjaiseen dokumentointiympäristöön. Teknisen viestinnän alalla XML-pohjaiset dokumentointijärjestelmät ovat yleistyneet 2000-luvun alusta lähtien ja monet yritykset ovat edelleen siirtymässä uuteen järjestelmään. Tämän tutkimuksen tarkoituksena on selvittää, miten tietoa kannattaa analysoida ja järjestää uudelleen siirryttäessä uuteen dokumentointijärjestelmään.
Teoreettisen viitekehyksen ensimmäinen osio koostuu informaatioarkkitehtuurin ja informaation suunnittelun välisen suhteen ja niiden eri piirteiden käsittelystä. Toinen osio käsittelee modulaarista dokumentaatiota ja siihen liittyviä periaatteita, kuten yksilähteistämistä ja DITA XML -kieltä teknisen viestinnän kontekstissa.
Tutkimus on Marioff Corporation Oy:lle tehty tapaustutkimus. Tutkimuksen metodina käytetään teoriaohjaavaa laadullista sisällönanalyysiä, jota ohjaa sisällön uudelleenkäytön analyysin malli. Uudelleenkäytön analyysin mallia käytetään, jotta analyysilla pystytään vastaamaan juuri tiedon uudelleenjärjestämistä koskevaan tutkimuskysymykseen. Tutkimuksen aineistona toimii Marioff Corporation Oy:n tekninen dokumentaatio, joka koostuu palonsammutusjärjestelmän osana toimivan pumppuyksikön käyttöohjeesta ja teknisistä datalehdistä. Tutkimuksen hypoteesi on, ettei Marioff Corporation Oy:n dokumenteista löydy mittavasti uudelleenkäytettävää sisältöä.
Tutkimuksen johtopäätös on, että uuteen dokumentointijärjestelmään siirrettävä materiaali on analysoitava huolellisesti yrityksen kontekstissa. Analyysin tulee tehdä henkilö, joka tuntee yrityksen tuotteet ja osaa täten arvioida, miten sisältö kannattaa jakaa moduuleiksi. Huolellisella analyysillä voidaan maksimoida sisällön uudelleenkäyttö. Tutkimuksessa esitetty hypoteesi ei toteudu vaan dokumenteista löytyy odotettua enemmän uudelleenkäytettävää sisältöä.
Tutkimuksessa selviää myös, että sisältöä pitää analysoida yrityksen sisällönhallintajärjestelmän asettamien rajoitusten puitteissa. Erityisesti sisällön uudelleenkäytön strategia pitää suunnitella sisällönhallintajärjestelmän mukaisesti. Tämä tutkimus tukee aiemmissa modulaarista dokumentaatiota käsittelevissä teoksissa esiintyvää ajatusta, että yksityiskohtaisia ohjeistuksia sisällön uudelleenjärjestämiseen ei voi antaa, koska sisällön jakaminen on tapauskohtaista eli riippuu jaettavasta sisällöstä, jota siirretään modulaariseen dokumentointiympäristöön. Tämän tutkimuksen analyysin pohjalta nostetaan kuitenkin esiin asioita, jotka kannattaa ottaa huomioon uuteen dokumentointiympäristöön siirryttäessä. Tutkimuksen jatkotutkimusaiheena esitetään palautteenkeruuprosessin muuttuminen XML-pohjaisessa dokumentointiympäristössä.
Teoreettisen viitekehyksen ensimmäinen osio koostuu informaatioarkkitehtuurin ja informaation suunnittelun välisen suhteen ja niiden eri piirteiden käsittelystä. Toinen osio käsittelee modulaarista dokumentaatiota ja siihen liittyviä periaatteita, kuten yksilähteistämistä ja DITA XML -kieltä teknisen viestinnän kontekstissa.
Tutkimus on Marioff Corporation Oy:lle tehty tapaustutkimus. Tutkimuksen metodina käytetään teoriaohjaavaa laadullista sisällönanalyysiä, jota ohjaa sisällön uudelleenkäytön analyysin malli. Uudelleenkäytön analyysin mallia käytetään, jotta analyysilla pystytään vastaamaan juuri tiedon uudelleenjärjestämistä koskevaan tutkimuskysymykseen. Tutkimuksen aineistona toimii Marioff Corporation Oy:n tekninen dokumentaatio, joka koostuu palonsammutusjärjestelmän osana toimivan pumppuyksikön käyttöohjeesta ja teknisistä datalehdistä. Tutkimuksen hypoteesi on, ettei Marioff Corporation Oy:n dokumenteista löydy mittavasti uudelleenkäytettävää sisältöä.
Tutkimuksen johtopäätös on, että uuteen dokumentointijärjestelmään siirrettävä materiaali on analysoitava huolellisesti yrityksen kontekstissa. Analyysin tulee tehdä henkilö, joka tuntee yrityksen tuotteet ja osaa täten arvioida, miten sisältö kannattaa jakaa moduuleiksi. Huolellisella analyysillä voidaan maksimoida sisällön uudelleenkäyttö. Tutkimuksessa esitetty hypoteesi ei toteudu vaan dokumenteista löytyy odotettua enemmän uudelleenkäytettävää sisältöä.
Tutkimuksessa selviää myös, että sisältöä pitää analysoida yrityksen sisällönhallintajärjestelmän asettamien rajoitusten puitteissa. Erityisesti sisällön uudelleenkäytön strategia pitää suunnitella sisällönhallintajärjestelmän mukaisesti. Tämä tutkimus tukee aiemmissa modulaarista dokumentaatiota käsittelevissä teoksissa esiintyvää ajatusta, että yksityiskohtaisia ohjeistuksia sisällön uudelleenjärjestämiseen ei voi antaa, koska sisällön jakaminen on tapauskohtaista eli riippuu jaettavasta sisällöstä, jota siirretään modulaariseen dokumentointiympäristöön. Tämän tutkimuksen analyysin pohjalta nostetaan kuitenkin esiin asioita, jotka kannattaa ottaa huomioon uuteen dokumentointiympäristöön siirryttäessä. Tutkimuksen jatkotutkimusaiheena esitetään palautteenkeruuprosessin muuttuminen XML-pohjaisessa dokumentointiympäristössä.