Teknillinen korkeakoulu Tik-76.601 Ohjelmistotuotannon perusopintojakso Review of Dokuments Henna Pietiläinen 45356D Ti Raportti löydetyistä virheistä 1. Johdanto Tässä raportissa käydään läpi dokumetista Requirements document for a parking garage control system löytyneet virheet. Tämä raportti on tarkoitus käydä läpi tarkistustilaisuudessa, jossa tilaisuuteen osallistuvat ovat kaikki lukeneet kyseisen dokumentin ja laatinneet oman raporttinsa löytämistään epäkohdista. Tarkistustilaisuudessa on tarkoitus käydä nämä raportit läpi yhdessä dokumentin kirjoittajan kanssa, keskustella löytyneistä virheistä kannustavassa hengessä, jonka jälkeen dokumenttiin voidaan tehdä tarvittavat muutokset. 2. Löydetyt virheet luokiteltuina Dokumentista löydetyt virheet on luokiteltu Mary Smithin ehdottamalla tavalla, eli seuraaviin kuuteen luokkaan: Moniselitteiset tiedot, asiaankuulumattomat tiedot, ristiriitaiset tiedot, väärät faktat, sekavat virheet, sekä puuttuvat tiedot. Jotta virhekohtien löytyminen dokumentista olisi mahdollisimman helppoa käytän tässä raportissa merkitsemistapaa, jossa ensin kerrotaan virheen numero, sitten sivunumero, josta virhekohta löytyy dokumentista, sen jälkeen kerron vielä kappaleen otsikon. 2.1 Moniselitteiset tiedot [1], s.1, Contents Otsikko 3.4 Attributes on mielestäni liian moniselitteinen otsikoksi. Koska se on sijoitettu otsikon 3. Requirements alaotsikoksi, pitäisi otsikko muuttaa sellaiseksi että se kuvaa enemmän vaatimuksia. Kyseessä on virhe jonka korjaaminen vaatii tiedon lisäämistä dokumenttiin. 2.2 Asiaankuulumattomat tiedot [14.], s.7, 2.2 Product Perspective Parkkihallin portteja kuvailtaessa kerrotaan että porttien tilan vaihtoon kuluu jonkinverran aikaa, mielestäni sen kertominen on tarpeetonta tässä yhteydessä. Kyseessä on virhe jonka korjaaminen vaatii tiedon poistamista dokumentista. 2.3 Ristiriitaiset tiedot [5.], s.3, 1.4 Definitions Termin Parking garage selityksessä käytetään varatuista parkkipaikoista kirjainta r, mutta kuvassa 2.1 käytetään varatuista parkkipaikoista lyhennettä res. Mielestäni kannattaisi käyttää molemmissa samaa merkitsemistapaa. Kyseessä on virhe jonka korjaaminen vaatii tiedon editoimista dokumentissa. [9.], s.6, 2.1 Overview Kohdassa Entry väitetään että näyttötaulu saisi arvon full, vaikka aiemmin on kerrottu että sillä on vain kaksi arvoa: free ja occupied. Kyseessä on virhe jonka korjaaminen vaatii tiedon editoimista dokumentissa. [10.], s.6 2.1 Overview Kohdassa Entry kerrotaan että ticket machine kirjoittaa ajan lippuun ja kohdassa Payment for drivers without a reserved parking space kerrotaan että cashier kirjoittaa ajan lippuun. Tässä koko kappaleessa jää epäselväksi se milloin aika merkitään lippuun ja miten ja milloin parkkimaksu maksetaan. Kyseessä on virhe jonka korjaaminen vaatii tiedon editoimista dokumentissa. [15.], s.7, 2.2. Product Perspective Sivun alalaidassa kerrotaan miten tilanäytöllä on kaksi arvoa: full ja available kun taas aikaisemmin on kerrottu arvojen olevan: free ja occupied. Kyseessä on virhe jonka korjaaminen vaatii tiedon editoimista dokumentissa. 2.4 Väärät faktat 2.5 Sekavat virheet [12.], s.7, 2.1 Overview Kohdassa Change occupied status, kohdassa 2 mainitaan r -arvo, jota ei ole aikaisemmin tässä kappaleessa määritelty. Mielestäni siinä pitäisi selittää mitä tuo r tarkoittaa. Kyseessä on virhe jonka korjaaminen vaatii tiedon lisäämistä dokumenttiin. [17.], s.8, 2.3 Product Functions Listan viimeisessä kohdassa mainitaan k, jota ei ole määritelty. Mielestäni tuo k pitäisi määritellä tarkemmin. Kyseessä on virhe jonka korjaaminen vaatii tiedon lisäämistä dokumenttiin. 2.6 Puuttuvat tiedot [2], s.2, 1.2 Scope Tässä kappaleessa voitaisiin mielestäni kuvata toteutettavaa järjestelmää tarkemmin. Olisi mukavaa jos jo tässä vaiheessa muodostuisi kokonaiskuva siitä minkälaista järjestelmää loppudokumentissa esitellään. Kyseessä on virhe jonka korjaaminen vaatii tiedon lisäämistä dokumenttiin. [3.], s.2, 1.3 Overview Tässä kappaleessa esitellään mitä kaikkea dokumentti pitää sisällään, mutta siinä on kokonaan unohdettu mainita ja esitellä kappaleen 3. Requirements alakohta Attributes. Kyseessä on virhe jonka korjaaminen vaatii tiedon lisäämistä dokumenttiin. [4.], s.3, 1.4 Definitions Termin Parking garage selityksessä ei kerrota mitään kuvassa 2.1 olevasta cashier-neliöstä. Koska kuvan kaikki muut kohdat on selitetty, pitäisi mielestäni kertoa mikä tuo cashierkin on. Kyseessä on virhe jonka korjaaminen vaatii tiedon lisäämistä dokumenttiin. [6.], s.3, 1.4 Definitions Termin Entrance selityksestä puuttuu kokonaan selitys siitä mikä on induction loop ja mitä käyttöä sillä on sisäänkäynnissä. Kyseessä on virhe jonka korjaaminen vaatii tiedon lisäämistä dokumenttiin. [7.], s.3, 1.4 Definitions Termin Entrance selityksessä ei kerrota miten täsmällisesti näyttötaulu ilmoittaa onko parkkihallissa vielä paikkoja vapaana. Kuvassa 2.2 kuvasta sen voi kuitenkin päätellä, mutta mielestäni olisi selkeää kertoa se myös tekstissä. Kyseessä on virhe jonka korjaaminen vaatii tiedon lisäämistä dokumenttiin. [8.], s.5, 1.4 Definitions Termin Control Unit selityksessä voitaisiin mielestäni kuvailla tarkemmin mihin control unitia käytetään ja mitä niillä kolmella erikoisnappulalla (total, reserved ja enter) nappuloilla tehdään. Kyseessä on virhe jonka korjaaminen vaatii tiedon lisäämistä dokumenttiin. [11.], s.7, 2.1 Overview Kohdassa Change occupied status kohdassa 1 puhutaan siitä, miten järjestelmää voidaan testata syöttämällä varattujen paikkojen lukumääriä laitteeseen. Kohdassa ei kuitenkaan kerrota mistä laitteesta on kyse. Kyseessä on virhe jonka korjaaminen vaatii tiedon lisäämistä dokumenttiin. [13.], s.7, 2.2 Product Perspective Heti kappaleen alussa kerrotaan järjestelmän olevan embedded system, mutta ei kuitenkaan kerrota mitä se tarkoittaa. Kyseessä on virhe jonka korjaaminen vaatii tiedon lisäämistä dokumenttiin. [16.], s.8, 2.3 Product Functions Heti kappaleen alussa luetellaan mitä kaikkia laitteita järjestelmä kontrolloi. Listasta on kuitenkin unohtunut pois induction loop ja control unit. Kyseessä on virhe jonka korjaaminen vaatii tiedon lisäämistä dokumenttiin. [18.], s.8, 2.4 User Characteristics Eikö käyttäjille tosiaankaan järjestetä edes minkäänlaisia opasteita? Kyseessä on virhe jonka korjaaminen vaatii tiedon lisäämistä dokumenttiin. [19.], s.15, 3.2.1 User Interfaces Mielestäni tilanäyttötaulu pitää myös lisätä tämän otsikon alle. Kyseessä on virhe jonka korjaaminen vaatii tiedon lisäämistä dokumenttiin.