Documentation Framework for Software Projects
Savela, Matias (2011)
2011
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-2023092026082
https://urn.fi/URN:NBN:fi:amk-2023092026082
Tiivistelmä
The aim of this Bachelor’s thesis was to develop a fully automated documentation framework.
The idea for this project came from a lack of united documentation convention for a company. The requirements for this project were to provide an convenient way to produce software documentation for various projects. The framework had to be fully automated and easy to use.
Open-source tools were used for this project. This document consists of installation and introduction of these tools and technologies. The system was installed and configured in CentOS environment.
As a result, a working and easy to use documentation system was produced for company’s needs. The framework can be used in numerous different software projects. The system is open to several different future development possibilities. Opinnäytetyön tavoite oli kehittää kokonaan automatisoitu dokumentointijärjestelmä.
Idea työhön tuli yrityksen puuttuvasta yhtenäisestä dokumentointikäytännöstä. Työn vaatimuksena oli tarjota kätevä tapa dokumentoida erilaisia ohjelmistoprojekteja. Järjestelmän täytyi olla automatisoitu ja helppokäyttöinen.
Työssä on hyödynnetty avoimen lähdekoodin työkaluja. Työ koostuu näiden työkalujen ja teknologioiden esittelystä sekä asennuksesta. Järjestelmä asennettiin ja säädettiin CentOS ympäristöön.
Työn lopputuloksena on toimiva ja helppokäyttöinen dokumentointijärjestelmä yrityksen tarpeisiin. Järjestelmää voidaan hyödyntää lukuisissa eri dokumentointiprojekteissa. Projekti on lisäksi avoin useille eri jatkokehitysmahdollisuuksille.
The idea for this project came from a lack of united documentation convention for a company. The requirements for this project were to provide an convenient way to produce software documentation for various projects. The framework had to be fully automated and easy to use.
Open-source tools were used for this project. This document consists of installation and introduction of these tools and technologies. The system was installed and configured in CentOS environment.
As a result, a working and easy to use documentation system was produced for company’s needs. The framework can be used in numerous different software projects. The system is open to several different future development possibilities.
Idea työhön tuli yrityksen puuttuvasta yhtenäisestä dokumentointikäytännöstä. Työn vaatimuksena oli tarjota kätevä tapa dokumentoida erilaisia ohjelmistoprojekteja. Järjestelmän täytyi olla automatisoitu ja helppokäyttöinen.
Työssä on hyödynnetty avoimen lähdekoodin työkaluja. Työ koostuu näiden työkalujen ja teknologioiden esittelystä sekä asennuksesta. Järjestelmä asennettiin ja säädettiin CentOS ympäristöön.
Työn lopputuloksena on toimiva ja helppokäyttöinen dokumentointijärjestelmä yrityksen tarpeisiin. Järjestelmää voidaan hyödyntää lukuisissa eri dokumentointiprojekteissa. Projekti on lisäksi avoin useille eri jatkokehitysmahdollisuuksille.