Les différents types de documents logiciels peuvent globalement être classés comme suit :
- Documentation interne
- Documentation externe
La documentation interne correspond aux fonctionnalités de compréhension du code fournies dans le cadre du code source lui-même. La documentation interne est fournie par le biais d'en-têtes de modules appropriés et de commentaires intégrés dans le code source. La documentation interne est également fournie par les noms de variables utiles, les en-têtes de modules et de fonctions, l'indentation du code, la structuration du code, l'utilisation de types énumérés et d'identificateurs constants, l'utilisation de types de données définis par l'utilisateur, etc. Des expériences minutieuses suggèrent que, de tous les types de documentation interne, les noms de variables significatifs sont les plus utiles pour comprendre le code. Des expériences approfondies suggèrent que, de tous les types de documentation interne, les noms de variables significatifs sont les plus utiles à la compréhension du code. Le résultat de la recherche est évidemment vrai lorsque les commentaires sont écrits sans réflexion. Par exemple, le style de commentaire de code suivant n'aide en rien à la compréhension du code.
a = 10 ; /* a fait 10 */
Mais même lorsque le code est soigneusement commenté, les noms de variables significatifs sont toujours plus utiles pour comprendre un morceau de code. Les bonnes organisations de développement de logiciels assurent généralement une bonne documentation interne en formulant de manière appropriée leurs normes et leurs directives de codage.
La documentation externe est fournie par différents types de documents de support tels que le manuel des utilisateurs, le document de spécification des exigences logicielles, le document de conception, les documents de test, etc. Un style de développement logiciel systématique permet de s'assurer que tous ces documents sont produits de manière ordonnée.
Fichier PDF :
http://www.vssut.ac.in/lecture_notes/lecture1428551142.pdf