Dossier de documentation logicielle

Ce dossier traite du développement d'un projet informatique et plus précisément du dossier de documentation logicielle qui accompagne le processus de développement. Il est ici question du contenu de ce dossier de documentation logicielle. Il est apporté des conseils pour le constituer : conseils sur la méthode et proposition d'outils (modèles de documents).

Contenu (succinct) du dossier de documentation logicielle
Le dossier de documentation logicielle contient la documentation technique qui accompagne le développement (de la phase de spécification à la phase de validation du logiciel). Il aborde également les aspects d'organisation et de suivi du développement.

Modèle de dossier de documentation logicielle
Il est proposé un modèle de dossier documentaire à produire sur un projet logiciel : " Documentation associée à un projet logiciel ".

Utilisation préconisée du modèle
Ce modèle n'est pas proposé pour être suivi à la lettre sur un projet, mais plutôt comme appui pour balayer tous les points auxquels réfléchir en terme de documentation. En particulier sur un projet existant il n'est pas question d'adapter la documentation à la référence présentée.

Modèle et documentation existante
Sur un projet déjà documenté (au moins en partie) il n'est pas très rentable d'adapter la documentation existante à la référence que propose le modèle " Documentation associée à un projet logiciel ". Si pour un élément donné du dossier modèle, l'information existe déjà éparpillée, l'essentiel sera plutôt d'indiquer précisément où la trouver. La fiche " point d'entrée " du dossier modèle sert à cela. Elle facilite l'accès à l'information, tout en évitant de réorganiser ce qui est déjà écrit.

La fiche " point d'entrée " du dossier de documentation logicielle
Le modèle " Documentation associée à un projet logiciel " commence par définir la fiche " point d'entrée " du dossier de documentation logicielle. Celle-ci répertorie l'ensemble des documents associés au logiciel.