Solutravo - Documentation technique publique¶
Cette documentation a pour objectif d'aider un développeur à reprendre le développement des modules Solutravo sans connaître l'historique du projet.
Elle documente :
- le rôle fonctionnel de chaque module ;
- les fichiers à lire en priorité ;
- les flux techniques ;
- les tables et contrats de données ;
- les risques, bugs connus et points d'attention ;
- les commandes de diagnostic et de vérification.
Documentation publique
Cette documentation est publiee publiquement. Elle conserve les détails utiles a la reprise de développement, mais ne doit jamais exposer de secrets, tokens, mots de passe, clés API, données client, identifiants internes sensibles ou URLs d'administration non publiques.
Démarrage rapide¶
Pour reprendre un module :
- Lire la page du module dans
Modules. - Lire les fichiers "Points d'entrée" listés dans la page.
- Vérifier les migrations ou scripts SQL associés.
- Rejouer les tests recommandés.
- Examiner les risques avant toute modification.
Source de l'inventaire¶
L'inventaire initial a été construit en croisant l'historique Git, les noms de fichiers, les routes, les vues, les modèles, les services et les scripts SQL.
Il sert à prioriser les zones fonctionnelles à documenter. Il ne remplace pas une analyse du code actuel : un module peut avoir évolué, changer de responsabilité ou partager des fichiers avec d'autres modules.