The ARDoCo Tool Landscape: REST API, TraceView, and TraceViz for Architecture Traceability
Cet article présente l'ARDoCo Tool Landscape, une suite de logiciels disponible publiquement comprenant une API REST, un front-end basé sur un navigateur (TraceView) et une extension VS Code (TraceViz) qui rend la récupération de liens de traçabilité de pointe accessible aux développeurs et aux architectes tout en démontrant une meilleure compréhension grâce à la visualisation directement dans l'IDE.
Article original sous licence CC BY 4.0 (http://creativecommons.org/licenses/by/4.0/). Ceci est une explication générée par l'IA de l'article ci-dessous. Elle n'a pas été rédigée ni approuvée par les auteurs. Pour une précision technique, consultez l'article original. Lire la clause de non-responsabilité complète
Imaginez que vous soyez l'architecte d'une ville massive et complexe. Vous disposez de trois ensembles de plans différents pour cette ville :
- Le Livre d'Histoires (SAD) : Une description écrite de la manière dont la ville devrait fonctionner, rédigée en anglais courant.
- Les Diagrammes (SAM) : Des dessins et des modèles formels montrant comment les bâtiments et les routes sont connectés.
- La Construction (Code) : Les briques, le mortier et le câblage réels qui constituent la véritable ville.
Le problème est que ces trois éléments s'éloignent souvent l'un de l'autre. Le Livre d'Histoires peut dire « construire un pont », mais les Diagrammes l'ont oublié, et l'équipe de Construction a construit un tunnel à la place. Maintenir tout cela en synchronisation est un cauchemar pour les humains car il y a trop d'informations à suivre manuellement.
Ce document présente une « boîte à outils magique » appelée ARDoCo qui trouve automatiquement les connexions entre ces trois plans et repère les désaccords. Pour rendre cette boîte à outils facile à utiliser pour tout le monde, l'équipe a construit trois « portes » différentes dans le système :
1. La Salle des Machines : L'API REST
Considérez cela comme une centrale électrique centrale. C'est la machinerie lourde qui effectue le travail réel de comparaison du Livre d'Histoires, des Diagrammes et de la Construction.
- À qui cela s'adresse-t-il : Aux autres outils logiciels ou aux programmeurs qui souhaitent brancher ce moteur dans leurs propres systèmes.
- Comment cela fonctionne : Vous envoyez vos plans à ce moteur via Internet. Il exécute la comparaison, enregistre les résultats (pour ne pas avoir à refaire le travail si vous le demandez à nouveau) et renvoie la réponse. C'est comme commander une pizza : vous envoyez la commande, la cuisine prépare la pizza et la livre.
2. La Tour de Contrôle : TraceView
Il s'agit d'un tableau de bord basé sur le Web que n'importe qui peut ouvrir dans un navigateur sans rien installer.
- À qui cela s'adresse-t-il : Aux architectes et aux gestionnaires qui ont besoin d'avoir une « vue d'ensemble ».
- Comment cela fonctionne : Imaginez un écran divisé en trois fenêtres. À gauche se trouve votre Livre d'Histoires, au milieu vos Diagrammes et à droite la Construction. Lorsque vous cliquez sur une phrase dans le Livre d'Histoires, l'outil met instantanément en évidence la partie correspondante dans les Diagrammes et la Construction sur les autres écrans. Il agit également comme un projecteur d'erreurs, clignotant en rouge lorsque le Livre d'Histoires mentionne un bâtiment qui n'existe pas dans les Diagrammes.
3. L'Affichage Tête Haute : TraceViz
Il s'agit d'un ajout spécial pour l'espace de travail des développeurs de logiciels (spécifiquement pour un programme appelé VS Code).
- À qui cela s'adresse-t-il : Aux véritables constructeurs (développeurs) qui écrivent le code.
- Comment cela fonctionne : Au lieu de vous faire changer de fenêtre, cet outil peint de petits points colorés juste à côté des lignes de code que vous tapez. Si vous survolez un point, il vous dit : « Hé, cette ligne de code est liée à cette phrase du Livre d'Histoires. » C'est comme un GPS pour le code, vous permettant de passer instantanément d'une exigence écrite à la pièce de code exacte qui la remplit, sans jamais quitter votre bureau.
Est-ce que cela a fonctionné ?
L'équipe a testé ces outils sur des projets logiciels réels.
- Le Moteur : La correspondance automatique est très efficace pour trouver les connexions, réussissant souvent plus de 80 % du temps, ce qui est une amélioration énorme par rapport à l'absence de système.
- L'Affichage Tête Haute : Ils ont demandé à un petit groupe de développeurs d'utiliser l'outil. Le résultat ? Tout le monde est tombé d'accord sur le fait que cela les aidait à mieux comprendre le code. Avant d'utiliser l'outil, ils devaient fouiller manuellement dans les dossiers pour trouver les connexions. Avec les points colorés, ils pouvaient sauter directement à la réponse. Un développeur a même déclaré que ce serait idéal pour former les nouvelles recrues.
L'essentiel
L'équipe d'ARDoCo a transformé une recherche en informatique complexe et difficile d'utilisation en une boîte à outils conviviale. Que vous souhaitiez faire fonctionner le moteur vous-même, consulter un tableau de bord dans votre navigateur ou voir les connexions pendant que vous codez, il existe un outil pour vous permettre de maintenir les plans de la ville logicielle et sa construction en parfaite synchronisation.
Noyé(e) sous les articles dans votre domaine ?
Recevez des digests quotidiens des articles les plus récents correspondant à vos mots-clés de recherche — avec des résumés techniques, dans votre langue.