Katselmointiraportti:

 

Aika: 5.3.2004  klo 10:00 Xetor-projektin 5. palaverin yhteydessä

Paikka:  sovellusprojektien kokoustila AgC223.1

Katselmoitava dokumentti: vaatimusmäärittely

Dokumentin versio: 0.3

 

Katselmointiin osallistuneet:

Kari Kärkkäinen                                                                                                                                                           

Tommi Lahtonen                                                                                                                                                            

Jani Lirkki          (sihteeri)                                                                                                                                               

Olavi Paananen  (puheenjohtaja)                                                                                                                                                           

Perttu Poikonen

Raimo Pitkänen                                                                                                                                                            

Jussi Räisänen    (sihteeri)                                                                                                                                                      

Olli Tietäväinen

 

Virheiden luokat:

A = Vakava virhe tai puute. Dokumentti joudutaan katselmoimaan uudestaan.

B = Suuri virhe tai puute. Projektipäällikkö tarkistaa korjauksen.

C = Vähäinen virhe.  Esitystavassa korjattavaa, esimerkiksi huono sanamuoto, epäselvä esitystapa, pieni suunnitteluvirhe, tms. Projektipäällikkö tarkistaa korjauksen. 

 

Katselmoitava dokumentti hyväksytään seuraavin korjauksin.

     

(sivu/luku)

Virhe

Luokka

Korjaus

kaikkialla

kappaleväli liian pieni

c

isommaksi

kaikkialla

riviväli liian pieni

c

isommaksi

kansilehti

versio pienellä

c

versio kirjoitetaan isolla ja

korjattu version on 1.0

1

pno kirjoitetaan kokonaan

c

puhelinnumero

1

tiivistelmä ei kuvaa tätä dokumenttia

c

kirjoitetaan tätä dokumenttia kuvaava tiivistelmä

1

vuodet puuttuvat päivämääristä ja kolmosesta puuttuu piste

c

nämä lisätään

1

kaikkia dokumentin tekoon osallistuneita ei ole mainittu

c

kaikki tekijät mainitaan dokumenteissa lyhenteillä

johdanto

jossa

c

jolla

johdanto

kurssin nimi kirjoitettu väärin

c

isolla, väliviiva

johdanto

huonosti muotoiltu lause

”määritellään… määritellään”

c

”…tässä dokumentissa esitetään tilaajien kanssa määritetyt…”

johdanto

sana ”luvussa” puuttuu

c

”luvussa” lisätään

termit

sidostekstiin kuvaus, jossa selvitetään termien jakoa kahteen kappaleeseen

c

termit  on jaettu yleisiin ja XML-editoriin liittyviin termeihin

termit

termejä väärässä kappaleessa

c

DOM, java, javapavut ja Jaxp ja jDk ja jre siirretään yleisiin termeihin

termit

termit xml-dokumentti, tekstinäkymä, esikatselunäkymä, leikepöytä puuttuvat

c

lisätään XML-editoriin liittyviin käsitteisiin

termit

2.1 ja 2.2 alla turha lause

c

poistetaan

termit

attribuutti: huonosti muotoiltu

c

määre->ominaisuus

termit

spesifikaatio väärinkirjoitettu

c

korjataan

termit

lähdeviittaukset puuttuvat termeistä

c

lähdeviittaukset lisätään termeihin ja poistetaan muualta

termit

selaimella huono selitys

c

vaihdetaan IT-sanakirjan selitykseen

termit

englanninkielisiä sanoja ei ole kursivoitu

c

kursivoidaan(cascading style sheets, extensible markup language,…)

termit

tekstidokumentti puuttuu termeistä

c

puuttuva termi lisätään ja selitys termille otetaan IT-kirjasta

termit

merkistöt puuttuvat termeistä

c

lisätään termeihin UTF-8 ja ISO8859-1

termit

XML-prosessointiohjeet puuttuvat termeistä

c

puuttuva termi lisätään

termit

virhealue puuttuu termeistä

c

puuttuva termi lisätään

termit

validointi puuttuu termeistä

c

Mikäli dokumentti on hyvin muodostettu, tarkistetaan onko se dtd:n mukainen

termit

CSS-ominaisuus puuttuu termeistä

c

puuttuva termi lisätään

termit

CSS-valitsin (selectorit) puuttuu termeistä

c

puuttuva termi lisätään sekä siitä viittaus css-spesifikaatioon

3

otsikko huono

c

otsikoksi käyttöliittymän yleiskuvaus

3

rakennemuutos: poistetaan kaikki ennen käyttöliittymää

b

rakennetta muutetaan

3

ristiriita attribuuttien näyttämisessä vaatimuksen kanssa

c

korjataan: ”attribuutit voi näyttää myös puunäkymässä”

3

vahvennetulla kirjasimella

c

muutetaan korostettuna

 

Kappale 3.3 turha

c

poistetaan

4

”Jokaiselle vaatimukselle on annettu järjestysnumero ja prototyypin numero kertoo, mihin prototyyppiin kyseinen vaatimus on kaavailtu”

c

”Jokaiselle vaatimukselle on annettu yksilöllinen numero ja prioriteetin  numero.”

4.1

V1 huonosti muotoiltu

c

Lukea tekstidokumenttia

4.1

V2 huonosti muotoiltu

c

Muokata tekstidokumenttia

4.1

V3 huonosti muotoiltu

c

Tallentaa tekstidokumentti

4.1

epäolennaisia vaatimuksia

c

V4 ja V5 poistetaan

4.2

pilkku virheitä seuraavissa vaatimuksissa V10, V11, V14, V15

c

pilkut lisätään käytössä-sanan jälkeen

4.4

vaatimus puuttuu

b

lisätään teknisiin vaatimuksiin JRE ja sen versio

4.2

V18:ssa huono sanajärjestys

c

Käyttäjä voi määrittää pikanäppäimiä elementtien lisäykselle puuhun

4.2

V21 huonosti muotoiltu

c

Sovelluksella voi tulostaa puunäkymän kokonaisuudessaan tai osittain

4.2

V19 huonosti muotoiltu ja pilkkuvirhe

c

”Dokumenttia ei voi muokata puunäkymän kautta, mikäli validointi epäonnistuu”

4.2

V20 huonosti muotoiltu

c

”Puunäkymässä näytetään virhekohta tekstinäkymässä suoritetun validoinnin epäonnistuessa”

4.2

vaatimus puuttuu

b

lisätään vaatimuksiin ”Puunäkymä ehdottaa DTD:n mukaisia mahdollisia lisättäviä elementtejä.”

4.2

V23 huonosti muotoiltu

c

Tekstinäkymä esittää XML-dokumentissa elementit, attribuutit, attribuuttien arvot, elementtien arvot, prosessointiohjeet ja elementtien tekstisisällön eri väreillä.

4.2

vaatimus puuttuu

b

lisätään vaatimus: esitetään myös php-, dtd-, css- ja html-dokumentit väreillä eroteltuina

4.2

V24 huonosti muotoiltu

c

Käyttäjä voi valita lisättävän elementin DTD:n mukaiselta listalta.

4.2

V25 huonosti muotoiltu

c

Tekstinäkymään voi liittää leikepöydältä tekstiä.

4.2

V26 huonosti muotoiltu

c

Dokumentista voi tarkistaa onko se hyvin muodostettu ja dtd:n mukainen.

4.2

turha vaatimus

c

V28 poistetaan

4.2

vaatimus puuttuu

b

Virheellisten rivien rivinumerot korostetaan(3)

4.2

V29 pilkkuvirhe(epäonnistuu,)

c

korjataan

4.2

V33 huonosti muotoiltu

c

Virheilmoituksesta on linkki virheelliselle riville.

4.2

V34 huonosti muotoiltu

c

tietyn -> määritellyn

4.2

V37 huonosti muotoiltu(mm. Word wrap on selittämättä)

c

Tekstieditorissa on automaattinen rivitys, joka on mahdollista kytkeä päälle tai pois

4.2

V40 huonosti muotoiltu

c

”elementin kaikki mahdolliset attribuutit”

4.2

turha vaatimus

c

V43 poistetaan

4.2

V44 huonosti muotoiltu

c

Kaikki puussa valitun -> Valitun

4.2

V45 huonosti muotoiltu

c

aktiivisen -> valitun

4.2

V46 huonosti muotoiltu

c

aktiiviselle -> valitulle

4.2

V47 huonosti muotoiltu

c

CSS-ominaisuudet ryhmitellään css-valitsimien mukaan

4.2

V13, V14, V18 väärässä prototyypissä

c

Siirretään 2:sta 3:en

4.3

V48 huonosti  muotoiltu

c

Ohjelma osaa tallentaa käyttöliittymän tilan lopetettaessa (3)

4.3

V50 huonosti muotoiltu

c

”Puun tai sen osan voi kopioida leikepöydälle kuvana (3).” tämä vaatimus siirretään puunäkymän vaatimuksiin

4.3

V53 huonosti muotoiltu

c

Eri näkymien kirjasimia, kirjasinten kokoa ja niiden väriä pystyy muuttamaan.

4.3

vaatimus puuttuu

b

lisätään vaatimuksiin ”Käsiteltävä dokumentti tai dokumentin tallennuspaikka voidaan antaa syötteenä ulkoiselle ohjelmalle.”

4.3

vaatimus puuttuu

b

”Sovelluksessa on Undo/redo-toiminto.”

4.3

V57lisäys

 

, jotka sijaitsevat omassa hakemistossaan.

4.3

V60 huonosti muotoiltu

c

lisätään ”Attribuuttien sisällölle”

4.3

vaatimus puuttuu

c

lisätään vaatimus "CSS-ominaisuuksiin voi lisätä uuden CSS-valitsimen, sekä uuden CSS-arvon."

4.3

V58 huonosti muotoiltu

c

Lisätään ”on”, muutetaan välimuisti->lokaalille koneelle.

4.4

V61 huonosti muotoiltu

c

Tarvitaan JRE(versio), ei puhuta pc:stä.

4.4

V62-64 huonosti muotoiltuja

c

yhdistetään laitteistovaatimukset yhdeksi vaatimukseksi

”Ohjelman ajamiseen riittää…”

4.4

V58 väärässä prototyypissä

c

Siirretään 3:sta 2:en

4.5

vaatimukset toistettu

c

vaatimuksesta merkitään vain numeroittain taulukkoon prototyypin mukaan(matriisiin)

5

ensimmäinen lause huonosti muotoiltu

c

Tässä luvussa esitellään XML-editorin käyttötapauksia seuraavien toimintojen osalta.

5.1.1

kuvaus huonosti muotoiltu

c

dialogi pois, Käyttäjältä kysytään haluaako hän avata jo olemassa olevan dokumentin.

5.1.1

jälkitilanne puuttuu

c

lisätään jälkitilanne, Ohjelma on käynnissä ja ohjelman käyttäminen voi alkaa.

5.1.2

kuvaus huonosti muotoiltu

c

Jos kysymyksessä on XML-dokumentti, sovellus muodostaa …

Jos tiedostotyyppi on joku muu, avataan se vaan tekstitiedostona.

Valitaan minkä tyyppinen tiedosto valitaan.

5.1.2

jälkitilanne puuttuu

c

lisätään jälkitilanne, Dokumentti on avoinna käytössä olevissa näkymissä.

5.1.3

kuvaus huonosti muotoiltu

c

tarkennetaan onko valittuna tietty alue, vai koko dokumentti ja

valitaan lisäksi mistä halutaan korvata

5.1.3

väärä poikkeus

c

vaihdetaan poikkeus, korvauksen jälkeen dokumentti on epävalidi, käyttäjän tulee korjata virheet tekstinäkymässä

5.2.1-3

jälkitilanne huonosti muotoiltu

c

lisätään tarkennus"…ja mitä on lisätty puunäkymään."

5.3.1

kuvauksessa pilkku- ja kirjoitusvirhe(takastetaan)

c

virheet korjataan

5.3.1

kuvaus huonosti muodostettu

c

kuvausta supistetaan

5.3.2

ehdoissa kuvaukseen kuuluvaa asiaa

c

Ehdoista siirretään asiaa kuvaukseen, kaikki ensimmäisestä lausetta lukuun ottamatta.

5.3.2

kuvaus huonosti muotoiltu

c

Attribuutit laitetaan tyhjiksi tai oletusarvoiksi

Lähteet

väärät päivämäärät

c

korjataan päivämäärät milloin lähdettä on käytetty

Lähteet

ulkoasua korjataan

c

www-osoitteet kooodikirjasemilla

 

 

HUOMIO: Suositusselain Internet Explorer