Projektityö 31.3.2006 Ylläpito-ohje Käyttöohje Loppuraportti - Projektikertomus - loppuraporttin tiivistelmä Projekti CD Kevään henkilökohtainen raportti Projektiesitykset 17.5 Ryhmien palautekeskustelut Lähteinä: Haikala ja Märijärvi, Ohjelmistotuotanto, Talentum, 2005. Harsu: Ohjelmistojen ylläpito ja uudistaminen. Kalvot: Timo Poranen (tp@cs.uta.fi). 1
Ohjelmistojen ylläpito 1/2 Ylläpito on asiakkaan ongelmien ratkomista, virheiden korjaamista, ohjelman muuttamista vaatimusten muuttuessa sekä uusien piirteiden lisäämistä. Voidaan jakaa korjaavaan, adaptiiviseen ja täydentävään ylläpitoon. Korjaavassa ylläpidossa korjataan virheitä. Adaptiivisessa ylläpidossa muutetaan ohjelmaa, koska ympäristön vaatimukset ovat muuttuneet. Täydentävässä parannellaan ohjelmaa muuttamalla tai lisäämällä sen toiminnallisuutta. 2
Ohjelmistojen ylläpito 2/2 Ohjelmistotuoteprojekteissa ei useinkaan ole erillistä ylläpitovaihetta vaan korjaukset, muutokset ja lisäykset toteutetaan seuraavan version projektissa. Asiakasprojekteissa taas käyttöönotto ja ylläpidon organisointi ovat erittäin tärkeitä ja keskeisiä vaiheita. Elinkaarikustannuksilla tarkoitetaan ohjelmiston kehitystyön ja ylläpidon kustannuksia sen kehittämisen aloittamisesta käytöstä poistamiseen asti. Ylläpidon kustannukset ovat keskimäärin 67% elinkaarikustannuksista! Kirjallisuutta: Pigoski, T.M.: Practical Software Maintenance. John Wiley & Sons, 1996. 3
Ylläpito-ohje Miksi? Käytännössä jokaisessa oikeassa projektissa tehdään ylläpitoa. Ylläpitäjä yleensä eri henkilö kuin toteuttaja. Ylläpito-ohjeen sisältö riippuu erittäin paljon kyseessä olevasta sovelluksesta. Asioiden käsittelytapa ja tyyli riippuu dokumentin kohderyhmästä (onko muita projektin dokumentteja käytössä, toinen ryhmä firman sisältä, toinen yritys, loppukäyttäjä,...). Tarkkuus sillä tasolla, että ulkopuolinen osaa tehdä pieniä lisäyksiä tai korjauksia ohjelmaan. Annetaan yleensä asiakasyrityksen ylläpitäjälle, ei loppukäyttäjälle. 4
Ylläpito-ohjeen sisältö http://www.cs.tut.fi/~projekti/dokumentit/ ylla-sisalto.txt Saa muokata tarpeen mukaan. Kuvataan toteutusfilosofia, ohjelman rakenne (luokka / moduulikaavio), ohjelman ja moduulien rajapinnat, make-tiedostot, konfigurointitiedostot, ohjelmiston fyysinen sijainti... Suosittelen lukua, jossa käydään läpi yleisimpiä ylläpitotilanteita, ja annetaan ohjeet toimimiseen. Esim. Kuinka muokkaan dialogien tekstiä, kuinka vaihdan väriä, kuinka lisään tietokantaan manuaalisesti 100 asiakasta... 5
Käyttöohje 1/3 Ei pakollinen kaikissa projekteissa, mutta useimpiin tulee vähintään tooltip tasoinen ohjeistus ja online helpit. Lähtökohta: Käyttöohje on olennainen osa (kaupallista) tuotetta ja käyttöohjeen laatu on osa tuotteen laatua. Vaikka käyttäjä olisi huippuasiantuntija tulee hänellekin usein tarve tarkistaa asioita ja etsiä kuinka jokin harvinaisempi toiminto tehdään. Hyvä käyttöohje opastaa oikeaan, turvalliseen, tehokkaaseen ja miellyttävään käyttöön. Ehkäisee vaaratilanteisiin johtavaa väärinkäyttöä! 6
Käyttöohje 2/3 Mikä on lukijakunta? Paljonko käyttökokemusta? Mitä asioita eri käyttäjäryhmien tarvitsee tietää? Usein eri käyttäjäryhmille tehdään omat dokumentit (noviisit vs. ammattilaiset). Yleensä ohjeessa on: Perustiedot ohjelman ymmärtämiseen. Laitteistovaatimukset. Vianmääritys. Selvitetään ohjelman käyttötarkoitus. Kerrotaan, kuinka ohjelmaa käytetään. Paljon esimerkkejä ja näyttökuvia. Usein hakemisto, josta löytää nopeasti oikean kohdan. Voi sisältää sanaston. Pikaohje. Sisällysluettelo. 7
Käyttöohje 3/3 Isoissa projekteissa käyttöohjeen laativat teknisen viestinnän ammattilaiset. IEEE Std 1063-2001 IEEE Standard for Software User Documentation. ISO/IEC 18019: Guidelines for the design and preparation of software user documentation. Pohja käyttöohjeelle: http://www.cs.tut.fi/~projekti/ dokumentit/kayt-sisalto.txt Suvi Melakoski-Vistbacka (TUTUT), ohjeita käyttöohjeen kirjoittamiseen: http://www.cs.tut.fi/~projekti/ dokumentit/sunnumv_kayttoohje2005.pdf. TUKES:in ohjeita käyttöohjeen laadintaan: http://www.tukes.fi/kayttoohjeopas.html 8
Loppuraportti 1/2 Loppuraportti kuvaa projektin johtamisen (hallinnon) ja projektin tekemän työn. Kertoo mitä kokemuksia projektista on saatu. Kuvaa projektin heikkoudet ja vahvuudet. Antaa näkökulmia muille, lukijoina usein (saman firman) projektipäällikköitä, yrityksen muut työntekijät, asiakkaan edustaja, yrityksen johto, kurssin luennoitsija... Antaa myös muille projekteille käsityksen siitä, mitä on tehty. 9
Loppuraportti 2/2 Ryhmä tekee yhdessä! Pohjana: http: //www.cs.tut.fi/~projekti/dokumentit/loprap-sis.txt. Paitsi seuraavat muutokset: Lisäys lukuun 7. kuinka toimititte lopputuotteen asiakkaalle, teittekö testausta yhdessä,... Lukuun 11: Kappale: 11.5 Projektityötä edeltävät kurssit (kuinka laitoksen muut kurssit sopivat yhteen projektityön kanssa, mitä asioita jäit kaipaamaan, mikä on ollut täysin hyödytöntä,...). Lukuun 11: Kappale: 11.6 Käytettävyys ohjelmistoprojekteissa (kerro ryhmäsi kokemuksia tämän vuotiseen käytettävyysryhmäkokeiluun. Toiveita tuleville kursseille). 10
Loppuraportin tiivistelmä 1/2 Jokainen projekti kirjoittaa 3-4 sivun kertomuksen projektistaan ja liittää kuvaukseen mukaan tärkeimmät tilastot (mm. tuntitaulukko, lista tehdyistä dokumenteista ja koodirivien lukumäärästä). Kertomuksessa esitellään: Projektiorganisaatio, asiakas, projektin aihe. Kuinka projekti eteni, kokemuksia Kohdattuja ongelmia ja mukavia asioita. Projektin hallinta (kuinka käytönnössä toimittiin) Käytetyt työvälineet, työmenetelmät Valokuvia projektiryhmästä, näyttökuvia tuotteesta, muita omia juttuja. 11
Loppuraportin tiivistelmä 2/2 Kaikkien projektien raportit julkaistaan laitossarjassa sähköisessä muodossa. Salaisissa projekteissa - keskustelkaa asioista toimeksiantajanne kanssa, mitä saatte julkaista. Tiivistelmä toimitetaan luennoitsijalle LaTeX -formaatissa viimeistään torstaina 11.5. Jokaisella ryhmällä pitää olla henkilö, jolta voin tarvittaessa kysyä ja tarkistaa asioita palautuksen jälkeen. Mikäli haluatte, että annan teille kommenttia juttunne sisällöstä, palauttakaa siitä versioita jo aiemmin! Muuten ehdin tehdä vain oikoluvun. 12
Loppukertomus ja LaTex Ohjeet LaTeXin käyttöön ja pohja loppukertomusta varten löytyy osoitteesta: http://www.cs.uta.fi/pt/2005_6/loppukertomus/. Kopioi tiedostot projektinnimi.tex ja Timo_Poranen_S1.eps omaan hakemistoon laitoksen linux -koneilla. Editoi tiedostoa projektinnimi.tex valitsemallasi editorilla. Muuta tiedoston nimi oman projektisi nimelle! Tiedosto sisältää myös ohjeita ja valmiit tilastotaulukot, joita pitää käyttää!!! Erinomainen johdanto latexin käyttöön löytyy MTF:n kurssilta: http://mtl.uta.fi/opetus/latex/. Luennoitsia antaa opastusta LaTeXin käyttöön tarvittaessa! Käydään vielä läpi kuinka homma menee! 13
Projektien loppuesitykset 17.5 Vastaavasti kuin joulukuussa. Aikaa 15 minuuttia. Tärkeät asiat: Lopputuotteen esittely Kuinka projekti eteni Millaisia asioita projektiryhmä kohtasi, oliko ongelmia, kuinka niistä selvittiin. Oliko lopputulos sitä mitä ryhmä / asiakas odotti, jos ei niin miksi? Kertokaa omia kokemuksianne muille ryhmille. Ohjeita ja tilaisuuden aikataulu: http: //www.cs.uta.fi/pt/2005_6/material/schedule-may.txt. 14
Projekti CD ja kevään henkilökohtainen loppuraportti Kun projekti on valmis, niin jokainen projekti tekee oman projekti CD:n. CD annetaan (ainakin) luennoitsijalle ja toimeksiantajalle. CD sisältää projektinne kaikki dokumentit ja ohjelmakoodit. Muistilista mitä levyltä pitäisi löytyä: http: //www.cs.uta.fi/pt/2005_6/material/project-cd.txt. CD:ssä pitää olla README.txt tiedosto, jossa lukee mitä CD sisältää ja mitä missäkin hakemistossa on. Mainitkaa myös tekijänoikeus / salattavuus asiat. Kun projekti CD on palautettu, on hk. kevätraportin aika! www.cs.uta.fi/pt/2005_6/material/spring-report.txt. 15
Ryhmien palautekeskustelut Kun ryhmä on palauttanut projekti CD:nsä ja jokainen ryhmän jäsen on täyttänyt kevätraportin, voi ryhmä varata ajan (pakolliseen) palautekeskusteluun. Tilaisuudessa käydään läpi projektin kulkua ja loppuraportti luennoitsijan kanssa. Tarkoituksena on lopettaa projekti hallitusti. Tilaisuudessa voi esitellä ohjelmistotuotetta luennoitsijalle, mikäli esim. loppuesityksessä ei kaikki oleellinen ole tullut esille! Hyviä päiviä: 18.5, 19.5, 22.5 ja 23.5. Tilaisuuteen kuluu aikaa noin 20 minuuttia. Ryhmät varaavat ajan luennoitsijalta samoin kuin katselmoinneissa. Paikka esim. projektityöhuone. 16