PROJEKTIN DOKUMENTOINTI JOUNI HUOTARI, ESA SALMIKANGAS

Transkriptio

1 PROJEKTIN DOKUMENTOINTI JOUNI HUOTARI, ESA SALMIKANGAS

2 MIKSI DOKUMENTOINTI ON TÄRKEÄÄ? MITÄ ASIOITA DOKUMENTOIDAAN? Pohdi ensin yksin ja sitten parin kanssa tai pienryhmässä: miksi dokumentointi on niin tärkeää projektin eri vaiheissa mitä asioita dokumentoidaan Jouni Huotari 2

3 MIKSI DOKUMENTOINTI ON TÄRKEÄÄ? Muistetaan, mitä on sovittu Muut voivat helpommin kommentoida esim. projektisuunnitelmaa Helpottaa uusien henkilöiden mukaantulemista projektiin Seurannan apuvälineeksi: voidaan verrata esim. toteutunutta suunniteltuun Lainaus kirjasta Ohjelmistotuotanto, Luku 3: Ohjelmistotuotanto on spesifikaatiodokumenttien tuottamista. Jos myös ohjelmat ymmärretään dokumenteiksi, ei ohjelmistotyö oikeastaan muuta olekaan. Jouni Huotari 3

4 MIKSI DOKUMENTOINTI ON TÄRKEÄÄ? Nyrkkisääntönä: Heti kun tehtävän työn koko kasvaa yli parin-kolmen ihmisen, täytyy dokumentoida siten, että työn kulusta - projektin aikana ja sen jälkeen - on kaikilla osallisilla selkeä ja yhtenäinen käsitys. Jouni Huotari 4

5 MITÄ DOKUMENTOIDAAN? Aikataulu Resurssit (henkilöt, työvälineet, tilat) Kustannukset Vaiheet ja tehtävät Muutokset Jouni Huotari 5

6 Projektialoite Esitutkimusraportti Projektin asettamiskirje (ja sen pohjalta mahdollinen projektipäällikön tekemä tarkennus) Projektisopimus: projektin alustava kuvaus Projektisuunnitelma PROJEKTIKANSION SISÄLTÖ Projektisopimus: projektin lopullinen rajaus Yhteystiedot, jakelulistat, -matriisi Jouni Huotari 6

7 PROJEKTIKANSION SISÄLTÖ ( JATKUU) Johtoryhmän kokousmuistiot Tilannekatsaukset, suunnittelupalaverimuistiot Dokumenttien nimeämis- ja tallennuskäytännöt Projektisuunnitelmaa täydentävät suunnitelmat Virallinen kirjeenvaihto, leimauskäytännöt Loppuraportti Jouni Huotari 7

8 MITÄ ASIOITA JOKAISESTA DOKUMENTISTA ON LÖYDYTTÄVÄ? Mihin projektiin dokumentti kuuluu Mikä dokumentti on kyseessä Kuka tehnyt Milloin tehty / päivitetty Jouni Huotari 8

9 KUKA ON VASTUUSSA DOKUMENTOINNISTA? Kukin vuorollaan esim. kiertävä dokumentointivastaava / sihteeri => sovittu roolijako + aikataulu (esim. kuukausi / hlö) Oletusarvo: projektipäällikkö vastuussa, jos ei erikseen sovittu Jouni Huotari 9

10 MIHIN DOKUMENTIT TALLENNETAAN? Paperitulostus => mappiin (esim. pp:n hyllyyn) Sähköposti (luodaan kansio, joka jaetaan muille) Muistitikku (=> riskit?) Z-asema (Labranet-verkossa), H-asema (JATMANET) => luodaan kansio, joka jaetaan muille Google docs, wiki tms. => FreeNest Himaserveri => RDC-yhteys tms. koneeseen Versionhallinta, esim. Git; version.labranet.jamk.fi Dropbox jaettu kansio Jouni Huotari 10

11 DOKUMENTOINNIN ARKISTOINTI Projektin alussa on määritelty Asiakirjojen luokittelu (tilat, julkisuusaste ym.) Arkistointitapa (paperinen/sähköinen) Arkistointipaikka Vastuut Jokaisessa dokumentissa tulee olla Dokumentin nimi, versionumero ja versiohistoria Laatijan nimi ja luonti-/ muokkauspäivämäärä Dokumentin tallennuspaikka / hakemistopolku Dokumentin tila (luonnos, valmis katselmoitavaksi, hyväksytty) Julkisuusaste (julkinen, sisäinen, luottamuksellinen) Jouni Huotari 11

12 DOKUMENTIN HYVYYDEN ARVIOINTI Täydellisyys: kaikki tarpeellinen, ei mitään turhaa Tarkkuus: asiat esitetty tarpeeksi tarkasti Virheettömyys: ei virheitä eikä ristiriitaisuuksia Ymmärrettävyys sekä tekstin että kuvien osalta Testattavuus: miten dokumentin laatu testataan tai miten "mitataan", onko vaatimus täytetty Jäljitettävyys (traceability): esim. mistä vaatimus on peräisin ja miten tärkeä se on Jouni Huotari 12

13 HYVIÄ DOKUMENTOINTIKÄYTÄNTÖJÄ ASIAT JOTKA SOVITAAN KIRJATAAN Jouni Huotari 13

14 PROJEKTIKOKOUKSEN DOKUMENTOINTI (MISSÄ OLLAAN, MIHIN OLLAAN MENOSSA) Mitä on: Tehty JA Saatu aikaiseksi = tuotokset Edellisen kerran avoimet tehtävät projektin edistyminen (käydään läpi esim. henkilö henkilöltä) poikkeamat ja niiden syyt vaikutus kustannuksiin, aikatauluun, resursseihin, muihin tuleviin tehtäviin Kokouksen aikana tulleet avoimet tehtävät (kuka tekee, mitä tekee, milloin tekee) Projektin yleiset asiat / tiedotusasiat (esim. terveiset projektin johtoryhmältä) Riskilistan katsaus päivitys Jouni Huotari 14

15 0.1 = nauruversio VERSIONUMEROINTI 1.0 = (johtoryhmässä) hyväksytty versio Versionumero hyvä olla sekä kansilehdellä että ylätunnisteessa (tai alatunnisteessa) Tiedostonimessä VvvvKkPp => lajittelu tulee oikein Jouni Huotari 15

16 TEHTÄVÄ Sopikaa ryhmässänne Roolit Projektipäällikkyys, kiertävä Kuka toimii dokumentointivastaavana (sihteerinä) => tehtävän kierrätys Henkilöt, yhteystiedot Projektinhallinta; tallennuspaikka dokumenteille Hakemistorakenne (kopioikaa sis.luettelo mallipohjasta) Dokumenttien nimeämiskäytännöt Muu viestintä Mitä wikissä/tracissa ja mitä muilla välineillä (nimeä millä) Yhteinen viestintäkanava (IRC-kanava tms.) Dokumentoikaa nämä päätökset wikiin Jouni Huotari 16