Dokumentoija: osana ohjelmointia

Hyvä ohjelmoija myös suunnittelee ja dokumentoi tekemänsä.

Dokumentti x ohjelma = ❤

Vuosikymmeniä sitten on jo huomattu, että ohjelmoinnin “flow” -vaiheessa on suuri riski aliarvioida dokumentoinnin tärkeys.

Kun koodia syntyy, ohjelmoija ei halua keskeyttää tätä hyvänolon tunnetta dokumentoinnin vuoksi.

Ohjelmiston dokumentointi on kuitenkin lähes kullanarvoista myöhemmin, kun ohjelmaan halutaan tehdä muutoksia. Dokumentti kertoo “ulkopuoliselle” havainnoitsijalle, mistä ohjelmassa on kyse; ja mitkä ovat sen olettamat periaatteet ja rajoitukset.

Ohjelmistojen kehitys tuskin tulee rajoittumaan siksi, että potentiaalisista kyvykkäistä tekijöistä olisi pulaa. Mutta motivaatioon ja projektien onnistumiseen voi vaikuttaa olennaisesti projektin ja koodin ympärillä oleva kontekstuaalinen ymmärrys ja opastus, historia, dokumentointi.

Dokumentoijat ovat kenties tulevaisuudessa osittain GAN/AI linjalla, eli bulkkitekstin voi tuottaa automaatti, mutta dokumentoinnista tulisi kuitenkin muistaa tehdä nimeomaan ihmistä kiinnostavaa.

Välttely:

prokrastinaation neurobiologisena perustana: mieli välttelee tehtäviä, jotka eivät tuota välitöntä palkkiota, vaikka ne olisivat pitkällä tähtäimellä tärkeitä, kuten dokumentointi.