This Visual Studio Code extension provides a comprehensive solution for maintaining architectural consistency and enhancing traceability within your software development projects. By ensuring that design decisions are traceable from inception through to implementation, this tool helps developers maintain coherence, prevent architectural erosion, and facilitate future maintenance.
Features
Encoding Design Decisions: Define and encode architectural design decisions using JSON.
Creating Traceability Links: Establish links between architectural decisions and source code elements.
Monitoring Decisions: Real-time monitoring of source code modifications to maintain architectural integrity.
Visualizing Traceability Links: Intuitive visualization of traceability links within Visual Studio Code.
Usage
Step 1: Encoding Design Decisions
Define your architectural design decisions using JSON.
Use the provided interface to input the name, roles, and constraints for each decision.
Step 2: Creating Traceability Links
Open the source code file where you want to establish a traceability link.
Use the form to create a traceability link by specifying the design decision and the corresponding code fragment details (file path, starting line, ending line).
Submit the form to inject the annotation directly into the Java class. If the annotation already exists, the new role will be appended to the array of roles.
Step 3: Monitoring Decisions
The tool continuously monitors source code modifications.
Any detected violations of architectural constraints are promptly reported to the developer.
Step 4: Visualizing Traceability Links
Access the visualization interface to explore the traceability links.
Collapse nodes to focus on specific decisions or navigate to the source code representing a role by clicking on a node.
