Käyttöohjeiden hallinnan haasteet : Ratkaisuna rakenteisuus, modulaarisuus ja yksilähteistäminen?
West, Pia (2023-05-12)
West, Pia
12.05.2023
Julkaisun pysyvä osoite on
https://urn.fi/URN:NBN:fi-fe2023051243951
https://urn.fi/URN:NBN:fi-fe2023051243951
Tiivistelmä
Työelämän prosessit ovat digitalisoituneet ja käytettävien ohjelmistojen määrä sekä kompleksisuus kasvavat jatkuvasti. Ohjelmistojen käytön tueksi ja niiden hyödyntämisen optimoimiseksi tarvitaan useimmiten käyttöohjeita. Niiden tuottaminen lineaarisena dokumentaationa tekstinkäsittelyohjelmia käyttäen ei vastaa laajan ohjelmistoportfolion käyttöohjeiden tehokkaan hallinnoinnin asettamia vaatimuksia. Rakenteisuus, modulaarisuus ja yksilähteistäminen tarjoavat teoriassa ratkaisuja dokumentaation hallinnontiin, mutta kuinka hyvin ratkaisu on toteutettavissa käytännön työkaluissa eli sisällönhallintajärjestelmissä?
Tämän tutkielman tavoitteena oli selvittää, miten dokumentaation rakenteistaminen, modulaarisuus ja yksilähteistäminen ratkaisevat kompleksisen ohjelmistotuoteportfolion tuomia haasteita käyttöohjeiden tuottamisessa ja ylläpidossa. Analyysi oli kaksivaiheinen. Ensimmäinen osio suoritettiin asiantuntija-arviointina, jossa tarkasteltiin kolmen komponenttisisällönhallintajärjestelmän ominaisuuksia, jotta saataisiin selville, tukevatko järjestelmien tarjoamat työkalut rakenteistamisen, modulaarisuuden ja yksilähteistämisen periaatteita. Analyysi osoitti, että vertailussa olleet järjestelmät tukevat hyvin näitä periaatteita. Analyysin toisessa osiossa testattiin yhtä ensimmäisessä tutkimusosiossa tutkittua komponenttisisällönhallintajärjestelmää käytännössä, tavoitellen tehokasta käyttöohjekokonaisuuden hallintamallia. Ratkaisuja haettiin erityisesti viiteen tunnistettuun haasteita aiheuttavaan päätekijään: eri kohderyhmien tiedontarpeet, tilannekohtaiset erilaajuiset tiedontarpeet, sovellusten väliset riippuvuudet, sovellusten eri tuoteversiot sekä käyttöohjeiden eri kieliversiot. Testi suoritettiin muuntamalla ensin kahden tiedonhallintaan liittyvän sovelluksen lineaariset käyttöohjeet modulaariseen muotoon, ja toteuttamalla ne sen jälkeen sisällönhallintajärjestelmään, sen toiminnallisuuksia ja työkaluja hyödyntäen. Testin perusteella voitiin todeta, että komponenttisisällönhallintajärjestelmä tarjosi käyttöohjeiden hallintaan helpotusta, joskin ei täydellisiä ratkaisuja kaikilla viidellä osa-alueella.
Tutkimuksen perusteella voidaan todeta, että rakenteisuutta, modulaarisuutta ja yksilähteistämistä tukeva sisällönhallintajärjestelmä voi vähentää kompleksisen dokumentaation hallinnoinnin haasteita. Järjestelmän optimaalinen hyödyntäminen edellyttää myös sisällön suunnittelua ja kokonaisvaltaista organisointia. Processerna i arbetslivet har digitaliserats, och mängden programvaror som används ökar kontinuerligt, liksom deras komplexitet. Som stöd för användningen och utnyttjandet av tillämpningarna behövs oftast användarmanualer. Att producera manualerna som linjär dokumentation med hjälp av textbehandlingsprogram motsvarar inte de krav som ställs på effektiv hantering av användarmanualerna för en omfattande produktportfölj. Strukturerad dokumentation, modularitet och återanvändning av innehåll erbjuder i teorin lösningar för hantering av dokumentationen, men hur bra kan lösningen förverkligas i de praktiska verktygen, det vill säga i innehållshanteringssystemen?
Målet med denna undersökning var att ta reda på hur strukturerad dokumentation, modularitet och återanvändning av innehåll löser de utmaningar som finns med att producera och upprätthålla användarmanualer för en komplex programvaruportfölj. Undersökningen var tvådelad. Den första delen utfördes som en expertbedömning, där egenskaperna hos tre innehållshanteringssystem granskades för att ta reda på om de verktyg som systemen tillhandahåller stöder principerna för strukturerad dokumentation, modularitet och återanvändning av innehåll. Undersökningen visade att de system som jämfördes stöder dessa principer väl. I undersökningens andra del testades ett av de tre jämförda komponentinnehållshanteringssystemen i praktiken, med syfte att hitta en effektiv hanteringsmodell för manualerna. Lösningar söktes specifikt för fem identifierade huvudfaktorer som orsakar utmaningar: olika målgruppers informationsbehov, situationsspecifika informationsbehov, korrelation mellan tillämpningarna, olika versioner av tillämpningarna samt manualernas språkversioner. Testen utfördes genom att först omvandla de linjära användarmanualerna för två tillämpningar till modulär form, och sedan förverkliga dem i innehållshanteringssystemet, genom att utnyttja dess funktionaliteter och verktyg. På basen av denna test kunde man konstatera, att komponentinnehållshanteringssystemet på samtliga fem delområden underlättade, men gav inte fullkomliga lösningar för hanteringen av manualerna.
På basen av undersökningen kan konstateras, att innehållshanteringssystem som stöder strukturerad dokumentation, modularitet och återanvändning av innehåll kan minska utmaningarna med hanteringen av komplex dokumentation. Ett optimalt utnyttjande av systemet förutsätter också planering och helhetsorganisering av innehållet.
Tämän tutkielman tavoitteena oli selvittää, miten dokumentaation rakenteistaminen, modulaarisuus ja yksilähteistäminen ratkaisevat kompleksisen ohjelmistotuoteportfolion tuomia haasteita käyttöohjeiden tuottamisessa ja ylläpidossa. Analyysi oli kaksivaiheinen. Ensimmäinen osio suoritettiin asiantuntija-arviointina, jossa tarkasteltiin kolmen komponenttisisällönhallintajärjestelmän ominaisuuksia, jotta saataisiin selville, tukevatko järjestelmien tarjoamat työkalut rakenteistamisen, modulaarisuuden ja yksilähteistämisen periaatteita. Analyysi osoitti, että vertailussa olleet järjestelmät tukevat hyvin näitä periaatteita. Analyysin toisessa osiossa testattiin yhtä ensimmäisessä tutkimusosiossa tutkittua komponenttisisällönhallintajärjestelmää käytännössä, tavoitellen tehokasta käyttöohjekokonaisuuden hallintamallia. Ratkaisuja haettiin erityisesti viiteen tunnistettuun haasteita aiheuttavaan päätekijään: eri kohderyhmien tiedontarpeet, tilannekohtaiset erilaajuiset tiedontarpeet, sovellusten väliset riippuvuudet, sovellusten eri tuoteversiot sekä käyttöohjeiden eri kieliversiot. Testi suoritettiin muuntamalla ensin kahden tiedonhallintaan liittyvän sovelluksen lineaariset käyttöohjeet modulaariseen muotoon, ja toteuttamalla ne sen jälkeen sisällönhallintajärjestelmään, sen toiminnallisuuksia ja työkaluja hyödyntäen. Testin perusteella voitiin todeta, että komponenttisisällönhallintajärjestelmä tarjosi käyttöohjeiden hallintaan helpotusta, joskin ei täydellisiä ratkaisuja kaikilla viidellä osa-alueella.
Tutkimuksen perusteella voidaan todeta, että rakenteisuutta, modulaarisuutta ja yksilähteistämistä tukeva sisällönhallintajärjestelmä voi vähentää kompleksisen dokumentaation hallinnoinnin haasteita. Järjestelmän optimaalinen hyödyntäminen edellyttää myös sisällön suunnittelua ja kokonaisvaltaista organisointia.
Målet med denna undersökning var att ta reda på hur strukturerad dokumentation, modularitet och återanvändning av innehåll löser de utmaningar som finns med att producera och upprätthålla användarmanualer för en komplex programvaruportfölj. Undersökningen var tvådelad. Den första delen utfördes som en expertbedömning, där egenskaperna hos tre innehållshanteringssystem granskades för att ta reda på om de verktyg som systemen tillhandahåller stöder principerna för strukturerad dokumentation, modularitet och återanvändning av innehåll. Undersökningen visade att de system som jämfördes stöder dessa principer väl. I undersökningens andra del testades ett av de tre jämförda komponentinnehållshanteringssystemen i praktiken, med syfte att hitta en effektiv hanteringsmodell för manualerna. Lösningar söktes specifikt för fem identifierade huvudfaktorer som orsakar utmaningar: olika målgruppers informationsbehov, situationsspecifika informationsbehov, korrelation mellan tillämpningarna, olika versioner av tillämpningarna samt manualernas språkversioner. Testen utfördes genom att först omvandla de linjära användarmanualerna för två tillämpningar till modulär form, och sedan förverkliga dem i innehållshanteringssystemet, genom att utnyttja dess funktionaliteter och verktyg. På basen av denna test kunde man konstatera, att komponentinnehållshanteringssystemet på samtliga fem delområden underlättade, men gav inte fullkomliga lösningar för hanteringen av manualerna.
På basen av undersökningen kan konstateras, att innehållshanteringssystem som stöder strukturerad dokumentation, modularitet och återanvändning av innehåll kan minska utmaningarna med hanteringen av komplex dokumentation. Ett optimalt utnyttjande av systemet förutsätter också planering och helhetsorganisering av innehållet.