Ctrl K

Automating Requirements and Documentation Comprehension (ARDoCo)

Automating Requirements and Documentation Comprehension (ARDoCo) is a framework to connect architecture documentation, requirements, and models while identifying missing or deviating elements (inconsistencies). An element can be any representable item of the model like a software component.

119
mentions
5
contributors
Get started
3214 commitsLast commit ≈ 1 week ago9 stars3 forks

Cite this software

Description

ARDoCo - Automating Requirements and Documentation Comprehension

Maven Verify Maven Quality Gate Status Latest Release DOI

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.

Our recent approaches, such as LiSSA, leverage Large Language Models (LLMs) and Information Retrieval (IR) to enable more generic and effective traceability link recovery across various artifact types.

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.

Website: ardoco.de

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.

Additional Resources

  • Approaches - Overview of different approaches including LiSSA
  • Publications - Research papers and presentations
  • People - Team members and contributors

Maven


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

Snapshots

Releases are on Maven Central. Development versions (-SNAPSHOT) are published to the public package registry of the ARDoCo mirror group on gitlab.kit.edu. Projects that use io.github.ardoco:parent as their parent resolve them automatically; otherwise add the repository:

<repositories>
	<repository>
		<id>ardocoSnapshots</id>
		<url>https://gitlab.kit.edu/api/v4/groups/253644/-/packages/maven</url>
		<releases>
			<enabled>false</enabled>
		</releases>
		<snapshots>
			<enabled>true</enabled>
		</snapshots>
	</repository>
</repositories>

To deploy a snapshot, configure a GitLab personal or group access token with api access in ~/.m2/settings.xml (for a deploy token with write_package_registry, use the header Deploy-Token instead of Private-Token):

<server>
	<id>ardocoSnapshots</id>
	<configuration>
		<httpHeaders>
			<property>
				<name>Private-Token</name>
				<value>${env.GITLAB_TOKEN}</value>
			</property>
		</httpHeaders>
	</configuration>
</server>

and run

mvn -Pdeployment -DskipTests -Dgpg.skip package deploy:deploy -DaltDeploymentRepository=ardocoSnapshots::https://gitlab.kit.edu/api/v4/projects/203206/packages/maven

Alternatively, run the Deploy Snapshot workflow for a branch. It only deploys -SNAPSHOT versions and needs the secret GITLAB_SNAPSHOT_TOKEN, a group deploy token with write_package_registry.

Participating organisations

Karlsruhe Institute of Technology (KIT)

Reference papers

Mentions

Contributors

SC
Sophie Corallo
Maintainer
Karlsruher Institut für Technologie
JK
Jan Keim
Maintainer
Karlsruhe Institute of Technology
TH
Tobias Hey

Helmholtz Program-oriented Funding IV

Related projects

Core Informatics

The future Helmholtz Topic "Core Informatics for Multidomain Impact" in the Research Field "Information".

Updated 4 weeks ago
In progress
The Helmholtz RSD will undergo scheduled maintenance on Thursday, 19. November 2026, from 13:00 to 14:00 CET. During this time, the service may be unavailable. We apologise for any inconvenience and appreciate your understanding.