Qu'est-ce que la documentation du programme ?

4 Réponses


  • La documentation du programme est une sorte de documentation qui donne une description procédurale complète d'un programme. Il montre comment le logiciel est écrit. La documentation du programme a même la capacité de soutenir toute maintenance ou développement ultérieur du programme. La documentation du programme décrit ce que fait exactement un programme en mentionnant les exigences des données d'entrée et l'effet de l'exécution d'une tâche de programmation.

    Ainsi, si vous voulez savoir ce qu'un programme est censé faire et comment il doit être exécuté, vous devez vous référer à la documentation du programme. Les exemples les plus courants seraient les manuels d'instructions d'un produit logiciel, qui sont remis à l'utilisateur final. Ainsi, le manuel d'instructions d'un langage de programmation comme Java ou de compréhension d'un traitement de texte peut relever de la documentation du programme. Les langages de description utilisés sont informels et sont destinés à faciliter la vie de l'utilisateur final.

    Il existe également un autre type de documentation de programme qui est écrite pour le bien des programmeurs qui écrivent le logiciel réel et peuvent devoir le modifier ou l'utiliser dans le cadre d'un autre programme qu'ils écrivent à l'avenir. Alors que la documentation de l'utilisateur final a un langage convivial sur le logiciel, la documentation du programme décrit les choses dans un langage qui peut convenir au programmeur.
  • Il décrit le programme, c'est-à-dire l'entrée, la sortie, la logique appliquée dans le programme, l'organigramme/l'algorithme, les éventuels inconvénients, l'échantillon de sortie, etc.
  • La documentation du programme comprend des manuels papier ou électroniques qui permettent aux utilisateurs, aux développeurs de programmes et aux opérateurs d'interagir avec succès avec un programme. La documentation de l'utilisateur se compose normalement d'un manuel de l'utilisateur. Ce manuel peut fournir des instructions pour l'exécution du programme. Une description des commandes logicielles, plusieurs exemples utiles d'applications et un guide de dépannage pour vous aider en cas de difficultés. Les développeurs de programmes incluent les personnes qui conçoivent, écrivent, testent et maintiennent des programmes, c'est-à-dire toute personne contribuant au processus de développement de logiciels.

    La documentation du développeur se compose généralement d'outils qui simplifieront toute tâche de développement. Ces outils peuvent inclure des exemples de programmes, une description des outils de conception intégrés au produit, des instructions pour le débogage et les tests, des astuces de maintenance, etc. Étant donné que les développeurs connaissent très bien les ordinateurs, la documentation des développeurs est écrite à un niveau plus technique que la documentation. La documentation des développeurs devient également de plus en plus électronique. La documentation de l'opérateur comprend des manuels en ligne et sur papier qui aident les opérateurs de machines à configurer les périphériques matériels, à apprendre les tenants et aboutissants d'un fonctionnement réussi du matériel et à diagnostiquer les dysfonctionnements de la machine. La documentation de l'opérateur dépend de la machine et à moins d'avoir une bonne connaissance du matériel, elle peut être difficile à lire.
  • La documentation est un processus continu, commençant par la définition du problème. La documentation implique la collecte, l'organisation, le stockage et le maintien d'un enregistrement complet des programmes et autres documents associés au système de traitement des données. Pour plus d'informations, obtenez de l'aide à l'aide de CodeAvail -
    Online Computer Science Assignment help

Ecrivez votre réponse

Votre réponse apparaîtra après modération