Tämä teksti on jatkoa aikaisemmin julkaistulle tekstille, joten kannattaa lukea se ensin.

Edellisessä osassa puhuttiin erilaisista hyödyistä, kun käytetään suunnittelumalleja dokumentoinnin apuna. Tässä osassa näytetään, kuinka projektin käytännöistä saadaan luotua suunnittelumalleja. Kannattaa huomioida, että vaikka projektit ja tilanteet ovat erilaisia, suunnittelumallien pitäisi olla yleiskäyttöisiä, kestäviä ja käytettävissä myös oman projektin ulkopuolella – helposti muuttuvat yksittäistapausten yksityiskohdat voi dokumentoida muuten.

Suunnittelumallien on tarkoitus kuvata olemassa olevia käytäntöjä, jolloin niihin ei kannata laittaa osioita, joita ei ole oikeasti käytössä tai itse kokeiltu. Lue lisää

Erilaisissa projekteissa tulee poikkeuksetta vastaan tilanne, jossa projektin aikana opittuja asioita pitäisi dokumentoida. Dokumentti voi olla tarkoitettu itselle muistiinpanoksi (”näin aloitat uuden kirjaston tekemisen”), projektin muille/tuleville jäsenille hyödyksi (”kannattaa käyttää tässä kirjastoa X tai muuta vastaavaa”) tai tiedoksi jopa laajemmalle joukolle (”kun olet rakentamassa palvelua A, muista ottaa huomioon nämä asiat”). Dokumentaatio voi koskea projektin yleisiä käytäntöjä tai sitten esimerkiksi tuotettua koodia. Lue lisää