Kehittäjäkokemuksen toteutuminen teknisessä dokumentaatiossa

Ohjelmistokehitys, siinä missä moni muukin ajatustyö, on ihmislähtöistä toimintaa. Vaikka ala on hyvin teknologiaorientoitunut, loppupeleissä työnteosta vastaavat aina ohjelmoijat, ihmiset. Tämän vuoksi ohjelmoijien työskentelytyytyväisyyteen eli kehittäjäkokemukseen on kiinnitettävä erityistä huomi...

Full description

Bibliographic Details
Main Author: Mäntylä, Mikael
Other Authors: Informaatioteknologian tiedekunta, Faculty of Information Technology, Informaatioteknologia, Information Technology, Jyväskylän yliopisto, University of Jyväskylä
Format: Master's thesis
Language:fin
Published: 2023
Subjects:
Online Access: https://jyx.jyu.fi/handle/123456789/85016
_version_ 1826225751000612864
author Mäntylä, Mikael
author2 Informaatioteknologian tiedekunta Faculty of Information Technology Informaatioteknologia Information Technology Jyväskylän yliopisto University of Jyväskylä
author_facet Mäntylä, Mikael Informaatioteknologian tiedekunta Faculty of Information Technology Informaatioteknologia Information Technology Jyväskylän yliopisto University of Jyväskylä Mäntylä, Mikael Informaatioteknologian tiedekunta Faculty of Information Technology Informaatioteknologia Information Technology Jyväskylän yliopisto University of Jyväskylä
author_sort Mäntylä, Mikael
datasource_str_mv jyx
description Ohjelmistokehitys, siinä missä moni muukin ajatustyö, on ihmislähtöistä toimintaa. Vaikka ala on hyvin teknologiaorientoitunut, loppupeleissä työnteosta vastaavat aina ohjelmoijat, ihmiset. Tämän vuoksi ohjelmoijien työskentelytyytyväisyyteen eli kehittäjäkokemukseen on kiinnitettävä erityistä huomiota. Tässä tutkimuksessa tutkittiin toimeksiantajan yhteistyökumppanien suhtautumista sen tekniseen dokumentaatioon kehittäjäkokemuksen näkökulmasta. Kirjallisuuden avulla perehdyttiin lean-ajatteluun ohjelmistokehityksessä, kehittäjäkokemukseen sekä dokumentaatioon. Teorian avulla luotiin kyselylomake ja se lähetettiin toimeksiantajalta saaduille sähköpostiosoitteisiin yhdessä saatekirjeen kanssa. Tarkoituksena oli selvittää, miten kumppanit kokevat dokumentaation palvelevan heitä heidän jokapäiväisessä työssään ja, miten se voisi olla entistä parempi. Tutkimus toteutettiin siis määrällisenä kyselytutkimuksena, mutta avoimien kysymysten vuoksi siinä oli myös laadullisia osa-alueita. Kyselytutkimuksen otanta osoittautui odotettua pienemmäksi, minkä vuoksi tuloksista ei voida yleistää vaan niistä voidaan vetää ainoastaan suuntaa antavia johtopäätöksi toimeksiantajan dokumentaation tiimoilta. Yleisesti ottaen dokumentaatio osoittautui melko hyväksi kumppanien keskuudessa, mutta silti joitain kehitysehdotuksia löytyi. Etenkin dokumentaation sekavuus, keskeneräisyys ja koodiesimerkkien määrä saivat kritiikkiä. Dokumentaation rakenteen selkeyttäminen parantaisi sekavuutta, mikä puolestaan kohentaisi kehittäjäkokemusta. Vastaajat kaipasivat yleisesti lisää koodiesimerkkejä ja mielellään useimmilla eri ohjelmointikielillä. Eniten ääni keräsivät PHP, JavaScript, Python ja Curl. Software development, like many other forms of thinking-related work, is a people-oriented activity. Although the industry is very technology-oriented, at the end of the day, the work is always done by people. Therefore, particular attention must be paid to the job satisfaction of programmers, i.e., the developer experience. This study investigated the attitude of the client's technical partners. Literature was used to explore lean thinking in software development, developer experience and documentation. A questionnaire was created using the theory and sent to the email addresses provided by the client together with a cover letter. The aim was to find out how the partners perceive the documentation to help them in their daily work and how it could be improved. The survey was therefore conducted as a quantitative survey, but due to the open questions, it also had qualitative elements. The survey sample turned out to be smaller than expected, which means that the results cannot be generalised and can only be used to draw some indicative conclusions about the client's documentation. In general, the documentation proved to be quite good among the partners, but there were still some improvements to be done. In particular, the documentation was criticised for its incoherence, incompleteness, and the amount of code examples. Clarifying the structure of the documentation would improve the confusion, which would improve the developer experience. Respondents generally wanted more code examples, preferably in more programming languages. PHP, JavaScript, Python and Curl received the most amount votes.
first_indexed 2023-01-16T21:00:57Z
format Pro gradu
free_online_boolean 1
fullrecord [{"key": "dc.contributor.advisor", "value": "Sepp\u00e4nen, Ville", "language": "", "element": "contributor", "qualifier": "advisor", "schema": "dc"}, {"key": "dc.contributor.author", "value": "M\u00e4ntyl\u00e4, Mikael", "language": "", "element": "contributor", "qualifier": "author", "schema": "dc"}, {"key": "dc.date.accessioned", "value": "2023-01-16T06:19:01Z", "language": null, "element": "date", "qualifier": "accessioned", "schema": "dc"}, {"key": "dc.date.available", "value": "2023-01-16T06:19:01Z", "language": null, "element": "date", "qualifier": "available", "schema": "dc"}, {"key": "dc.date.issued", "value": "2023", "language": "", "element": "date", "qualifier": "issued", "schema": "dc"}, {"key": "dc.identifier.uri", "value": "https://jyx.jyu.fi/handle/123456789/85016", "language": null, "element": "identifier", "qualifier": "uri", "schema": "dc"}, {"key": "dc.description.abstract", "value": "Ohjelmistokehitys, siin\u00e4 miss\u00e4 moni muukin ajatusty\u00f6, on ihmisl\u00e4ht\u00f6ist\u00e4 toimintaa. Vaikka ala on hyvin teknologiaorientoitunut, loppupeleiss\u00e4 ty\u00f6nteosta vastaavat aina ohjelmoijat, ihmiset. T\u00e4m\u00e4n vuoksi ohjelmoijien ty\u00f6skentelytyytyv\u00e4isyyteen eli kehitt\u00e4j\u00e4kokemukseen on kiinnitett\u00e4v\u00e4 erityist\u00e4 huomiota. T\u00e4ss\u00e4 tutkimuksessa tutkittiin toimeksiantajan yhteisty\u00f6kumppanien suhtautumista sen tekniseen dokumentaatioon kehitt\u00e4j\u00e4kokemuksen n\u00e4k\u00f6kulmasta. Kirjallisuuden avulla perehdyttiin lean-ajatteluun ohjelmistokehityksess\u00e4, kehitt\u00e4j\u00e4kokemukseen sek\u00e4 dokumentaatioon. Teorian avulla luotiin kyselylomake ja se l\u00e4hetettiin toimeksiantajalta saaduille s\u00e4hk\u00f6postiosoitteisiin yhdess\u00e4 saatekirjeen kanssa. Tarkoituksena oli selvitt\u00e4\u00e4, miten kumppanit kokevat dokumentaation palvelevan heit\u00e4 heid\u00e4n jokap\u00e4iv\u00e4isess\u00e4 ty\u00f6ss\u00e4\u00e4n ja, miten se voisi olla entist\u00e4 parempi. Tutkimus toteutettiin siis m\u00e4\u00e4r\u00e4llisen\u00e4 kyselytutkimuksena, mutta avoimien kysymysten vuoksi siin\u00e4 oli my\u00f6s laadullisia osa-alueita. Kyselytutkimuksen otanta osoittautui odotettua pienemm\u00e4ksi, mink\u00e4 vuoksi tuloksista ei voida yleist\u00e4\u00e4 vaan niist\u00e4 voidaan vet\u00e4\u00e4 ainoastaan suuntaa antavia johtop\u00e4\u00e4t\u00f6ksi toimeksiantajan dokumentaation tiimoilta. Yleisesti ottaen dokumentaatio osoittautui melko hyv\u00e4ksi kumppanien keskuudessa, mutta silti joitain kehitysehdotuksia l\u00f6ytyi. Etenkin dokumentaation sekavuus, keskener\u00e4isyys ja koodiesimerkkien m\u00e4\u00e4r\u00e4 saivat kritiikki\u00e4. Dokumentaation rakenteen selkeytt\u00e4minen parantaisi sekavuutta, mik\u00e4 puolestaan kohentaisi kehitt\u00e4j\u00e4kokemusta. Vastaajat kaipasivat yleisesti lis\u00e4\u00e4 koodiesimerkkej\u00e4 ja mielell\u00e4\u00e4n useimmilla eri ohjelmointikielill\u00e4. Eniten \u00e4\u00e4ni ker\u00e4siv\u00e4t PHP, JavaScript, Python ja Curl.", "language": "fi", "element": "description", "qualifier": "abstract", "schema": "dc"}, {"key": "dc.description.abstract", "value": "Software development, like many other forms of thinking-related work, is a people-oriented activity. Although the industry is very technology-oriented, at the end of the day, the work is always done by people. Therefore, particular attention must be paid to the job satisfaction of programmers, i.e., the developer experience. This study investigated the attitude of the client's technical partners. Literature was used to explore lean thinking in software development, developer experience and documentation. A questionnaire was created using the theory and sent to the email addresses provided by the client together with a cover letter. The aim was to find out how the partners perceive the documentation to help them in their daily work and how it could be improved. The survey was therefore conducted as a quantitative survey, but due to the open questions, it also had qualitative elements. The survey sample turned out to be smaller than expected, which means that the results cannot be generalised and can only be used to draw some indicative conclusions about the client's documentation. In general, the documentation proved to be quite good among the partners, but there were still some improvements to be done. In particular, the documentation was criticised for its incoherence, incompleteness, and the amount of code examples. Clarifying the structure of the documentation would improve the confusion, which would improve the developer experience. Respondents generally wanted more code examples, preferably in more programming languages. PHP, JavaScript, Python and Curl received the most amount votes.", "language": "en", "element": "description", "qualifier": "abstract", "schema": "dc"}, {"key": "dc.description.provenance", "value": "Submitted by Paivi Vuorio (paelvuor@jyu.fi) on 2023-01-16T06:19:01Z\nNo. of bitstreams: 0", "language": "en", "element": "description", "qualifier": "provenance", "schema": "dc"}, {"key": "dc.description.provenance", "value": "Made available in DSpace on 2023-01-16T06:19:01Z (GMT). No. of bitstreams: 0\n Previous issue date: 2023", "language": "en", "element": "description", "qualifier": "provenance", "schema": "dc"}, {"key": "dc.format.extent", "value": "73", "language": "", "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": "In Copyright", "language": null, "element": "rights", "qualifier": null, "schema": "dc"}, {"key": "dc.subject.other", "value": "kehitt\u00e4j\u00e4kokemus", "language": "", "element": "subject", "qualifier": "other", "schema": "dc"}, {"key": "dc.subject.other", "value": "dokumentaatio", "language": "", "element": "subject", "qualifier": "other", "schema": "dc"}, {"key": "dc.subject.other", "value": "tekninen dokumentaatio", "language": "", "element": "subject", "qualifier": "other", "schema": "dc"}, {"key": "dc.subject.other", "value": "API-dokumentaatio", "language": "", "element": "subject", "qualifier": "other", "schema": "dc"}, {"key": "dc.subject.other", "value": "API-kehitys", "language": "", "element": "subject", "qualifier": "other", "schema": "dc"}, {"key": "dc.title", "value": "Kehitt\u00e4j\u00e4kokemuksen toteutuminen teknisess\u00e4 dokumentaatiossa", "language": "", "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-202301161319", "language": "", "element": "identifier", "qualifier": "urn", "schema": "dc"}, {"key": "dc.type.ontasot", "value": "Pro gradu -tutkielma", "language": "fi", "element": "type", "qualifier": "ontasot", "schema": "dc"}, {"key": "dc.type.ontasot", "value": "Master\u2019s thesis", "language": "en", "element": "type", "qualifier": "ontasot", "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.department", "value": "Informaatioteknologia", "language": "fi", "element": "contributor", "qualifier": "department", "schema": "dc"}, {"key": "dc.contributor.department", "value": "Information Technology", "language": "en", "element": "contributor", "qualifier": "department", "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": "Tietoj\u00e4rjestelm\u00e4tiede", "language": "fi", "element": "subject", "qualifier": "discipline", "schema": "dc"}, {"key": "dc.subject.discipline", "value": "Information Systems Science", "language": "en", "element": "subject", "qualifier": "discipline", "schema": "dc"}, {"key": "yvv.contractresearch.funding", "value": "0", "language": "", "element": "contractresearch", "qualifier": "funding", "schema": "yvv"}, {"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.subject.oppiainekoodi", "value": "601", "language": "", "element": "subject", "qualifier": "oppiainekoodi", "schema": "dc"}, {"key": "dc.subject.yso", "value": "dokumentointi", "language": null, "element": "subject", "qualifier": "yso", "schema": "dc"}, {"key": "dc.subject.yso", "value": "ohjelmistokehitys", "language": null, "element": "subject", "qualifier": "yso", "schema": "dc"}, {"key": "dc.format.content", "value": "fulltext", "language": null, "element": "format", "qualifier": "content", "schema": "dc"}, {"key": "dc.rights.url", "value": "https://rightsstatements.org/page/InC/1.0/", "language": null, "element": "rights", "qualifier": "url", "schema": "dc"}, {"key": "dc.type.okm", "value": "G2", "language": null, "element": "type", "qualifier": "okm", "schema": "dc"}]
id jyx.123456789_85016
language fin
last_indexed 2025-02-18T10:55:57Z
main_date 2023-01-01T00:00:00Z
main_date_str 2023
online_boolean 1
online_urls_str_mv {"url":"https:\/\/jyx.jyu.fi\/bitstreams\/55b9d31e-cffc-4ac1-be35-aa9cc71ae2ce\/download","text":"URN:NBN:fi:jyu-202301161319.pdf","source":"jyx","mediaType":"application\/pdf"}
publishDate 2023
record_format qdc
source_str_mv jyx
spellingShingle Mäntylä, Mikael Kehittäjäkokemuksen toteutuminen teknisessä dokumentaatiossa kehittäjäkokemus dokumentaatio tekninen dokumentaatio API-dokumentaatio API-kehitys Tietojärjestelmätiede Information Systems Science 601 dokumentointi ohjelmistokehitys
title Kehittäjäkokemuksen toteutuminen teknisessä dokumentaatiossa
title_full Kehittäjäkokemuksen toteutuminen teknisessä dokumentaatiossa
title_fullStr Kehittäjäkokemuksen toteutuminen teknisessä dokumentaatiossa Kehittäjäkokemuksen toteutuminen teknisessä dokumentaatiossa
title_full_unstemmed Kehittäjäkokemuksen toteutuminen teknisessä dokumentaatiossa Kehittäjäkokemuksen toteutuminen teknisessä dokumentaatiossa
title_short Kehittäjäkokemuksen toteutuminen teknisessä dokumentaatiossa
title_sort kehittäjäkokemuksen toteutuminen teknisessä dokumentaatiossa
title_txtP Kehittäjäkokemuksen toteutuminen teknisessä dokumentaatiossa
topic kehittäjäkokemus dokumentaatio tekninen dokumentaatio API-dokumentaatio API-kehitys Tietojärjestelmätiede Information Systems Science 601 dokumentointi ohjelmistokehitys
topic_facet 601 API-dokumentaatio API-kehitys Information Systems Science Tietojärjestelmätiede dokumentaatio dokumentointi kehittäjäkokemus ohjelmistokehitys tekninen dokumentaatio
url https://jyx.jyu.fi/handle/123456789/85016 http://www.urn.fi/URN:NBN:fi:jyu-202301161319
work_keys_str_mv AT mäntylämikael kehittäjäkokemuksentoteutuminenteknisessädokumentaatiossa