Vaatimusmäärittely Good Minton Sulkapalloliiton kilpailutoiminnan rekisteriohjelma

Transkriptio

1 Vaatimusmäärittely Good Minton Sulkapalloliiton kilpailutoiminnan rekisteriohjelma Versiohistoria: Versio: Pvm: Laatijat: Muutokset: Jani Eränen Alustava Jani Eränen Asiakirjapohja muokattu valmiiksi Jani Eränen Lisätty sisältö lukuihin Jani Eränen Lisätty toiminnalliset ja eitoiminnalliset vaatimukset Jani Eränen Lisätty järjestelmän yleiskuvaus Jani Eränen, Timo Hassinen Kirjoitusasua siistitty, vaatimusten toimijat kohtaa tarkennettu Jani Eränen Muokattu liiketoimintatavoitteita Jani Eränen Valmis tarkastettavaksi Jani Eränen Projektiryhmän tarkastama versio Jani Eränen Asiakkaan hyväksymä versio DOKUMENTIN TILA: Alustava Valmis Tarkastettu X

2 Sisällysluettelo SISÄLLYSLUETTELO JOHDANTO LIIKETOIMINTATAVOITTEET KÄSITTEET JÄRJESTELMÄN YLEISKUVAUS KÄYTTÄJÄRYHMÄT TOIMINNALLISET VAATIMUKSET TOIMINNOT F1 KÄYTTÄJÄN LISÄYS F2 KÄYTTÄJÄN MUOKKAUS F3 KÄYTTÄJÄN POISTO F4 SEURAN LISÄYS F5 SEURAN MUOKKAUS F6 SEURAN POISTO F7 PELAAJAN LISÄYS F8 PELAAJAN MUOKKAUS F9 PELAAJAN POISTO F10 PELAAJIEN LISENSSIEN SEURANTA F11 KILPAILUN LISÄYS F12 KILPAILUN MUOKKAUS F13 KILPAILUN POISTO F14 KILPAILUKALENTERIN SEURANTA F15 ILMOITTAUTUMISEN LISÄYS F16 ILMOITTAUTUMISEN MUOKKAUS F17 ILMOITTAUTUMISEN POISTO F18 ILMOITTAUTUMISTEN SEURANTA F19 ILMOITTAUTUMISEN SULKEUTUMINEN F20 TULOSTEN LISÄYS F21 TULOSTEN MUOKKAUS F22 TULOSTEN POISTO F23 RANKING SÄÄNTÖJEN LISÄYS F24 RANKING SÄÄNTÖJEN MUOKKAUS F25 RANKING SÄÄNTÖJEN POISTO F26 KÄYTTÄJÄN SISÄÄNKIRJAUTUMINEN F27 KÄYTTÄJÄN ULOSKIRJAUTUMINEN...20 Good Minton 2 (23)

3 7 EI TOIMINNALLISET VAATIMUKSET N1 SUORITUSKYKY N2 KÄYTETTÄVYYS N3 TOIPUMINEN N4 TURVALLISUUS JA SUOJAUKSET N5 YLLÄPETTÄVYYS N6 SIIRRETTÄVYYS N7 YHTEENSOPIVUUS RAJOITTEET C1 STANDARDIT C2 LAITTEISTORAJOITTEET C3 OHJELMISTORAJOITTEET MUUT RAJOITTEET...23 Good Minton 3 (23)

4 1 Johdanto Tässä dokumentissa määritellään vaatimukset kurssilla, T Ohjelmistokehitysprojekti I, toteutettavalle Sulkapalloliiton tilaamalle kilpailutoiminnan rekisteriohjelmalle. Taulukko 11: Dokumentin kohderyhmät Lukijaryhmä Asiakas Järjestelmän kehittäjät Testaajat Muiden asiakirjojen kirjoittajat Projektiryhmä Mentor Dokumentin merkitys ryhmälle Varmistaa, että projektiryhmä on ymmärtänyt projektille asetetut vaatimukset. Kuvaa toteutettavat toiminnot Mahdollistaa järjestelmän testaamisen vaatimusten perusteella Materiaalin lähde Projektin tilan seuranta Projektin tilan seuranta 2 Liiketoimintatavoitteet Projektin pääasialliset tavoitteet ovat: Taulukko 2. Liiketoimintatavoitteet ja niiden toteutumiskriteerit Asiakkaan liiketoimintatavoitteet 1. Tavoitteena on korvata vanha järjestelmä. 2. Tavoitteena on parantaa yhteensopivuutta seuroissa käytettävien ohjelmien ja liiton kilpailutoiminnan rekisteriohjelman kanssa. 3. Tavoitteena on vähentää Sulkapalloliiton työmäärää tarjoamalla seuroille mahdollisuutta tallentaa kilpailutietoja. 4. Tavoitteena on helpottaa pelaajaluetteloiden ja rankingtietojen tuottamisesta. 5. Tavoitteena on parantaa helppokäyttöisyyttä. Toteutumiskriteeri Toteutuu, jos uusi järjestelmä otetaan käyttöön Suomen Sulkapalloliitossa. Asiakas arvioi projektin lopussa, onko yhteensopivuus seuroissa käytettävien ohjelmien ja liiton kilpailutoiminnan rekisteriohjelman kanssa riittävä. Asiakas ja projektiryhmä arvioivat, onko kilpailutietojen tallentaminen mahdollistettu vaatimuksiin kirjatulla tavalla. Asiakas arvioi projektin lopussa, onko tavoite toteutunut. Asiakas arvioi projektin lopussa, onko tuote helppokäyttöinen. Good Minton 4 (23)

5 6. Tavoitteena on uuden järjestelmän päivitettävyys ja ylläpidettävyys tulevien sääntömuutosten varalta. 7. Tavoitteena on historiatietojen helppo hallinta, saatavuus ja varmistus. 8. Tavoitteena on toteuttaa seuroille tarjottava kilpailuunilmoittautumisjärjestelmä. Asiakas ja projektiryhmä arvioivat, onko sääntöjen päivitettävyys ja ylläpidettävyys toteutettu vaatimuksiin kirjatulla tavalla. Asiakas arvioi projektin lopussa, onko tavoite toteutunut. Toteutuu, jos ilmoittautumisjärjestelmä on sisällytetty uuteen järjestelmään. 3 Käsitteet Järjestelmän osa alueiden relaatiot on helpointa kuvata graafisesti. Kilpailu Seura Peli Pelaaja Kuva 1: Järjestelmän tärkeimpien käsitteiden relaatiot Järjestelmän tietovarasto koostuu seurojen järjestämistä kilpailuista, joihin on liitetty seurojen pelaajia. Kilpailu koostuu peleistä, joita pelaa kilpailuun liitetyt pelaajat. Näillä käsitteillä on useita attribuutteja, joita käsitellään järjestelmää käytettäessä. Pelaajien pelituloksista eri kilpailuissa lasketaan pelaajien ranking tilastot. Good Minton 5 (23)

6 Taulukko 3: Tärkeimmät projektiin liittyvät määritelmät, termit ja lyhenteet. Määritelmä Kilpailu Luokka Pelimuoto Luokitus Kilpailu sisältää pelejä eri luokissa. Pelit pelataan joko eliminointi tai lohko ja eliminointi menettelyllä. <tarkennettava> Pelaajat jaettu 5 eri luokkaan <tarkennettava> Pelimuotoja on kaksinpeli, nelinpeli ja sekanelinpeli Pelaajien luokitukset lasketaan puolivuosittain. Good Minton 6 (23)

7 4 Järjestelmän yleiskuvaus Korkean tason kuvaus toteutettavasta järjestelmästä. Kuva 2: Järjestelmän yleiskuvaus Good Minton 7 (23)

8 Järjestelmää käyttää neljä eri käyttäjäryhmää, joilla kaikilla on hyvin erilaiset tehtävät ja oikeudet järjestelmässä. ylläpitäjä hallinnoi kaikkea järjestelmän dataa, Ranking säännöistä peli tuloksiin. Manager Liiton päivittäjä hoitaa yleisimpiä tehtäviä kuten seurojen ja pelaajien tietojen hallintaa ja kilpailujen ilmoittautumisia ja tuloksia. Updater Seuran päivittäjä taas hoitaa seuran kilpailuja ja ilmoittautumisia sekä tallentaa kilpailujen tuloksia. User tavallinen www palvelujen käyttäjä taas tarkastelee vain kilpailujen perusteella tehtyjä pelaaja listoja sekä ranking tuloksia. 5 Käyttäjäryhmät Järjestelmän käyttäjät voidaan jakaa neljään ryhmään. Taulukko 4. Käyttäjäryhmät Käyttäjäryhmä Käyttäjämäärä Käyttäjäryhmän tärkeys Ylläpitäjä 1 Manager Sulkapalloliiton päivittäjä 1 10 Updater Jäsenseuran päivittäjä User WWWpalvelun käyttäjä Toiminnalliset vaatimukset Järjestelmän toiminnalliset vaatimukset sisältävät jonkun toimijan kuten ylläpitäjän toimesta toteutettavia toimintoja. Vaatimukset luokitellaan niiden tärkeyden mukaan kolmeen luokkaan: kriittinen, tärkeä ja lisäominaisuus. Vaatimuksille annetaan yksilöllinen tunniste ja nimi. Lisäksi kirjataan lyhyt kuvaus vaatimuksesta, toiminnon mahdolliset käyttäjät, aloitus ja lopetusehdot, tapahtumien peruspolku, poikkeukset peruspolkuun, vaatimuksen tila sekä vaatimukseen liittyvät testitapaukset. Vaatimukset kirjataan taulukon 4 mukaiseen käyttötapauslomakkeeseen. Taulukko 5: Käyttötapauslomake <Yksilöllinen tunnus> <Yksilöllinen nimi> <Lyhyt kuvaus> <Lista käyttäjistä tai muista järjestelmistä, jotka käyttävät tätä toimintoa> Good Minton 8 (23)

9 < toiminnon kulusta> < poikkeustapauksista> <Kriittinen, tärkeä, lisätoiminto> <, hyväksytty, toteutettu, testattu> 6.1 Toiminnot F1 Käyttäjän lisäys F1 Käyttäjän lisäys Toimija lisää järjestelmään uuden käyttäjän < toiminnon kulusta> < poikkeustapauksista> 1 Kriittinen F2 Käyttäjän muokkaus F2 Käyttäjän muokkaus Toimija muokkaa järjestelmässä olevan käyttäjän tietoja < toiminnon kulusta> < poikkeustapauksista> 1 Kriittinen Good Minton 9 (23)

10 6.1.3 F3 Käyttäjän poisto F3 Käyttäjän poisto Toimija poistaa järjestelmässä olevan käyttäjän < toiminnon kulusta> < poikkeustapauksista> 1 Kriittinen F4 Seuran lisäys F4 Seuran lisäys Toimija lisää järjestelmään uuden jäsenseuran < toiminnon kulusta> < poikkeustapauksista> 1 Kriittinen Good Minton 10 (23)

11 6.1.5 F5 Seuran muokkaus F5 Seuran muokkaus Toimija muokkaa järjestelmässä olevan jäsenseuran tietoja < toiminnon kulusta> < poikkeustapauksista> 1 Kriittinen F6 Seuran poisto F6 Seuran poisto Toimija poistaa järjestelmässä olevan jäsenseuran < toiminnon kulusta> < poikkeustapauksista> F7 Pelaajan lisäys F7 Good Minton 11 (23)

12 Pelaajan lisäys Toimija lisää järjestelmää uuden pelaajan, Manager < toiminnon kulusta> < poikkeustapauksista> 1 Kriittinen F8 Pelaajan muokkaus F8 Pelaajan muokkaus Toimija muokkaa järjestelmässä olevan pelaajan tietoja < toiminnon kulusta> < poikkeustapauksista> 1 Kriittinen F9 Pelaajan poisto F9 Pelaajan poisto Toimija poistaa järjestelmässä olevan pelaajan < toiminnon kulusta> Good Minton 12 (23)

13 < poikkeustapauksista> F10 Pelaajien lisenssien seuranta F10 Pelaajien lisenssien seuranta Toimija seuraa pelaajien lisenssien maksutilannetta, Manager < toiminnon kulusta> < poikkeustapauksista> 3 Lisätoiminto F11 Kilpailun lisäys F11 Kilpailun lisäys Toimija lisää järjestelmään uuden kilpailun, Manager, Updater < toiminnon kulusta> < poikkeustapauksista> 1 Kriittinen Good Minton 13 (23)

14 F12 Kilpailun muokkaus F12 Kilpailun muokkaus Toimija muokkaa järjestelmässä olevaa kilpailun tietoja, Manager, Updater < toiminnon kulusta> < poikkeustapauksista> 1 Kriittinen F13 Kilpailun poisto F13 Kilpailun poisto Toimija poistaa järjestelmässä olevan kilpailun, Manager, Updater < toiminnon kulusta> < poikkeustapauksista> F14 Kilpailukalenterin seuranta Good Minton 14 (23)

15 F14 Kilpailukalenterin seuranta Toimija seuraa järjestelmässä olevia kilpailuja kalenteriesityksenä tai listana, Manager, Updater < toiminnon kulusta> < poikkeustapauksista> F15 Ilmoittautumisen lisäys F15 Ilmoittautumisen lisäys Toimija lisää ilmoittautuneen pelaajan kilpailuun, Manager, Updater < toiminnon kulusta> < poikkeustapauksista> 1 Kriittinen F16 Ilmoittautumisen muokkaus F16 Ilmoittautumisen muokkaus Toimija muokkaa kilpailuun ilmoittautuneen pelaajan tietoja, Manager, Updater Good Minton 15 (23)

16 < toiminnon kulusta> < poikkeustapauksista> F17 Ilmoittautumisen poisto F17 Ilmoittautumisen poisto Toimija peruuttaa ilmoittautuneen pelaajan osallistumisen kilpailuun, Manager, Updater < toiminnon kulusta> < poikkeustapauksista> F18 Ilmoittautumisten seuranta Prioriteetti Tärkeys F18 Ilmoittautumisten seuranta Toimija seuraa kilpailuun ilmoittautuneita pelaajia, Manager, Updater < toiminnon kulusta> < poikkeustapauksista> Good Minton 16 (23)

17 F19 Ilmoittautumisen sulkeutuminen F19 Ilmoittautumisen sulkeutuminen Toimija sulkee ilmoittautumisen ja hakee ilmoittautuneiden pelaajien tiedot kilpailun järjestäjää varten Järjestelmä < toiminnon kulusta> < poikkeustapauksista> F20 Tulosten lisäys F20 Tulosten lisäys Toimija lisää kilpailuun pelit ja pelikohtaiset tulokset, Manager, Updater < toiminnon kulusta> < poikkeustapauksista> 1 Kriittinen Good Minton 17 (23)

18 F21 Tulosten muokkaus F21 Tulosten muokkaus Toimija muokkaa kilpailun pelejä ja pelikohtaisia tuloksia, Manager, Updater < toiminnon kulusta> < poikkeustapauksista> F22 Tulosten poisto F22 Tulosten poisto Toimija poistaa kilpailusta pelin ja/tai pelikohtaisia tuloksia, Manager, Updater < toiminnon kulusta> < poikkeustapauksista> F23 Ranking sääntöjen lisäys F23 Ranking sääntöjen lisäys Toimija lisää järjestelmään ranking tuloksia Good Minton 18 (23)

19 laskevan säännön < toiminnon kulusta> < poikkeustapauksista> F24 Ranking sääntöjen muokkaus F24 Ranking sääntöjen muokkaus Toimija muokkaa järjestelmään tallennettuja ranking laskentasääntöjä < toiminnon kulusta> < poikkeustapauksista> F25 Ranking sääntöjen poisto F25 Ranking sääntöjen poisto Toimija poistaa järjestelmästä ranking tuloksia laskevan säännön < toiminnon kulusta> Good Minton 19 (23)

20 < poikkeustapauksista> F26 Käyttäjän sisäänkirjautuminen F26 Käyttäjän sisäänkirjautuminen Toimija kirjautuu järjestelmään, Manager, Updater < toiminnon kulusta> < poikkeustapauksista> 1 Kriittinen F27 Käyttäjän uloskirjautuminen F25 Ranking sääntöjen poisto Toimija poistaa järjestelmästä ranking tuloksia laskevan säännön < toiminnon kulusta> < poikkeustapauksista> 1 Kriittinen Good Minton 20 (23)

21 7 Ei toiminnalliset vaatimukset Ei toiminnalliset vaatimukset on lueteltu taulukossa 5. Vaatimusten tarkemmat kuvaukset on esitetty myöhemmin omina osioinaan. Taulukko 6: Ei toiminnalliset vaatimukset Prioritization viewpoints Vaatimus tuuriin Vaikutus Tärkeys arkkiteh N1 Suorituskyky Tärkeä Normaali Normaali N2 Käytettävyys Kriittinen Normaali Korkea N3 Toipuminen Tärkeä N4 Turvallisuus ja Tärkeä Suojaukset N5 Ylläpidettävyys Kriittinen Korkea Korkea N6 Siirrettävyys Lisätoiminto Matala N7 Yhteensopivuus Tärkeä Korkea Normaali 7.1 N1 Suorituskyky Liittyvät käyttötapaukset Liittyvät testitapaukset Järjestelmän tulee suoriutua normaalista www liikenteen aiheuttamasta kuormasta. Normaali liikenne selvitetään nykyiseltä palveluntarjoajalta ja järjestelmä testataan kyseistä kuormaa vastaavalla määrällä varautuen samalla tulevaisuuden kasvuun. 7.2 N2 Käytettävyys Järjestelmän yksi tärkeimmistä tavoitteista on järjestelmän helppo käyttö. Tämän mittaaminen on hankalaa, joten järjestelmän hyvä käytettävyys pyritään varmistamaan heuristisella analyysillä ja käyttäjätesteillä. 7.3 N3 Toipuminen Järjestelmän tulee toipua yhteyskatkoista ja tietojen tallennuksessa mahdollisesti esiintyvistä erikoismerkeistä. Muuten järjestelmän osalta luotetaan virtuaalipalvelimen omiin varmennusjärjestelmiin. 7.4 N4 Turvallisuus ja suojaukset Järjestelmän on oltava turvallinen sen sisältämän datan vuoksi. Tietokanta sisältää henkilötietoja ja pelitietoja, joiden suojaus, eheys ja oikeellisuus on tärkeää. Turvallisuus varmistetaan käyttämällä riittävän turvallisia salasanoja, TSL tai SSL Good Minton 21 (23)

22 sertifikaatteja suojatun yhteyden luomiseksi järjestelmään sekä tarkistamalla järjestelmään syötettävän datan sisältö mahdollisten väärinkäyttöyritysten estämiseksi. 7.5 N5 Ylläpidettävyys Järjestelmän tulee olla ylläpidettävä ja jatkokehityksen on oltava mahdollista ilman merkittäviä panostuksia järjestelmään tutustumiseen. Ylläpidettävyys varmistetaan kattavalla dokumentaatiolla ja template tekniikalla. 7.6 N6 Siirrettävyys Järjestelmä tulee olla siirrettävissä nykyiseltä virtuaalipalvelimelta muuhunkin vastaavaan ympäristöön. Järjestelmä tullaan kehittämään LAMP Linux, Apache, MySQL, PHP ympäristössä ja tällä varmistetaan hyvä siirrettävyys LAMP ympäristöä tukevien alustojen välillä. 7.7 N7 Yhteensopivuus Järjestelmän vaatimuksissa on yhteensopivuus yleisimpien selainten kanssa. Tämä varmistetaan toteuttamalla järjestelmä HTML 4.01 tason koodilla ja testaamalla järjestelmä yleisimmillä selaimilla kuten MS Internet Explorer 6, FireFox 1.x ja Netscape 8.1 sekä mahdollisuuksien mukaan Mac ympäristössä Safari selaimella. 8 Rajoitteet Taulukko 7: Järjestelmää koskevat rajoitteet Rajoite Liittyvät testitapaukset C1 Standardit C2 Laitteistot C3 Ohjelmistot 8.1 C1 Standardit Järjestelmää kehitettäessä tullaan käyttämään taulukossa 7 esitettyjä standardeja. Taulukko 8: Käytettävät standardit Standardi HTML 4.01 ANSI/ISO SQL standardi Tavoite / Käytön syy Selain yhteensopivuus MySQL palvelin tukee kyseistä standardia Good Minton 22 (23)

23 8.2 C2 Laitteistorajoitteet Tuotantopalvelin sijaitsee Kotisivut.com palveluntarjoajan virtuaalipalvelimella. Virtuaalipalvelimen käyttöjärjestelmä on Debian GNU/Linux ja se ei aseta järjestelmälle muita kuin ohjelmisto rajoitteita. 8.3 C3 Ohjelmistorajoitteet Virtuaalipalvelimelle on asennettu seuraavat palvelinohjelmistoversiot, joita järjestelmän toteutuksessa käytetään: Taulukko 9: Käytettävät ohjelmistot Ohjelmisto Versio Syy Apache HTML Palvelin PHP 4.4 Dynaamisten HTML sivujen toteutus MySQL Relaatiotietokanta Smarty HTML Template moottori 8.4 Muut rajoitteet Järjestelmälle ei tässä vaiheessa ole asetettu muita rajoitteita. Good Minton 23 (23)