Converting Technical Documentation into DITA: An Ethnographic Study of a Conversion Process

Abstract

Digital content management and structured documentation systems have become increasingly popular within companies that deal with considerable amounts of technical documentation. Implementing a structured documentation system often requires converting old content into the new system, which can lead to issues caused by the two differing systems. The purpose of this thesis is to study what kind of issues may arise during such a conversion process and how they could be prevented. The conversion process in this thesis revolves around a type of technical document, a technical specification. This study is done in cooperation with Valmet Technologies Oy. The theoretical framework of this study consists of information management, single sourcing, and markup languages, which are all prominent concepts within the field of technical communications. Information management and its related theories of information architecture and information design are used in this thesis to provide multiple viewpoints from which to approach the conversion process and its potential issues. Single sourcing and markup languages provide background for the technical concepts discussed in this study. Ethnographic research methodology, namely participant observation, is used in the study to gather data regarding the conversion process from the personnel at Valmet Technologies Oy. This data is processed into field notes which are then analyzed for possible issues in the conversion process. Alongside field notes, artifacts procured from the work environment are also used to support the analysis. The analysis is done by using an information analysis model and thematical analysis. The results display that the conversion process of the technical specification faces technical issues and workflow issues. Technical issues include issues such as documentation output format and problems with a database integration. Workflow issues include problems with having multiple writers in the writing process and with increased workload brought by new tasks and roles for the employees. The results of this thesis can potentially aid companies with their own conversion processes. For the field of technical communications, this study provides information on a common, yet relatively undocumented process within the field. Future research could be done on other conversion processes to increase openly available information.

Digitaalinen sisällönhallinta ja rakenteinen dokumentaatio ovat kasvattaneet suosiotaan yrityksissä, jotka käsittelevät huomattavia määriä teknistä dokumentaatiota. Rakenteisen dokumentointijärjestelmän perustaminen vaatii usein vanhan sisällön konvertointia uuteen järjestelmään, mikä saattaa johtaa ongelmiin kahden erilaisen järjestelmän välillä. Tämän tutkielman tarkoituksena on tutkia, millaisia ongelmia tällaisen konversioprosessin aikana saattaa ilmetä ja kuinka niitä voidaan ehkäistä. Tutkielmassa käsitelty konversioprosessi rakentuu teknisen dokumenttityypin, teknisen erittelyn, ympärille. Tutkielma on toteutettu yhteistyössä Valmet Technologies Oy:n kanssa. Tutkielman teoreettinen viitekehys koostuu teknisen viestinnän alan käsitteiden teoriasta, kuten informaatiohallinnasta, yksilähteistämisestä ja merkintäkielistä. Informaatiohallintaa ja siihen liittyviä informaatioarkkitehtuurin ja informaatiosuunnittelun teorioita käytetään tutkielmassa tuomaan useita eri näkökulmia konversioprosessiin ja sen mahdollisiin ongelmiin. Yksilähteistäminen ja merkintäkielet pohjustavat tutkielmassa käsiteltäviä teknisiä käsitteitä. Tutkielmassa käytetään etnografista tutkimusmenetelmää, erityisesti osallistuvaa havainnointia, aineiston keräämiseen Valmet Technologies Oy:n henkilöstöltä. Aineisto prosessoidaan kenttämuistiinpanoiksi, jotka analysoidaan mahdollisten ongelmakohtien löytämiseksi konversioprosessista. Kenttämuistiinpanojen ohella myös työympäristöstä hankittuja artefakteja käytetään analyysin tukena. Aineiston analyysi toteutetaan informaatioanalyysimallin ja temaattisen analyysin avulla. Tulokset osoittavat, että teknisen erittelyn konversioprosessissa on teknisiä ja työnkulkuun liittyviä ongelmia. Teknisiä ongelmia ovat muun muassa dokumentin ulostuloformaatin aiheuttamat hankaluudet ja tietokantaintegraatioon liittyvät haasteet. Työnkulkuongelmia ovat esimerkiksi kirjoittajien lukumäärästä johtuvat ongelmat sekä uusien työtehtävien ja roolien aiheuttama kuormitus työntekijöille. Tutkimuksen tulokset voivat auttaa yrityksiä ratkaisemaan vastaavia konversioprosesseja. Teknisen viestinnän kentälle tutkimus tuo tietoa yleisestä, mutta vähän dokumentoidusta prosessista. Tulevaisuudessa tutkimusta voitaisiin tehdä vastaavista konversioprosesseista, jotta näistä saataisiin enemmän avointa tietoa.