Dokumenteerimise nõue on tarkvara arenduses täiesti möödapääsmatu, eriti tähtis on korralik dokumenteerimine kommertstarkvara projektide juures. Dokumentatsioon on vajalik, kuna arendusprojektid on muutunud oluliselt suuremaks kui need olid mõnda aega tagasi. Täna töötab ühe lahenduse väljatöötamise juures enamasti rohkem kui üks inimene, tihti isegi mitu erinevat gruppi.

Hästi-struktureeritud dokumentatsioon peab rahuldama järgmisi vajadusi:

·         Õppimisvõimalus: uued inimesed, kes liituvad arendusmeeskonnaga, peavad leidma abi dokumentatsioonist arendusprojektiga tutvumisel.

·         Infovahetus: kõigi tootega seotud inimestel (arendajad, projektijuhid, tugispetsialistid jne) peab olema võimalik saada neile vajalik info dokumentatsiooni abil.

·         Informatsioon: dokumentatsioon peab sisaldama infot projektiga seotud arendustegevuse ja lahenduse ja kirjeldama näiteks programmi peamised nõuded ja funktsionaalsuse.

Arendusprotsessi jooksul võivad dokumentatsioonile esitatavad nõuded muutuda: näiteks arendusfaasis peab dokumentatsioon olema peaasjalikult tehniline ja võib seetõttu olla tavakasutajale raskesti mõistetav, kuid lõppversioon peab kindlasti sisaldama kasutajajuhendit mis oleks tavakasutajale lihtsalt mõistetav ja üheselt arusaadav.

Arendusprotsessis vajaliku dokumentatsiooni jaoks on loodud eraldi vahendeid, millega arenduse käigus loodud lahendusi ja tehtud muutusi on võimalik lihtsalt dokumenteerida (näiteks: tracking systems) ning mitmetesse arendusvahenditesse on integreeritud erinevad vahendid tarkvara loomise käigus luua ka tehniline dokumentatsioon (näiteks XML keeles Microsoft Visual Studios tehtud kommentaarid on võimalik hiljem koondada ühtseks dokumentatsiooniks).

Kasutajajuhendid peavad sisaldama juhendit programmi kasutamise kohta, kuid heas kasutajajuhendis on ka juhised kasutaja töö efektiivsemaks muutmiseks. Hea kasutajajuhend on nii abi- kui ka õppimisvahend. Tänapäevased kasutajajuhendid sisaldavad tihti terveid peatükke erinevate tarkvara funktsioonide efektiivsest kasutamisest.

Programmi loogika kirjeldamiseks kasutatakse nii tehnilises dokumentatsioonis kui ka kasutajajuhendis tihti voodiagramme, mis selgitavad, kuidas, mille alusel ja kuidas toimub andmete töötlemine ning kuidas programmi erinevad moodulid on suhestatud.

Peale voodiagrammide kasutatakse dokumentatsioonis tihti lahenduse kirjeldamiseks ka otsustuspuid ja UML diagramme. Otsustuspuud on otsuste puukujuline kujutamine puul on juurtipp ning iga uus tipp sisaldab mõnda otsust, sõltuvalt otsusest liigutakse puus kuni lehtedeni, kus on lõpuks lahendid (väljundid).

Lisalugemist: www.aaai.org (otsustuspuu) ja wikipedia.org (UML)