Artikkelienhallintasovelluksen dokumentointi ja dokumentointityökalun käyttöohje

Abstract

JBB Dantekin ohjelmiston tarkoituksena on yksinkertaisella järjestelmällä rekiste-röidä tietoja konferensseja varten. Sen tarkoituksena on saada tilaisuuksien järjes-täjille artikkelitietojen lähettäminen joustavaksi. Lähetetyistä tiedoista konferens-sin järjestäjä valitsee osan painettavaksi julkaisuun. Lopputyössäni olen dokumen-toinut ohjelmiston.

Keskeisenä työssä on PHP-kielisen ohjelman dokumentointi ja dokumentaation generointi Doxygen- ohjelmalla. Ohjelmiston rakenne uudistui työn aikana. Aluksi tiedostot lähetettiin ylläpitäjän sähköpostiin. Uudistetussa järjestelmässä hyö-dynnetään palvelimen ominaisuuksia ottamalla käyttöön tietokannat. Työhön si-sältyy dokumentointiin käytettävän ohjelman suppea käyttöohje.

Opinnäytetyöhön kuului myös palvelimen ja dokumentoitavan ohjelman asenta-minen omalle koneelle testikäyttöä varten.

Article management system by JBB Dantek is targeted for scientific conference organizers. It can be used to manage articles for conferences: users can send and modify their articles. Conference organizers can use the system to manage and edit the articles and select the articles for conference publications.

Thesis consists of documentation of the source code of the article management system, which is written in PHP language and adding the comments to the source code using Doxygen documentation software. During the span of the project the overall design of the article management system was restructured and enhanced. In the latest version the server side of the software is utilizing database for docu-ment management. Writing a user manual for document management software was also part of the thesis.

During the work, the whole article management system was installed to a separate test environment by the author.