Ohjelmistokehityspaketin dokumentointi selkeäksi ja myyväksi
Nikola, Reima (2025)
2025
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-2025060520777
https://urn.fi/URN:NBN:fi:amk-2025060520777
Tiivistelmä
Tämän insinöörityön tarkoitus oli laatia Playnest-nimisen mobiilipelialustan ohjelmistokehityspaketille tekninen dokumentaatio. Tavoitteena oli tehdä dokumentaatiosta selkeä ja helppo käyttää. Lisäksi dokumentaation tuli olla myyvän näköinen.
Osa aineistosta dokumentaatiota varten saatiin olemassaolevista dokumenteista ja loput tuotettiin tutkimalla koodikantaa ja kirjoittamalla uutta tekstiä. Dokumentaation tueksi kehitettiin Playnest-alustalla toimiva esimerkkipeli. Esimerkkipeli jaetaan kehittäjille ohjelmistokehityspaketin mukana.
Dokumentaatiota varten rakennettiin ja julkaistiin verkkosivu Notion-projektinhallintatyökalulla. Dokumentaation versionhallinta oli sisäänrakennettu Notion-työkaluun. Esimerkkipeli toteutettiin Unity-pelimoottorilla hyödyntäen Playnest SDK-ohjelmistokehityspakettia. Pelin versionhallintaan käytettiin GitHub-palvelua ja omaa Git-haaraa työn tilaajan kuvauskannassa.
Insinöörityö valmistui tilaajan asettaman aikataulun puitteissa ja täytti vaaditut kriteerit. Työtä varten tutkittiin hyvän teknisen dokumentaation periaatteita. Samoja periaatteita voidaan hyödyntää myös muissa vastaavissa dokumentaatioissa. Valmis työ on luettavissa Playnestin verkkosivuilla osoitteessa https://playnest.notion.site/playnest-docs.
Osa aineistosta dokumentaatiota varten saatiin olemassaolevista dokumenteista ja loput tuotettiin tutkimalla koodikantaa ja kirjoittamalla uutta tekstiä. Dokumentaation tueksi kehitettiin Playnest-alustalla toimiva esimerkkipeli. Esimerkkipeli jaetaan kehittäjille ohjelmistokehityspaketin mukana.
Dokumentaatiota varten rakennettiin ja julkaistiin verkkosivu Notion-projektinhallintatyökalulla. Dokumentaation versionhallinta oli sisäänrakennettu Notion-työkaluun. Esimerkkipeli toteutettiin Unity-pelimoottorilla hyödyntäen Playnest SDK-ohjelmistokehityspakettia. Pelin versionhallintaan käytettiin GitHub-palvelua ja omaa Git-haaraa työn tilaajan kuvauskannassa.
Insinöörityö valmistui tilaajan asettaman aikataulun puitteissa ja täytti vaaditut kriteerit. Työtä varten tutkittiin hyvän teknisen dokumentaation periaatteita. Samoja periaatteita voidaan hyödyntää myös muissa vastaavissa dokumentaatioissa. Valmis työ on luettavissa Playnestin verkkosivuilla osoitteessa https://playnest.notion.site/playnest-docs.