diff --git a/MODULE.bazel b/MODULE.bazel index 275582c4f1..0dfd74462a 100644 --- a/MODULE.bazel +++ b/MODULE.bazel @@ -51,3 +51,8 @@ bazel_dep(name = "buildifier_prebuilt", version = "8.2.0.2") bazel_dep(name = "aspect_rules_lint", version = "1.5.3") bazel_dep(name = "score_tooling", version = "1.0.2") bazel_dep(name = "score_docs_as_code", version = "2.3.3") +git_override( + module_name = "score_docs_as_code", + commit = "56ebbde1e4f0d73ec269099babd719a046736ec9", + remote = "https://github.com/eclipse-score/docs-as-code.git", +) diff --git a/process/folder_templates/modules/module_name/component_name/docs/architecture/index.rst b/process/folder_templates/modules/module_name/component_name/docs/architecture/index.rst index 669d78e88f..6fa660cbc8 100644 --- a/process/folder_templates/modules/module_name/component_name/docs/architecture/index.rst +++ b/process/folder_templates/modules/module_name/component_name/docs/architecture/index.rst @@ -82,9 +82,7 @@ The components are designed to cover the expectations from the feature architect :security: YES :safety: ASIL_B :status: invalid - :implements: logic_arc_int__feature_name__interface_name1 - :fulfils: comp_req__component_name__some_title - :includes: comp_arc_sta__component_name__2 + :belongs_to: comp__component_name_template .. needarch:: :scale: 50 @@ -100,7 +98,7 @@ Dynamic Architecture :security: YES :safety: ASIL_B :status: invalid - :fulfils: comp_req__component_name__some_title + :belongs_to: comp__component_name_template Put here a sequence diagram @@ -126,7 +124,7 @@ Internal Components :safety: ASIL_B :security: YES :fulfils: comp_req__component_name__some_title - :implements: logic_arc_int__feature_name__interface_name1 + :belongs_to: comp__component_example_2 No architecture but detailed design diff --git a/process/folder_templates/modules/module_name/component_name/docs/requirements/index.rst b/process/folder_templates/modules/module_name/component_name/docs/requirements/index.rst index 66b777004c..24e835803c 100644 --- a/process/folder_templates/modules/module_name/component_name/docs/requirements/index.rst +++ b/process/folder_templates/modules/module_name/component_name/docs/requirements/index.rst @@ -44,6 +44,7 @@ Component Requirements :safety: ASIL_B :satisfies: feat_req__feature_name__some_title :status: invalid + :belongs_to: comp__component_name_template The Component shall do xyz to another component to bring it to this condition at this time diff --git a/process/general_concepts/_assets/score_building_blocks_meta_model.drawio.svg b/process/general_concepts/_assets/score_building_blocks_meta_model.drawio.svg index 1c8fda4a87..dee7d5bc3c 100644 --- a/process/general_concepts/_assets/score_building_blocks_meta_model.drawio.svg +++ b/process/general_concepts/_assets/score_building_blocks_meta_model.drawio.svg @@ -1,4 +1,4 @@ - + @@ -27,7 +27,7 @@ -
+
1, * @@ -35,7 +35,7 @@
- + 1, * @@ -45,7 +45,7 @@ -
+
belongs_to @@ -67,7 +67,7 @@ -
+
includes @@ -105,14 +105,14 @@ - - + + -
+
implements / @@ -122,7 +122,7 @@
- + implements /... @@ -229,7 +229,7 @@ -
+
fulfills @@ -244,14 +244,14 @@ - + -
+
includes @@ -259,12 +259,52 @@
- + includes + + + + + + + + +
+
+
+ has +
+
+
+ + + has + + + + + + + + +
+
+
+ belongs_to +
+
+
+ + + belongs_to + + + + @@ -298,7 +338,7 @@ -
+
satifies @@ -306,7 +346,7 @@
- + satifies @@ -344,7 +384,7 @@ -
+
1,* @@ -352,7 +392,7 @@
- + 1,* @@ -362,7 +402,7 @@ -
+
belongs_to @@ -370,7 +410,7 @@
- + belongs_to @@ -380,7 +420,7 @@ -
+
consists of @@ -388,7 +428,7 @@
- + consists of @@ -402,7 +442,7 @@ -
+
includes @@ -410,7 +450,7 @@
- + includes @@ -465,7 +505,7 @@ -
+
has @@ -483,7 +523,7 @@ -
+
belongs_to @@ -491,7 +531,7 @@
- + belongs_to @@ -634,7 +674,7 @@ -
+
1, * @@ -642,7 +682,7 @@
- + 1, * @@ -652,7 +692,7 @@ -
+
consists of @@ -660,7 +700,7 @@
- + consists of @@ -670,7 +710,7 @@ -
+
has @@ -688,7 +728,7 @@ -
+
1, * @@ -696,7 +736,7 @@
- + 1, * @@ -733,7 +773,7 @@ -
+
1 @@ -778,7 +818,7 @@ -
+
fulfills @@ -829,7 +869,7 @@ -
+
satifies @@ -837,7 +877,7 @@
- + satifies @@ -869,7 +909,7 @@ -
+
belongs_to @@ -881,7 +921,7 @@
- + belongs_to @@ -942,7 +982,7 @@ -
+
satifies @@ -964,7 +1004,7 @@ -
+
implements @@ -982,7 +1022,7 @@ -
+
consists of @@ -990,14 +1030,14 @@
- + consists of - + @@ -1019,9 +1059,9 @@ - + - + @@ -1155,7 +1195,7 @@ -
+
1, * @@ -1163,7 +1203,7 @@
- + 1, * @@ -1200,8 +1240,8 @@ - - + + @@ -1319,7 +1359,7 @@ -
+
verifies @@ -1327,7 +1367,7 @@
- + verifies @@ -1337,7 +1377,7 @@ -
+
violates @@ -1345,7 +1385,7 @@
- + violates @@ -1355,7 +1395,7 @@ -
+
mitigated_by @@ -1363,7 +1403,7 @@
- + mitigated_by @@ -1373,7 +1413,7 @@ -
+
verifies @@ -1381,7 +1421,7 @@
- + verifies @@ -1486,7 +1526,7 @@ -
+
violates @@ -1494,7 +1534,7 @@
- + violates @@ -1504,7 +1544,7 @@ -
+
mitigated_by @@ -1512,7 +1552,7 @@
- + mitigated_by @@ -1522,7 +1562,7 @@ -
+
mitigated_by @@ -1530,7 +1570,7 @@
- + mitigated_by @@ -1540,7 +1580,7 @@ -
+
mitigated_by @@ -1548,7 +1588,7 @@
- + mitigated_by @@ -1558,7 +1598,7 @@ -
+
verifies @@ -1566,7 +1606,7 @@
- + verifies @@ -1603,7 +1643,7 @@ -
+
verifies @@ -1611,7 +1651,7 @@
- + verifies @@ -1621,7 +1661,7 @@ -
+
verifies @@ -1629,7 +1669,7 @@
- + verifies @@ -1710,7 +1750,7 @@ -
+
mitigated_by @@ -1718,7 +1758,7 @@
- + mitigated_by @@ -1758,7 +1798,7 @@ -
+
mitigated_by @@ -1766,7 +1806,7 @@
- + mitigated_by @@ -1780,7 +1820,7 @@ -
+
violates @@ -1788,7 +1828,7 @@
- + violates @@ -1974,7 +2014,7 @@ -
+
belongs_to @@ -1982,7 +2022,7 @@
- + belongs_to diff --git a/process/process_areas/architecture_design/architecture_concept.rst b/process/process_areas/architecture_design/architecture_concept.rst index bd693653d7..e34ce9ec73 100644 --- a/process/process_areas/architecture_design/architecture_concept.rst +++ b/process/process_areas/architecture_design/architecture_concept.rst @@ -211,8 +211,8 @@ The *component architecture* describes the implementation of the functionalities :status: valid :safety: ASIL_B :security: NO - :includes: comp__archex_sub_component_1, comp__archex_sub_component_2, comp__archex_sub_component_3 :fulfils: comp_req__example_feature__archex_example_req + :belongs_to: comp__component_example_1 .. needarch:: :scale: 50 @@ -538,8 +538,8 @@ The following section is an example, how an component looks like and how the det :status: valid :safety: ASIL_B :security: NO - :includes: comp__archex_sub_component_1, comp__archex_sub_component_2, comp__archex_sub_component_3 :fulfils: comp_req__example_feature__archex_example_req + :belongs_to: comp__component_example_1 .. needarch:: :scale: 50 @@ -556,7 +556,7 @@ The following section is an example, how an component looks like and how the det :security: NO :includes: logic_arc_int__example_feature__archex_logical_interface_1, comp__archex_sub_component_1, comp__archex_sub_component_2, comp__archex_sub_component_3 :fulfils: comp_req__example_feature__archex_example_req - + :belongs_to: comp__component_component_getstrt .. needarch:: :scale: 50 :align: center @@ -603,6 +603,7 @@ Debug example for component architecture: :security: NO :includes: :fulfils: comp_req__example_feature__archex_example_req + :belongs_to: comp__component_example_1 .. needarch:: :scale: 50 @@ -629,6 +630,7 @@ To make *needuml* work we have to replace the *need()* call with a different fun :security: NO :uses: logic_arc_int__example_feature__archex_logical_interface_1 :fulfils: comp_req__example_feature__archex_example_req + :belongs_to: comp__component_component_manual_getstrt .. needuml:: @@ -644,6 +646,7 @@ To make *needuml* work we have to replace the *need()* call with a different fun :security: NO :uses: logic_arc_int__example_feature__archex_logical_interface_1 :fulfils: comp_req__example_feature__archex_example_req + :belongs_to: comp__component_example_1 .. needarch:: diff --git a/process/process_areas/architecture_design/guidance/architecture_modeling_example.rst b/process/process_areas/architecture_design/guidance/architecture_modeling_example.rst index 67025ca77e..0860c0b9a3 100644 --- a/process/process_areas/architecture_design/guidance/architecture_modeling_example.rst +++ b/process/process_areas/architecture_design/guidance/architecture_modeling_example.rst @@ -220,8 +220,7 @@ Component Architecure File(s) :status: valid :safety: ASIL_B :security: NO - :includes: comp__archex_sub_component_1, comp__archex_sub_component_2, comp__archex_sub_component_3 - :fulfils: comp_req__example_feature__archex_example_req + :belongs_to: comp__component_example_1 .. needarch:: :scale: 50 @@ -285,5 +284,6 @@ Requierements for the Example :safety: ASIL_B :satisfies: feat_req__example_feature__archdes_example_req :status: valid + :belongs_to: comp__component_example_2 The component shall provide the Logical Operation 4 to get the .. diff --git a/process/process_areas/requirements_engineering/guidance/requirements_templates.rst b/process/process_areas/requirements_engineering/guidance/requirements_templates.rst index 630c773553..11f7deb055 100644 --- a/process/process_areas/requirements_engineering/guidance/requirements_templates.rst +++ b/process/process_areas/requirements_engineering/guidance/requirements_templates.rst @@ -65,6 +65,7 @@ Templates :safety: :satisfies: :status: + :belongs_to: .. gd_temp:: AoU Requirement Template :id: gd_temp__req_aou_req