Evaluation of a Use Case Taxonomy: Preparing a documentation set for future solutions

Abstract

Tutkielmassa tarkastellaan DITA XML -muotoisen dokumentaatiosetin varhaista valmistelua tulevaisuuden dokumentaatioratkaisuja varten, erityisesti tutkielman aineistona toimivan käyttötapaustaksonomian arvioinnin näkökulmasta. Teknisen viestinnän alalla teknisen dokumentaation toimitus- ja esitysmenetelmät ovat jatkuvassa kehityksessä, jolloin dokumentaatiokokonaisuuksien lähdemateriaalin tulee myös vastata tulevaisuuden vaatimuksia. Esimerkiksi keskustelubotit ja fasettihakuiset hakuportaalit vaativat dokumenttisetin valmistelua. Usein tällainen valmistelu tarkoittaa sisällön merkitsemistä metadatalla ja sen kuvaamista hierarkkisesti taksonomian muodossa. Tutkielma vastaa tutkimuskysymyksiin, kuinka taksonomian luonti on kohdeyrityksessä onnistunut ja kuinka olemassa olevat taksonomian arviointiin tehdyt attribuutit soveltuvat tämän kaltaisen taksonomian arviointiin.

Tutkimuksen teoreettisena viitekehyksenä toimii taustateoria taksonomioista ja metadatasta, kuin myös DITA XML -merkintäkielestä. Tutkimuksen menetelmä perustuu attribuuttianalyysiin, joka hyödyntää useita kvantitatiivisia ja kvalitatiivisia menetelmiä kuten haastatteluja ja käyttäjätestausta.

Tutkielman aineistona toimii kohdeyrityksen ohjelmiston käyttötapauksia kuvaava taksonomia. Aineisto on osa suuremmasta taksonomiasta. Aineisto, yritys ja näihin liittyvät tiedot ovat anonymisoitu ja taksonomiasta esitetään vain tutkielman tapauksessa tarvittavat tapausesimerkit.

Tutkielman analyysiosuus perustuu taksonomioiden arvioimiskirjallisuudessa esiteltyihin arviointiattribuutteihin. Tutkielma vastaa tällöin tutkimusaukkoon attribuuttien soveltuvuudesta arvioida erityyppistä taksonomiaa mitä lähdekirjallisuus oli attribuuttien synteesissä huomioinut. Tutkielmassa annetaan suuri painoarvo asiantuntijahaastatteluille ja taksonomian kehitysprosessin arvioinnille, mutta tarkastellaan myös taksonomian sisäisiä ominaisuuksia attribuuttien avulla esimerkiksi käyttäjätestauksen avulla. Tutkielman tarpeisiin kehitettiin myös uusi attribuutti vastaamaan tarvetta tarkastella taksonomian kielellisiä ominaisuuksia. Tutkielmassa tehdään huomioita luontiprosessin realiteetteihin kiteytyvistä vaatimuksista kuin myös taksonomian onnistuneesta kyvystä kuvata käyttötapauksia kielellisesti yhtenevästi.

The thesis examines the early phases of preparing a large documentation set for future solutions from the point of view of the evaluation of a use case taxonomy. The documentation set of the target company is written in DITA XML. In the field of technical communication, the methods of delivering and presenting technical documentation are in constant development and the source material of the documentation needs to fulfil the requirements of such methods. For example, chatbots and facet type searches require the preparation of a documentation set. The preparation can be, for example, tagging the content with metadata and presenting the metadata in a hierarchical form as a taxonomy. The thesis answers the research questions of how taxonomy work has succeeded in the target company the thesis is made for and how are the existing taxonomy evaluation attributes suited in evaluating a taxonomy of this kind.

The theoretical framework of the thesis consists of background theory on taxonomies, metadata, and DITA XML language. The method of the thesis is an attribute analysis which consists of multiple qualitative and quantitative methods such as interviews and user testing.

The material of the thesis consists of a use case taxonomy which presents the use cases of the target company’s software. The material is part of a larger taxonomy. The material, the company and sensitive information are anonymized, and the thesis presents only the examples required to explain the analysis.

The analysis section of the thesis is based on the taxonomy evaluation attributes presented in the taxonomy literature. The thesis fills a research gap by testing how the attributes suit in evaluating a different type of taxonomy compared to the taxonomies presented in the literature. The thesis emphasizes the expert interviews and the evaluation of the creation process of the taxonomy. However, the taxonomy’s other properties are also evaluated, for example, by user testing. A new taxonomy evaluation attribute was also developed to examine the linguistic features of the taxonomy. The thesis makes observations on the realities of a taxonomy creation process and the taxonomy’s ability to depict use cases in a linguistically uniform manner.