Skip to content

docs(requirements): improve traceability #624

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AlexanderLanin merged 7 commits into from
Jul 2, 2026
Merged

docs(requirements): improve traceability #624

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e748d53
fix: satisfied valid_from/until already
a-zw Jun 29, 2026
29f288f
chore: add tool_req__arch_linkage_safety
a-zw Jun 29, 2026
16f2e53
Potential fix for pull request finding
RolandJentschETAS Jun 29, 2026
4290ff9
Fix typo in requirements.rst from 'included by' to 'included_by'
RolandJentschETAS Jun 29, 2026
a581974
Fix formatting of requirement links in documentation
RolandJentschETAS Jun 29, 2026
a02099f
Fix formatting for Docs-As-Code need types section
RolandJentschETAS Jun 29, 2026
e4ac0aa
fix: consistently consists_of
a-zw Jun 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 32 additions & 1 deletion docs/internals/requirements/requirements.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -503,7 +503,10 @@ Versioning
:implemented: YES
:version: 2
:parent_covered: YES
:satisfies: gd_req__req_validity[version==1]
:satisfies:
gd_req__req_validity[version==1],
gd_req__req_attr_valid_from[version==1],
gd_req__req_attr_valid_until[version==1],
:status: valid

Docs-as-Code shall enforce that the ``valid_from`` and ``valid_until`` attributes of stakeholder and feature requirements are correct.
Expand Down Expand Up @@ -788,6 +791,34 @@ Architecture Attributes
"belongs_to", "corresponding architecture element same level"
"includes", "corresponding architecture element lower level"

The following requirement maybe be overlapping with other tool requirements,
but for ease of traceability this is a separate one.
Comment thread
RolandJentschETAS marked this conversation as resolved.
Outdated

.. tool_req:: Correlations of the architectural building blocks
:id: tool_req__arch_linkage_safety
:implemented: PARTIAL
:version: 1
:satisfies: gd_req__arch_linkage_safety[version==1]
Comment thread
a-zw marked this conversation as resolved.
:parent_covered: YES

.. csv-table::
:header: "Link source", "Relation", "Link Target", "Mandatory", "Implemented"

feat, consist_of, comp, yes, no
Comment thread
a-zw marked this conversation as resolved.
Outdated
Comment thread
a-zw marked this conversation as resolved.
Outdated
Comment thread
a-zw marked this conversation as resolved.
Outdated
feat, includes, logic_arc_int, yes, only optional
mod, includes, comp, yes, yes
real_arc_int_op, included by, real_arc_int, yes, yes
Comment thread
RolandJentschETAS marked this conversation as resolved.
Outdated
Comment thread
RolandJentschETAS marked this conversation as resolved.
Outdated
Comment thread
Copilot marked this conversation as resolved.
Outdated
logic_arc_int, includes, logic_arc_int_op, no, yes
real_arc_int_op, implements, logic_arc_int_op, no, yes
comp, implements, logic_arc_int, no, yes
comp, uses, logic_arc_int, no, yes
comp, consists_of, comp, no, yes

.. warning::

Implementation and this requirement uses ``consists_of``
while :need:`gd_req__arch_linkage_safety` uses ``consist_of``
without the "s".
Comment thread
a-zw marked this conversation as resolved.
Outdated
Comment thread
a-zw marked this conversation as resolved.
Outdated
Comment thread
a-zw marked this conversation as resolved.
Outdated

💻 Detailed Design & Code
##########################
Expand Down
6 changes: 6 additions & 0 deletions src/extensions/score_metamodel/metamodel.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -415,6 +415,7 @@ needs_types:
# req-Id: tool_req__docs_common_attr_status
status: ^(valid|invalid)$
optional_links:
# req-Id: tool_req__arch_linkage_safety
includes: logic_arc_int, logic_arc_int_op
uses: logic_arc_int, logic_arc_int_op
provides: logic_arc_int, logic_arc_int_op # preparation for linking change according to DR-005
Expand Down Expand Up @@ -485,6 +486,7 @@ needs_types:
# req-Id: tool_req__docs_common_attr_status
status: ^(valid|invalid)$
optional_links:
# req-Id: tool_req__arch_linkage_safety
includes: logic_arc_int_op
fulfils: feat_req
tags:
Expand Down Expand Up @@ -526,6 +528,7 @@ needs_types:
# req-Id: tool_req__docs_common_attr_status
status: ^(valid|invalid)$
mandatory_links:
# req-Id: tool_req__arch_linkage_safety
includes: comp
tags:
- architecture_element
Expand Down Expand Up @@ -572,6 +575,7 @@ needs_types:
mandatory_links:
belongs_to: feat # preparation for linking change according to DR-005
optional_links:
# req-Id: tool_req__arch_linkage_safety
implements: logic_arc_int, real_arc_int_op
uses: logic_arc_int, real_arc_int_op
consists_of: comp
Expand Down Expand Up @@ -660,8 +664,10 @@ needs_types:
# req-Id: tool_req__docs_common_attr_status
status: ^(valid|invalid)$
mandatory_links:
# req-Id: tool_req__arch_linkage_safety
included_by: real_arc_int
optional_links:
Comment thread
a-zw marked this conversation as resolved.
# req-Id: tool_req__arch_linkage_safety
implements: logic_arc_int_op
tags:
- architecture_element
Expand Down
Loading