- Production de la documentation finale -[ Toute la documentation ] |
|
Trois sortes de documentation doivent être produites :
La documentation techniqueElle est constituée par le Dossier de Réalisation (DR) qui est une synthèse des différents DRP, et qui contient la totalité des modèles, maquettes et descriptifs qui ont servi au codage et à l'intégration. Le DRP intègre également tous les documents DRNR, FAP et FMP qui ont été utilisés pour les corrections et les modifications.La structure en plusieurs prototypes doit être conservée car elle est l'image exacte de la structure finale du logiciel. Une remise à plat de cette structure pourra éventuellement être faite plus tard, à l'occasion de l'étude d'une nouvelle version. Cette documentation sera utilisée conjointement avec les commentaires intégrés aux sources, lors des opérations de maintenance ultérieures au cours desquelles elle sera mise à jour. Selon la façon dont les sources ont été structurés et en fonction du langage utilisé, une grande partie de la documentation pourra être obtenue par extraction des programmes sources en utilisant des logiciels de retro-ingénierie disponibles avec certains AGL ou d'extraction automatique de commentaires tel que Javadoc. La documentation contractuelleCette documentation permet de définir parfaitement toutes les prestations qui interviendront pendant la durée de vie du logiciel : garantie, procédures de sécurité et d'assistance, maintenance, évolutions prévues...Certains documents seront de véritables contrats qui engagent les parties, d'autres seront de simples prescriptions qui décriront les procédures à suivre lors de l'arrivée de certains événements. Ces documents seront décrits lors de la phase de déploiement. La documentation utilisateurElle est constituée du Guide d'Installation (GI) et du Manuel Utilisateur (MU).Ces deux documents doivent être rédigés complètement en s'inspirant de ceux qui avaient été livrés avec les prototypes (GIP et MUP) et en tenant compte des remarques faites par les utilisateurs-valideurs. Le GI devra intégrer les procédures d'installation proposées aux utilisateurs et, si les procédures automatisées sont performantes, il pourra être réduit à sa plus simple expression. Le MU présentera le logiciel en décrivant chaque fonction de façon individuelle et en indiquant quelles sont les commandes qui permettent de lancer chacune d'entre elles. Autant que faire se peut, les fonctions seront regroupées par cas d'utilisation, tels qu'ils ont été définis au début du projet. De cette façon, on gardera une certaine homogénéité par rapport aux utilisateurs. Ce document pourra être considéré comme un complément à l'aide interactive intégrée au logiciel. |
![]() |




