Skip to content
Snippets Groups Projects
Vaatimusmaarittely.md 3.6 KiB
Newer Older
L4134's avatar
L4134 committed
# TTOW0635 Mobile Project -kurssin projektin "Fireset" vaatimusmäärittely
L4134's avatar
L4134 committed

L4134's avatar
L4134 committed
* Versio 0.6
* Päivitetty 11.12.2019
L4134's avatar
L4134 committed

L4134's avatar
L4134 committed
------
L4134's avatar
L4134 committed
[Johdanto](#johdanto)
L4134's avatar
L4134 committed
[API rajapinta](#api-rajapinta)
L4134's avatar
L4134 committed
[Luokka- ja yhteyskaavio](#luokka-ja-yhteyskaavio)
L4134's avatar
L4134 committed
[Palvelun/ohjelmiston arkkitehtuuri](#palvelunohjelmiston-arkkitehtuuri)
L4134's avatar
L4134 committed
[UI Mockup](#ui-mockup)
L4134's avatar
L4134 committed
[Tärkeimmät käyttötapaukset](#tärkeimmät-käyttötapaukset)
L4134's avatar
L4134 committed
[Tärkeimmät tunnistetut ominaisuudet](#tärkeimmät-tunnistetut-ominaisuudet)
L4134's avatar
L4134 committed
[Vaatimukset](#vaatimukset)
L4134's avatar
L4134 committed

------
L4134's avatar
L4134 committed
# Johdanto

L4134's avatar
L4134 committed
Mobile Project (TTOW0635) kurssin projekti "Fireset", joka on jatkoa Mobile Application Development (TTOW0615) kurssin tutkimustyölle.
Projektiin kuuluu sovelluksen suunnittelu ja dokumentointi, sovelluksen toteutus, testaus sekä loppuseminaari.
L4134's avatar
L4134 committed

L5192's avatar
L5192 committed
# API rajapinta

[API dokumentaatio](API.md)

# Luokka- ja yhteyskaavio

L5192's avatar
L5192 committed
![Luokka- ja yhteyskaavio 1](Images/PlayerCardClassDiagram.png)
![Luokka- ja yhteyskaavio 2](Images/MessageClassDiagram.png)
L4134's avatar
L4134 committed

L5192's avatar
L5192 committed
# Palvelun/ohjelmiston arkkitehtuuri 

L5192's avatar
L5192 committed
![Arkkitehtuuri](Images/Architecture.png)
L5192's avatar
L5192 committed
# UI Mockup

![UI Mockup](Images/mockuiplayground.PNG)

L4134's avatar
L4134 committed
# Tärkeimmät käyttötapaukset
L4134's avatar
L4134 committed

| # | Käyttäjätyyppi | Käyttötapaus | Kuvaus |
|:-:|:-:|:-:|:-:|
| 1 | Pelaaja | KT-1 | Käyttäjä pystyy luomaan peli session, johon muut pelaajat voivat osallistua |
L4134's avatar
L4134 committed
| 2 | Pelaaja | KT-2 | Käyttäjä pystyy valitsemaan pelin johon haluaa liittyä |
| 3 | Pelaaja | KT-3 | Käyttäjä pystyy liittymään valmiina olevaan peliin |
L4134's avatar
L4134 committed
| 4 | Pelaaja | KT-4 | Käyttäjä pystyy lähtemään peli sessiosta pois |
L4134's avatar
L4134 committed
| 5 | Pelaaja | KT-5 | Käyttäjät pystyvät pelaamaan peliä yhdessä |
L4134's avatar
L4134 committed


# Tärkeimmät tunnistetut ominaisuudet

| Ominaisuus | Prioriteetti |
| :-: | :-: |
L4134's avatar
L4134 committed
| FT1 | Peli session luonti | Tärkeä |
| FT2 | Peliin liittyminen | Tärkeä |
| FT3 | Pelin lopettaminen | Tärkeä |
L4134's avatar
L4134 committed
| FT4 | Peli, jota voi pelata | Tärkeä |
L4134's avatar
L4134 committed
# Vaatimukset
## Palveluun liittyvät tärkeimmät toiminnalliset vaatimukset

| VaatimusID | Tyyppi | Kuvaus | Ominaisuus johon vaikuttaa |								
|:-:|:-:|:-:|:-:|
L4134's avatar
L4134 committed
| FUN-REQ-001 | Functional Requirement | Käyttäjän tulee pystyä liittymään valmiiksi luotuun peli sessioon | FT2 |
L4134's avatar
L4134 committed
| FUN-REQ-002 | Functional Requirement | Peli ei saa loppua, jos pelaaja tippuu pelistä | FT4 |
| FUN-REQ-003 | Functional Requirement | Käyttäjän tulee pystyä lähtemään pelistä pois | FT3 |
| FUN-REQ-004 | Functional Requirement | Käyttäjän tulee pystyä luomaan peli sessio | FT1 |
L4134's avatar
L4134 committed

## Palveluun liittyvät tärkeimmät ei-toiminnalliset vaatimukset
### Suorituskyky 

| VaatimusID | Tyyppi | Kuvaus | Ominaisuus johon vaikuttaa |								
|:-:|:-:|:-:|:-:|
L4134's avatar
L4134 committed
| PER-REQ-001 | Non-Functional Performance | Käyttäjän suorittamasta toimenpiteestä ei saa mennä yli 2s, jos kyseessä pelaaminen tai yli 5s, jos kyse muusta toimenpiteen suorittamisesta, ellei lataus ikoni ole näkyvissä | |
L4134's avatar
L4134 committed
| PER-REQ-002 | Non-Functional Performance | Pelin tulee pyöriä sulavasti lähes koko ajan (min 15fps) | FT4 |
L4134's avatar
L4134 committed

L4134's avatar
L4134 committed
### Käytettävyys

L4134's avatar
L4134 committed
| VaatimusID | Tyyppi | Kuvaus |								
L4134's avatar
L4134 committed
|:-:|:-:|:-:|
L4134's avatar
L4134 committed
| USAB-REQ-001 | Non-Functional Usability | Käyttöliittymän kontrasti tulee olla tarpeeksi suuri |
| USAB-REQ-002 | Non-Functional Usability | Käyttöliittymän nappuloiden tulee olla tarpeeksi isot ja selvät |
| USAB-REQ-003 | Non-Functional Usability | Käyttöliittymän pitää skaalautua oikein eri mobiililaitteilla |
L4134's avatar
L4134 committed
## Tuotteen järjestelmävaatimukset
L4134's avatar
L4134 committed

L4134's avatar
L4134 committed
| VaatimusID | Tyyppi | Kuvaus |								
L4134's avatar
L4134 committed
|:-:|:-:|:-:|
| SYS-REQ-0001 | System Requirement | AR: ARKit (iOS) tai ARCore (Android) yhteensopiva laite |
| SYS-REQ-0002 | System Requirement | VR: Cardboard (iOS and Android), Daydream and Gear VR |