Suunnitteludokumenteista

Suunnitteludokumenteista on termi, jota käytetään viittaamaan suunnitteluvaiheessa laadittuihin asiakirjoihin, jotka kuvaavat, miten järjestelmä, tuote tai projekti aiotaan toteuttaa. Niiden tarkoituksena on varmistaa selvä viestintä sidosryhmien välillä, toimia ohjeena kehitystyölle sekä tarjota säilytettävä referenssi tulevia ylläpito-, laajennus- ja muutosprosesseja varten.

Dokumentit voivat sisältää arkkitehtuurin kuvaamisen, moduulien vastuineen ja rajapintoineen sekä tiedon- ja datamallien kuvaukset. Lisäksi niissä käsitellään tekniset ratkaisut, valitut teknologiat ja työkalut sekä ei-funktionaaliset vaatimukset kuten suorituskyky, luotettavuus, turvallisuus ja käytettävyys. Usein käsitellään myös testaus- ja laadunvarmistusstrategia sekä virheenkäsittely ja konfiguroitavuus.

Suunnitteludokumentteja voidaan pitää korkean tason suunnitelmina, jotka kuvaavat yleisen arkkitehtuurin ja suunnan, sekä yksityiskohtaisempina suunnitelmina, joissa tarkennetaan moduulien rajapinnat ja algoritmit. Joissakin organisaatioissa käytetään arkkitehtuuriin liittyvien päätösten kirjaamiseen tarkoitettua ADR-käytäntöä (Architecture Decision Records) päätösten perusteineen ja konteksteineen.

Dokumentit ovat elävä osa projektia, ja niitä päivitetään merkittävien muutosten yhteydessä. On suositeltavaa pitää ne versionhallinnassa sekä linkitettyinä koodivarastoihin ja testijärjestelmiin, jotta ne pysyvät ajantasaisina ja helposti saatavilla tiimin jäsenille sekä sidosryhmille. Suunnitteludokumentit toimivat viitekehyksenä sekä toteutukselle että myöhemmälle ylläpidolle ja kehitysvaiheiden hallinnalle.