diff --git a/MODULE.bazel b/MODULE.bazel index 275582c4f1..c0a796f3ed 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 = "f784d4370240cc0eafce779e5c317f6bf8988fb2", + remote = "https://github.com/eclipse-score/docs-as-code.git", +) diff --git a/process/folder_templates/features/feature_name/architecture/index.rst b/process/folder_templates/features/feature_name/architecture/index.rst index 008ac3bcb8..153945052f 100644 --- a/process/folder_templates/features/feature_name/architecture/index.rst +++ b/process/folder_templates/features/feature_name/architecture/index.rst @@ -92,6 +92,7 @@ Static Architecture :status: invalid :fulfils: feat_req__feature_name__some_title :includes: logic_arc_int__feature_name__interface_name1 + :belongs_to: feat__feature_name .. needarch:: :scale: 50 @@ -108,6 +109,7 @@ Dynamic Architecture :safety: ASIL_B :status: invalid :fulfils: feat_req__feature_name__some_title + :belongs_to: feat__feature_name Put here a sequence diagram diff --git a/process/folder_templates/features/feature_name/requirements/index.rst b/process/folder_templates/features/feature_name/requirements/index.rst index a8a1c8393b..700718d552 100644 --- a/process/folder_templates/features/feature_name/requirements/index.rst +++ b/process/folder_templates/features/feature_name/requirements/index.rst @@ -54,6 +54,7 @@ Requirements :safety: ASIL_B :satisfies: stkh_req__requirements__template :status: invalid + :belongs_to: feat__feature_name The Feature shall do xyz to the user to bring him to this condition at this time. 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..b2d0027f63 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 @@ -70,21 +70,23 @@ Static Architecture The components are designed to cover the expectations from the feature architecture (i.e. if already exists a definition it should be taken over and enriched). +A component can optional also consist of subcomponents to further structure the architecture. The component and its static views can also optionally use interfaces provided by other components. + .. comp:: Component Name :id: comp__component_name_template :security: YES :safety: ASIL_B :status: invalid :implements: logic_arc_int__feature_name__interface_name1 + :consists_of: comp__archex_sub_component_1, comp__archex_sub_component_2, comp__archex_sub_component_3 .. comp_arc_sta:: Component Name (Static View) :id: comp_arc_sta__component_name__static_view :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 + :uses: logic_arc_int__feature_name__interface_name1 .. needarch:: :scale: 50 @@ -100,7 +102,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 +128,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..4bbb42900c 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,28 +1,10 @@ - + - - - - -
-
-
- has -
-
-
- - - has - - - - @@ -105,25 +87,23 @@ - - + + -
+
- implements / -
uses
- - implements /... + + uses @@ -244,14 +224,14 @@ - + -
+
includes @@ -259,12 +239,34 @@
- + includes + + + + + + + + +
+
+
+ belongs_to +
+
+
+ + + belongs_to + + + + @@ -291,8 +293,8 @@ - - + + @@ -380,7 +382,7 @@ -
+
consists of @@ -388,7 +390,7 @@
- + consists of @@ -461,24 +463,6 @@ - - - - -
-
-
- has -
-
-
- - - h... - - - - @@ -796,6 +780,24 @@ + + + + +
+
+
+ uses +
+
+
+ + + uses + + + + @@ -854,13 +856,14 @@
- has +
+
+
- has @@ -869,19 +872,15 @@ -
+
belongs_to -
-
-
-
- + belongs_to @@ -916,24 +915,6 @@ - - - - -
-
-
- has -
-
-
- - - has - - - - @@ -1042,13 +1023,13 @@ - + -
+
* @@ -1056,7 +1037,7 @@
- + * @@ -1215,7 +1196,7 @@
- Feature Safety/FMEA/ + Feature Safety/
Security Analysis
@@ -1223,7 +1204,7 @@
- Feature Safety/FMEA/... + Feature Safety/... @@ -1522,7 +1503,7 @@ -
+
mitigated_by @@ -1530,7 +1511,7 @@
- + mitigated_by @@ -2076,6 +2057,28 @@ + + + + + + + + +
+
+
+ implements +
+
+
+ + + implements + + + + diff --git a/process/process_areas/architecture_design/_assets/metamodel_architectural_design.drawio.svg b/process/process_areas/architecture_design/_assets/metamodel_architectural_design.drawio.svg index 878e0974e1..f434f83e92 100644 --- a/process/process_areas/architecture_design/_assets/metamodel_architectural_design.drawio.svg +++ b/process/process_areas/architecture_design/_assets/metamodel_architectural_design.drawio.svg @@ -1,15 +1,15 @@ - + - - + + -
+
includes @@ -17,20 +17,42 @@
- + includes - + + -
+
+
+
+ consist_of +
+
+
+ + + consist_of + + + + + + + + + + + +
Feature @@ -40,42 +62,42 @@
- + Feature... - - + + -
+
- included by + includes
- - included by + + includes - + -
+
Logical Interface @@ -86,44 +108,68 @@
- + Logical Interface... - + + -
+
+
+
+ included_by +
+
+
+ + + included_by + + + + + + + + + + + +
Logical Interface
Operation +
+ (logic_arc_int_op)
- + Logical Interface... - - + + -
+
implements @@ -131,44 +177,47 @@
- + implements - + -
+
Real Interface
Operation +
+ (real_arc_int_op) +
- + Real Interface... - - + + -
+
included by @@ -176,42 +225,45 @@
- + included by - + -
+
Real Interface +
+ (real_arc_int) +
- - Real Interface + + Real Interface... - - + + -
+
implements / uses @@ -219,21 +271,21 @@
- + implements / uses - - + + -
+
consist_of @@ -241,20 +293,20 @@
- + consist_of - + -
+
Component @@ -265,21 +317,21 @@
- + Component... - - + + -
+
includes @@ -287,29 +339,116 @@
- + includes - + -
+
Module +
+ (mod) +
+
+
+
+ + + Module... + + + + + + + + + + + +
+
+
+ Legend +
+
+
+ + + Legend + + + + + + + + + + + +
+
+
+ mandatory +
+
+
+ + + mandatory + + + + + + + + + + + +
+
+
+ optional +
+
+
+ + + optional + + + + + + + + + + + +
+
+
+ Line Color
- - Module + + Line Color diff --git a/process/process_areas/architecture_design/architecture_concept.rst b/process/process_areas/architecture_design/architecture_concept.rst index bd693653d7..c0bac46111 100644 --- a/process/process_areas/architecture_design/architecture_concept.rst +++ b/process/process_areas/architecture_design/architecture_concept.rst @@ -132,6 +132,7 @@ The first viewpoint is named as *feature architecture*. It displays the SW Compo :status: valid :includes: logic_arc_int__example_feature__archex_logical_interface_1, logic_arc_int__example_feature__archex_logical_interface_2 :fulfils: feat_req__example_feature__archdes_example_req + :belongs_to: feat__example_feature .. needarch:: :scale: 50 @@ -211,8 +212,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 @@ -497,6 +498,7 @@ The following section is an example, how an `Feature :valid_until: :status: + :belongs_to: .. gd_temp:: Component Requirements Template :id: gd_temp__req_comp_req @@ -65,6 +66,7 @@ Templates :safety: :satisfies: :status: + :belongs_to: .. gd_temp:: AoU Requirement Template :id: gd_temp__req_aou_req