Skip to content

Commit 70d5387

Browse files
authored
docs(requirements): improve traceability (#624)
Follow-up on remaining table completeness point tracked in #629.
1 parent 46cfe04 commit 70d5387

2 files changed

Lines changed: 37 additions & 5 deletions

File tree

docs/internals/requirements/requirements.rst

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -503,7 +503,10 @@ Versioning
503503
:implemented: YES
504504
:version: 2
505505
:parent_covered: YES
506-
:satisfies: gd_req__req_validity[version==1]
506+
:satisfies:
507+
gd_req__req_validity[version==1],
508+
gd_req__req_attr_valid_from[version==1],
509+
gd_req__req_attr_valid_until[version==1],
507510
:status: valid
508511

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

794+
The following requirement may be overlapping with other tool requirements,
795+
but for ease of traceability this is a separate one.
796+
797+
.. tool_req:: Correlations of the architectural building blocks
798+
:id: tool_req__arch_linkage_safety
799+
:implemented: PARTIAL
800+
:version: 1
801+
:satisfies: gd_req__arch_linkage_safety[version==1]
802+
:parent_covered: YES
803+
804+
.. csv-table::
805+
:header: "Link source", "Relation", "Link Target", "Mandatory", "Implemented"
806+
807+
feat, consists_of, comp, yes, no
808+
feat, includes, logic_arc_int, yes, only optional
809+
mod, includes, comp, yes, yes
810+
real_arc_int_op, included_by, real_arc_int, yes, yes
811+
logic_arc_int, includes, logic_arc_int_op, no, yes
812+
real_arc_int_op, implements, logic_arc_int_op, no, yes
813+
comp, implements, logic_arc_int, no, yes
814+
comp, uses, logic_arc_int, no, yes
815+
comp, consists_of, comp, no, yes
816+
791817

792818
💻 Detailed Design & Code
793819
##########################
@@ -877,9 +903,9 @@ Testing
877903

878904
Docs-as-Code shall ensure that test cases link to requirements on the correct level:
879905

880-
- If Partially/FullyVerifies are set in Feature Integration Test these shall link to Feature Requirements
881-
- If Partially/FullyVerifies are set in Component Integration Test these shall link to Component Requirements
882-
- If Partially/FullyVerifies are set in Unit Test these shall link to Component Requirements
906+
- If Partially/FullyVerifies are set in Feature Integration Test these shall link to Feature Requirements
907+
- If Partially/FullyVerifies are set in Component Integration Test these shall link to Component Requirements
908+
- If Partially/FullyVerifies are set in Unit Test these shall link to Component Requirements
883909

884910

885911
.. tool_req:: Provide Metrics for linked requirements
@@ -1034,7 +1060,7 @@ Testing
10341060
gd_req__saf_attr_uid,
10351061
:parent_covered: YES
10361062

1037-
Docs-As-Code shall support the following need types:
1063+
Docs-As-Code shall support the following need types:
10381064

10391065
* Feature FMEA (Failure Modes and Effect Analysis) -> ``feat_saf_fmea``
10401066
* Component FMEA (Failure Modes and Effect Analysis) -> ``comp_saf_fmea``

src/extensions/score_metamodel/metamodel.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -415,6 +415,7 @@ needs_types:
415415
# req-Id: tool_req__docs_common_attr_status
416416
status: ^(valid|invalid)$
417417
optional_links:
418+
# req-Id: tool_req__arch_linkage_safety
418419
includes: logic_arc_int, logic_arc_int_op
419420
uses: logic_arc_int, logic_arc_int_op
420421
provides: logic_arc_int, logic_arc_int_op # preparation for linking change according to DR-005
@@ -485,6 +486,7 @@ needs_types:
485486
# req-Id: tool_req__docs_common_attr_status
486487
status: ^(valid|invalid)$
487488
optional_links:
489+
# req-Id: tool_req__arch_linkage_safety
488490
includes: logic_arc_int_op
489491
fulfils: feat_req
490492
tags:
@@ -526,6 +528,7 @@ needs_types:
526528
# req-Id: tool_req__docs_common_attr_status
527529
status: ^(valid|invalid)$
528530
mandatory_links:
531+
# req-Id: tool_req__arch_linkage_safety
529532
includes: comp
530533
tags:
531534
- architecture_element
@@ -572,6 +575,7 @@ needs_types:
572575
mandatory_links:
573576
belongs_to: feat # preparation for linking change according to DR-005
574577
optional_links:
578+
# req-Id: tool_req__arch_linkage_safety
575579
implements: logic_arc_int, real_arc_int_op
576580
uses: logic_arc_int, real_arc_int_op
577581
consists_of: comp
@@ -660,8 +664,10 @@ needs_types:
660664
# req-Id: tool_req__docs_common_attr_status
661665
status: ^(valid|invalid)$
662666
mandatory_links:
667+
# req-Id: tool_req__arch_linkage_safety
663668
included_by: real_arc_int
664669
optional_links:
670+
# req-Id: tool_req__arch_linkage_safety
665671
implements: logic_arc_int_op
666672
tags:
667673
- architecture_element

0 commit comments

Comments
 (0)