Mallinnusohjelman tekninen dokumentaatio

Abstract

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.

The purpose of this thesis was to present one part of technical documentation for new modeling program by KPM-Engineering Oy. The technical document explains the main functionality of Skeleton Framework that is used as the core of the modeling program in a generic way. What are the extensibility possibilities with the framework and how to expand it are also a part of this thesis. Criterion for the presentation told that a new employee who starts in a project that uses Skeleton Framework should be able to start working immediately after reading this thesis. The main problems consisted of the large amount of source material that the source code of Skeleton Framework provided. Reading Skeleton Framework’s source code, literature and Internet-source material were used as resource materials.

As a result this thesis includes a comprehensive big picture of Skeleton Framework, examples how to expand the framework and how threading works inside the framework. A test person was able to make use of the thesis while creating new extensions and messages for Skeleton Framework. That proves the thesis has been created successfully according to the goals that were set as criterion.

As a conclusion one can agree on that the thesis has succeeded in its goals, because the written document can be used as guidance while briefing a new employee to work with Skeleton Framework. As an improvement suggestion this thesis could be expanded for example with a technical document of a user interface and how one could make use of the framework in other software.