The ARDoCo Tool Landscape: REST API, TraceView, and TraceViz for Architecture Traceability
This paper presents the ARDoCo Tool Landscape, a publicly available suite comprising a REST API, a browser-based frontend (TraceView), and a VS Code extension (TraceViz) that makes state-of-the-art traceability link recovery accessible to developers and architects while demonstrating improved comprehension through in-IDE visualization.
Original paper licensed under CC BY 4.0 (http://creativecommons.org/licenses/by/4.0/). This is an AI-generated explanation of the paper below. It is not written or endorsed by the authors. For technical accuracy, refer to the original paper. Read full disclaimer
Imagine you are the architect of a massive, complex city. You have three different sets of blueprints for this city:
- The Storybook (SAD): A written description of how the city should work, written in plain English.
- The Diagrams (SAM): Formal drawings and models showing how the buildings and roads connect.
- The Construction (Code): The actual bricks, mortar, and wiring that make up the real city.
The problem is that these three things often drift apart. The Storybook might say "build a bridge," but the Diagrams forgot it, and the Construction crew built a tunnel instead. Keeping them all in sync is a nightmare for humans because there is too much information to track manually.
This paper introduces a "magic toolkit" called ARDoCo that automatically finds the connections between these three blueprints and spots where they disagree. To make this toolkit easy for everyone to use, the team built three different "doors" into the system:
1. The Engine Room: The REST API
Think of this as the central power plant. It's the heavy-duty machinery that does the actual work of comparing the Storybook, Diagrams, and Construction.
- Who it's for: Other software tools or programmers who want to plug this engine into their own systems.
- How it works: You send your blueprints to this engine over the internet. It runs the comparison, saves the results (so it doesn't have to re-do the work if you ask again), and sends the answer back. It's like ordering a pizza: you send the order, the kitchen cooks it, and delivers the result.
2. The Control Tower: TraceView
This is a web-based dashboard that anyone can open in a browser without installing anything.
- Who it's for: Architects and managers who need to see the "big picture."
- How it works: Imagine a screen split into three windows. On the left is your Storybook, the middle is your Diagrams, and the right is the Construction. When you click on a sentence in the Storybook, the tool instantly highlights the matching part in the Diagrams and the Construction on the other screens. It also acts like a spotlight for errors, flashing red when the Storybook mentions a building that doesn't exist in the Diagrams.
3. The Head-Up Display: TraceViz
This is a special add-on for the software developers' workspace (specifically for a program called VS Code).
- Who it's for: The actual builders (developers) writing the code.
- How it works: Instead of making you switch windows, this tool paints little colored dots right next to the lines of code you are typing. If you hover over a dot, it tells you, "Hey, this line of code connects to this sentence in the Storybook." It's like a GPS for code, letting you jump instantly from a written requirement to the exact piece of code that fulfills it, without ever leaving your desk.
Did it work?
The team tested these tools on real-world software projects.
- The Engine: The automatic matching is very good at finding connections, often getting it right more than 80% of the time, which is a huge improvement over doing nothing.
- The Head-Up Display: They asked a small group of developers to use the tool. The result? Everyone agreed it helped them understand the code better. Before using it, they had to manually dig through folders to find connections. With the colored dots, they could jump straight to the answer. One developer even said it would be great for training new hires.
The Bottom Line
The ARDoCo team has taken complex, difficult-to-use computer science research and turned it into a friendly toolkit. Whether you want to run the engine yourself, look at a dashboard in your browser, or see the connections while you code, there is a tool for you to keep your software city's blueprints and construction in perfect sync.
Drowning in papers in your field?
Get daily digests of the most novel papers matching your research keywords — with technical summaries, in your language.