Documentation of the product during a software development process : the scaled agile framework

Abstract

Documentation is an essential part of software development processes, although as the use of agile methods has increased the role of documentation has become unclear, because agile practitioners argue against comprehensive documentation. The issue of how much documentation is enough and in which development phase should it be created has been studied for years, yet it still remains unclear. This thesis aims to find guidelines of product documentation when the company is using agile methods. The focus of the thesis is on case company’s product documentation, and the goal is to offer a possible future solution related to the documentation of their product. In the empirical study it was found out that requirements, functionalities, features, configurations and interfaces are important things to document. Wiki and UML diagrams were noted to be good documentation techniques.

Dokumentaatio on tärkeä osa ohjelmistotuotantoa, mutta ketterien menetelmien käytön yleistyminen on tuonut epävarmuutta dokumentoinnin rooliin, sillä ketterien menetelmien harjoittajat ovat sitä mieltä, ettei kattavaa dokumentaatiota tarvita. Sitä kuinka paljon dokumentaatiota tulisi tuottaa ja missä prosessin vaiheessa on tutkittu monia vuosia, mutta yksiselitteistä vastausta ei ole löydetty. Tämä diplomityö pyrkii löytämään suuntaviivoja ketterälle tuotedokumentaatiolle. Työ keskittyy case-yrityksen tuotteen dokumentointiin, ja työn tavoitteena on antaa ehdotus siitä, miten dokumentaatioprosessia voitaisiin yrityksessä lähteä kehittämään. Empiirisen tutkimuksen perusteella saatiin selville, että vaatimusten, toiminnallisuuksien, ominaisuuksien, konfiguraatioiden ja rajapintojen dokumentointi on tärkeää. Lisäksi Wiki ja UML-diagrammit todettiin hyviksi dokumentointitekniikoiksi.