Documentation of modular game collection

Abstract

The purpose of this thesis was to compile and develop the documentation of a modular game collection, a learning tool commissioned by South-Eastern Finland University of Applied Sciences. The design and implementation of the documentation for the game collection is described in this thesis. The modular game collection was developed with Unity game engine. Various documentation tools and methods were used for the documentation of the game collection. The requirements of the game collection changed during the development and affected the documentation. This thesis details the requirements and the design of the documentation, including changes made in the process. The objective was to develop a documentation system which, together with instructions, would enable a beginner game developer to construct game projects. The development and utilization of the documentation methods are the focus of this thesis, together with the documentation tools. The documentation system consists of multiple subsystems, forming a comprehensive description of the functionality and usage of the modular game collection. The system and the related guidelines were developed as a result of this thesis. The implemented system functions as a basis for the instructions of the learning tool. In order to discover and correct the defects and deficiencies in documentation, usability testing of the modular game collection is required.

Tämän opinnäytetyön tarkoitus oli kehittää ja koota yhteenveto modulaarisen pelikokoelman dokumentoinnista, jonka tilaajana on Kaakkois-Suomen ammattikorkeakoulu. Opinnäytetyö käsittelee opetuskäyttöön kehitetyn pelikokoelman dokumentoinnin suunnittelun ja toteutuksen käyttöä varten. Modulaarinen pelikokoelma toteutettiin Unity-pelimoottorilla ja sen dokumentointia varten käytettiin useita dokumentointityökaluja ja -tapoja. Pelikokoelman vaatimukset muuttuivat kehitysvaiheessa ja muutokset vaikuttivat dokumentaatioon. Dokumentoinnin vaatimusperusteet ja suunnittelu, sekä näihin kohdistuvat muutokset, käsitellään opinnäytetyön ensimmäisissä osissa. Dokumentoinnin tavoitteena oli kehittää dokumentaatiojärjestelmä, joka yhdessä ohjeiden kanssa mahdollistaisi peliprojektien tuottamisen aloittelevalta pelinkehittäjältä. Opinnäytetyön pääosa keskittyy dokumentaatiotapojen kehitykseen ja käyttöön yhdessä dokumentaatiotyökalujen kanssa. Dokumentaatiojärjestelmä koostuu useammasta osajärjestelmästä muodostaen kattavan kuvauksen modulaarisen pelikokoelman toiminnallisuudesta ja käytöstä. Opinnäytetyön tuloksena saatiin modulaarisen pelikokoelman dokumentointi ja dokumentoinnin ohjeistus kehitettyä. Toteutettu dokumentaatio toimii opetustyökalun ohjeiden pohjana. Dokumentaation puutteellisuuden ja virheellisyyden kartoittamista ja korjaamista varten vaaditaan jatkossa käyttötestausta.