Osan 6 etapit
  • Toiminnallisuuden täydentäminen
  • Ulkoasun, käytettävyyden ja toiminnallisuuden viilausta
  • Tarvittaessa päivitä jo tehtyjä dokumentaation osia
  • Aloita puuttuvan dokumentaation kirjoittaminen
  • Koodikatselmointi

Osassa 6 viet omaa sovellustasi eteenpäin ja tarkastelet myös muiden töitä katselmoinnissa. Tässä osassa päivitetään myös alustavan tietokantakaavio sekä käyttötapaukset vastaamaan sovelluksen tilaa. Käyttötapauksissa voi käyttötapauskohtaisesti ilmoittaa niiden tilan, eli onko käyttötapaus jo toteutettu vai onko se vielä toteuttamatta. Suurimman osan pitäisi tässä kohtaa kuitenkin olla jo toteutettuna. Erityisen vahva paino on myös dokumentaatiolla, jonka viimeistelystä lisää alla.

Dokumentaatio

Kertauksena johdannosta hieman tarkennettuna dokumentaation vaatimuksia, jotta työn saattaminen ajantasalle on helpompaa. Huomaathan, että alla olevat asiat on jo esitelty kurssin aikana, joten oletettavasti suurin osa on jo tehtynä. Tarkasta kuitenkin dokumentaatiosi ajantasaisuus.

Dokumentaation yleinen sisältö, eli mitä kaikkea oletetaan dokumentaatiosta löytyvän:

  • Aiheen kuvaus:
    • README.md -tiedostossa ohjelmiston yleiskuvaus, josta selviää GitHub-repositoriotasi tarkastelevalle helposti, mistä työssä on kyse.
  • Sovelluksen käyttöohje:
    • Miten sovellus toimii?
    • Mistä voi kirjautua, rekisteröityä?
    • Miten perustoiminnot tehdään?
  • Sovelluksen asennusohje:
    • Mitä erilaisia konfiguraatioita tai muuttujia tarvitsee asettaa, jotta sovelluksen voi saada pyörimään paikallisesti?
    • Entä mitä tarvitsee tehdä, jotta sovelluksen saa toimimaan pilvessä, kuten Herokussa?
  • Työn ja sovelluksen rajoitteet, puuttuvat ominaisuudet:
    • Kurssin aikana ei välttämättä ehdi tehdä kaikkia toiminnallisuuksia mitä haluaisi. Jatkokehitysideat ja puuttuvat ominaisuudet (pois lukien käyttötapaukset) kannattaa siirtää omaksi osuudekseen dokumentaatiossa ennen loppupalautusta, jotta työstä selkeästi näkee mitä on olemassa ja mitä vielä voisi tehdä.
  • Käyttötapaukset / user storyt ja niihin liittyvät SQL-kyselyt:
    • Vaikka SQLalchemy tekee suurimman osan kyselyistä puolestasi, pitää sinunkin tietää ja ymmärtää, mitä kyselyitä todellisuudessa tietokannasta kysytään. Jokaista käyttötapausta vastaa yksi tietokantakysely. Jos et ole vielä tehnyt, lisää dokumentaatiossasi käyttötapauksiin niihin liittyvät kyselyt.Jos jokin käyttötapaus jää toteuttamatta, merkitse siitä tieto dokumentaatioosi.
  • Tietokantarakenteen kuvaus:
    • Tietokannan tulee olla normalisoitu, tai normalisoinnin puute perusteltu ja dokumentoitu.
    • Loppupalautuksessa tietokannasta tulee olla tietokantakaavio, joka vastaa sovelluksen todellista tietokantaa. Dokumentaatiossa voi olla lisäksi suunnitelma laajemmasta tietokantakaaviosta, mutta merkitse hyvin, mikä kaavio vastaa todellisuutta ja mikä on suunnitelma.
    • Lisäksi dokumentaatiossa tulee olla CREATE TABLE-lauseet tietokannasta.
  • Dokumentaation vastaavuus toteutettuun työhön:
    • Dokumentaatiota on muokattu pitkin kurssia, ja sen pitäisi lopulta vastata sovelluksen todellista tilaa kaikilta osin.

Sisällysluettelo