Automating Requirements and Documentation Comprehension (ARDoCo)

The goal of the ARDoCo project is to connect architecture documentation and models with Traceability Link Recovery (TLR) while identifying missing or deviating elements (inconsistencies). An element can be any representable item of the model, like a component or a relation. To do so, we first create trace links and then make use of them and other information to identify inconsistencies.

ARDoCo is actively developed by researchers of the Modelling for Continuous Software Engineering (MCSE) group of KASTEL - Institute of Information Security and Dependability at the KIT.

This repository contains the framework and the approaches. As such, there is the definition of our pipeline and the data handling as well as the definitions for the various pipeline steps, inputs, outputs, etc.

For more information about the setup, the project structure, or the architecture, please have a look at the Wiki.

Maven

<dependencies>
	<dependency>
		<groupId>io.github.ardoco</groupId>
		<artifactId>parent</artifactId> <!-- or any other subproject -->
		<version>VERSION</version>
	</dependency>
</dependencies>

Relevant repositories

The following is an excerpt of repositories that use this framework and implement the different approaches and pipelines of ARDoCo:

• ardoco/core: implementing the core of the approach
• ardoco/tlr: implementing different traceability link recovery approaches
• ardoco/inconsistency-detection: implementing inconsistency detection approaches

Pull

• git subtree pull --prefix=core git@github.com:ardoco/core <<branch>>
• git subtree pull --prefix=tlr git@github.com:ardoco/tlr <<branch>>
• git subtree pull --prefix=inconsistency-detection git@github.com:ardoco/inconsistency-detection <<branch>>

Push

• git subtree push --prefix=core git@github.com:ardoco/core <<branch>>
• git subtree push --prefix=tlr git@github.com:ardoco/tlr <<branch>>
• git subtree push --prefix=inconsistency-detection git@github.com:ardoco/inconsistency-detection <<branch>>