Creating documentation practices for agile software development organizations a qualitative case study

Agile development methodologies have become increasingly popular in software development. These methodologies emphasize interaction between the development team and stakeholders, as well as continuous delivery of working software, over heavy planning, documentation, and processes. While streamlining...

Full description

Bibliographic Details
Main Author: Mielonen, Antti
Other Authors: Informaatioteknologian tiedekunta, Faculty of Information Technology, Informaatioteknologia, Information Technology, Jyväskylän yliopisto, University of Jyväskylä
Format: Master's thesis
Language:eng
Published: 2023
Subjects:
Online Access: https://jyx.jyu.fi/handle/123456789/86526
_version_ 1826225696788185088
author Mielonen, Antti
author2 Informaatioteknologian tiedekunta Faculty of Information Technology Informaatioteknologia Information Technology Jyväskylän yliopisto University of Jyväskylä
author_facet Mielonen, Antti Informaatioteknologian tiedekunta Faculty of Information Technology Informaatioteknologia Information Technology Jyväskylän yliopisto University of Jyväskylä Mielonen, Antti Informaatioteknologian tiedekunta Faculty of Information Technology Informaatioteknologia Information Technology Jyväskylän yliopisto University of Jyväskylä
author_sort Mielonen, Antti
datasource_str_mv jyx
description Agile development methodologies have become increasingly popular in software development. These methodologies emphasize interaction between the development team and stakeholders, as well as continuous delivery of working software, over heavy planning, documentation, and processes. While streamlining the development process can bring benefits during the project phase, the lack of documentation will inevitably lead to problems later in the system's lifecycle. Inadequate documentation makes software maintenance and further development challenging and time-consuming. Moreover, onboarding new developers and handing over the system from development to maintenance becomes more laborious. Despite these problems, the importance of documentation has received little attention in both the IT industry and information systems research. In the context of agile development, the discussion regarding documentation often merely requires it to be sufficient, without specifying what constitutes sufficient documentation. This thesis aimed to find answers to the question of how to produce sufficient documentation in agile software development. The research problem was approached by determining what information needs documentation users have and what practices and processes could fulfill these information needs. Based on these findings, the sufficiency of documentation was evaluated and the ways in which documentation practices could be integrated into the agile development process were explored. The study was conducted as a qualitative case study in a software consulting firm that delivers enterprise information systems. Empirical data was collected through semi-structured interviews with various system development experts, and the data was analyzed using thematic content analysis. The results emphasized the importance of aligning the production of documentation to the agile methodology and development process and the artifacts inherent to them. Additionally, the results implicated that documentation should avoid overlap with the source code and rather include information that cannot be conveyed through the code, such as information about the requirement that the functionality implements, the functional logic of the component, and the broader process that the described functionality is linked to.
first_indexed 2023-04-24T20:01:04Z
format Pro gradu
fullrecord [{"key": "dc.contributor.advisor", "value": "Halttunen, Veikko", "language": "", "element": "contributor", "qualifier": "advisor", "schema": "dc"}, {"key": "dc.contributor.author", "value": "Mielonen, Antti", "language": "", "element": "contributor", "qualifier": "author", "schema": "dc"}, {"key": "dc.date.accessioned", "value": "2023-04-24T05:53:51Z", "language": null, "element": "date", "qualifier": "accessioned", "schema": "dc"}, {"key": "dc.date.available", "value": "2023-04-24T05:53:51Z", "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/86526", "language": null, "element": "identifier", "qualifier": "uri", "schema": "dc"}, {"key": "dc.description.abstract", "value": "Agile development methodologies have become increasingly popular in software development. These methodologies emphasize interaction between the development team and stakeholders, as well as continuous delivery of working software, over heavy planning, documentation, and processes. While streamlining the development process can bring benefits during the project phase, the lack of documentation will inevitably lead to problems later in the system's lifecycle. Inadequate documentation makes software maintenance and further development challenging and time-consuming. Moreover, onboarding new developers and handing over the system from development to maintenance becomes more laborious. Despite these problems, the importance of documentation has received little attention in both the IT industry and information systems research. In the context of agile development, the discussion regarding documentation often merely requires it to be sufficient, without specifying what constitutes sufficient documentation. This thesis aimed to find answers to the question of how to produce sufficient documentation in agile software development. The research problem was approached by determining what information needs documentation users have and what practices and processes could fulfill these information needs. Based on these findings, the sufficiency of documentation was evaluated and the ways in which documentation practices could be integrated into the agile development process were explored. The study was conducted as a qualitative case study in a software consulting firm that delivers enterprise information systems. Empirical data was collected through semi-structured interviews with various system development experts, and the data was analyzed using thematic content analysis. The results emphasized the importance of aligning the production of documentation to the agile methodology and development process and the artifacts inherent to them. Additionally, the results implicated that documentation should avoid overlap with the source code and rather include information that cannot be conveyed through the code, such as information about the requirement that the functionality implements, the functional logic of the component, and the broader process that the described functionality is linked to.", "language": "en", "element": "description", "qualifier": "abstract", "schema": "dc"}, {"key": "dc.description.provenance", "value": "Submitted by Paivi Vuorio (paelvuor@jyu.fi) on 2023-04-24T05:53:51Z\nNo. of bitstreams: 0", "language": "en", "element": "description", "qualifier": "provenance", "schema": "dc"}, {"key": "dc.description.provenance", "value": "Made available in DSpace on 2023-04-24T05:53:51Z (GMT). No. of bitstreams: 0\n Previous issue date: 2023", "language": "en", "element": "description", "qualifier": "provenance", "schema": "dc"}, {"key": "dc.format.extent", "value": "81", "language": "", "element": "format", "qualifier": "extent", "schema": "dc"}, {"key": "dc.language.iso", "value": "eng", "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": "agile artifacts", "language": "", "element": "subject", "qualifier": "other", "schema": "dc"}, {"key": "dc.subject.other", "value": "documentation quality", "language": "", "element": "subject", "qualifier": "other", "schema": "dc"}, {"key": "dc.title", "value": "Creating documentation practices for agile software development organizations : a qualitative case study", "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-202304242640", "language": "", "element": "identifier", "qualifier": "urn", "schema": "dc"}, {"key": "dc.type.ontasot", "value": "Master\u2019s thesis", "language": "en", "element": "type", "qualifier": "ontasot", "schema": "dc"}, {"key": "dc.type.ontasot", "value": "Pro gradu -tutkielma", "language": "fi", "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": "restrictedAccess", "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": "ketter\u00e4t menetelm\u00e4t", "language": null, "element": "subject", "qualifier": "yso", "schema": "dc"}, {"key": "dc.subject.yso", "value": "ohjelmistokehitys", "language": null, "element": "subject", "qualifier": "yso", "schema": "dc"}, {"key": "dc.subject.yso", "value": "documentation", "language": null, "element": "subject", "qualifier": "yso", "schema": "dc"}, {"key": "dc.subject.yso", "value": "agile methods", "language": null, "element": "subject", "qualifier": "yso", "schema": "dc"}, {"key": "dc.subject.yso", "value": "software development", "language": null, "element": "subject", "qualifier": "yso", "schema": "dc"}, {"key": "dc.rights.url", "value": "https://rightsstatements.org/page/InC/1.0/", "language": null, "element": "rights", "qualifier": "url", "schema": "dc"}, {"key": "dc.rights.accessrights", "value": "The author has not given permission to make the work publicly available electronically. Therefore the material can be read only at the archival workstation at Jyv\u00e4skyl\u00e4 University Library (https://kirjasto.jyu.fi/collections/archival-workstation).", "language": "en", "element": "rights", "qualifier": "accessrights", "schema": "dc"}, {"key": "dc.rights.accessrights", "value": "Tekij\u00e4 ei ole antanut lupaa avoimeen julkaisuun, joten aineisto on luettavissa vain Jyv\u00e4skyl\u00e4n yliopiston kirjaston arkistoty\u00f6semalta. Ks. https://kirjasto.jyu.fi/kokoelmat/arkistotyoasema..", "language": "fi", "element": "rights", "qualifier": "accessrights", "schema": "dc"}]
id jyx.123456789_86526
language eng
last_indexed 2025-02-18T10:54:53Z
main_date 2023-01-01T00:00:00Z
main_date_str 2023
publishDate 2023
record_format qdc
source_str_mv jyx
spellingShingle Mielonen, Antti Creating documentation practices for agile software development organizations : a qualitative case study agile artifacts documentation quality Tietojärjestelmätiede Information Systems Science 601 dokumentointi ketterät menetelmät ohjelmistokehitys documentation agile methods software development
title Creating documentation practices for agile software development organizations : a qualitative case study
title_full Creating documentation practices for agile software development organizations : a qualitative case study
title_fullStr Creating documentation practices for agile software development organizations : a qualitative case study Creating documentation practices for agile software development organizations : a qualitative case study
title_full_unstemmed Creating documentation practices for agile software development organizations : a qualitative case study Creating documentation practices for agile software development organizations : a qualitative case study
title_short Creating documentation practices for agile software development organizations
title_sort creating documentation practices for agile software development organizations a qualitative case study
title_sub a qualitative case study
title_txtP Creating documentation practices for agile software development organizations : a qualitative case study
topic agile artifacts documentation quality Tietojärjestelmätiede Information Systems Science 601 dokumentointi ketterät menetelmät ohjelmistokehitys documentation agile methods software development
topic_facet 601 Information Systems Science Tietojärjestelmätiede agile artifacts agile methods documentation documentation quality dokumentointi ketterät menetelmät ohjelmistokehitys software development
url https://jyx.jyu.fi/handle/123456789/86526 http://www.urn.fi/URN:NBN:fi:jyu-202304242640
work_keys_str_mv AT mielonenantti creatingdocumentationpracticesforagilesoftwaredevelopmentorganizationsaqualitative