Ajankohtaista

  • Loppudemot
    • ti 12.12. klo 14-16 B123
    • to 14.12. klo 12-14 B123
    • Jokainen ryhmä osallistuu yhteen loppudemoon (demoviikolla ei enää pidetä asiakaspalaveria)
  • Varaa ryhmällesi aika täältä
  • Miniprojektin lopputoimenpiteet
  • Asiakastapaamisten (30 min) ajankohta palautussovelluksen välilehdeltä miniproject
  • Arvosteluperusteet

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

  • Aloitustilaisuutesi näet täältä, ryhmäjako tehdään aloitustilaisuudessa 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

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

viikko 3 (13-17.11.)

  • Ryhmä muodostuvat/muodostetaan
  • Ryhmät tapaavat asiakkaan aloitustilaisuuksissa
  • Projekti tulee rekisteröidä palautussovellukseen https://study.cs.helsinki.fi/stats/courses/ohtu2023.
    • 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
    • Jokaisen ryhmäläisen on oltava rekisteröitynyt projektiin viimeistään ensimmäisen sprintin lopuksi pidettävässä asiakastapaamisessa.
      • Ne ryhmäläiset joita ei ole rekisteröity ensimmäisen sprintin asiakastapaamiseen mennessä, eivät saa ryhmälle sprintistä tulevia pisteitä

viikko 4 (20-24.11.)

  • Sprintin 1 katselmointi ja sprintin 2 suunnittelu

viikko 5 (27.11-1.12.)

  • Sprintin 2 katselmointi ja sprintin 3 suunnittelu

viikko 6 (4-8.12.)

  • Sprintin 3 katselmointi ja sprintin 4 suunnittelu

viikko 7 (11-15.12.)

  • Loppudemot
    • ti 12.12. klo 14-16 B123
    • to 14.12. klo 12-14 B123
  • Jokainen ryhmä osallistuu yhteen loppudemoon
  • Ei erillistä asiakaspalaveria

Toteutettava ohjelmisto

Ohjelman alustava kuvaus, tarkemmat yksityiskohdat kuulet asiakkaalta.

Tekniset ja prosessiin liittyvät vaatimukset

  • Ryhmä laatii yhdessä asiakkaan kanssa product backlogin
    • Vaatimukset kirjataan backlogiin user storyinä
  • 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
  • Koodi on talletettu GitHubiin
  • 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 tukee 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 sprintistä 2 alkaen Robot-frameworkin syntaksilla
    • hyvänä käytänteenä on laittaa README:stä linkki hyväksymäkriteerit määritteleviin tiedostoihin
  • Toteutetun koodin testikattavuuden tulee olla kohtuullinen
  • 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 (noudattaa pylintin avulla määriteltyjä sääntöjä)

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/

Vihjeitä ryhmätyöskentelyyn

Melko varma resepti epäonnistumiseen on huono kommunikaatio. Tehkää siis asioita mahdollisimman paljon yhdessä, mieluiten paikanpäällä tai jos se ei onnistu niin esim. Discordin voice chatissa. Ylipäänsä on hyvä kommunikoida ryhmälle mitä lähtee tekemään ja milloin on saanut sen valmiiksi, tällöin vältytään päällekkäisyyksiltä. Erityisesti projektin alkuvaiheessa esim. GitHub-actionsia konfiguroitaessa yhdessä tapahtuvaan työskentelyyn kannattaa panostaa. Projektin kuluessa omatoiminenkin työskentely muuttuu jo helpommaksi jos ja kun ryhmä on sopinut työskentelyn periaatteista ja pelisäännöistä.

Pariohjelmointi/konfigurointi on havaittu erittäin hyödylliseksi. Voikin olla hyvä idea, että jokaista user storyä työstää aina kaksi henkilöä.

Jokaiselle asialle, kuten vaikkapa README.md-tiedostolle, project backlogille ja sprint backlogille kannattanee nimetä joku vastuuhenkilö joka varmistaa, että ryhmä hoitaa asian. Asian X vastuuhenkilö ei välttämättä siis tee asiaa itse, vaan varmistaa että se tulee tehdyksi.

Pitäkää ohjelma koko ajan toimintakykyisenä. On erittäin huono idea koittaa saada viikon aikana eri ihmisten koodaamat tuotokset integroitua tunti ennen asiakaspalaveria…

Teknologisia vihjeitä

  • Kokonaan uusien teknologioiden opettelu miniprojektin yhteydessä ei ole järkevää
  • Mahdollisten ulkoisten kirjastojen käyttöönotto, testien tekeminen ja CI:n konfigurointi tulee viemään ainakin alussa todella paljon aikaa
  • Komentoriviltä toimiva sovellus on teknologioiden suhteen riskittömin vaihtoehto
    • HUOM: Komentoriviltä toimivat sovellukset on syytä tehdä siten, että niiden IO-operaatiot eli tulostaminen ja syötteen lukeminen on eriytetty omaan injektoitavaan luokkaan viikon 1 laskareissa käsitellyn riippuvuuksien injektointi -esimerkin tapaan. Jos näin ei toimita tulee sprintistä 2 alkaen tehtävä käyttöliittymän läpi tapahtuva testaus olemaan erittäin haastavaa
  • Web-pohjaiselle sovellukselle voi ottaa mallia kurssin esimerkkisovelluksesta
  • Jos haluatte käyttää tietokantaa, on Tikapestakin tuttu SQLite hyvä vaihtoehto
    • SQLiten käyttöön Pythonilla löytyy ohjeita ainakin Ohjelmistotekniikka-kurssin materiaalista
    • Ohjelmistotekniikka-kurssin todo-sovellus on esimerkkisovellus SQLiten tietokannan käytöstä Python-projektissa
    • Huomaa, että jos tarkoituksena on julkaista sovellus jossain pilvipalvelussa, SQLiteä parempi vaihtoehto on PostgreSQL. Mallia PostgreSQL:n käyttöön Python-sovelluksessa voi ottaa esimerkiksi seuraavasta tälle kurssille tehdystä esimerkkisovelluksesta
  • Viikon 3 laskareista kannattaa ottaa mallia Robot Frameworkilla tapahtuvaan storyjen testaamiseen (vaaditaan sprintistä 2 alkaen)
  • Pythonin Tkinter-kirjastolla tehtyjen käyttöliittymien automatisoitu testaaminen on täysi mysteeri, sen takia kannattaanee välttää kirjaston käyttöä

Työn arvostelu

Arvosteluperusteet löytyvät täältä