Trace 7 - Documentation et diagrammes
Diagrammes de séquence et documentation du nouveau flux d'export.
Communication et documentation technique
Organisation et pilotage d'un chantier technique
Trace 7
Expliquer le chantier avec des schémas
Trace 7 - Diagramme utilisé pour expliquer le flux final avec jobs, batches, stockage et OpenSpout.
La Trace 7 ci-contre est un diagramme de séquence utilisé pour expliquer le nouveau fonctionnement de l'export Cockpit. Elle ne correspond pas à une fonctionnalité visible directement par l'utilisateur, mais à un support de compréhension pour l'équipe, pour la soutenance et pour le portfolio. Le but était de rendre une architecture technique lisible sans perdre l'essentiel.
Les éléments du diagramme représentent les acteurs techniques du flux : frontend, API PHP, MySQL, stockage fichiers et moteur OpenSpout. L'objectif était de montrer le chemin complet d'un export, depuis le clic de l'utilisateur jusqu'au fichier disponible dans l'historique. En construisant ce schéma pendant le chantier, j'ai aussi appris à capitaliser le travail au fur et à mesure pour discuter avec l'équipe et préparer la restitution.
La première étape pour construire la Trace 7 a été de choisir ce qu'il fallait montrer et ce qu'il fallait retirer. Un diagramme trop détaillé devient vite illisible ; un diagramme trop simple ne prouve pas vraiment la compréhension du système. J'ai donc gardé les étapes qui expliquent le mieux le chantier : création du job, envoi des données, stockage temporaire, génération et téléchargement.
La Trace 7 rappelle que documenter n'est pas juste "faire joli" : c'est une manière de vérifier que le système est compris et cohérent.