The ARDoCo Tool Landscape: REST API, TraceView, and TraceViz for Architecture Traceability
Dit artikel presenteert het ARDoCo Tool Landscape, een publiekelijk beschikbare suite bestaande uit een REST API, een browsergebaseerde frontend (TraceView) en een VS Code-extensie (TraceViz) die state-of-the-art herstel van traceability links toegankelijk maakt voor ontwikkelaars en architecten, terwijl het verbeterde begrip door middel van in-IDE visualisatie demonstreert.
Oorspronkelijk artikel gelicentieerd onder CC BY 4.0 (http://creativecommons.org/licenses/by/4.0/). Dit is een AI-gegenereerde uitleg van het onderstaande artikel. Het is niet geschreven of goedgekeurd door de auteurs. Raadpleeg het oorspronkelijke artikel voor technische nauwkeurigheid. Lees de volledige disclaimer
Stel je voor dat je de architect bent van een enorme, complexe stad. Je hebt drie verschillende sets blauwdrukken voor deze stad:
- Het Verhaal (SAD): Een geschreven beschrijving van hoe de stad zou moeten werken, geschreven in gewone Engelse taal.
- De Diagrammen (SAM): Formele tekeningen en modellen die laten zien hoe de gebouwen en wegen met elkaar verbonden zijn.
- De Constructie (Code): De eigenlijke bakstenen, mortel en bedrading die de echte stad vormen.
Het probleem is dat deze drie zaken vaak uit elkaar drijven. Het Verhaal zegt misschien "bouw een brug", maar de Diagrammen zijn het vergeten, en de Constructieploeg heeft een tunnel gebouwd in plaats daarvan. Het bijhouden van alles in synchronisatie is een nachtmerrie voor mensen, omdat er te veel informatie is om handmatig bij te houden.
Dit artikel introduceert een "magische gereedschapskist" genaamd ARDoCo die automatisch de verbindingen tussen deze drie blauwdrukken vindt en ontdekt waar ze van mening verschillen. Om deze gereedschapskist voor iedereen gemakkelijk te maken, heeft het team drie verschillende "deuren" in het systeem gebouwd:
1. De Machinekamer: De REST API
Beschouw dit als de centrale elektriciteitscentrale. Het is de zware machine die het eigenlijke werk doet van het vergelijken van het Verhaal, de Diagrammen en de Constructie.
- Voor wie het is: Andere softwaretools of programmeurs die deze motor in hun eigen systemen willen pluggen.
- Hoe het werkt: Je stuurt je blauwdrukken naar deze motor via het internet. Het voert de vergelijking uit, slaat de resultaten op (zodat het het werk niet opnieuw hoeft te doen als je er opnieuw om vraagt) en stuurt het antwoord terug. Het is alsof je een pizza bestelt: je stuurt de bestelling, de keuken bereidt de pizza en levert het resultaat.
2. De Controlekamer: TraceView
Dit is een webgebaseerd dashboard dat iedereen in een browser kan openen zonder iets te installeren.
- Voor wie het is: Architecten en managers die het "grote plaatje" moeten zien.
- Hoe het werkt: Stel je een scherm voor dat is opgedeeld in drie vensters. Aan de linkerkant is je Verhaal, in het midden zijn je Diagrammen, en aan de rechterkant is de Constructie. Wanneer je op een zin in het Verhaal klikt, markeert de tool direct het bijbehorende deel in de Diagrammen en de Constructie op de andere schermen. Het fungeert ook als een spotlight voor fouten, waarbij het rood knippert wanneer het Verhaal een gebouw vermeldt dat niet bestaat in de Diagrammen.
3. De Head-Up Display: TraceViz
Dit is een speciale add-on voor de werkplek van softwareontwikkelaars (specifiek voor een programma genaamd VS Code).
- Voor wie het is: De eigenlijke bouwers (developers) die de code schrijven.
- Hoe het werkt: In plaats van dat je van venster moet wisselen, schildert deze tool kleine gekleurde puntjes direct naast de regels code die je typt. Als je over een puntje zweeft, vertelt het je: "Hé, deze regel code is verbonden met deze zin in het Verhaal." Het is als een GPS voor code, waarmee je direct van een geschreven vereiste naar het exacte stukje code kunt springen dat eraan voldoet, zonder ooit je bureau te verlaten.
Werkte het?
Het team heeft deze tools getest op echte softwareprojecten.
- De Motor: De automatische koppeling is erg goed in het vinden van verbindingen en zit vaak meer dan 80% van de tijd goed, wat een enorme verbetering is ten opzichte van niets doen.
- De Head-Up Display: Ze vroegen een kleine groep ontwikkelaars om de tool te gebruiken. Het resultaat? Iedereen was het erover eens dat het hen hielp de code beter te begrijpen. Voordat ze de tool gebruikten, moesten ze handmatig door mappen graven om verbindingen te vinden. Met de gekleurde puntjes konden ze rechtstreeks naar het antwoord springen. Eén ontwikkelaar zei zelfs dat het geweldig zou zijn voor het trainen van nieuwe medewerkers.
De Kernboodschap
Het ARDoCo-team heeft complex, moeilijk bruikbaar computerwetenschappelijk onderzoek omgezet in een vriendelijke gereedschapskist. Of je nu de motor zelf wilt draaien, een dashboard in je browser wilt bekijken, of de verbindingen wilt zien terwijl je codeert, er is een tool voor jou om de blauwdrukken en de constructie van je softwarestad in perfecte synchronisatie te houden.
Verdrinkt u in papers in uw vakgebied?
Ontvang dagelijkse digests van de nieuwste papers die bij uw onderzoekswoorden passen — met technische samenvattingen, in uw taal.