Suomen Yrittäjäopisto

Versiohallinta ja ohjelmiston dokumentointi

Ohjelmistosuunnitteluprojektin laadun takaamiseksi dokumentoinnin täytyy olla kattavaa ja ajantasaista. Määrittelyt, suunnitelmat ja toteutukset täytyy dokumentoida siten, että koko ohjelmistoprojektin aikana ja sen jälkeenkin, dokumenteilla voidaan aukottomasti todentaa projektin kulku ja kulloisetkin projektivaiheet. Koska ohjelmistoprojektit enemmän tai vähemmän muuttuvat jo toteutuksen aikana, muutosten hallinta on osa tätä dokumentoinnilla hallittavaa projektin osaa. Muutosten hallinnassa myös ohjelmistojen versiohallinnalla on keskeinen osuus.

Kesto: 1 pv

Kenelle: Sovelluskehitystä aloittaville

Tavoitteet: Opiskelija tuntee keskeisimmät ohjelmistoprojektin dokumentit ja osaa suorittaa dokumentoinnin eri vaiheet itsenäisesti muutokset mukaan lukien. Kun ohjelmistoa toteutetaan, ohjelmisto-osien versioiden hallinta on osa tätä muutoksenhallintaa ja opiskelijan on tunnettava versiohallinnan perusteet.

Sisältö:
1. Dokumentointi
a. Kommentointi ja dokumentoiva ohjelmointi
b. Vaatimusmäärittely
c. Tekninen spesifikaatio
d. Käyttöliittymäspesifikaatio
e. Testaussuunnitelma
f. Asennus- ja käyttöohjeet
2. Versiohallinta
a. Menetelmät
b. Versiohallinnan ominaisuudet
c. Versionumerointi
d. Muutoksenhallinta