Enregistrement et repérage des modifications apportées dans les programmes
Une difficulté majeure lors des développements informatiques est la documentation technique.
Il faut, en effet, prévoir que le programmeur ne soit plus disponible lorsque le besoin de modifier le programme arrive.
Un des moyens d’assurer la pérennité est de définir une NORME, appliquée par tous les programmeurs, pour ajouter dans les programmes eux-mêmes les informations nécessaires.
Au début du programme
Tout d’abord, le développeur va écrire des lignes de commentaires au début du programme, avec :
Des informations initiales :
- Une brève description de l’objet du programme,
- Le nom du programme précédent et celui du programme suivant lorsque le programme fait partie d’une chaîne de programmes,
- La date de début ou de fin de la création du programme
- Le nom du programmeur (et surtout pas son acronyme), auteur du programme
Des informations itératives,
à chaque modification du programme, et qui s’ajoutent aux commentaires déjà présents :
- Un code identifiant la modification, l’ajout ou la suppression de lignes
- Une brève description de l’objet de la modification du programme,
- La date de début ou de fin de la modification du programme, (selon le même principe que celui choisi pour les commentaires en entête du programme)
- Le nom du programmeur ET son acronyme (généralement, ses initiales), auteur de la modification
- La version du programme et/ou de la chaîne de programmes à laquelle il appartient
Dans le corps du programme
Ligne ou bloc de ligne
Ensuite, le développeur va écrire des lignes de commentaires en entête de la ligne ou du bloc de lignes concernées par la suppression ou la modification, avec :
- Le code identifiant la modification
- L’acronyme de l’auteur de la modification
Sur chaque ligne
Enfin, selon le langage utilisé, il est possible d’ajouter ces mêmes informations en commentaire sur chaque ligne. Dans ce cas, on ajoute :
- D=ligne supprimée, ou
- M=ligne modifiée ou
- A=ligne ajoutée.
En AUCUN cas, les lignes initiales disparaissent, elles sont seulement neutralisées, c’est-à-dire qu’elles sont modifiées par le programmeur pour les transformer en commentaires.
Philippe Garin, plus de 20 ans de management en entreprise
Pour plus de conseils, contactez-moi : phgarin@gmail.com
Pour en savoir plus :
En complément :
Les étapes du développement d’application
Fonction de développeur
Développement ou Programmation base de l’informatique
Programmation
Lois de programmation des ordinateurs
Développement ou Programmation base de l’informatique
Autres Informatique :
Blog de Philippe Garin 