diff --git a/README.md b/README.md index b923f3b0..cfda8914 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,5 @@

- ArDoCo + ARDoCo

-# [ArDoCo - Architecture Documentation Consistency](https://github.com/ArDoCo) - -In this research project, we aim to provide consistency analyses between different kind of documentation, namely formal models and informal (textual) documentation. +# [ARDoCo - Automating Requirements and Documentation Comprehension](https://github.com/ardoco) diff --git a/_approaches/arcotl.md b/_approaches/arcotl.md new file mode 100644 index 00000000..6019ef4e --- /dev/null +++ b/_approaches/arcotl.md @@ -0,0 +1,17 @@ +--- +title: ArCoTL +description: ArCoTL – TLR between Software Architecture Models and Code. +permalink: /approaches/arcotl/ +importance: 2 +layout: approach +--- + +![ArCoTL Overview](/assets/img/approaches/icse24-transarc.svg){:width="100%" style="background-color: white; border-radius: 8px; padding: 10px; display: block; margin: 0 auto;"} + +ArCoTL (Architecture–Code Trace Links) focuses on linking a given architecture model (SAM) to the source code. +It assumes you have a formal model of the system's components and interfaces, and wants to find the corresponding code. +ArCoTL transforms both the architecture model and the code into intermediate representations (e.g. simplified graphs) and then applies various heuristics to match elements +These heuristics include standalone rules and dependent rules (which consider relationships) plus filters to refine the links. + +- How it works: Starting from a SAM and the codebase, ArCoTL builds simplified model and code representations. It then uses text similarity, naming conventions, and dependency heuristics to propose links between each model component and code artifact. +- Effectiveness: ArCoTL turned out to be very effective on its own. In experiments, the model-to-code step (ArCoTL) achieved an average F1 of ~0.98. diff --git a/_approaches/ardocode.md b/_approaches/ardocode.md new file mode 100644 index 00000000..1c381abd --- /dev/null +++ b/_approaches/ardocode.md @@ -0,0 +1,18 @@ +--- +title: ArDoCode +description: ArDoCode – TLR between Software Architecture Documentation and Code. +permalink: /approaches/ardocode/ +importance: 5 +layout: approach +--- + +![ArCoTL Overview](/assets/img/approaches/icse24-ardocode.svg){:width="100%" style="border-radius: 8px; padding: 10px; display: block; margin: 0 auto;"} + +ArDoCode is a simpler variant of trace recovery that treats source code itself as the "model". +Instead of first building a formal model, ArDoCode directly matches architecture document content with code elements using the same heuristics designed for linking docs to models. +In practice, it extracts key terms from the documentation and tries to align them with names in the code (e.g. class or module names) as if the code were the model. + +- Key idea: Apply the SWATTR approach without an explicit SAM by interpreting the codebase as a model. For example, if the doc mentions a component "WebUI" and there is a WebUI package in code, ArDoCode will link them. +- Effectiveness: Because it skips the formal modeling step, ArDoCode is easier to apply but less precise. In evaluations, ArDoCode achieved a weighted F1 of only ~0.62, substantially lower than the full TransArC method. It serves mainly as a baseline and demonstrates that without structured models, the TLR performance drops. + +See our [ICSE 2024 publication page](/c/icse24) for details, links, and resources. diff --git a/_approaches/inconsistency-detection.md b/_approaches/inconsistency-detection.md new file mode 100644 index 00000000..789772fa --- /dev/null +++ b/_approaches/inconsistency-detection.md @@ -0,0 +1,22 @@ +--- +title: Inconsistency Detection +description: Documentation-Model-Inconsistency-Analysis pipeline. +permalink: /approaches/inconsistency-detection/ +importance: 8 +layout: approach +--- + +![Approach Overview](/assets/img/approaches/icsa23-inconsistency.svg){:width="100%" style="background-color: white; border-radius: 8px; padding: 10px; display: block; margin: 0 auto;"} + +The ArDoCo inconsistency detection approach uses trace link recovery to detect inconsistencies between natural-language architecture documentation and formal models. +It identifies two kinds of issues: + +(a) Unmentioned Model Elements (UMEs): components or interfaces that appear in the model but are never described in the documentation; +(b) Missing Model Elements (MMEs): elements mentioned in the text that do not exist in the model. + +The method runs a TLR procedure (namely SWATTR) and then flags any model element with no corresponding text link (a UME) or any sentence that refers to a non-modeled item (an MME). + +- Detection strategy: Use the TLR results as a bridge. After linking as many sentences to model elements as possible, any "orphan" model nodes or text mentions indicate a consistency gap. For example, if the model has a "Cache" component with no sentence linked, that is an UME; if the doc talks about "Common" but the model lacks it, that is an MME. +- Results: The approach achieved an excellent F1 (0.81) for the underlying trace recovery. For inconsistency detection, it attained ~93% accuracy in identifying UMEs and ~75% for MMEs, significantly better than naive baselines. These results suggest that using trace links is a promising way to find documentation-model mismatches. + +See our [ICSA 2023 publication page](/c/icsa23) for details, links, and resources. diff --git a/_approaches/lissa.md b/_approaches/lissa.md new file mode 100644 index 00000000..f9d98bdc --- /dev/null +++ b/_approaches/lissa.md @@ -0,0 +1,19 @@ +--- +title: LiSSA +description: LiSSA – LLM/RAG-based TLR. +permalink: /approaches/lissa/ +importance: 6 +layout: approach +--- + +![LiSSA Overview](/assets/img/approaches/icse25-lissa.svg){:width="100%" style="background-color: white; border-radius: 8px; padding: 10px; display: block; margin: 0 auto;"} + +LiSSA (Linking Software System Artifacts) is a retrieval-augmented, LLM-based approach that aims to be generic across artifact types. +The key idea is to use a Large Language Model (LLM) together with information retrieval (IR) to find trace links. +For a given source artifact (e.g. a requirement or a sentence in documentation), LiSSA first uses IR techniques to retrieve a small set of potentially relevant target artifacts (code files, model elements, etc.). +It then queries the LLM with the retrieved context to generate or suggest the most likely trace link. + +- Scope: LiSSA was tested on multiple tasks including requirements→code, documentation→code, and architecture-docs→models. The same RAG process is applied in each case, making it a one-size-fits-many solution. +- Effectiveness: In experiments, LiSSA significantly outperformed state-of-the-art tools on the code-centric tasks. For example, it showed much higher accuracy when linking requirements to code than prior methods. + +LiSSA is primarily associated with our [ICSE 2025 publication page](/c/icse25), but is also related to our [REFSQ 2025 publication page](/c/refsq25). See these pages for details, links, and resources. diff --git a/_approaches/secdragon.md b/_approaches/secdragon.md new file mode 100644 index 00000000..09b1b4e0 --- /dev/null +++ b/_approaches/secdragon.md @@ -0,0 +1,9 @@ +--- +title: SecDragon +description: SecDragon – TLR for Security Requirements. +permalink: /approaches/secdragon/ +importance: 7 +layout: page +--- + +🚧 This approach is not available yet. diff --git a/_approaches/swattr.md b/_approaches/swattr.md new file mode 100644 index 00000000..9ebe1f19 --- /dev/null +++ b/_approaches/swattr.md @@ -0,0 +1,20 @@ +--- +title: SWATTR +description: SWATTR – TLR between Software Architecture Documentation and Software Architecture Models. +permalink: /approaches/swattr/ +importance: 1 +layout: approach +--- + +![SWATTR Overview](/assets/img/approaches/ecsa21-swattr.svg){:width="100%" style="border-radius: 8px; padding: 10px; display: block; margin: 0 auto;"} + +SWATTR (SoftWare Architecture TexT TRace link recovery) is an agent-based framework for linking textual architecture documentation (SAD) and formal models (SAM). +Rather than focusing on a single algorithm, SWATTR defines a pipeline with multiple stages where different "agents" can operate. +First it extracts and preprocesses text from the SAD and components from the architecture model. +Next, it uses NLP and heuristics to identify architecture elements (like component names) mentioned in the text. +Finally, it connects these identified text elements to model elements to form trace links. + +- Pipeline stages: The framework is extendable, meaning you can plug in different strategies at each step. For example, one agent might use term matching to find components in sentences, while another uses more advanced similarity measures. All results are aggregated to produce the final links. +- Results: SWATTR was evaluated on three case studies and achieved a weighted average F1-score of about 0.72 for trace recovery. This was a strong performance (outperforming simple baselines by ~0.24 F1) and demonstrated the benefit of the multi-stage approach. + +See our [ECSA 2021 publication page](/c/ecsa21) for details, links, and resources. diff --git a/_approaches/transarc.md b/_approaches/transarc.md new file mode 100644 index 00000000..bd4d0f71 --- /dev/null +++ b/_approaches/transarc.md @@ -0,0 +1,19 @@ +--- +title: TransArC +description: TransArC – TLR between Software Architecture Documentation, Models, and Code. +permalink: /approaches/transarc/ +importance: 3 +layout: approach +--- + +![TransArC Overview](/assets/img/approaches/icse24-transarc.svg){:width="100%" style="background-color: white; border-radius: 8px; padding: 10px; display: block; margin: 0 auto;"} + +TransArC is a transitive trace link recovery approach that connects architecture documents to code via an intermediate architecture model. +It first uses an existing method (SWATTR) to connect the textual architecture documentation and component-based architecture model (SAM), then applies a new method (ArCoTL) to link the model elements to code. +In other words, TransArC builds a bridge: document ⟶ model ⟶ code. +This two-step strategy helps bridge the semantic gap between informal text and code. + +- How it works: TransArC extracts combines the two link sets of trace links, namely SWATTR and ArCoTL, to produce trace links transitively from documentation to code. +- Results: In experiments on five systems, TransArC achieved a high average F1 score (~0.82) for recovering documentation-to-code links, significantly outperforming baseline methods. This shows that combining the two specialized steps yields much more accurate links than simpler approaches. + +See our [ICSE 2024 publication page](/c/icse24) for details, links, and resources. diff --git a/_approaches/transarcai.md b/_approaches/transarcai.md new file mode 100644 index 00000000..93efb698 --- /dev/null +++ b/_approaches/transarcai.md @@ -0,0 +1,20 @@ +--- +title: "TransArC-AI" +description: "TransArC-AI – LLM-based TLR between Software Architecture Documentation, Models, and Code." +permalink: /approaches/transarc-ai/ +importance: 4 +layout: approach +--- + +![TransArC-AI Overview](/assets/img/approaches/icsa25-transarc.svg){:width="100%" style="background-color: white; border-radius: 8px; padding: 10px; display: block; margin: 0 auto;"} + +TransArC-AI extends the TransArC idea by using an LLM to generate a simple architecture mode (SAM). +In this approach, instead of requiring a hand-made SAM, a large language model (such as GPT-4) is prompted to extract or invent the main component names from the SAD (and optionally from code). +These names serve as a minimal architecture model (i.e. a list of components). +Then, as in TransArC, these LLM-derived components are matched to code. +The goal is to bridge the SAD–code gap without manual modeling. + +- How it works: Given the software architecture text and the codebase, the system asks the LLM to list likely component names. That list of names forms a "Simple Software Architecture Model" (SSAM). Finally, code elements with matching names or descriptions are linked to the documentation. This pipeline avoids needing an explicit UML model. +- Effectiveness: TransArC-AI achieved very competitive results. Using GPT-4o, it obtained a weighted F1 of about 0.86, nearly as good as the original TransArC with a hand-made model (F1 0.87). It also substantially outperformed the ArDoCode baseline (which scored ~0.62). This shows that LLMs can automatically infer the key architectural components. + +See our [ICSA 2025 publication page](/c/icsa25) for details, links, and resources. diff --git a/_approaches/tv.md b/_approaches/tv.md new file mode 100644 index 00000000..ae42be27 --- /dev/null +++ b/_approaches/tv.md @@ -0,0 +1,11 @@ +--- +title: ARDoCo-TV +description: "Trace View: a viewer for trace links." +permalink: /approaches/tv/ +importance: 9 +layout: page +--- + +ARDoCo-TV is a tool for visualizing trace links between software artifacts, supporting the analysis and understanding of traceability in software projects. + +See our [ARDoCo TV](https://tv.ardoco.de) for more information. diff --git a/_pages/conferences/aire25.md b/_conferences/aire25.md similarity index 89% rename from _pages/conferences/aire25.md rename to _conferences/aire25.md index eb8b3d55..c886868f 100644 --- a/_pages/conferences/aire25.md +++ b/_conferences/aire25.md @@ -9,11 +9,13 @@ authors: - stefan_schwedt - jan_keim - tobias_hey +approaches: + - LiSSA --- To be published at the [33rd International Requirements Engineering Conference Workshops (REW)](https://aire-ws.github.io/aire25/). -![Approach Overview](/assets/img/aire-approach.svg){:width="100%" style="background-color: white; border-radius: 8px; padding: 10px; display: block; margin: 0 auto;"} +![AIRE25 Overview](/assets/img/approaches/aire25-aire.svg){:width="100%" style="background-color: white; border-radius: 8px; padding: 10px; display: block; margin: 0 auto;"} ## Abstract @@ -39,4 +41,4 @@ Moreover, it provides insights into the performance of traditional IR techniques ## Links - Paper on [KITopen](https://publikationen.bibliothek.kit.edu/1000183058) -- Replication Package on [Zenodo](https://doi.org/10.5281/zenodo.15837231) and the corresponding [GitHub repository](https://github.com/ArDoCo/Replication-Package-AIRE25_Beyond-Retrieval-Using-LLM-Ensembles-for-Candidate-Filtering-in-Req-TLR) +- Replication Package on [Zenodo](https://doi.org/10.5281/zenodo.15837231) and the corresponding [GitHub repository](https://github.com/ardoco/Replication-Package-AIRE25_Beyond-Retrieval-Using-LLM-Ensembles-for-Candidate-Filtering-in-Req-TLR) diff --git a/_pages/conferences/ecsa21.md b/_conferences/ecsa21.md similarity index 90% rename from _pages/conferences/ecsa21.md rename to _conferences/ecsa21.md index d1f9b7fb..2508f88f 100644 --- a/_pages/conferences/ecsa21.md +++ b/_conferences/ecsa21.md @@ -11,10 +11,14 @@ authors: - claudius_kocher - janek_speit - anne_koziolek +approaches: + - SWATTR --- Published at the [15th European Conference on Software Architecture (ECSA 2021), September 13-17 2021](https://conf.researchr.org/home/ecsa-2021) +![SWATTR Overview](/assets/img/approaches/ecsa21-swattr.svg){:width="100%" style="border-radius: 8px; padding: 10px; display: block; margin: 0 auto;"} + ## Abstract Software Architecture Documentation often consists of different artifacts. @@ -32,5 +36,5 @@ Moreover, our approach outperforms the baseline approaches on non-weighted avera ## Links - Paper on [Springer Link](https://doi.org/10.1007/978-3-030-86044-8_7) and on [KITopen](https://doi.org/10.5445/IR/1000138399) -- Replication Package on [Zenodo](https://doi.org/10.5281/zenodo.4730621) and the corresponding [GitHub repository](https://github.com/ArDoCo/SWATTR) +- Replication Package on [Zenodo](https://doi.org/10.5281/zenodo.4730621) and the corresponding [GitHub repository](https://github.com/ardoco/SWATTR) - [Slides](/assets/pdf/presentation_21_ecsa_TLR.pdf) diff --git a/_pages/conferences/fg-arch24.md b/_conferences/fg-arch24.md similarity index 87% rename from _pages/conferences/fg-arch24.md rename to _conferences/fg-arch24.md index bcbe7760..70c65dbe 100644 --- a/_pages/conferences/fg-arch24.md +++ b/_conferences/fg-arch24.md @@ -8,9 +8,7 @@ authors: - tobias_hey --- -

- ArDoCo -

+![FGARCH24 Titleslide](/assets/img/approaches/fgarch24-titleslide.png){:width="100%" style="background-color: white; border-radius: 8px; padding: 10px; display: block; margin: 0 auto;"} Vortrag bei der Jahrestagung der GI-Fachgruppe "Architekturen" am 24. und 25. Oktober 2024 in Paderborn. diff --git a/_pages/conferences/icsa23.md b/_conferences/icsa23.md similarity index 89% rename from _pages/conferences/icsa23.md rename to _conferences/icsa23.md index f13ecea3..b453c2a9 100644 --- a/_pages/conferences/icsa23.md +++ b/_conferences/icsa23.md @@ -9,13 +9,16 @@ authors: - sophie_corallo - dominik_fuchss - anne_koziolek +approaches: + - SWATTR + - "Inconsistency Detection" --- Published at the [20th IEEE International Conference on Software Architecture (ICSA 2023), March 13-17 2023](https://icsa-conferences.org/2023/). Additional presentation at the [Software Engineering 2024 (SE24)](https://se2024.se.jku.at/), the symposium of the German Computer Science Society (Gesellschaft für Informatik (GI)) together with the Austrian Computer Society. -![Approach Overview](/assets/img/approach_overview_icsa23.svg){:width="100%"} +![Inconsistency Detection Overview](/assets/img/approaches/icsa23-inconsistency.svg){:width="100%" style="background-color: white; border-radius: 8px; padding: 10px; display: block; margin: 0 auto;"} ## Abstract @@ -24,6 +27,6 @@ Documenting software architecture is important for a system’s success. Softwar ## Links - Paper on [IEEE Xplore](https://doi.org/10.1109/ICSA56044.2023.00021) and on [KITopen](https://doi.org/10.5445/IR/1000158208) -- Replication Package on [Zenodo](https://doi.org/10.5281/zenodo.7555194) and the corresponding [GitHub repository](https://github.com/ArDoCo/DetectingInconsistenciesInSoftwareArchitectureDocumentationUsingTraceabilityLinkRecovery) +- Replication Package on [Zenodo](https://doi.org/10.5281/zenodo.7555194) and the corresponding [GitHub repository](https://github.com/ardoco/DetectingInconsistenciesInSoftwareArchitectureDocumentationUsingTraceabilityLinkRecovery) - [Slides (ICSA23)](/assets/pdf/presentation_23_ICSA_InconsistencyDetection.pdf) - [Slides (SE24)](/assets/pdf/presentation_24_SE_InconsistencyDetection.pdf) diff --git a/_pages/conferences/icsa25.md b/_conferences/icsa25.md similarity index 88% rename from _pages/conferences/icsa25.md rename to _conferences/icsa25.md index ebb69321..2dbe4a0d 100644 --- a/_pages/conferences/icsa25.md +++ b/_conferences/icsa25.md @@ -10,11 +10,14 @@ authors: - tobias_hey - jan_keim - anne_koziolek +approaches: + - TransArC-AI + - TransArC --- Published at the [22nd IEEE International Conference on Software Architecture (ICSA 2025), March 31 - April 04 2025](https://conf.researchr.org/home/icsa-2025/). -![Approach Overview](/assets/img/icsa25-approach.svg){:width="100%" style="background-color: white; border-radius: 8px; padding: 10px; display: block; margin: 0 auto;"} +![TransArC-AI Overview](/assets/img/approaches/icsa25-transarc.svg){:width="100%" style="background-color: white; border-radius: 8px; padding: 10px; display: block; margin: 0 auto;"} ## Abstract @@ -34,5 +37,5 @@ In summary, our approach shows that LLMs can be used to make TLR between SAD and ## Links - Paper on [KITopen](https://publikationen.bibliothek.kit.edu/1000179830) -- Replication Package on [Zenodo](https://doi.org/10.5281/zenodo.14506935) and the corresponding [GitHub repository](https://github.com/ArDoCo/ReplicationPackage-EnablingArchitectureTraceabilitybyLLM-basedArchitectureComponentNameExtraction) +- Replication Package on [Zenodo](https://doi.org/10.5281/zenodo.14506935) and the corresponding [GitHub repository](https://github.com/ardoco/ReplicationPackage-EnablingArchitectureTraceabilitybyLLM-basedArchitectureComponentNameExtraction) - Slides as [pptx](/assets/pdf/presentation_icsa25.pptx) or [pdf](/assets/pdf/presentation_icsa25.pdf) diff --git a/_pages/conferences/icse24.md b/_conferences/icse24.md similarity index 89% rename from _pages/conferences/icse24.md rename to _conferences/icse24.md index 9240adda..92f6277a 100644 --- a/_pages/conferences/icse24.md +++ b/_conferences/icse24.md @@ -11,15 +11,18 @@ authors: - tobias_hey - tobias_telge - anne_koziolek +approaches: + - TransArC + - ArCoTL + - SWATTR + - ArDoCode --- Published at the [46th International Conference on Software Engineering (ICSE 2024), April 14-20 2024](https://conf.researchr.org/home/icse-2024). Additional presentation at the [Software Engineering 2025 (SE25)](https://se2025.sdq.kastel.kit.edu/), the symposium of the German Computer Science Society (Gesellschaft für Informatik (GI)). -

- Approach Overview -

+![TransArC Overview](/assets/img/approaches/icse24-transarc.svg){:width="100%" style="background-color: white; border-radius: 8px; padding: 10px; display: block; margin: 0 auto;"} ## Abstract @@ -44,6 +47,6 @@ In future research, we will explore further possibilities for such transitive ap ## Links - Paper (Open Access) on [ACM](https://doi.org/10.1145/3597503.3639130) or [KITopen](https://doi.org/10.5445/IR/1000165692) -- Replication Package on [Zenodo](https://doi.org/10.5281/zenodo.10411853) and the corresponding [GitHub repository](https://github.com/ArDoCo/Replication-Package-ICSE24_Recovering-Trace-Links-Between-Software-Documentation-And-Code) +- Replication Package on [Zenodo](https://doi.org/10.5281/zenodo.10411853) and the corresponding [GitHub repository](https://github.com/ardoco/Replication-Package-ICSE24_Recovering-Trace-Links-Between-Software-Documentation-And-Code) - Slides as [pptx](/assets/pdf/presentation_icse24.pptx) or [pdf](/assets/pdf/presentation_icse24.pdf) - [Slides (SE25)](/assets/pdf/presentation_25_SE_TransArC.pdf) diff --git a/_pages/conferences/icse25.md b/_conferences/icse25.md similarity index 90% rename from _pages/conferences/icse25.md rename to _conferences/icse25.md index 6d26c778..c34d5c94 100644 --- a/_pages/conferences/icse25.md +++ b/_conferences/icse25.md @@ -12,11 +12,13 @@ authors: - niklas_ewald - tobias_thirolf - anne_koziolek +approaches: + - LiSSA --- Published at the [47th IEEE/ACM International Conference on Software Engineering (ICSE 2025), April 27 - May 03 2025](https://conf.researchr.org/home/icse-2025/). -![Approach Overview](/assets/img/icse25-approach.svg){:width="100%" style="background-color: white; border-radius: 8px; padding: 10px; display: block; margin: 0 auto;"} +![LiSSA Overview](/assets/img/approaches/icse25-lissa.svg){:width="100%" style="background-color: white; border-radius: 8px; padding: 10px; display: block; margin: 0 auto;"} ## Abstract @@ -36,5 +38,5 @@ However, further research is required to improve the performance of RAG-based ap ## Links - Paper on [IEEE Xplore](https://doi.org/10.1109/ICSE55347.2025.00186) or [KITopen](https://publikationen.bibliothek.kit.edu/1000179816) -- Replication Package on [Zenodo](https://doi.org/10.5281/zenodo.14714706) and the corresponding [GitHub repository](https://github.com/ArDoCo/ReplicationPackage-ICSE25_LiSSA-Toward-Generic-Traceability-Link-Recovery-through-RAG/tree/main) +- Replication Package on [Zenodo](https://doi.org/10.5281/zenodo.14714706) and the corresponding [GitHub repository](https://github.com/ardoco/ReplicationPackage-ICSE25_LiSSA-Toward-Generic-Traceability-Link-Recovery-through-RAG/tree/main) - Slides as [pptx](/assets/pdf/presentation_icse25.pptx) or [pdf](/assets/pdf/presentation_icse25.pdf) diff --git a/_pages/conferences/refsq25.md b/_conferences/refsq25.md similarity index 88% rename from _pages/conferences/refsq25.md rename to _conferences/refsq25.md index cf909070..dbd41996 100644 --- a/_pages/conferences/refsq25.md +++ b/_conferences/refsq25.md @@ -9,11 +9,13 @@ authors: - dominik_fuchss - jan_keim - anne_koziolek +approaches: + - LiSSA --- Published at the [31st International Working Conference on Requirements Engineering: Foundation for Software Quality](https://2025.refsq.org/). -![Approach Overview](/assets/img/refsq25-approach.svg){:width="100%" style="background-color: white; border-radius: 8px; padding: 10px; display: block; margin: 0 auto;"} +![REFSQ25 Overview](/assets/img/approaches/refsq25-refsq.svg){:width="100%" style="background-color: white; border-radius: 8px; padding: 10px; display: block; margin: 0 auto;"} ## Abstract @@ -35,4 +37,4 @@ In an empirical evaluation on six benchmark datasets, we show that chain-of-thou ## Links - Paper on [KITopen](https://publikationen.bibliothek.kit.edu/1000179817) or [Springer Nature](https://doi.org/10.1007/978-3-031-88531-0_27) -- Replication Package on [Zenodo](https://doi.org/10.5281/zenodo.14779457) and the corresponding [GitHub repository](https://github.com/ArDoCo/ReplicationPackage-REFSQ25_Requirements-TLR-via-RAG) +- Replication Package on [Zenodo](https://doi.org/10.5281/zenodo.14779457) and the corresponding [GitHub repository](https://github.com/ardoco/ReplicationPackage-REFSQ25_Requirements-TLR-via-RAG) diff --git a/_pages/conferences/se24.md b/_conferences/se24.md similarity index 100% rename from _pages/conferences/se24.md rename to _conferences/se24.md diff --git a/_pages/conferences/se25.md b/_conferences/se25.md similarity index 100% rename from _pages/conferences/se25.md rename to _conferences/se25.md diff --git a/_config.yml b/_config.yml index f7d369e0..f1109771 100644 --- a/_config.yml +++ b/_config.yml @@ -5,7 +5,7 @@ title: blank # the website title (if blank, full name will be used instead) first_name: middle_name: -last_name: ArDoCo +last_name: ARDoCo contact_note: > If you have any questions, feel free to contact me at {{ site.email }}. @@ -146,6 +146,10 @@ collections: output: true projects: output: true + approaches: + output: true + conferences: + output: true # ----------------------------------------------------------------------------- # Jekyll settings diff --git a/_data/repositories.yml b/_data/repositories.yml index cd51822d..6373342e 100644 --- a/_data/repositories.yml +++ b/_data/repositories.yml @@ -3,8 +3,8 @@ github_users: null repo_description_lines_max: 2 github_repos: - - ArDoCo/ArDoCo - - ArDoCo/TLR - - ArDoCo/InconsistencyDetection - - ArDoCo/Metrics - - ArDoCo/LiSSA-RATLR + - ardoco/ardoco + - ardoco/tlr + - ardoco/inconsistency-detection + - ardoco/metrics + - ardoco/lissa-ratlr diff --git a/_data/socials.yml b/_data/socials.yml index ee1e52be..91b5c6a4 100644 --- a/_data/socials.yml +++ b/_data/socials.yml @@ -10,7 +10,7 @@ email: ardoco@lists.kit.edu # your email address # facebook_id: # your facebook id # flickr_id: # your flickr id -github_username: ArDoCo # your GitHub user name +github_username: ARDoCo # your GitHub user name # gitlab_username: # your GitLab user name # ieee_id: # your ieeexplore.ieee.org/author/id # inspirehep_id: # Inspire HEP author ID diff --git a/_layouts/approach.liquid b/_layouts/approach.liquid new file mode 100644 index 00000000..f84a56b9 --- /dev/null +++ b/_layouts/approach.liquid @@ -0,0 +1,36 @@ +--- +layout: page +--- +
+ {{ content }} +
+ +{% assign project_title = page.title %} +{% assign related = site.conferences | where_exp: 'conf', 'conf.approaches contains project_title' %} +{% if related.size > 1 %} +
+

Related Publications

+ +
+{% elsif related.size == 1 %} +
+

Related Publication

+

+ {{ related[0].title }} + {% if related[0].description -%} +
+ {{ related[0].description }} + {%- endif %} +

+
+{% endif %} diff --git a/_layouts/publication.liquid b/_layouts/publication.liquid index b97073ab..8d44d68d 100644 --- a/_layouts/publication.liquid +++ b/_layouts/publication.liquid @@ -36,6 +36,25 @@ layout: default {% endfor %}

{% endif %} + + {% if page.approaches %} +
+ {% if page.approaches.size > 1 %} + This publication is related to the following approaches: + + {% else %} + This publication is related to the following approach: + {% assign approach = page.approaches[0] %} + {{ approach }} + {% endif %} +
+ {% endif %} {{ content }} diff --git a/_pages/about.md b/_pages/about.md index c3190bd6..41938681 100644 --- a/_pages/about.md +++ b/_pages/about.md @@ -6,26 +6,25 @@ subtitle: no_title: true --- -

- ArDoCo -

+![ARDoCo Logo](/assets/img/logo.png){:height="210" style="display: block; margin: 0 auto;"} -# [ArDoCo - Architecture Documentation Consistency](https://github.com/ArDoCo) +# [ARDoCo - Automating Requirements and Documentation Comprehension](https://github.com/ardoco) -In this research project, we aim to provide consistency analyses between different kind of documentation, namely formal models and informal (textual) documentation. + -Documenting the architecture of a software system is important, especially to capture reasoning and design decisions. A lot of tacit knowledge is easily lost when the documentation is incomplete, resulting in threats for the software system’s success and increased costs. However, software architecture documentation is often missing or outdated. One explanation for this phenomenon is the tedious and costly process of creating documentation in comparison to (perceived) low benefits. With our project, we want to step forward in our long-term vision, where we plan to persist information from any sources, e.g. from whiteboard discussions, to avoid losing crucial information about a system. A core problem in this vision is the possible inconsistency of information from different sources. A major challenge of ensuring consistency is the consistency between formal artefacts, i.e. models, and informal documentation. We plan to address consistency analyses between models and textual natural language artefacts using natural language understanding and plan to include knowledge bases to improve these analyses. After extracting information out of the natural language documents, we plan to create traceability links and check whether statements within the textual documentation are consistent with the software architecture models. +In this research project, we aim to provide traceability link recovery and consistency analyses between different kinds of software artifacts. Our recent approaches, such as [LiSSA](/approaches/lissa/), leverage Large Language Models (LLMs) and Retrieval-Augmented Generation (RAG) to enable more generic and effective traceability link recovery across various artifact types. These methods combine information retrieval with LLMs to find and suggest trace links, making them adaptable to different tasks like requirements-to-code, documentation-to-code, and more. You can find our different approaches, including [LiSSA](/approaches/lissa/) and others, on the [approaches](/approaches/) page or read more about them using the info button on the [publications](/publications/) page. -ArDoCo is actively developed by researchers of the _[Modelling for Continuous Software Engineering (MCSE) group](https://mcse.kastel.kit.edu)_ of _[KASTEL - Institute of Information Security and Dependability](https://kastel.kit.edu)_ at the [KIT](https://www.kit.edu). +Documenting the architecture of a software system is important, especially to capture reasoning and design decisions. However, documentation is often incomplete, outdated, or missing, leading to loss of crucial knowledge and increased risks. Our long-term vision is to persist information from various sources, such as whiteboard discussions, to avoid losing essential system knowledge. A key challenge is ensuring consistency between formal artifacts (e.g., models) and informal documentation. We address this by applying natural language understanding and knowledge bases to analyze consistency and create traceability links between models and textual artifacts. + + + +ARDoCo is actively developed by researchers of the _[Modelling for Continuous Software Engineering (MCSE) group](https://mcse.kastel.kit.edu)_ of _[KASTEL - Institute of Information Security and Dependability](https://kastel.kit.edu)_ at the [KIT](https://www.kit.edu). ## Important Links -- [Project website](https://mcse.kastel.kit.edu/projects_ardoco.php) at the research group's website -- [Publications](https://mcse.kastel.kit.edu/projects_ardoco.php?tab=%5B577%5D#tabpanel-577) at the project website - [Open student theses](https://mcse.kastel.kit.edu/projects_ardoco.php?tab=%5B661%5D#tabpanel-661) -- [People](/people/) -- [GitHub organization](https://github.com/ArDoCo) -- Central code repository [ArDoCo/Core](https://github.com/ArDoCo/Core) +- [People](/people/) who are involved in the project +- Central code repository [ardoco/ardoco](https://github.com/ardoco/ardoco) ## Relevant and Recent Publications diff --git a/_pages/approaches.md b/_pages/approaches.md new file mode 100644 index 00000000..c65d525c --- /dev/null +++ b/_pages/approaches.md @@ -0,0 +1,34 @@ +--- +layout: page +title: approaches +permalink: /approaches/ +description: Approaches within ARDoCo +nav: true +nav_order: 0.25 +horizontal: false +--- + + +
+ +{% assign sorted_projects = site.approaches | sort: "importance" %} + + + +{% if page.horizontal %} + +
+
+ {% for project in sorted_projects %} + {% include projects_horizontal.liquid %} + {% endfor %} +
+
+ {% else %} +
+ {% for project in sorted_projects %} + {% include projects.liquid %} + {% endfor %} +
+ {% endif %} +
diff --git a/_pages/poster_2019.md b/_pages/poster_2019.md index 3d3e9ba4..d01e34a8 100644 --- a/_pages/poster_2019.md +++ b/_pages/poster_2019.md @@ -8,4 +8,4 @@ description: Although slightly outdated, the poster below from the [ICSA2019 New and Emerging Ideas (NEMI) Track](https://icsa-conferences.org/2019/call-for-papers/new-and-emerging-ideas/index.html) underlines our main goals for checking consistency between formal architecture artefacts like [Palladio Component Models](https://www.palladio-simulator.com/science/palladio_component_model/) and informal software architecture artefacts in the form of textual software architecture documentation. For more details, check the [paper](https://publikationen.bibliothek.kit.edu/1000096077) as well as the [publications page](https://mcse.kastel.kit.edu/projects_ardoco.php?tab=%5B577%5D#tabpanel-577). -![Poster](/assets/img/icsa2019_poster.png "Poster"){:width="100%"} +![Poster](/assets/img/approaches/icsa2019-poster.png "Poster"){:width="100%"} diff --git a/_pages/profiles.md b/_pages/profiles.md index c2ba1796..86d9bf45 100644 --- a/_pages/profiles.md +++ b/_pages/profiles.md @@ -2,38 +2,38 @@ layout: profiles permalink: /people/ title: people -description: members of ArDoCo +description: members of ARDoCo nav: true nav_order: 7 profiles: - align: right - image: /people/koziolek.jpg + image: /people/koziolek_anne.jpg content: about/koziolek.md image_circular: false more_info: - align: right - image: /people/corallo.jpg + image: /people/corallo_sophie.jpg content: about/corallo.md image_circular: false more_info: - align: right - image: /people/fuchss.jpg + image: /people/fuchss_dominik.jpg content: about/fuchss.md image_circular: false more_info: - align: right - image: /people/keim.jpg + image: /people/keim_jan.jpg content: about/keim.md image_circular: false more_info: - align: right - image: /people/hey.jpg + image: /people/hey_tobias.jpg content: about/hey.md image_circular: false more_info: - align: right - image: /people/liu.jpg + image: /people/liu_haoyu.jpg content: about/liu.md image_circular: false more_info: diff --git a/_pages/publications.md b/_pages/publications.md index 67a71085..e3cf8493 100644 --- a/_pages/publications.md +++ b/_pages/publications.md @@ -2,7 +2,7 @@ layout: page permalink: /publications/ title: publications -description: publications that are related to ArDoCo +description: publications that are related to ARDoCo nav: true nav_order: 2 --- diff --git a/assets/img/aire-approach.svg b/assets/img/approaches/aire25-aire.svg similarity index 100% rename from assets/img/aire-approach.svg rename to assets/img/approaches/aire25-aire.svg diff --git a/assets/img/approaches/ecsa21-swattr.svg b/assets/img/approaches/ecsa21-swattr.svg new file mode 100644 index 00000000..22483a5b --- /dev/null +++ b/assets/img/approaches/ecsa21-swattr.svg @@ -0,0 +1,4 @@ + + + +
Text Extraction
Text Extraction
Model Extraction
Model Extraction
Element
Identification
Element...
Element 
Connection
Element...
Architecture
Model
Archit...
Architecture Documentation
Archit...
Trace Links
Trace...Text is not SVG - cannot display \ No newline at end of file diff --git a/assets/img/titleslide-fg-arch24.png b/assets/img/approaches/fgarch24-titleslide.png similarity index 100% rename from assets/img/titleslide-fg-arch24.png rename to assets/img/approaches/fgarch24-titleslide.png diff --git a/assets/img/icsa2019_poster.png b/assets/img/approaches/icsa2019-poster.png similarity index 100% rename from assets/img/icsa2019_poster.png rename to assets/img/approaches/icsa2019-poster.png diff --git a/assets/img/approach_overview_icsa23.svg b/assets/img/approaches/icsa23-inconsistency.svg similarity index 100% rename from assets/img/approach_overview_icsa23.svg rename to assets/img/approaches/icsa23-inconsistency.svg diff --git a/assets/img/icsa25-approach.svg b/assets/img/approaches/icsa25-transarc.svg similarity index 100% rename from assets/img/icsa25-approach.svg rename to assets/img/approaches/icsa25-transarc.svg diff --git a/assets/img/approaches/icse24-ardocode.svg b/assets/img/approaches/icse24-ardocode.svg new file mode 100644 index 00000000..937ceaf3 --- /dev/null +++ b/assets/img/approaches/icse24-ardocode.svg @@ -0,0 +1,4 @@ + + + +
Text Extraction
Text Extraction
Model Extraction
Model Extraction
Element
Identification
Element...
Element 
Connection
Element...
Code Model
Code M...
Architecture Documentation
Archit...
Trace Links
Trace...Text is not SVG - cannot display \ No newline at end of file diff --git a/assets/img/approach_overview_icse24.svg b/assets/img/approaches/icse24-transarc.svg similarity index 100% rename from assets/img/approach_overview_icse24.svg rename to assets/img/approaches/icse24-transarc.svg diff --git a/assets/img/icse25-approach.svg b/assets/img/approaches/icse25-lissa.svg similarity index 100% rename from assets/img/icse25-approach.svg rename to assets/img/approaches/icse25-lissa.svg diff --git a/assets/img/refsq25-approach.svg b/assets/img/approaches/refsq25-refsq.svg similarity index 100% rename from assets/img/refsq25-approach.svg rename to assets/img/approaches/refsq25-refsq.svg diff --git a/assets/img/people/corallo.jpg b/assets/img/people/corallo_sophie.jpg similarity index 100% rename from assets/img/people/corallo.jpg rename to assets/img/people/corallo_sophie.jpg diff --git a/assets/img/people/fuchss.jpg b/assets/img/people/fuchss_dominik.jpg similarity index 100% rename from assets/img/people/fuchss.jpg rename to assets/img/people/fuchss_dominik.jpg diff --git a/assets/img/people/hey.jpg b/assets/img/people/hey_tobias.jpg similarity index 100% rename from assets/img/people/hey.jpg rename to assets/img/people/hey_tobias.jpg diff --git a/assets/img/people/keim.jpg b/assets/img/people/keim_jan.jpg similarity index 100% rename from assets/img/people/keim.jpg rename to assets/img/people/keim_jan.jpg diff --git a/assets/img/people/koziolek.jpg b/assets/img/people/koziolek_anne.jpg similarity index 100% rename from assets/img/people/koziolek.jpg rename to assets/img/people/koziolek_anne.jpg diff --git a/assets/img/people/liu.jpg b/assets/img/people/liu_haoyu.jpg similarity index 100% rename from assets/img/people/liu.jpg rename to assets/img/people/liu_haoyu.jpg