Ohjelmiston dokumentoinnin tukityökalu

Abstract

Opinnäytetyön aiheena oli tukityökalun toteuttaminen suomalaiselle ohjelmistoalan yritykselle matkapuhelinverkon tukiasemaohjaimen ohjelmiston dokumentoinnin helpottamiseksi. Samanlaista tai vastaavaa ohjelmaa yrityksessä ei ole saatavilla ja sen kehittäminen nähtiin tarpeellisena ohjelmiston koodimäärän kasvaessa ja dokumentointiin käytetyn työmäärän lisääntyessä. Dokumentoinnin työlästä luonnetta haluttiin lieventää työkalulla, joka tuottaisi automaattisesti osia TNSDL -koodin dokumentoinnista sekä toimisi ohjelmoijalle tukena ohjelmistokehityksessä.

Opinnäytetyössä perehdyttiin yleisellä tasolla ohjelmistotuotantoon, testaukseen ja automaatioon, sekä läpikäytiin työkalun spesifikaatiot.

Tukityökalu tehtiin yrityksen tiloissa ja haluttuja ominaisuuksia kartoitettiin ohjelmoijilta. Tukityökalu toteutettiin käyttäen C++ -, JavaScript (jQuery) -, HTML5 -, sekä CSS -ohjelmointi -ja kuvauskieliä. Työkalun käyttöliittymä toteutettiin käyttäen Windows -lomakkeita sekä selainpohjaista ratkaisua.

The purpose of this thesis was to create a support tool for a Finnish software industry company mobile network base station controller to ease software documentation. There is no equal or similar program available in the company and its development was seen necessary as both the amount of code in the software and the workload needed for documentation increases. The support tool was wanted to mitigate the arduous nature of documentation by automatically producing parts of the TNSDL code documentation and act as support for the programmer in software development.

Software development, testing and automation are introduced generally, and the specifications of the tool are presented in the thesis.

The support tool was created in company premises and the desired features were inquired from the programmers. The support tool was created using C++, JavaScript (jQuery), HTML5, and CSS programming and markup languages. The user interface was created using Windows forms and browser based solution.