| Yhteenveto: | Creating software user guides is an essential part of the software development process, as they guide the user in using the software and thus improve the value of the software to the user. Producing software documentation, which includes a user guide, is also a large expense for companies, as it is often a time-consuming process. Documentation management of product family software is particularly difficult, because unique user guides need to be written for each of the members in the product family, as their features vary.
In this study, an artifact was developed for a target company using the design science research method to automate the creation of user guides of the product family’s software. The operating logic of the artifact was based on previous research focusing on documentation automation. The implemented artifact enables the automatic creation of product-specific user guides for the product family, while also taking up-to-date images of the user interface for the user guide using the artifact’s own domain-specific language.
Based on the evaluation of the artifact, the artifact developed in the study succeeded in meeting the needs of the target company in automating the user guides of the product family, but there was also room for further research. Image automation of the artifact is based on searching for elements on a web page using XPath, which sometimes caused problems, especially in the case of reactive elements. The developer-friendliness of maintaining the order of the sections in the user guide also sparked ideas for further research.
Ohjelmiston käyttöohjeiden luominen on olennainen osa ohjelmistokehitysprosessia, sillä ne opastavat käyttäjää ohjelmiston käytössä ja siten parantavat ohjelmiston arvoa käyttäjälle. Ohjelmistojen dokumentaatioiden, joihin käyttöohje sisältyy, tuottaminen on myös suuri kuluerä yrityksille, sillä se on usein aikaa vievä prosessi. Erityisesti hankaluuksia tuottaa tuoteperheohjelmistojen dokumentaation hallinta, sillä tuoteperheen jäsenille joudutaan kirjoittamaan omat käyttöohjeensa tuotteiden ominaisuuksien vaihdellessa.
Tässä tutkielmassa kehitettiin suunnittelutieteen tutkimusmenetelmää hyödyntäen kohdeyritykselle artefakti, joka automatisoi tuoteperheen ohjelmistojen käyttöohjeiden luomisen. Artefaktin toimintalogiikka suunniteltiin hyödyntäen aikaisempaa dokumentaation automatisointiin keskittyvää tutkimusta. Toteutettu artefakti mahdollistaa tuoteperheen tuotekohtaisten käyttöohjeiden luomisen automaattisesti, samalla myös ottaen ajantasaiset kuvat käyttöliittymästä käyttöohjeeseen artefaktin omaa täsmäkieltä käyttäen.
Artefaktin arvioinnin perusteella tutkimuksessa kehittetty artefakti onnistui vastaamaan kohdeyrityksen tarpeisiin tuoteperheen käyttöohjeiden automatisoinnissa, mutta myös jatkotutkimuksille jäi tilaa. Artefaktin kuvien automatisointi perustuu verkkosivun elementtien etsimiseen XPathia käyttäen, mikä toisinaan aiheutti ongelmia, etenkin reaktiivisten elementtien tapauksessa. Myös käyttöohjeen osioiden järjestyksen ylläpitämisen kehittäjäystävällisyys herätti ajatuksia jatkotutkimuksesta.
|
|---|