Ohjelmistotekniikka ja projektinhallinta, 4 op

Esitys aiheesta: "Ohjelmistotekniikka ja projektinhallinta, 4 op"— Esityksen transkriptio:

1 Ohjelmistotekniikka ja projektinhallinta, 4 op
DOkumentointi Seppo Räsänen Savonia-ammattikorkeakoulu Terveysala, kuopio

2 Dokumentointi… Ohjelmistotyöhön kuuluu oleellisena osana dokumenttien kirjoittaminen laadukkaiden dokumenttien tuottaminen vaikeaa Aikataulut kireitä, dokumentoinnista on helppo nipistää päiviä muuhun työhön Määrittelyssä vaatimusten huolimaton dokumentointi voi aiheuttaa katkeria riitoja asiakkaan ja toimittajan välillä Jos dokumentointi on puutteellista, niin esim. ohjelmiston ylläpito hankalaa… tekijäryhmän henkilöt saattavat muistaa yksityiskohdat, mutta entäpä kun henkilöstö vaihtuu

3 Dokumentointi… Liiallinen dokumentaatio on lähes yhtä huono asia kuin dokumentaation puuttuminen Dokumentoinnin ongelmia pyritään välttämään käyttämällä dokumenttimalleja ja katselmoimalla järjestelmällisesti tuotetut dokumentit Dokumenttien määrä riippuu myös projektin koosta ja projektin monimutkaisuudesta pieni projekti selviää vähäisellä perusdokumentoinnilla aina pitäisi löytyä määrittely- ja suunnitteludokumentit myös testausdokumentaation olemassaolo helpottaa myöhempien ohjelmiston muutosten testausta

4 Dokumentointi… Ohjelmistotuotannon dokumentit voidaan jakaa
laatukäsikirjan dokumentteihin Laatukäsikirja, ohjeistukset, pöytäkirjat, dokumenttipohjat, työmääräennusteet ja vastaavat toteutumat, resurssiarviot ja vastaavat toteutumat projektihallinnan dokumentteihin Sopimukset, projektisuunnitelma, seurantaraportit, loppuraportti tuotedokumentteihin tuote/tuoteperheeseen liittyvä dokumentaatio, projektikohtaiset tuotedokumentit, tuotekohtaiset tuotedokumentit, keskeisimmät toiminnallinen määrittely, tekninen määrittely ja testausdokumentit

5 Dokumentointi… Suunnittelu Esitutkimus Toteutus Määrittely Testaus
tekninen määrittely integrointitestaussuunnitelma tarkennettu käyttöohje alustava ylläpito-ohje alustava operointi/huolto-ohje alustava asennusohje Toteutus moduulisuunnitelmat moduulitestaussuunnitelmat moduulitestauspöytäkirjat koodit integrointitestauspöytäkirjat integroitu ohjelmisto tarkennettu ylläpito-ohje tarkennettu operointi/huolto-ohje tarkennettu asennusohje Testaus järjestelmätestauspöytäkirjat hyväksymistestauspöytäkirjat paketointi-ohje koulutusmateriaali tuotedokumenttien viimeistellyt versiot Esitutkimus alustava sopimus alustava projektisuunnitelma alustava toiminnallinen määrittely alustava toteutussuunnittelu alustava testaussuunnittelu alustava tuotteenhallintasuunnitelma alustava laatusuunnitelma dokumentointisuunnitelma Määrittely tarkennettu sopimus tarkennettu projektisuunnitelma toiminnallinen määrittely alustava tekninen määrittely tarkennettu testaussuunnittelu (järjestelmä- ja hyväksymistestaus) tarkennettu tuotteenhallintasuunnitelma tarkennettu laatusuunnitelma alustava käyttöohje

6 Dokumentointi… toiminnallinen määrittely versio n Koodi tekninen määrittely versio n+1 tuotteen dokumentit projektin dokumentit tuotedokumenttien päivitys versioon n+1 projektin toiminnallinen määrittely (uudet ja muuttuneet vaatimukset) arkkitehtuurisuunnittelu projektin tekninen määrittely Evo-mallin mukaisesti etenevä dokumentaatio eri versioille

7 Dokumentointi… Tuotetason dokumentaatio jää monesti päivittämättä
tuotteen tekninen määrittely ei ole ajantasalla tuotetason dokumentaatio kannattaakin kirjoittaa sen verran yleisellä tasolla, ettei jokainen pikkumuutos aiheuta tarvetta päivitykseen projektin tekninen määrittely on tarkempi ja sen päivitystarvetta ei enää projektin päätyttyä ole Kun projekti päättyy, projektin tuotedokumentaatio muutetaan osaksi tuotekohtaista tuotedokumentaatiota Käyttöohje, asennus- ja operointiohje, koulutusmateriaali, tekninen dokumentaatio, toiminnallinen määrittely, tekninen määrittely, testaukseen ja tuotehallintaan liittyvät ohjeistukset

8 Dokumentointi… Ohjelmistohankkeen prosessi toteuttaja asiakas
neuvottelut/ valmistelu asettaminen projekti/ hanke käyttöönotto käyttö resurssit, ideat tarpeet tehtävää koskevat asiakirjat tuotekansio Ohjelmistohankkeen prosessi

9 Projektisuunnittelu, seuranta ja ohjaus
Dokumentointi… Projektiin liittyvä dokumentit P r o j e k t i a l p ä y Ohjeistukset - projektiohje - määrittelyohje - tarkastusohje - suunnitteluohje - ohjelmointiohje - testausohje alustava projektisuunnitelma Projektisuunnittelu, seuranta ja ohjaus tarkennettu kokouspöytäkirjat loppuraportti toiminnallinen määrittely tekninen testaus- raportti tarkastukset suunnittelu ohjelmointi integrointitestaus järjestelmätestaus ohjelmakoodi järjestelmä- suunnitelma pöytäkirjat määrittely- katselmus suunnittelu- hyväksymis- Katselmukset

10 Dokumentointi… Dokumenttimallien käyttäminen on suositeltavaa/pakollista dokumenttien ulkoasu on aina samanlainen dokumenteista löytyvät aina tietyt tiedot ennalta määrätyistä paikoista Dokumentit alkavat kansilehdellä organisaatio, projekti, dokumentin nimi, versio, sivujen lukumäärä, tekijät(t), tila Kansilehteä seuraa tiivistelmä, sisällysluettelo, versiohistoria Jokaisella sivulla tulisi olla sivunumero, dokumentin nimi, versionumero ja päivämäärä Edellisestä versiosta muuttuneet kohdat tulisi selvitä versiohistoriasta lisäksi Word:n Jäljitä –toiminnolla voidaan viimeisimmät muutokset jättää näkyviin Osa dokumentaatiosta voi olla myös sähköisessä muodossa Käyttöohjeet, projektin dokumentaatio voi olla hypertekstinä Dokumenttimallit kuuluvat osana laatujärjestelmän dokumentaatiota

11 Dokumentointi… Lähdekoodi on osa dokumentaatiota!!
lähdekoodin dokumentaatio tulee olla yhdenmukaista koko projektissa Laatujärjestelmään liittyy yleensä tyyliopas alkukommentit muuttujien nimeäminen sisennykset koodin kommentointi kielletyt asiat

12 Dokumentointi… Koodin dokumentointi Miten Miksi muuttujien määrittely
olioiden, luokkien, komponenttien, ohjainten nimeäminen funktioiden (aliohjelmien) nimeäminen sisennykset (ohjausrakenteet) koodirivien kommentointi aliohjelmien kommentointi koko ohjelman kommentointi (alku, loppu, ohjelman osat) ohjelmakoodien tallennus ja hakemistot ohjelmien versiointi Miksi koodin luettavuus paranee koodin korjaaminen helpottuu koodaamisvirheet vähenevät standardointi lisääntyy uudelleenkäytettävyys paranee jne…

13 Dokumentointi… Dokumentointiin vaikuttavia standardeja
de facto (käytännön standardi) IEEE (Institute of Electrical and Electronics Engineers) ANSI (American National Standards Institute) NBS (National Bureau of Standards) NASA (National Aeronautics and Space Administration) DoD (Department of Defence, USA:n armeija) ISO (International Organisation of Standardization) ESA (European Space Agency) KOTEL (KomponenttiTeollisuuden Yhteistyöjärjestö) SFS (Suomen Standardoimisliitto) TIEKE (Tietoyhteiskunnan kehittämiskeskus ry)

14 Dokumentointi… IEEE-standardeja laatujärjestelmä, prosessi: 1074-1991
projektinhallinta: määrittely: suunnittelu: ohjelmointi testaus: , käyttö, ylläpito: dokumentointi: laadunohjaus: , , , , , , tuotteenhallinta: ,

15 Dokumentointi… Dokumenttipohjia, tuotettu TKV-projektissa Esitutkimus
Esitutkimus Toiminnallinen määrittely (vaatimusmäärittely) IEEE830 Projektisuunnitelma Tekninen määrittely IEEE1016 Tuotekuvaus Testaussuunnitelma Käyttöohje Ylläpito-ohje

16 Dokumentointi… Kysymyksiä Kommentteja