Matematiikan oppifoorumi Projektisuunnitelma Carl Johansson Jukka Kariola Outi Marttila Helena Venäläinen Sampsa Virtanen Ohjaaja Jukka Eskola Asiakas Mikko Mäkelä Ohjelmistotuotantoprojekti 29.10.1999 HELSINGIN YLIOPISTO Tietojenkäsittelytieteen laitos
Sisältö 1. Tausta 1 2. Tavoitteet ja rajaukset 1 2.1 Työn tavoite 1 2.2 Tehtävät 1 2.3 Asiakkaan hyväksyntä 2 3. Ympäristö 2 3.1 Kehitysympäristö ja järjestelmävaatimukset 2 3.2 Yleisarkkitehtuuri 2 3.3 Käyttäjät 3 4. Projektiryhmä 3 5. Toimintasuunnitelma 3 5.1 Työn ositus 3 5.2 Alustava tehtävänjako 4 5.3 Tarkistuspisteet 5 6. Menetelmät ja standardit 5 6.1 Ohjelmistomenetelmät 5 6.2 Käytettävät standardit ja tyylioppaat 5 6.3 Työkalut 6 6.4 Tuotteenhallinta 6 Liitteet: 1. Gantt-kaavio (2 sivua) Versio 0.1 Helena Venäläinen 23.9.1999 Gantt-kaavio Versio 0.1 Carl Johansson 27.9.1999 Teksti ja gantt-kaavio Versio 0.2 Carl Johansson 8.10.1999 Teksti ja gantt-kaavio Versio 0.3 Carl Johansson 29.10.1999 Otsikko ja luku 5.3
1 1 Tausta Tietokoneavusteisessa opetuksessa matematiikka on alusta lähtien ollut eräs yleisimmistä oppiaineista, jonka opetustarpeisiin on pyritty vastaamaan. Suurin osa ohjelmistoista on kuitenkin kehitetty kouluikäisten opetukseen ja vain harvat ovat suunnattuja korkeakouluopiskelijoille. Lisäksi vain harvoissa järjestelmissä on pyritty palautteen avulla kehittyvään materiaaliin. Nykyisin Internet tarjoaa lukuisia esimerkkejä aktiivisista, tietyn asian ympärille keskittyvistä keskustelufoorumeista, joiden kautta kuka tahansa voi yrittää etsiä vastausta ongelmaansa tai vastata muiden kysymyksiin. Samaa perusideaa voidaan käyttää etäopetuksessa. Toinen Internetissä laajassa käytössä oleva (etä)opetusmuoto on erilaisten valmiiden oppimateriaalien toimittaminen WWW-selaimilla katseltavassa muodossa (HTML & Java). Toistaiseksi vain verraten harvoja yrityksiä näiden kahden lähestymistavan yhdistämiseksi on tehty. 2 Tavoitteet ja rajaukset 2.1 Työn tavoite Työn tavoitteena on suunnitella ja toteuttaa mahdollisimman helppokäyttöisiä työvälineitä matematiikan "WWW-oppifoorumin" luomiseksi. Tarkoituksena on, että tuotettava "virtuaalioppikirja" (josta työryhmä koostaa vain demoversion) toimii palautetta ja keskustelua ohjaavana kehyksenä. Palautteen antamista rohkaistaan tekemällä se mahdollisimman helpoksi, "yhden klikkauksen" toiminnoksi. Samoin avun antaminen palautteen perusteella vaikeiksi koettuihin asioihin pyritään tekemään mahdollisimman vaivattomaksi. Tuotteen käyttöönotolle pitäisi olla mahdollisimman vähän esteitä, sen tähden sen tulisi toimia mahdollisimman monessa laitteistoympäristössä. Matemaattisia kaavoja pitäisi voida esittää ja käyttää. 2.2 Tehtävät Projektiryhmä keskittyy ensisijaisesti tuotteen määrittelyyn ja suunnitteluun, myöhempi projektiryhmä täydentää toteutuspuolta. Laadukkaiden dokumenttien luominen on
2 projektin ensisijainen prioriteetti. Myös kattava selvitys erilaisista teknisistä vaihtoehdoista on syytä tehdä suunnitteluvaiheessa. 2.3 Asiakkaan hyväksyntä Asiakas on tiiviisti mukana projektin määrittelyvaiheessa ja hyväksyy yleiset suuntaviivat, projektiryhmällä on tähän verrattuna enemmän toimintavapautta toteutuksen suunnittelussa. Asiakas hyväksyy halutessa myös toteutuksen. Asiakas osallistuu vaatimustarkastuksiin, halutessa myös muihin kokouksiin. 3 Ympäristö 3.1 Kehitysympäristö ja järjestelmävaatimukset Tuotetta toteutetaan Linux-ympäristössä Apache www-palvelimella. Lopullinen tuote käyttää Apache Jserv 1.0 tai vastaavan lisäosan joka mahdollistaa Java palvelinsovelmien käytön Apachessa. Tarvittaessa tuote käyttää myös erillisiä Java luokkia, joiden avulla se pystyy kääntämään Java Server Page (JSP) koodia. Kääntäminen tapahtuu jonkun suositun ja ilmaisen Java Development Kitin avulla. Tietokantana käytetään Solid Serveriä täydennettynä JDBC-ajurilla. Lopullinen tuote vaatii JSP-yhteensopivan WWW-palvelimen, JDBC-yhteensopivan tietokannan, sekä todennäköisesti myös Java-yhteensopivan selaimen. 3.2 Yleisarkkitehtuuri Tuote toimii client-server periaatteella, mutta lähiverkon sijaan Internetin/Intranetin kautta. Tietokanta ja ohjelmisto sijaitsevat www-palvelimella, ja asiakkaat ottavat yhteyttä siihen www-selainten avulla.
3 3.3 Käyttäjät Tuotetta voi käyttää jonkun matematiikkakurssin opettamisen tukena, jolloin käyttäjät ovat kyseisen kurssin osallistujia. Mutta tuotetta voi myös avata satunnaisille käyttäjille Internetin kautta. Järjestelmässä on seuraavat käyttäjätyypit: opiskelija joka lukee kurssisisällön, kouluttaja joka tuottaa kurssisisältöä ja ylläpitäjä joka vastaa käyttäjähallinnasta ja avustaa kouluttajia kurssirakenteiden luomisessa. 4 Projektiryhmä Projektipäällikkönä toimii toistaiseksi Jukka Kariola, toinen projektiryhmän jäsen voi myöhemmässä vaiheessa tarvittaessa tulla tilalle. Projektin sihteerinä toimii kahden viikon ajan kerralla jokainen paitsi projektipäällikkö. Projektin www-sivua ylläpitää Jukka Kariola. Muut tehtävät pyritään jakamaan tasaisesti projektiryhmän jäsenten kesken, kuitenkin jokaisen taitojen mukaan. Projektin ohjaajana toimii Jukka Eskola. 5 Toimintasuunnitelma Projekti toteutetaan iteroivaa vesiputousmallia käyttäen, johon on lisätty myös prototyypin teko. Projektissa on seuraavat dokumentit: kokouspöytäkirjat, projektisuunnitelma, vaatimusdokumentti, suunnitteludokumentti, toteutusdokumentti, käyttö-ohje, ylläpitoohje, loppuraportti. Kaikista dokumenteista tehdään myös WWW-versio. 5.1 Työn ositus Työssä on neljä päävaihetta: käynnistysvaihe, vaatimusten selvitysvaihe, järjestelmän suunnittelu ja toteutusvaihe. Vaiheita suoritetaan pääsääntöisesti pienemmissä osaryhmissä. Ks. Liite 1. Liitteestä ilmenee myös työn aikataulu.
4 5.2 Alustava tehtävänjako Vaatimusten selvitysvaihe Jukka Kariola tutkii pääasiassa käyttöliittymään liittyviä asioita (liite 1: käyttöliittymän suunnittelu), Carl Johansson selvittää tietokannat ja palvelimet (liite 1: tietokuvaus). Helena Venäläinen vastaa työvaiheesta Vaatimusten määrittely ja Sampsa Virtanen tekee toimintokuvausta. Ryhmä suunnittelee yhdessä toimintokuvausosuuden luokkakaaviota. Outi Marttila avustaa aluksi Jukka Kariolaa käyttöliittymän suunnittelussa matematiikan kannalta. Kun tämä osa-alue on selvitetty, hän tekee käyttötapaukset. Carl Johansson tekee suorituskyky ja käytettävyysosuutta. Outi Marttila vastaa testausosuudesta, Carl Johansson käyttörajoitusosuudesta. Muut vapautuneet tekijät liittyvät myös tähän. Dokumentin koostamisesta vastaa Helena Venäläinen. Järjestelmän suunnittelu Carl Johansson vastaa vaiheesta arkkitehtuurin kuvaus, Jukka Kariola vaiheesta käyttöliittymän kuvaus, Outi Marttila vaiheesta toteutuksen rajaaminen. Sampsa Virtanen ja Helena Venäläinen liittyvät vaativimpiin vaiheisiin. Helena Venäläinen kokoaa suunnitteludokumenttia. Kaikki viimeistelevät suunnitteludokumenttia. Toteutusvaihe Carl Johansson ja Jukka Kariola huolehtivat kehitysympäristöstä. Kaikki osallistuvat työn toteutukseen. Outi Marttila ja Helena Venäläinen tekevät testaussuunnitelmaa ja Carl Johansson, Jukka Kariola ja Sampsa Virtanen toteutuksen dokumentointia. Helena Venäläinen ja Outi Marttila suorittavat järjestelmätestausta, Carl Johansson ja Helena Venäläinen suorituskykyanalyysiä ja Jukka Kariola, Sampsa Virtanen, Outi Marttila tekevät MatWO-käyttöohjetta. Kaikki yhdessä tekevät loppuraporttia.
5 5.3 Tarkistuspisteet Dokumenttien palautuspäivämäärät ovat: Projektisuunnitelma 27.9 Vaatimusdokumenttia 14.10 Suunnitteludokumenttia 4.11 Toteutusdokumentti 13.12 Loppuraportti 17.12 Suunnitteludokumenttia katselmoidaan 8.11. MatWO:n demoaminen tapahtuu 2.12 ja sovelluksen palautus 13.12. Seurantakokouksien päivämäärät ovat: 30.9, 14.10, 4.11 ja 25.11. 6 Menetelmät ja standardit 6.1 Ohjelmistomenetelmät Projekti toteutetaan JSP:llä (Java Server Pages), tällä menettelyllä saadaan aikaan kaksi toisistaan riippumatonta moduulia, HTML-pohjaiset www-sivut sekä niiden seassa JSP:llä kirjoitettuja osuuksia, jotka huolehtivat tietokantayhteyksistä. Näin voidaan helposti antaa HTML-osuus yhdelle tehtäväksi, ja toiselle skriptiosuus. HTML-osuudessa voi tarvittaessa myös olla itsenäisiä Java-appletteja, jotka esittävät matematiikkaa graafisesti. 6.2 Käytettävät standardit ja tyylioppaat Arkkitehtuurin mallinnuksessa noudatetaan UML-standardia, tai työkalujen puuttuessa, jotain sitä muistuttavaa standardia. Tietokannan mallinnuksessa käytetään Entity- Relationship mallia.
6 Java ohjelmoinnissa käytetään Sun Microsystemsin tyyliopasta, saatavilla osoitteessa http://java.sun.com/docs/codeconv. Tässä on myös nimeämis- ja kommentointiohjeita. 6.3 Työkalut Projektin dokumentit tuotetaan Microsoft Word 95/7.0 formaatissa, ja JSP ohjelmointi tapahtuu Jrun-lisämoduulia käyttämällä. Muilta osin projektin jäsenillä on vapaus käyttää sopivaksi katsomaansa työkalua. 6.4 Tuotteenhallinta Ensimmäisestä päivityksestä alkaen liitetään jokaiseen dokumenttiin versiohistoria.