Ohjelmistokoodin dokumentointi
Jerva, Jonne (2023)
2023
All rights reserved. This publication is copyrighted. You may download, display and print it for Your own personal use. Commercial use is prohibited.
Julkaisun pysyvä osoite on
https://urn.fi/URN:NBN:fi:amk-2023111029053
https://urn.fi/URN:NBN:fi:amk-2023111029053
Tiivistelmä
Opinnäytetyössä tarkoituksena on toteuttaa ohjelmistokoodin dokumentaatio sekä kehittää yrityksen ohjelmistokoodin dokumentointi menetelmiä tarjoten toimivia ratkaisuja dokumentoinnin kehittämiseksi. Ohjelmistokoodin dokumentoinnin kehittämisellä pyritään luomaan helppo ja yhtenäinen tapa dokumentoida yrityksen ohjelmistokoodi. Ilman asianmukaista dokumentaatiota koodin jatkokehittäminen on erittäin hankalaa.
Yrityksessä ei opinnäytetyön aloitus hetkellä ollut dokumentaatiota koodista eikä tähän liittyviä käytäntöjä, joten tärkeänä kehityksen kohteena oli koodidokumentaation tuottaminen ja ohjelmistodokumentaatio käytäntöjen kehittäminen.
Opinnäytetyö toteutettiin haastattelemalla ohjelmiston kehittäjää sekä tutkimalla yrityksen nykyistä ohjelmiston kehityksen prosessia ja sen dokumentaatioita sekä myös arvioimalla yrityksen ohjelmisto dokumentaatio käytäntöjä. Tämän pohjalta tuotettiin ohjelmistokoodin dokumentaatio-ohje ja käytännöt. Ohjetta ja käytäntöä testattiin yrityksen ohjelmiston dokumentointiin.
Yrityksessä ei opinnäytetyön aloitus hetkellä ollut dokumentaatiota koodista eikä tähän liittyviä käytäntöjä, joten tärkeänä kehityksen kohteena oli koodidokumentaation tuottaminen ja ohjelmistodokumentaatio käytäntöjen kehittäminen.
Opinnäytetyö toteutettiin haastattelemalla ohjelmiston kehittäjää sekä tutkimalla yrityksen nykyistä ohjelmiston kehityksen prosessia ja sen dokumentaatioita sekä myös arvioimalla yrityksen ohjelmisto dokumentaatio käytäntöjä. Tämän pohjalta tuotettiin ohjelmistokoodin dokumentaatio-ohje ja käytännöt. Ohjetta ja käytäntöä testattiin yrityksen ohjelmiston dokumentointiin.