Documentation of a UI-library used in web development

Abstract

The thesis deals with documentation site developed by the author. The subject of the study was to implement a Web application which provides documentation for a UI-library. The work resulted in the application, which will be updated in parallel with the continuous development of the user interface library. The application presents the library’s components, styles, and other features, as well as aspects of the operation of the UI-library. This thesis report presents the application and the different technologies that have been used in the application and the UI-library.

This thesis report describes the different technologies used in the library and the documentation web application. It goes through the design and architecture of the application and also explains the development process, tools and best practices in web development. Thesis also describes good software development practices and tools that were used during this work.

Opinnäytetyö käsittelee tekijän toteuttamaa käyttöliittymäkirjaston dokumentaatiosivustoa. Työn aiheena oli toteuttaa Web-sovellus, jonka tehtävä on dokumentoida käyttöliittymäkirjastoa. Työn tuloksena syntyi sovellus, jota päivitetään käyttöliittymäkirjaston kehityksen yhteydessä. Sovellus esittelee kirjaston komponentteja, tyylejä ja muita ominaisuuksia, sekä kirjaston käyttöön liittyviä seikkoja. Tämä opinnäytetyöraportti esittelee sovellusta, sen kehittämisprosessia ja eri teknologioita joita sovelluksessa ja käyttöliittymäkirjastossa on käytetty.

Opinnäytetyöraportissa esitellään käyttöliittymäkirjastossa ja dokumentaatiosivustossa käytetyt teknologiat. Raportti esittelee dokumentaatiosivuston rakenteen ja arkkitehtuurin, sekä selittää kehitystyöhön liittyvät prosessit, työkalut ja työskentelytavat. Raportti myös käsittelee työn aikana hyväksi todettuja ohjelmiston kehittämismenetelmiä ja työkaluja.