Toată lumea lasă întocmirea documentaţiei pe mai târziu, căci se consideră că realizarea produsului software este activitatea de bază. Realitatea arată că un produs software este respins şi în cazul în care documentaţia lui este de proastă calitate. Este ca şi cum avem 100 de becuri legate în serie şi 99 sunt bune, iar ultimul bec e ars, deci nici celelalte 99 nu se vor aprinde.
O documentaţie este bună dacă:
- este completă,
- are toate detaliile,
- există concordanţă între ea şi textul sursă,
- are structura cerută de standarde,
- este corectă,
- are nivelul maxim de consistenţă,
- nu conţine prezentări disproporţionate,
- nu se constată omisiuni,
- este întocmită cu onestitate,
- este concordanţă între ea şi textul sursă,
- explică toate elementele din textul sursă,
- este o bună bază pentru mentenanţă.
am văzut documentaţii făcute de IBM care permiteau o bună înţelegere a produsului program, cum am văzut şi documentaţii anemice care prezentau structuri de articole ale unor fişiere şi erau câmpuri care nu se regăseau în textul programului. Alte documentaţii descriau modulele cu niveluri foarte diferite de detaliere. La unele module se specifica doar numele, iar la altele erau date detalii legate de parametrii, de natura prelucrărilor, de rezultatele care se obţineau.