Dokumentaatio ketterässä kehityksessä ja siihen liittyvät käytänteet ja työkalut

Abstract

Hyvä dokumentaatio selkeyttää ohjelmiston tavoitteita, auttaa uusien kehittäjien perehdyttämisessä ja parantaa viestintää ketterissä kehitystiimeissä. Vaikka yksi ketterän ohjelmistokehityksen julistuksen pääperiaatteista on asettaa toimiva ohjelmisto kattavan dokumentaation edelle, tehokkaalla dokumentaatiolla on silti tärkeä rooli. Tutkielma keskittyy siihen, mitä nykyaikaisesta ohjelmistosta dokumentoidaan. Tyypillisesti dokumentoitavat osat, kuten käyttäjätarinat, toiminnalliset ja ei-toiminnalliset vaatimukset. Nämä auttavat kehittäjiä ymmärtämään ja hallitsemaan projektin laajuutta ja vaatimuksia. Lisäksi tässä tutkimuksessa tarkastellaan työkaluja, kuten wikejä, jotka tukevat kehittäjiä dokumentaation ylläpidossa ja kirjoittamisessa. Nämä työkalut mahdollistavat kehittäjille dokumentaation yhteisöllisen ja iteratiivisen kirjoittamisen, säästäen aikaa ja parantaen yhteistyötä ketterissä tiimeissä. Tutkimus nostaa esiin kysymyksen siitä, miksi dokumentaation laatiminen on usein välteltävä tehtävä ketterien ohjelmistokehittäjien keskuudessa sekä näennäistä ristiriitaa, jossa kehittäjät tunnustavat silti tehokkaan dokumentaation tärkeyden työssään.

Documentation in agile software development is a frequently discussed topic. Although one of the main principles of agile software development is to prioritize working software over comprehensive documentation, effective documentation still plays an important role. Effective documentation clarifies the software’s goals, helps in the onboarding of new developers, and improves communication within agile development teams. The thesis focuses on various aspects of documentation in modern software. It consists of multiple different elements. These elements, such as user stories, functional and nonfunctional requirements, assist developers in understanding and managing the project’s scope and specifications. Additionally, this study examines tools, e.g. wikis, that support developers in maintaining and writing documentation. These tools enable developers to collaboratively and iteratively write documentation, saving time and enhancing synergy within agile teams. This study raises the question of why documentation is often viewed as a dreaded task among agile software developers. It also explores the apparent contradiction where developers still recognize the importance of effective documentation in their work.