Documentation du programme

Tout texte écrit, illustration ou vidéo décrivant un logiciel ou un programme à ses utilisateurs est appelé program or software document. L'utilisateur peut être n'importe qui, du programmeur, de l'analyste système et de l'administrateur à l'utilisateur final. À différents stades de développement, plusieurs documents peuvent être créés pour différents utilisateurs. En réalité,software documentation est un processus critique dans le processus global de développement logiciel.

Dans la programmation modulaire, la documentation devient encore plus importante car différents modules du logiciel sont développés par différentes équipes. Si quelqu'un d'autre que l'équipe de développement veut ou a besoin de comprendre un module, une bonne documentation détaillée facilitera la tâche.

Voici quelques conseils pour créer les documents -

  • La documentation doit être du point de vue du lecteur

  • Le document doit être sans ambiguïté

  • Il ne devrait pas y avoir de répétition

  • Les normes de l'industrie doivent être utilisées

  • Les documents doivent toujours être mis à jour

  • Tout document obsolète devrait être éliminé après l'enregistrement en bonne et due forme de l'élimination.

Avantages de la documentation

Voici quelques-uns des avantages de fournir une documentation de programme -

  • Garde une trace de toutes les parties d'un logiciel ou d'un programme

  • L'entretien est plus facile

  • Les programmeurs autres que le développeur peuvent comprendre tous les aspects du logiciel

  • Améliore la qualité globale du logiciel

  • Aide à la formation des utilisateurs

  • Assure la décentralisation des connaissances, réduisant les coûts et les efforts si les gens quittent brusquement le système

Exemples de documents

Un logiciel peut être associé à de nombreux types de documents. Certains des plus importants incluent -

  • User manual - Il décrit les instructions et les procédures permettant aux utilisateurs finaux d'utiliser les différentes fonctionnalités du logiciel.

  • Operational manual - Il répertorie et décrit toutes les opérations en cours et leurs interdépendances.

  • Design Document- Il donne un aperçu du logiciel et décrit les éléments de conception en détail. Il documente des détails commedata flow diagrams, entity relationship diagrams, etc.

  • Requirements Document- Il contient une liste de toutes les exigences du système ainsi qu'une analyse de la viabilité des exigences. Il peut avoir des cas d'utilisateurs, des scénarios réels, etc.

  • Technical Documentation - Il s'agit d'une documentation de composants de programmation réels tels que des algorithmes, des organigrammes, des codes de programme, des modules fonctionnels, etc.

  • Testing Document - Il enregistre le plan de test, les cas de test, le plan de validation, le plan de vérification, les résultats des tests, etc. Les tests sont une phase du développement logiciel qui nécessite une documentation intensive.

  • List of Known Bugs- Chaque logiciel présente des bogues ou des erreurs qui ne peuvent pas être supprimés car ils ont été découverts très tardivement ou sont inoffensifs ou nécessiteront plus d'efforts et de temps que nécessaire pour les corriger. Ces bogues sont répertoriés avec la documentation du programme afin qu'ils puissent être supprimés ultérieurement. Ils aident également les utilisateurs, les implémenteurs et les responsables de la maintenance si le bogue est activé.