2.1 Introduction
2.1.1 - Objectifs de la documentation détaillée
La conception détaillée a pour objectif de fournir des informations précises sur les fonctionnalités du système et sur la répartition de ces fonctionnalités dans les applicatifs, leurs couches et leurs composants.
Or la meilleure documentation détaillée est celle présente dans le code.
Donc une bonne partie de ce chapitre s’appuie sur la documentation générée depuis le code (définition de javadoc et JXR). Le chapitre 2.9 liens documentaires rassemble les liens documentaires.
2.1.2 - Les grands ensembles dans le code
Le dépôt de code de la solution est séparé en plusieurs grands ensembles :
- le répertoire 1-conception contient la documentation de l’ensemble de la solution. Cela comprend des éléments d’architecture, fonctionnels, techniques et des guides pour l’équipe. Cette documentation se fera au plus près du code au point d’être versionnée avec le code. Ainsi, chaque partie d’une fonctionnalité de la solution sera relue, de sa documentation à ses tests automatisés.
- le répertoire 2-code/socle contient le code du BACK, le socle applicatif Java portant les fonctionnalités du stockage des données jusqu’aux APIs exposant des services.
- le répertoire 2-code/front contient le code du FRONT, le framework et les applications WEB de démarche (sommaire description au chapitre 1.3.1).
- le répertoire 2-code/ias contient le code du projet Ansible permettant d’installer, déployer et démarrer l’ensemble des applicatifs.