Mallinnusohjelman tekninen dokumentaatio
Kettunen, Anssi (2013)
Kettunen, Anssi
Tampereen ammattikorkeakoulu
2013
All rights reserved
Julkaisun pysyvä osoite on
https://urn.fi/URN:NBN:fi:amk-201305168866
https://urn.fi/URN:NBN:fi:amk-201305168866
Tiivistelmä
Tämä työ on kirjoitettu KPM-Engineering Oy:n tilauksesta osaksi uutta mallinnusohjelman teknistä dokumentaatiota. Työn tavoitteena oli esittää uuden mallinnusohjelman ytimenä käytetyn Skeleton Framework -ohjelmistokehyksen toiminnallisuus yleisellä tasolla sekä kehyksen laajennusmahdollisuudet ja -menetelmät. Esittämistavan kriteerinä oli että projektissa aloittava uusi työntekijä voisi työn luettuaan aloittaa työskentelyn Skeleton Frameworkin päälle tehdyn ohjelmiston kehittäjänä. Ongelmaksi todettiin lähdemateriaalina käytetyn lähdekoodin suuri määrä. Lähdemateriaalina on käytetty Skeleton Frameworkin lähdekoodia, kirjallisuutta ja Internet-lähdemateriaalia.
Tuloksena tämä työ sisältää kattavan yleiskuvan Skeleton Framework -ohjelmistokehyksestä, esimerkkejä kehyksen sisäisen viestitoiminnan laajentamisesta ja lisäosien luomisesta sekä tarkennettua tietoa kehyksen säikeistyksestä. Työn lukenut testihenkilö osasi soveltaa tätä työtä uusien lisäosien ja viestitoimintojen luomisessa Skeleton Frameworkin päälle luotuun ohjelmistoon, mikä todistaa konkreettisesti työn onnistumisen tavoitteiden mukaisesti.
Johtopäätöksenä voidaan todeta, että työ on onnistunut tavoitteessaan, sillä dokumenttia voidaan käyttää hyödyksi opastettaessa uutta työntekijää Skeleton Frameworkilla tehdyn ohjelmiston kehityksessä. Kehittämisehdotuksena työtä voisi laajentaa esimerkiksi käyttöliittymän teknisellä dokumentilla ja selvityksellä miten ohjelmistokehystä voisi hyödyntää muissa sovelluksissa.
Tuloksena tämä työ sisältää kattavan yleiskuvan Skeleton Framework -ohjelmistokehyksestä, esimerkkejä kehyksen sisäisen viestitoiminnan laajentamisesta ja lisäosien luomisesta sekä tarkennettua tietoa kehyksen säikeistyksestä. Työn lukenut testihenkilö osasi soveltaa tätä työtä uusien lisäosien ja viestitoimintojen luomisessa Skeleton Frameworkin päälle luotuun ohjelmistoon, mikä todistaa konkreettisesti työn onnistumisen tavoitteiden mukaisesti.
Johtopäätöksenä voidaan todeta, että työ on onnistunut tavoitteessaan, sillä dokumenttia voidaan käyttää hyödyksi opastettaessa uutta työntekijää Skeleton Frameworkilla tehdyn ohjelmiston kehityksessä. Kehittämisehdotuksena työtä voisi laajentaa esimerkiksi käyttöliittymän teknisellä dokumentilla ja selvityksellä miten ohjelmistokehystä voisi hyödyntää muissa sovelluksissa.