Ohjelmistotuotannon kehittäminen elementtikirjaston avulla

Abstract

Insinöörityön tarkoituksena oli kehittää elementtikirjasto ohjelmistoalan yritykselle. Tilaajayritys toteuttaa elementeistä eli komponenteista koostuvia verkkosovelluksia muiden yritysten perehdytys- ja koulutustarpeisiin. Elementtien uudelleenkäyttöä pyrittiin helpottamaan kehittämällä kirjasto, johon tallennetut elementit ovat kaikkien työntekijöiden saatavilla helposti selattavassa muodossa. Tavoitteena oli kehittää yrityksen tiedonhallintaa ja parantaa tuotantoprosessia. Työhön kuului järjestelmän suunnittelu, toteutus ja käyttöönotto.

Kirjastoon haluttiin ensisijaisesti tallentaa elementtien koodit. Lisäksi tarvittiin käyttöliittymä elementtien selaamiseen. Elementteihin haluttiin myös liittää erilaisia metatietoja. Tarkempien vaatimusten selvittämiseksi toteutettiin kysely, jonka avulla kartoitettiin kirjaston mahdollisia käyttötapoja ja työntekijöiden toiveita kirjaston ominaisuuksien suhteen. Lisäksi suunnitteluvaiheessa perehdyttiin yrityksen tuotantoprosessiin. Projektin lopussa kartoitettiin, miten uusi järjestelmä vaikutti prosessiin.

Elementtikirjaston vaatimukset listattiin ja käsiteltiin käyttötapauskaavion avulla. Sisältömallin suunnittelua varten selvitettiin, millaista sisältöä kirjastoon halutaan lisätä. Lisäksi suunniteltiin, miten sisältöjä luokitellaan ja mitä tietoja niihin liitetään. Elementtien koodit päätettiin tallentaa ohjelmistoprojektien versionhallintapalveluun. Elementtien esikatselua varten suunniteltiin erillinen käyttöliittymä, joka toteutettiin sisällönhallintajärjestelmällä. Käyttöliittymään toteutettiin muun muassa interaktiivinen esimerkki elementtien toimintojen testaamiseen, kuvagalleria toteutuksista ja näkymä, jossa listattavia elementtejä voidaan suodattaa niille määriteltyjen luokittelujen ja muiden metatietojen avulla.

Kun käyttöliittymän tärkeimmät ominaisuudet oli toteutettu, järjestettiin käyttöönottopalaveri, jossa työntekijöitä opastettiin kirjaston käyttöön. Lisäksi kirjastolle laadittiin käyttöohje. Käyttöönoton jälkeen työntekijöiltä kerättiin palautetta. Vastausten perusteella uuteen järjestelmään oltiin tyytyväisiä: toteutustapaa pidettiin toimivana ja ohjeistusta hyödyllisenä. Konkreettiset hyödyt tulevat näkyviin vasta myöhemmin, kun kirjastoon on lisätty useita elementtejä, joita voidaan jatkokehittää ja uudelleenkäyttää. Järjestelmän hyödyllisyyden kannalta on tärkeää saada työntekijät käyttämään sitä aktiivisesti. Myös selkeän ohjeistuksen ja sen noudattamisen merkitys on suuri. Elementit tulee nimetä ja luokitella johdonmukaisesti, jotta kirjaston käyttö on selkeää ja elementtien löytäminen helppoa.

The purpose of the thesis was to develop a component library for a software company that is specialized in creating component-based web applications for different organizations’ educational needs. To ease the reuse of the components, they wanted to be made easily accessible for all employees through a library. The goal was to improve the company’s data management and production process. Designing, developing and deploying the system were all part of the project.

The library needed to have a place for saving the components’ code as well as a user interface for browsing the components. The components also needed to have metadata assigned to them. More detailed requirements were defined with the help of a survey, where the employees were asked to describe what kind of features the component library should have. The company’s production process was also analysed at the beginning of the project. When the project was finished, the library’s effects on the process were defined.

The requirements of the component library were listed and also presented as a use case diagram. In order to create a content model for the library, the content types and their metadata were defined. It was decided that the components’ code would be saved into a code hosting service. A separate user interface for previewing the components was built with a content management system. It included an interactive example for demonstrating the components’ functionalities, a photo gallery of different implementations and a view for filtering the components based on their categories and other metadata.

When the main functionalities of the user interface were implemented, all employees were invited to a training session, where they were shown how to use the component library and how to add new elements. After the library had been in use for a while, the employees were asked to give feedback about it. Based on that they were mostly pleased with the system and found it useful. The concrete benefits cannot be seen until later, when the library has multiple elements that can be reused and improved by all employees. To ensure the usefulness of the library, it is important to motivate the employees to use it actively. The components must be named and categorized consistently to guarantee their findability. Clear instructions and following them is also essential.