Avatud lähtekoodiga tarkvaraprojektide Dokumentatsiooni Kättesaadavuse mudeli optimiseerimine

Date

2011

Journal Title

Journal ISSN

Volume Title

Publisher

Tartu Ülikool

Abstract

Avatud lähtekoodiga tarkvara (inglise keeles – Open Source Software) on üks uusimaid trende tänapäeva tarkvaraarenduses. Nagu nimigi ütleb, on avatud lähtekoodiga tarkvara kood avalik, ning võimaldab seega kõigil huvilistel osaleda tarkvaraarenduse protsessis. Tänasel päeval põhinevad paljud infosüsteemid rohkemal või vähemal määral avatud koodiga tarkvaral. Tarkvara tootmine sel viisil on odav võrreldes traditsioonilise tarkvaraarendusega kuna projektis osalejad edendavad tarkvara tavaliselt oma enda huvist ja vabast tahtest. Kuna avatud lähtekoodiga tarkvara projektides osalejad on erineva taustaga ja oskustasemega, on ka projektide kvaliteet kõikuv. Tagamaks kvaliteetset lõpptoodet on oluline hinnata jooksvalt arendamise käigus projekti hetkeseisu, et teada kuidas parandada või säilitada toote kvaliteeti. Projekti kvaliteedi hindamisel võib lähtuda mitmetest eri aspektidest: tarkvara koodi kvaliteedist, toote kvaliteedist või toote dokumentatsiooni kvaliteedist. Käesolevas bakalaureusetöös oleme keskendunud avatud lähtekoodiga projektide dokumentatsiooni kvaliteedile ja kvaliteedi hindamisele. Selleks, et adekvaatselt hinnata tarkvara projekti dokumentatsiooni kvaliteeti, on vajalik vastavate meetodite olemasolu. Hetkel on olemas vaid mõned meetodid hindamaks avatud lähtekoodiga tarkvaraprojekti kvaliteeti, kuid nende peamiseks puuduseks on kindlate mõõtmiskriteeriumite puudumine. Käesoleva töö eesmärgiks on välja töötada dokumentatsiooni kvaliteedihindamise mudel hindamaks avatud lähtekoodiga tarkvara. Uue mudeli aluseks on eelnevalt väljatöötatud dokumentatsiooni kvaliteedihindamise mudel (Dokumentatsiooni Kättesaadavuse mudel, inglise keeles Documentation Availability (DA) model). See mudel põhineb erinevate tootearenduses eksisteerivate huvigruppide - toote omandaja, toote kasutaja, toote arendaja, arenduse finantseerija – vajadustest dokumentatsiooni järele. Antud mudel ei ole loodud spetsiaalselt avatud lähtekoodiga tarkvara hindamiseks vaid baseerub üldistel IEEE tarkvaraarenduse standarditel. Seetõttu ei kata DA mudel täielikult avatud lähtekoodiga tarkvaraprojektide vajadusi. Antud töös analüüsisime ja optimiseerisime dokumentatsiooni kvaliteedi hindamise mudelit (DA mudel) lähtudes varasemalt läbi viidud uuringu andmete analüüsist, ja avatud lähtekoodiga tarkvara dokumentatsiooni uurimisest. DA mudeli adapteerimisel kasutuseks avatud lähtekoodiga tarkvara dokumentatsiooni kvaliteedi hindamiseks (1) elimineerisime mudelist dokumentatsiooni sisutiheduse kirjed, mis ei ole avatud koodiga tarkvara puhul kasutusel (2) lisasime mudelisse relevantsed kirjed, näiteks “Koodi kompileerimine”, “Arendusvahendid” ja dokumendi tüübid, näiteks ”Wiki” (3) iga kirje osatähtsuse määramiseks ühe dokumendi tüübi lõikes lisasime dokumentatsiooni sisutiheduse kirjetele kaalud. Muudatuste tulemina valmis uus spetsiaalselt avatud lähtekoodiga tarkvara dokumentatsiooni kvaliteedihindamise mudel. Mudeli valideerimiseks hindasime 14 avatud lähtekoodiga tarkvaral põhinevat äriprotsesside analüüsi ja tarkvara modelleerimise projekti dokumentatsiooni. Tulemused näitavad, et uus mudel sobib avatud lähtekoodiga tarkvara dokumentatsiooni hindamiseks ning võimaldab hinnata projektide kvaliteeti täpsemalt kui töö aluseks võetud DA mudel.
Open source software is one of the current trends in software development. Many information systems (IS) are built more or less on OSS. The OSS development process is cheaper as the contributors do it to for free from their own interest. The background of the contributors varies, as varies their skill level. In order to have a good quality product you have to evaluate the current situation to see how to maintain or increase the quality of a product. The quality of a tool can be analysed from different aspects: code quality, tool quality or documentation quality. Our work focuses on documentation quality. There are only couple of methods how to evaluate OSS documentation quality. For our work basis we chose Documentation Availability model (DA model). This model is based on the needs of different stakeholders (product acquirer, product user, product developer and product contractor). The main limitation of the model is that it is not designed for OSS, but is rather based on the IEEE general software development standards. Therefore it does not apply completely for the OSS documentation. In this thesis we analysed and revised the DA model, based on the data of the previous research and on the data we observed at the selected OSS documentations. The revised documentation availability model (1) excludes unused completeness entries (2) includes relevant entries for example “Code commit rules”, “Building from Source” (3) adds new document types for example “Wiki”. We also enforce documentation completeness entries with the weights, which helps take into account importance of separate entries. To validate our proposal we have analysed 14 OSS products from the Business Process management and software modelling domain. The results show that the new introduced model applies to the OSS development process and can be used to evaluate OSS documentation quality more relevantly than the model used before.

Description

Keywords

Citation