Miniprojekti

Ajankohtaista

Johdanto

  • Kurssin viikoilla 4-7 tehdään miniprojekti
  • Kurssin läpipääsy edellyttää hyväksyttyä osallistumista miniprojektiin tai sen hyväksilukemista

  • Projekti tehdään noin 5-6 hengen ryhmissä
  • Projektissa ohjelmoidaan jonkin verran, pääpaino ei ole ohjelmoinnissa vaan systemaattisen prosessin (tästä lisää myöhemmin) noudattamisessa.
  • Jokaisen ryhmän jäsenen on tarkoitus tehdä kunkin sprintin aikana töitä noin 6 tuntia projektin eteen
    • Asiakastapaamisiin menevää aikaa ei lasketa viikoittaiseen työaikaan!
  • Ryhmä tekee kussakin sprintissä sen minkä se sprinttiin varatussa ajassa pystyy tekemään, ei enempää eikä vähempää
    • Kuuden tunnin työajan reilu ylittäminen siis ei ole järkevää, se on suorastaan kiellettyä

Ryhmän muodostaminen

  • Ryhmät muodostetaan lauantaina 14.11. “algoritmisesti”, pääasiassa noudattaen ilmoittautumisessa kerrottuja sopivia työskentelyaikoja
  • Ryhmäsi aloitustilaisuuden ajankohta selviää ilmoittautumissovelluksesta. Kaikkien ryhmäläisten on pakko osallistua tilaisuuteen, jonka kesto on noin 2 tuntia
  • Aloitustilaisuuteen tullessa on syytä tuntea materiaalin osien 1 ja 2 asioista ainakin seuraavat:
    • scrum
    • sprintti
    • user story
    • product backlog
    • sprint backlog
    • hyväksymäkriteeri
    • definition of done
  • Tämä dokumentti ja miniprojektin arvosteluperusteet on myös syytä lukea huolellisesti ennen aloitustilaisuutta
  • Ryhmä keksii itselleen nimen, luo Github-repositorion ja rekisteröi itsensä palautussovellukseen https://study.cs.helsinki.fi/stats/courses/ohtu2020
    • yksi ryhmäläinen kirjautuu järjestelmään, menee välilehdelle miniprojects
      • luo projektin create project -napista avautuvasta lomakkeesta
      • ja jakaa muille ryhmäläisille luodun projektin id:n
    • muut ryhmäläiset kirjautuvat järjestelmään ja liittyvät id:n avulla ryhmään join project -napista avautuvasta lomakkeesta

Työn eteneminen

Seuraavien viikkojen asiakastapaaminen (sprintin katselmointi ja uuden sprintin suunnittelu) tapahtuu saman 2h sisällä missä aloitustilaisuus pidetään. Tilaisuuden kesto on 30 minuuttia. Aika kerrotaan palautussovelluksen välilehdeltä miniproject viimeistään sunnuntaina 22.11.

viikko 4 (16-20.11.)

  • Ryhmä muodostuvat/muodostetaan
  • Ryhmät tapaavat asiakkaan aloitustilaisuuksissa
  • Aloitustilaisuudessa pidettävän asiakastapaamisen pohjalta ryhmä tekee alustavan product backlogin ja sopii asiakkaan kanssa ensimmäisen sprintin tavoitteesta
  • Ryhmä suunnittelee ensimmäisen sprintin ja aloittaa työskentelyn
    • sprintin suunnittelun tuloksena ryhmä tekee sprint backlogin
    • backlogien sisällöstä enemmän täällä
  • Sprintin 1 arvosteluperusteet kannattaa lukea huolellisesti

viikko 5 (23-29.11.)

  • Sprintin 1 katselmointi ja sprintin 2 suunnittelu
    • asiakastapaamisen aikataulu selviää palautussovelluksen välilehdeltä miniproject

viikko 6 (30.11-6.12.)

  • Sprintin 2 katselmointi ja sprintin 3 suunnittelu
    • asiakastapaamisen aikataulu selviää palautussovelluksen välilehdeltä miniproject

viikko 7 (7-13.12.)

  • Sprintin 3 katselmointi (eli loppudemot)
    • tiistai 8.12. klo 12-14
    • torstai 10.12. klo 14-16
    • perjantai 11.12. klo 14-16
  • jokainen ryhmä osallistuu yhteen loppudemoon
  • varaa aika täällä

Toteutettava ohjelmisto

Tekniset ja prosessiin liittyvät vaatimukset

  • Ryhmä laatii yhdessä asiakkaan kanssa product backlogin
    • Vaatimukset kirjataan backlogiin user story:inä
  • Sprintin suunnittelun yhteydessä ryhmä sitoutuu toteuttamaan sopivan määrän backlogin kärjessä olevista user storyistä
    • Jokaisen ryhmäläisen “työaika” on 6 tuntia viikossa
      • Työajan ylittävä sankarikoodaus ei ole suositeltavaa, se on jopa kiellettyä
    • Ryhmä sitoutuu ainoastaan niihin storyihin, jotka se kuvittelee kykenevänsä toteuttamaan sprintissä definition of donen määrittelemällä laatutasolla. Definition of done on määritelty alla
    • Kannattaa huomata, että storyihin sitoutuminen ei tarkoita sitä, että ne on pakko tehdä valmiiksi. Ohjelmistoja tehdessä sattuu ja tapahtuu ennakoimattomia asioita, ja aina suunnitelmat eivät toteudu.
    • Asiakkaalle ei kannata luvata liikaa, ja varsinkin ensimmäisten sprinttien aikana arvioissa on otava varovainen, konfiguroimiseen, testaamiseen ja ryhmän järjestäytymiseen tulee kulumaan paljon aikaa
  • Ryhmä ylläpitää sprint backlogia
    • User storyt jaetaan sprintin suunnittelussa teknisen tason tehtäviksi eli taskeiksi jotka sijoitetaan sprint backlogiin
    • Ryhmä tekee päivittäin jäljellä olevan työajan arviointia ja dokumentoi tämän sprintin burndown-käyränä
    • Sprint backlogista tulee ilmetä kunkin taskin osalta
      • jäljellä olevan työajan estimaatti
      • taskin tila (esim. aloitettu, ohjelmoitu, testauksessa, valmis)
      • taskin tekijä(t)
  • Ryhmä toteuttaa jatkuvaa integraatiota (continuous integration)
    • Oletusarvoisesti kannattaa käyttää laskareista 1 tuttua Github Actionsia, muita vaihtoehtoja esim. TravisCI
  • Koodi on talletettu GitHub:iin
  • Projektin GitHub-repositoriolla on järkevä README.md

Product ja sprint backlog

  • Backlogissa vaatimukset ilmaistaan järkevästi muotoiltuna user storyinä
    • miniprojektissa ei ole tarvetta estimoida user storya, ainoastaan sprintissä olevien taskien työmäärä estimoidaan
  • Kuten edellä todettiin sprint backlogista tulee ilmetä kunkin taskin osalta
    • jäljellä olevan työajan estimaatti
    • taskin tila (esim. aloitettu, ohjelmoitu, testauksessa, valmis)
    • taskin tekijä(t)
  • Backlogit voi toteuttaa esim. Google Docs -spreadsheetinä, mallia voi ottaa seuraavista:
  • Backlogit voi tehdä Google Docsin sijaan myös johonkin backlogien ylläpitämiseen tarkoitettuun työkaluun
    • kannattaa varmistaa, että työkalu kuitenkin tulee edellä lueteltuja vaatimuksia
    • esim. https://trello.com ei tue scrum-tyylisiä backlogeja oikeastaan ollenkaan, ja Trelloa kannattaakin välttää tässä projektissa

Definition of done

Seuraavassa lähtökohta definition donelle. Ryhmän tulee määritellä GitHub-repositorioon oma, omiin lähtökohtiin sopiva DoD

  • User storyille tulee määritellä hyväksymiskriteerit, jotka dokumentoidaan Cucumberin featureiksi
    • hyvänä käytänteenä on laittaa README:stä linkki hyväksymäkriteerit määritteleviin tiedostoihin
  • Toteutetun koodin testikattavuuden tulee olla kohtuullinen (esim. noin 70% muiden paitsi triviaalin koodin, kuten gettereiden/settereiden osalta)
  • Asiakas pääsee näkemään koko ajan koodin ja testien tilanteen CI-palvelusta
  • Koodin ylläpidettävyyden tulee olla mahdollisimman hyvä
    • järkevä nimeäminen
    • järkevä/selkeä ja perusteltu arkkitehtuuri
    • yhtenäinen koodityyli

Repositorio ja README

README:ssa tulee löytyä ainakin seuraavat asiat:

  • Linkit backlogeihin (backlogeista tulee olla luettavissa olevat versiot julkisessa internetissä)
  • Linkki CI-palveluun
  • Linkki sovelluksen toimivaan versioon (jos sovellus on verkossa)
  • Jos kyse työpöytäsovelluksesta, tulee ohjelmalle olla asennus- ja käyttöohje
  • Työlle tulee määritellä lisenssi https://help.github.com/articles/licensing-a-repository/

Teknologisia vihjeitä

  • Kokonaan uusien teknologioiden opettelu miniprojektin yhteydessä ei ole järkevää
  • Komentoriviltä toimiva sovellus on teknologioiden suhteen riskittömin vaihtoehto ainakin Javaa käytettäessä
  • Mahdollisten ulkoisten kirjastojen käyttöönotto, testien tekeminen ja CI:n konfigurointi tulee viemään ainakin alussa todella paljon aikaa
  • Jos haluatte käyttää tietokantaa, on Tikapestakin tuttu sqlite hyvä vaihtoehto
  • Viikon 3 laskareista kannattaa ottaa mallia Cucumberilla tapahtuvaan storyjen testaamiseen
  • JavaFX:llä tehtyjen sovellusten automatisoitu testaaminen on mahdollista TestFX-kirjaston avulla. Kirjaston dokumentaatio ei ole parhaasta päästä
  • Edellisinä vuosina on huomattu, että Java Springin konfigurointi (toimimaan yhdessä gradlen, cucumberin ja CircleCI:n kanssa) miniprojektille varatun ajan puitteissa on osoittautunut haastavaksi. Käyttäkää siis springiä omalla vastuulla

Työn arvostelu

Arvosteluperusteet löytyvät täältä