TD: Rewrite Resume

Chroma-Case · Nov 18, 2023 · 11d098c · 11d098c
1 parent 498eb26
commit 11d098c
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/tech_documentation/resume.tex b/tech_documentation/resume.tex
@@ -1,5 +1,7 @@
-Tout projet informatique doit être délivré avec 2 types de documentation: une documentation destinée à l’utilisateur du produit final, et une documentation destinée aux développeurs du projet. Cette dernière existe afin de permettre de aux potentiels nouveaux développeurs arrivant sur le projet de comprendre la structure, le fonctionnement et les normes que suit le projet.
+Tout projet informatique doit être délivré avec 2 types de documentation: une documentation destinée à l’utilisateur du produit final, et une documentation destinée aux développeurs du projet. Cette dernière vise à permettre aux nouveaux développeurs arrivant sur le projet de comprendre la structure et le design du projet, le fonctionnement des blocs qui le compose, et les interactions que ces blocs ont entre eux.
 
-Dans ce document, le lecteur pourra retrouver une description détaillée des de la structure du projet ChromaCase, de ses composants, c’est-à-dire de sa base de donnée, du serveur, de l’application front-end et du scorometer, ainsi que la manière dont ses composants communiquent entre eux. De plus, en lisant ce document, le développeur retrouvera comment prendre contact avec les différentes équipes du projet, et comment celles-ci coopèrent. Enfin, ce document explique le workflow de développement, permettant au développeur de comprendre quelles sont les étapes à suivre pour que ses contributions soient considérées et acceptées.
+Le project ChromaCase repose sur une structure en micro-service. Chaque micro-service, le choix des technologies utilisées, leur fonctionnement et architecture sont decrits dans ce document.
 
-Grâce à ce document, le lecteur aura tous les éléments nécessaires pour comprendre le fonctionnement et collaborer avec l’équipe ChromaCase.
+Le developement du projet suit des règles strictes inférées par une CI/CD et des verifications regulières de coding-style et norme (Lint, Prettier).
+
+À la fin de la lecture de ce document, le lecteur sera capable de comprendre le fonctionnement interne du projet et y contribuer.
diff --git a/tech_documentation/revisions.tex b/tech_documentation/revisions.tex
@@ -1,2 +1,4 @@
 13-08-2023 & 1.0     & Arthur JAMET & Toutes   & Première version	\\
-30-09-2023 & 1.1     & Arthur JAMET & Toutes   & Ajout de l'identité visuelle
+30-09-2023 & 1.1     & Arthur JAMET & Toutes   & Ajout de l'identité visuelle \\
+30-09-2023 & 1.1.1   & Arthur JAMET & Résumé   & Réécriture du résumé
+