Sulautettujen laitteiden dokumentaatiokäytännöt
Alavahtola, Aleksi (2024)
2024
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-2024060320089
https://urn.fi/URN:NBN:fi:amk-2024060320089
Tiivistelmä
Opinnäytetyön aiheena on tehdä tutkimusta sulautettujen laitteiden dokumentaatiosta. Työn ta-voitteena on tutkia olemassa olevia tutkimuksia ja artikkeleita dokumentoinnista, saaden parem-man yleiskuvan dokumentoinnin tilasta ja käytänteistä.
Opinnäytetyön tutkimusaineisto kerättiin käyttämällä Oulun ammattikorkeakoulun kirjaston e-materiaaleja, sekä tieteellisiin artikkeleihin keskittyviä hakukoneita, kuten Google Scholar ja Re-searchGatea. Tutkimusaineistoa varten keskityttiin hakemaan aineistoa, jossa aiheena oli doku-mentointi, sulautetut laitteet ja dokumentoinnin aiheuttamat kustannukset.
Materiaalista löydettiin yhtenäisyyksiä kehittäjien mielipiteiden, dokumentaation puutteiden ja mahdollisten parannuskohteiden osilta. Kehittäjät kokevat matalan tason dokumentaation kuten koodikommentit tärkeiksi. Yleisimmät ongelmat tutkimuksien mukaan olivat dokumentaation epä-tarkkuus, puutteellisuus ja dokumentaation epäluotettavuus.
Opinnäytetyössä tehtyä tutkimusta voisi jatkaa tulevaisuudessa, keskittyen mahdollisesti empii-risen tiedon keräämiseen, tai dokumentaation automatisoinnin tutkimiseen. Työn tutkimusmateri-aalia voisi myös syventää käsittelemällä olemassa olevaa materiaalia pidemmin.
Opinnäytetyön tutkimusaineisto kerättiin käyttämällä Oulun ammattikorkeakoulun kirjaston e-materiaaleja, sekä tieteellisiin artikkeleihin keskittyviä hakukoneita, kuten Google Scholar ja Re-searchGatea. Tutkimusaineistoa varten keskityttiin hakemaan aineistoa, jossa aiheena oli doku-mentointi, sulautetut laitteet ja dokumentoinnin aiheuttamat kustannukset.
Materiaalista löydettiin yhtenäisyyksiä kehittäjien mielipiteiden, dokumentaation puutteiden ja mahdollisten parannuskohteiden osilta. Kehittäjät kokevat matalan tason dokumentaation kuten koodikommentit tärkeiksi. Yleisimmät ongelmat tutkimuksien mukaan olivat dokumentaation epä-tarkkuus, puutteellisuus ja dokumentaation epäluotettavuus.
Opinnäytetyössä tehtyä tutkimusta voisi jatkaa tulevaisuudessa, keskittyen mahdollisesti empii-risen tiedon keräämiseen, tai dokumentaation automatisoinnin tutkimiseen. Työn tutkimusmateri-aalia voisi myös syventää käsittelemällä olemassa olevaa materiaalia pidemmin.