diff --git a/MODULE.bazel b/MODULE.bazel index c89935d233..f0bd0d67b5 100644 --- a/MODULE.bazel +++ b/MODULE.bazel @@ -50,4 +50,4 @@ 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.1") +bazel_dep(name = "score_docs_as_code", version = "2.3.2") diff --git a/process/process_areas/architecture_design/architecture_concept.rst b/process/process_areas/architecture_design/architecture_concept.rst index 80d964c300..d18de894da 100644 --- a/process/process_areas/architecture_design/architecture_concept.rst +++ b/process/process_areas/architecture_design/architecture_concept.rst @@ -141,6 +141,8 @@ The first viewpoint is named as *feature architecture*. It displays the SW Compo In all views, the components which are marked as ASIL_B related are drawn with red borders. +See :ref:`uml_diagram_selection` in guideline for further information about the UML diagram selection for static architecture. + Dynamic View ------------ @@ -156,6 +158,8 @@ This view shows the *dynamic behavior* of the feature including the interaction :align: center :caption: Dynamic Feature Architecture +See :ref:`uml_diagram_selection` in guideline for further information about the UML diagram selection and usage for dynamic architecture. + Interface View -------------- @@ -181,7 +185,7 @@ A SW Module represents a outcome of an component or a set of components realizin On this level also a view shall be defined which is called *Module View*. It represents the allocation of components into modules and displays the dependencies between the single modules. In this view also cyclic dependencies between modules can be identified. -.. mod_view_sta:: Module 1 Static View +.. mod_view_sta:: Module 1 Static View concept :id: mod_view_sta__example_feature__archcon_1 :includes: comp__component_example_1 @@ -486,7 +490,7 @@ The following section is an example, how an `Feature LI1: EXTRA_LINKAGE_MANUALLY_ADDED -.. comp_arc_sta:: Component Static View - Get Started Manually Edited +.. comp_arc_sta:: Component Architecture Static View - Rendered Example Manually Edited :id: comp_arc_sta__example_feature__component_manual_getstrt :status: valid :safety: ASIL_B diff --git a/process/process_areas/architecture_design/architecture_workproducts.rst b/process/process_areas/architecture_design/architecture_workproducts.rst index 90385e8161..1732b230e1 100644 --- a/process/process_areas/architecture_design/architecture_workproducts.rst +++ b/process/process_areas/architecture_design/architecture_workproducts.rst @@ -29,7 +29,7 @@ Architecture Work Products * Dynamic view (UML) - Sequences of component interactions and state diagrams * Interface view (Sphinx Needs) - Overview of used and provided interfaces - Technical concept on platform level. + Technical concept on platform or feature level. .. workproduct:: Component Architecture :id: wp__component_arch @@ -39,7 +39,7 @@ Architecture Work Products Component Architecture linked to Component Requirements - * Static view (Sphinx Needs) - Component interfaces (to outside of Component) and interfaces between own (lower level) components + * Static view (Sphinx Needs) - Component interfaces (to outside of component) and interfaces between own (lower level) components * Dynamic view (UML) - Sequences of components interactions and components states * Interface view (Sphinx Needs) - Overview of used and provided interfaces @@ -52,4 +52,4 @@ Architecture Work Products :tags: doc_lifecycle_model_2 Depends on architecture guideline and tooling. - May include several methods like inspection, modelling ... Which are selected in SW Verification Plan. + May include several methods like inspection, modelling, ... which are selected in projects SW Verification Plan. 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 ac6afe43bc..8eb0364a41 100644 --- a/process/process_areas/architecture_design/guidance/architecture_modeling_example.rst +++ b/process/process_areas/architecture_design/guidance/architecture_modeling_example.rst @@ -27,7 +27,7 @@ Feature Architecture File :security: YES :safety: QM :status: valid - :includes: logic_arc_int__example_feature__archex_logical_interface_1, logic_arc_int__example_feature__archex_logical_interface_2 + :includes: logic_arc_int__example_feature__archex_logical_interface_1, logic_arc_int__example_feature__archex_logical_interface_2, logic_arc_int__example_feature__archex_logical_interface_3 :consists_of: comp__component_example_1 This is the example feature. @@ -37,7 +37,7 @@ Feature Architecture File :security: YES :safety: QM :status: valid - :includes: logic_arc_int__example_feature__archex_logical_interface_1, logic_arc_int__example_feature__archex_logical_interface_2 + :includes: logic_arc_int__example_feature__archex_logical_interface_1, logic_arc_int__example_feature__archex_logical_interface_2, logic_arc_int__example_feature__archex_logical_interface_3 :fulfils: feat_req__example_feature__archdes_example_req .. needarch:: @@ -151,13 +151,13 @@ Module Viewpoint :security: YES :safety: ASIL_B :status: valid - :includes: comp__component_example_1 + :includes: comp__component_example_1, comp__component_example_2 This is Module 1. -.. mod_view_sta:: Module 1 +.. mod_view_sta:: Module 1 Static View :id: mod_view_sta__example_feature__archex_1 - :includes: comp__component_example_1 + :includes: comp__component_example_1, comp__component_example_2 .. needarch:: :scale: 50 @@ -165,9 +165,18 @@ Module Viewpoint {{ draw_module(need(), needs) }} -.. mod_view_sta:: Module 2 +.. mod:: Module 2 + :id: mod__example_feature_archex_module_2 + :security: YES + :safety: ASIL_B + :status: valid + :includes: comp__component_example_3 + + This is Module 2. + +.. mod_view_sta:: Module 2 Static View :id: mod_view_sta__example_feature__archex_2 - :includes: comp__archex_sub_component_3 + :includes: comp__component_example_3 .. needarch:: :scale: 50 @@ -183,31 +192,35 @@ Component Architecure File(s) :security: YES :safety: ASIL_B :status: invalid - :implements: logic_arc_int__example_feature__archex_logical_interface_1, logic_arc_int__example_feature__archex_logical_interface_2, logic_arc_int__example_feature__archex_logical_interface_3 + :implements: logic_arc_int__example_feature__archex_logical_interface_1 :consists_of: comp__archex_sub_component_1, comp__archex_sub_component_2, comp__archex_sub_component_3 Example Component 1 description. -.. comp_arc_sta:: Component 1 Static View - :id: comp_arc_sta__example_feature__archdes_component_1 - :status: valid +.. comp:: Component 2 + :id: comp__component_example_2 + :security: YES :safety: ASIL_B - :security: NO - :uses: logic_arc_int__example_feature__archex_logical_interface_1 - :fulfils: comp_req__example_feature__archex_example_req + :status: invalid + :implements: logic_arc_int__example_feature__archex_logical_interface_2 - .. needarch:: - :scale: 50 - :align: center + Example Component 2 description. - {{ draw_component(need(), needs) }} +.. comp:: Component 3 + :id: comp__component_example_3 + :security: YES + :safety: ASIL_B + :status: invalid + :implements: logic_arc_int__example_feature__archex_logical_interface_3 + + Example Component 3 description. -.. comp_arc_sta:: Component 3 Static View - :id: comp_arc_sta__example_feature__archdes_component_3 +.. comp_arc_sta:: Component 1 Static View + :id: comp_arc_sta__example_feature__archdes_component_1 :status: valid - :safety: QM + :safety: ASIL_B :security: NO - :uses: logic_arc_int__example_feature__archex_logical_interface_1, logic_arc_int__example_feature__archex_logical_interface_2, logic_arc_int__example_feature__archex_logical_interface_3 + :includes: comp__archex_sub_component_1, comp__archex_sub_component_2, comp__archex_sub_component_3 :fulfils: comp_req__example_feature__archex_example_req .. needarch:: @@ -223,26 +236,27 @@ Component Architecure File(s) :status: valid :safety: ASIL_B :security: NO - :uses: logic_arc_int__example_feature__archex_logical_interface_3 - :implements: logic_arc_int__example_feature__archex_logical_interface_2 + :uses: logic_arc_int__example_feature__archex_logical_interface_2 + :implements: logic_arc_int__example_feature__archex_logical_interface_1 .. comp:: Lower Level Component 2 :id: comp__archex_sub_component_2 :status: valid :safety: ASIL_B :security: NO - :uses: logic_arc_int__example_feature__archex_logical_interface_3 - :implements: logic_arc_int__example_feature__archex_logical_interface_1 + :uses: logic_arc_int__example_feature__archex_logical_interface_2 + :implements: logic_arc_int__example_feature__archex_logical_interface_2 .. comp:: Lower Level Component 3 :id: comp__archex_sub_component_3 :status: valid :safety: QM :security: NO - :implements: logic_arc_int__example_feature__archex_logical_interface_3 -.. - Requirements +Requierements for the Example +============================= + +.. Requirements .. stkh_req:: Example Stkh Req :id: stkh_req__example_feature__archdes_example_req