Käyttöohjeiden tuottamisen automatisointi tuoteperheen ohjelmistoille

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...

Full description

Bibliographic Details
Main Author: Peltomaa, Olli
Other Authors: Informaatioteknologian tiedekunta, Faculty of Information Technology, Jyväskylän yliopisto, University of Jyväskylä
Format: Master's thesis
Language:fin
Published: 2025
Subjects:
Online Access: https://jyx.jyu.fi/handle/123456789/103417
_version_ 1834856795520106496
author Peltomaa, Olli
author2 Informaatioteknologian tiedekunta Faculty of Information Technology Jyväskylän yliopisto University of Jyväskylä
author_facet Peltomaa, Olli Informaatioteknologian tiedekunta Faculty of Information Technology Jyväskylän yliopisto University of Jyväskylä Peltomaa, Olli Informaatioteknologian tiedekunta Faculty of Information Technology Jyväskylän yliopisto University of Jyväskylä
author_sort Peltomaa, Olli
datasource_str_mv jyx
description 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.
first_indexed 2025-06-11T20:04:37Z
format Pro gradu
free_online_boolean 1
fullrecord [{"key": "dc.contributor.advisor", "value": "Mikkonen, Tommi", "language": null, "element": "contributor", "qualifier": "advisor", "schema": "dc"}, {"key": "dc.contributor.author", "value": "Peltomaa, Olli", "language": null, "element": "contributor", "qualifier": "author", "schema": "dc"}, {"key": "dc.date.accessioned", "value": "2025-06-11T11:21:51Z", "language": null, "element": "date", "qualifier": "accessioned", "schema": "dc"}, {"key": "dc.date.available", "value": "2025-06-11T11:21:51Z", "language": null, "element": "date", "qualifier": "available", "schema": "dc"}, {"key": "dc.date.issued", "value": "2025", "language": null, "element": "date", "qualifier": "issued", "schema": "dc"}, {"key": "dc.identifier.uri", "value": "https://jyx.jyu.fi/handle/123456789/103417", "language": null, "element": "identifier", "qualifier": "uri", "schema": "dc"}, {"key": "dc.description.abstract", "value": "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.\n\nIn 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\u2019s 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\u2019s own domain-specific language.\n\nBased 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.", "language": "en", "element": "description", "qualifier": "abstract", "schema": "dc"}, {"key": "dc.description.abstract", "value": "Ohjelmiston k\u00e4ytt\u00f6ohjeiden luominen on olennainen osa ohjelmistokehitysprosessia, sill\u00e4 ne opastavat k\u00e4ytt\u00e4j\u00e4\u00e4 ohjelmiston k\u00e4yt\u00f6ss\u00e4 ja siten parantavat ohjelmiston arvoa k\u00e4ytt\u00e4j\u00e4lle. Ohjelmistojen dokumentaatioiden, joihin k\u00e4ytt\u00f6ohje sis\u00e4ltyy, tuottaminen on my\u00f6s suuri kuluer\u00e4 yrityksille, sill\u00e4 se on usein aikaa viev\u00e4 prosessi. Erityisesti hankaluuksia tuottaa tuoteperheohjelmistojen dokumentaation hallinta, sill\u00e4 tuoteperheen j\u00e4senille joudutaan kirjoittamaan omat k\u00e4ytt\u00f6ohjeensa tuotteiden ominaisuuksien vaihdellessa. \n\nT\u00e4ss\u00e4 tutkielmassa kehitettiin suunnittelutieteen tutkimusmenetelm\u00e4\u00e4 hy\u00f6dynt\u00e4en kohdeyritykselle artefakti, joka automatisoi tuoteperheen ohjelmistojen k\u00e4ytt\u00f6ohjeiden luomisen. Artefaktin toimintalogiikka suunniteltiin hy\u00f6dynt\u00e4en aikaisempaa dokumentaation automatisointiin keskittyv\u00e4\u00e4 tutkimusta. Toteutettu artefakti mahdollistaa tuoteperheen tuotekohtaisten k\u00e4ytt\u00f6ohjeiden luomisen automaattisesti, samalla my\u00f6s ottaen ajantasaiset kuvat k\u00e4ytt\u00f6liittym\u00e4st\u00e4 k\u00e4ytt\u00f6ohjeeseen artefaktin omaa t\u00e4sm\u00e4kielt\u00e4 k\u00e4ytt\u00e4en. \n\nArtefaktin arvioinnin perusteella tutkimuksessa kehittetty artefakti onnistui vastaamaan kohdeyrityksen tarpeisiin tuoteperheen k\u00e4ytt\u00f6ohjeiden automatisoinnissa, mutta my\u00f6s jatkotutkimuksille j\u00e4i tilaa. Artefaktin kuvien automatisointi perustuu verkkosivun elementtien etsimiseen XPathia k\u00e4ytt\u00e4en, mik\u00e4 toisinaan aiheutti ongelmia, etenkin reaktiivisten elementtien tapauksessa. My\u00f6s k\u00e4ytt\u00f6ohjeen osioiden j\u00e4rjestyksen yll\u00e4pit\u00e4misen kehitt\u00e4j\u00e4yst\u00e4v\u00e4llisyys her\u00e4tti ajatuksia jatkotutkimuksesta.", "language": "fi", "element": "description", "qualifier": "abstract", "schema": "dc"}, {"key": "dc.description.provenance", "value": "Submitted by jyx lomake-julkaisija (jyx-julkaisija.group@korppi.jyu.fi) on 2025-06-11T11:21:51Z\nNo. of bitstreams: 0", "language": "en", "element": "description", "qualifier": "provenance", "schema": "dc"}, {"key": "dc.description.provenance", "value": "Made available in DSpace on 2025-06-11T11:21:51Z (GMT). No. of bitstreams: 0", "language": "en", "element": "description", "qualifier": "provenance", "schema": "dc"}, {"key": "dc.format.extent", "value": "50", "language": null, "element": "format", "qualifier": "extent", "schema": "dc"}, {"key": "dc.format.mimetype", "value": "application/pdf", "language": null, "element": "format", "qualifier": "mimetype", "schema": "dc"}, {"key": "dc.language.iso", "value": "fin", "language": null, "element": "language", "qualifier": "iso", "schema": "dc"}, {"key": "dc.rights", "value": "CC BY 4.0", "language": null, "element": "rights", "qualifier": null, "schema": "dc"}, {"key": "dc.title", "value": "K\u00e4ytt\u00f6ohjeiden tuottamisen automatisointi tuoteperheen ohjelmistoille", "language": null, "element": "title", "qualifier": null, "schema": "dc"}, {"key": "dc.type", "value": "master thesis", "language": null, "element": "type", "qualifier": null, "schema": "dc"}, {"key": "dc.identifier.urn", "value": "URN:NBN:fi:jyu-202506115216", "language": null, "element": "identifier", "qualifier": "urn", "schema": "dc"}, {"key": "dc.contributor.faculty", "value": "Informaatioteknologian tiedekunta", "language": "fi", "element": "contributor", "qualifier": "faculty", "schema": "dc"}, {"key": "dc.contributor.faculty", "value": "Faculty of Information Technology", "language": "en", "element": "contributor", "qualifier": "faculty", "schema": "dc"}, {"key": "dc.contributor.organization", "value": "Jyv\u00e4skyl\u00e4n yliopisto", "language": "fi", "element": "contributor", "qualifier": "organization", "schema": "dc"}, {"key": "dc.contributor.organization", "value": "University of Jyv\u00e4skyl\u00e4", "language": "en", "element": "contributor", "qualifier": "organization", "schema": "dc"}, {"key": "dc.subject.discipline", "value": "Ohjelmistokehityksen opintosuunta", "language": "fi", "element": "subject", "qualifier": "discipline", "schema": "dc"}, {"key": "dc.subject.discipline", "value": "Specialisation in Software Development", "language": "en", "element": "subject", "qualifier": "discipline", "schema": "dc"}, {"key": "dc.type.coar", "value": "http://purl.org/coar/resource_type/c_bdcc", "language": null, "element": "type", "qualifier": "coar", "schema": "dc"}, {"key": "dc.rights.copyright", "value": "\u00a9 The Author(s)", "language": null, "element": "rights", "qualifier": "copyright", "schema": "dc"}, {"key": "dc.rights.accesslevel", "value": "openAccess", "language": null, "element": "rights", "qualifier": "accesslevel", "schema": "dc"}, {"key": "dc.type.publication", "value": "masterThesis", "language": null, "element": "type", "qualifier": "publication", "schema": "dc"}, {"key": "dc.format.content", "value": "fulltext", "language": null, "element": "format", "qualifier": "content", "schema": "dc"}, {"key": "dc.rights.url", "value": "https://creativecommons.org/licenses/by/4.0/", "language": null, "element": "rights", "qualifier": "url", "schema": "dc"}, {"key": "dc.description.accessibilityfeature", "value": "ei tietoa saavutettavuudesta", "language": "fi", "element": "description", "qualifier": "accessibilityfeature", "schema": "dc"}, {"key": "dc.description.accessibilityfeature", "value": "unknown accessibility", "language": "en", "element": "description", "qualifier": "accessibilityfeature", "schema": "dc"}]
id jyx.123456789_103417
language fin
last_indexed 2025-06-11T20:04:37Z
main_date 2025-01-01T00:00:00Z
main_date_str 2025
online_boolean 1
online_urls_str_mv {"url":"https:\/\/jyx.jyu.fi\/bitstreams\/02c7ce6d-7317-498b-8443-9f6139e49b2f\/download","text":"URN:NBN:fi:jyu-202506115216.pdf","source":"jyx","mediaType":"application\/pdf"}
publishDate 2025
record_format qdc
source_str_mv jyx
spellingShingle Peltomaa, Olli Käyttöohjeiden tuottamisen automatisointi tuoteperheen ohjelmistoille Ohjelmistokehityksen opintosuunta Specialisation in Software Development
title Käyttöohjeiden tuottamisen automatisointi tuoteperheen ohjelmistoille
title_full Käyttöohjeiden tuottamisen automatisointi tuoteperheen ohjelmistoille
title_fullStr Käyttöohjeiden tuottamisen automatisointi tuoteperheen ohjelmistoille Käyttöohjeiden tuottamisen automatisointi tuoteperheen ohjelmistoille
title_full_unstemmed Käyttöohjeiden tuottamisen automatisointi tuoteperheen ohjelmistoille Käyttöohjeiden tuottamisen automatisointi tuoteperheen ohjelmistoille
title_short Käyttöohjeiden tuottamisen automatisointi tuoteperheen ohjelmistoille
title_sort käyttöohjeiden tuottamisen automatisointi tuoteperheen ohjelmistoille
title_txtP Käyttöohjeiden tuottamisen automatisointi tuoteperheen ohjelmistoille
topic Ohjelmistokehityksen opintosuunta Specialisation in Software Development
topic_facet Ohjelmistokehityksen opintosuunta Specialisation in Software Development
url https://jyx.jyu.fi/handle/123456789/103417 http://www.urn.fi/URN:NBN:fi:jyu-202506115216
work_keys_str_mv AT peltomaaolli käyttöohjeidentuottamisenautomatisointituoteperheenohjelmistoille