Katselmointiraportti:

 

Aika: 2.4.2004  klo 09:00 Xetor-projektin 9. palaverin yhteydessä

Paikka:  sovellusprojektien kokoustila AgC223.1

Katselmoitava dokumentti: sovellussuunnitelma

Dokumentin versio: 0.4

 

Katselmointiin osallistuneet:

Hilkka Heikkilä

Kari Kärkkäinen                                                                                                                                                          

Tommi Lahtonen                                                                                                                                                            

Jani Lirkki                                                                                                                                                         

Olavi Paananen  (puheenjohtaja)                                                                                                                                                          

Raimo Pitkänen (sihteeri)                                                                                                                                                            

Jussi Räisänen

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.

Kohta

Virhe

Luokka

Korjausehdotus

Kaikkialla

Virheellinen tavutus

C

Laitetaan tavutus kuntoon.

Kaikkialla

Komennot eivät erotu tekstistä

C

Komennot kirjoitetaan koodikirjasimella.

Kaikkialla

Joidenkin kuvatekstien lopusta puuttuu piste

C

Lisätään pisteet kuvateksteihin.

Sisällysluettelo

Liitteet puuttuu

C

Lisätään liitteet sisällysluetteloon.

Sisällysluettelo

Lähteet -kohdassa sivunumero väärin

C

Korjataan sivunumero.

Johdanto

Maininta yhteenvedosta ja liitteistä puuttuu

C

Lisätään maininta.

Termit

UTF 8: kohta huonosti muotoiltu

C

Lisätään, että se on vaihtelevan pituinen merkistön koodaustapa.

Termit

XPath puuttuu termeistä

C

XPath lisätään termiluetteloon.

Termit

Termit puunäkymä ja tekstinäkymä ovat puutteellisia

C

Englanninkielinen nimi lisätään kyseisille termeille.

Termit

Ominaisuuseditori puuttuu termiluettelosta

C

Lisätään ominaisuuseditorin termiluetteloon.

Termit

Termiluettelosta puuttuu termi png

C

Lisätään termi luetteloon.

Luku 3.1

Luokkien nimillä väärä kirjasintyyppi

C

Luokkien nimet kirjoitetaan koodikirjasimella.

Luku 3.1

Teksti huonosti muotoiltu

C

Muutetaan teksti muotoon:  ”JDom.Document –oliolla voi käsitellä vain rakenteisia dokumentteja, mutta sovelluksella pitää pystyä käsittelemään dokumentteja riippumatta siitä, ovatko ne rakenteisia.”

Luku 3.2

Puute luokkakaaviossa ja tekstissä

C

Lisätään lukuun 3.2 selitys luokkakaavion kerroksista.

Luku 3.2

Puute kuvatekstissä

C

Muutetaan kuvatekstiksi UML-luokkakaavio.

Luku 3.3.2

EIWrapper-luokan kuvauksessa puute

C

Korjataan tekstistä seuraavat kohdat: …elementin attribuutteja… à …elementin attribuuttien arvoja…

…kaikki attribuutit… à …kaikkien attribuuttien nimet ja arvot…

Luku 3.3.2

UndoManager-luokan kuvauksessa puute

C

Lisätään maininta, että luokka sisältyy javan standardikirjastoihin.

Luku 3.3.3

PlainDocument-kohdan määrityksessä virhe

C

Kirjoitetaan javax.swing.text koodikirjasimella.

Luku 4.3.1

Virheellinen viite

C

Viite korjataan.

Luku 4.3.1

Tallenna-komennon kuvauksessa kaksi kirjoitusvirhettä

C

talletettu à tallennettu

talletettaessa à tallennettaessa

Luku 4.3.1

Tallenna nimellä –kohdassa käytetty väärää kieltä

C

Save as muutetaan suomenkieliseen muotoon.

Luku 4.3.1

Tallenna kaikki –kohdassa käytetty väärää kieltä

C

Save all ja Save muutetaan suomenkieliseen muotoon.

Luku 4.3.1

Esikatselu kohdassa huonosti muotoiltu lause

C

Korjataan lause muotoon: ”…katsella mahdollisen tulostuksen ulkoasua.”

Luku 4.3.2

Kohdassa Toista väärä kieli

C

Undo muutetaan sanaksi Kumoa.

Luku 4.3.2

Kohdassa Liitä väärä kieli

C

Paste muutettava sanaksi Liitä.

Luku 4.3.2

Kohdassa etsi väärä sanavalinta

C

Korvataan kohta …merkkijono mustataan…à …löydetty merkkijono korostetaan…

Luku 4.3.2

Kohdasta Etsi puuttuu maininta XPathista

B

Lisätään maininta.

Luku 4.3.2

Kohdassa Etsi ja korvaa virheellinen merkintä

C

Muutetaan sulut suomenkielisen termin ympäriltä englanninkielisen termin ympärille.

Luku 4.3.2

Kohdasta Etsi ja korvaa puuttuu maininta XPathista

B

Lisätään maininta.

Luku 4.3.2

Kuva 4.7 puutteellinen

B

Lisätään kenttä Xpath –lausekkeelle ja valintaruutu sen aktivoimiseksi.

Luku 4.3.2

Kuvan 4.7 area –kohta puutteellinen

C

Lisättävä From cursor –valinta ja sana document korvattava tekstillä whole document. Sana area korvattava sanalla scope.

Luku 4.3.2

Kuva 4.7 puutteellinen

C

Lisätään painikkeet Replace, Replace all ja Cancel.

Luku 4.3.2

Kohdassa Yleiset asetukset kohdassa ylimääräinen valinta

C

Kielen valinta otettava pois ja lisättävä johonkin valikoista.

Luku 4.3.2

Kohdassa Käytettävä merkistö puute

C

Lisätään listaus siitä, mitä merkistöjä on käytössä.

Luku 4.3.2

Kohdasta Värit puutteita

C

Lisätään kohtaan maininta siitä, että värit voi valita standardidialogilla. Lauseen loppuun lisätään kaksoispiste.

Luku 4.3.2

Kohta Elementtien värit ylimääräinen

C

Kohta poistetaan.

Luku 4.3.2

Kohdassa Kirjasimet on puute

C

Lisättävä maininta siitä, että kirjasimet valitaan vakiodialogilla.

Luku 4.3.3

Valikon nimi virheellinen, puute valikon kohdassa

C

Muutetaan valikon nimeksi Add ja muutetaan kohta Document type muotoon DTD. Lisäksi muutetaan kaikki Document –sanat Add sanoiksi ja Dokumentti-sanat Lisää-sanoiksi.

Luku 4.3.3

Kohdassa Dokumenttityyppi väärä kieli tekstikappaleen termissä

C

Muutetaan Document type sanaksi Dokumenttityyppi

Luku 4.3.5

Kuvassa 4.10 virhe

C

Pikanäppäimet korjataan oikeiksi.

 Luku 4.3.6

Kirjoitusvirhe kohdissa Limitä, Järjestä leveyssuunnassa ja Järjestä pystysuunnassa

C

Muutetaan termi ”tiedosto” termiksi ”näkymäikkuna”.

Luku 4.3.7

Kirjoitus- ja asiavirhe kohdassa Näppäinkomennot

B

Sana Mappings muutetaan sanaksi Shortcuts. Muutetaan selitys muotoon: ”Käyttäjä voi listata käytössä olevat pikanäppäimet.”

Luku 4.4

Virheellinen sana

C

Korvataan sana ”pikanäppäimet” sanalla ”pikavalinnat”.

Luku 4.5

Kohta huonosti muotoiltu

C

Poistetaan alemmasta kappaleesta lause ”Jos puusta on valittu…” ja yhdistetään kappaleet

Luku 4.5.2

Väärä kieli viimeisessä kappaleessa

C

Korvataan sana ”preferences” sanalla ”asetukset”.

Luku 4.5.3

Väärä sanamuoto listassa

C

Muotoiltava lista lausemuotoon.

Luku 4.5.3

Väärä sanajärjestys listan alkiossa

C

Muutettava muotoon ”näppäinyhdistelmällä Ctrl+C”.

Luku 4.6.1

Kohta Lisääminen avustetusti virheellisesti kuvattu

C

Lisättävä maininta, että kyseessä on oltava XML dokumentti ja että käyttäjän on odotettava pieni hetki, ennen kuin avusteinen lisääminen alkaa.

Luku 4.10

Kirjoitusvirhe

C

Muutetaan taulukkoa edeltävä lause muotoon: ”Taulukossa 4.10 on listattu tekstejä…”

Luku 4.11

Virheellinen pikanäppäinyhdistelmä ja kirjoitusvirhe

C

Muutettava Ctrl+R Ctrl+H:ksi. Sana ”Elementtieditori” korvataan sanalla ”Ominaisuuseditori”

Luku 5.1

Väärä muotoilu

C

Korvataan: CVS palveluun à CVS versiohistoriaan.

Luku 5.2

Taulukon 5.2 sarakkeissa Alkukirjain ja Esimerkki väärä kirjasin

C

Muutetaan koodikirjasimeksi.

Luku 5.3

Virhe koodiesimerkissä

C

Korjattava TempString alkamaan pienellä.

Luku 6.1

Sanamuodossa virhe

C

Muutettava sana ”testaussuunnitelma” sanaksi ”testaussuunnitelmassa”.

Luku 7.1

Viimeinen lause puutteellinen

C

Korvataan viimeiseen lauseeseen seuraavat dokumenttityypit: XHTML 1.0 Strict, XHTML Basic, XHTML 1.1

Luku 7.2 ja 7.3.2

Puute ja virhe tekstissä

C

Tiedoston nimi lisätään esimerkkikoodiin ja poistetaan XML-määritys.

Kuva 8.14

Kuva virheellinen

C

Korjataan valikot oikeaan muotoon.