L’importance de la documentation logicielle !

La documentation est un sujet bel et bien présent, notamment autour de la réalisation de projets informatiques. Celle-ci fait d’ailleurs partie des deux problématiques jugées les plus importantes pour les professionnels, “la difficulté à garder la connaissance du système d’information”.

La documentation logicielle, qu’est-ce que c’est ?  

La documentation logicielle est un texte explicatif autour du process de développement du logiciel qui sert de support de communication. Elle a pour objectif de présenter la manière dont le logiciel a été développé, comment il fonctionne et comment le faire évoluer auprès de son public cible. La documentation peut être à destination des développeurs, qui s’intéresseront davantage à la manière dont le logiciel a été conçu, ou bien à destination des utilisateurs finaux qui s’intéresseront davantage à la manière d’utiliser le logiciel. 

Prenons pour exemple un projet de développement d’application mobile. Il y a trois étapes majeures de documentation, la première qui est la documentation en lien avec le recueil du besoin client. Ensuite, la documentation générale qui résume globalement le projet et pour terminer la documentation technique à destination des développeurs.

Pourquoi la documentation logicielle est-elle importante ? 

Le capital connaissance est indispensable pour les entreprises. La capitalisation du savoir et des connaissances est une tâche gourmande en temps, mais qui s’avère nécessaire. Ne pas créer de documentation développe certains risques importants :

  • Lorsque l’information est détenue par un seul et même expert, il est difficile de se séparer de cette personne. Cela induit une charge importante pour le sachant et un risque majeur pour l’entreprise dans le cas ou l’expert ne souhaite plus faire parti du projet. 
  • Des coûts supplémentaires en terme de support humain dans le but de former et d’informer (développeurs ou utilisateurs).
  • Une perte de connaissance globale qui impacte les évolutions futures du projet
  • Une perte de temps autour des échanges répétitifs entre les acteurs du projet (développeurs et porteurs de projets), concernant le fonctionnement et le développement du logiciel

Les différentes documentations 

Au même titre qu’il existe différentes cibles pour la documentation logicielle, il existe plusieurs types de supports. Il est nécessaire pour vous de déterminer lesquels sont pertinents pour votre projet. 

  • Spécifications
  • Guide de rédaction
  • Guide de référence
  • Didacticiel
  • Cahier des charges
  • Manuel utilisateur
  • Procédures
  • Suivi de projet
  • Plan de tests
  • Document d’architecture 
  • Etc…

Les bonnes pratiques 

La création de documentation doit répondre à certains besoins, en effet, il arrive que les documents ne soient pas adaptés à la cible ou que le volume trop important de celle-ci n’incite pas à la consulter. Cela peut avoir un impact sur sa maintenance à long terme. Il est intéressant de :

  • Bien définir la cible de sa documentation 
  • Ne pas faire reposer toutes les connaissances sur une seule et même personne, développer les pratiques collaboratives
  • Réaliser une documentation concise et pertinente
  • Rendre les documents facilement accessibles 

 

Laura Tessier

Responsable Communication, a rédigé cet article.

Leave a Reply

Your email address will not be published. Required fields are marked *