AntoineArchy / Lettings-FR

Refactoring d'une base de code comportant de nombreuses dettes techniques. Mise en place d'un pipeline CI/CD avec GitHub Actions et Docker.
1 stars 0 forks source link

Documentation de l’application #14

Closed AntoineArchy closed 7 months ago

AntoineArchy commented 8 months ago

créer une documentation de spécification technique

La documentation doit comporter : ● la description du projet ; ● les instructions sur l’installation du projet ; ● un guide de démarrage rapide ; ● les technologies et les langages de programmation à utiliser ; ● une description de la structure de la base de données et des modèles de données ; ● une description des interfaces de programmation ; ● un guide d’utilisation (avec des cas d’utilisation) ; ● les procédures de déploiement et de gestion de l'application.