I diversi tipi di documentazione del software possono essere classificati a grandi linee nei seguenti:
- Documentazione interna
- Documentazione esterna
La documentazione interna è le caratteristiche di comprensione del codice fornite come parte del codice sorgente stesso. La documentazione interna è fornita attraverso intestazioni di moduli appropriati e commenti incorporati nel codice sorgente. La documentazione interna è anche fornita attraverso i nomi utili delle variabili, le intestazioni dei moduli e delle funzioni, l'indentazione del codice, la strutturazione del codice, l'uso di tipi enumerati e identificatori costanti, l'uso di tipi di dati definiti dall'utente, ecc. Esperimenti accurati suggeriscono che, tra tutti i tipi di documentazione interna, i nomi di variabili utili sono i più utili per capire il codice. Questo è naturalmente in contrasto con l'aspettativa comune che i commenti al codice siano i più utili. Il risultato della ricerca è ovviamente vero quando i commenti sono scritti senza pensare. Per esempio, il seguente stile di commento al codice non aiuta in alcun modo a capire il codice.
a = 10; /* a ha fatto 10 */
Ma anche quando il codice è attentamente commentato, nomi di variabili significativi sono più utili per capire un pezzo di codice. Le buone organizzazioni di sviluppo del software di solito assicurano una buona documentazione interna formulando in modo appropriato i loro standard di codifica e le linee guida di codifica.
La documentazione esterna è fornita attraverso vari tipi di documenti di supporto come il manuale dell'utente, il documento di specifica dei requisiti del software, il documento di progettazione, i documenti di test, ecc. Uno stile sistematico di sviluppo del software assicura che tutti questi documenti siano prodotti in modo ordinato.
File PDF:
http://www.vssut.ac.in/lecture_notes/lecture1428551142.pdf