top of page
Documentation
Définition
La documentation est essentielle dans chaque projet.
Pour un utilisateur, elle permet de lui rendre accessible l'information, et d'avoir un outil pour faciliter l'utilisation d'un programme informatique.
Pour un développeur, elle lui permet de savoir comment l'application a été réalisée, et de faciliter en amont la modification ou l'ajout de fonctionnalités à celle-ci.
Application
Cette documentation a joué un rôle essentiel dans la plupart de mes réalisations, mais surtout lors de mon stage à Hélidax. Bien que l'entreprise souhaitait prolonger ma période de stage sur l'alternance pour continuer le projet, elle n'en avait pas la possibilité.
De ce fait, j'ai du léguer l'application à un prochain développeur, et donc réaliser un ensemble de documentations techniques sur mon travail effectué en programmation, ou encore de la documentation utilisateur sur la bonne utilisation de l'application, grâce aux outils comme Word.
J'ai pu aussi réaliser de la documentation en rédigeant un cahier de recette pour l'application Médikit47. Ce cahier de recette m'a permis de vérifier que le processus métier est couvert par la solution, et de garantir la réussite de la mise en production.
​
Enfin, j'ai aussi pu utiliser un outil différent, un logiciel qui permet de réaliser une documentation logicielle automatique à partir du code source d'un programme : Doxygen.
Dans mon projet professionnel
La documentation est aussi essentielle dans mon projet. Pour la documentation technique, elle permettra de pouvoir revenir plus facilement sur le code de l'application.
En ce qui concerne la documentation utilisateur, elle permettra aux utilisateurs finaux de la solution de retrouver aisément les fonctionnalités de l'application et la façon de les utiliser. Bien entendu les autres types de documentations seront tout aussi importantes dans tous mes projets futurs.
9
Expertise
Réalisation(s) associée(s)
bottom of page