From 0b4c458ac8e52f3890f552f0f8f62603e726cd71 Mon Sep 17 00:00:00 2001 From: Jan Keim Date: Mon, 4 Mar 2024 16:33:44 +0100 Subject: [PATCH] Add description for ID --- docs/InconsistencyDetection.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/InconsistencyDetection.md b/docs/InconsistencyDetection.md index 03e9c783b..735af75bd 100644 --- a/docs/InconsistencyDetection.md +++ b/docs/InconsistencyDetection.md @@ -1 +1,13 @@ # Inconsistency Detection + +Currently, there are two kinds of inconsistencies that are supported by the approach: Missing Model Elements (MMEs) and Undocumented Model Elements (UMEs). + +Undocumented Model Elements (UMEs) are elements within the Software Architecture Model (SAM) that are not documented in the natural language Software Architecture Documentation (SAD). +Our heuristic looks for model elements that do not have any (or below a certain threshold, per default 1) trace links associated with them. +In the configuration options, you can fine tune the threshold as well as set up a regex-based whitelist. + +Missing Model Elements (MMEs) are architecture elements that are described within the SAD that cannot be traced to the SAM. +For this, we make use of the recommendations from the Recommendation Generator within the [Traceability Link Recovery (TLR)](tlr). +Each of these recommendations that are not linked with a model element are potential inconsistencies. +To further increase precision, we make use of filters. +For example, we use a filter to get rid of commonly used software (development) terminology that look similar to, e.g., components but rarely are model elements.