remove out-of-scope gd_req and inline example changes

Author: RSingh1511

process/process_areas/architecture_design/architecture_concept.rst

@@ -123,22 +123,8 @@ The feature architecture contain the following views:
 Static View
 -----------
 
-The first viewpoint is named as *feature architecture*. It displays the SW Components within the SW modules (= dependable elements) which are required to realize the feature including their interactions. Also the *logical interfaces* and the interaction between the feature and the user are included in this view. On this architectural level the feature requirements shall be allocated. An example for the static architecture is shown here:
-
-.. feat_arc_sta:: Feature 1 Architecture
-   :id: feat_arc_sta__example_feature__feature_1
-   :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
-   :satisfies: feat_req__example_feature__archdes_example_req
-   :belongs_to: feat__example_feature
-
-   .. needarch::
-      :scale: 50
-      :align: center
-
-      {{ draw_feature(need(), needs) }}
+The first viewpoint is named as *feature architecture*. It displays the SW Components within the SW modules (= dependable elements) which are required to realize the feature including their interactions. Also the *logical interfaces* and the interaction between the feature and the user are included in this view. On this architectural level the feature requirements shall be allocated. A full rendered example for the static architecture is maintained in the
+`module template documentation <https://eclipse-score.github.io/module_template/main/>`__.
 
 In all views, the components which are marked as ASIL_B related are drawn with red borders.
 
@@ -164,20 +150,8 @@ See :ref:`uml_diagram_selection` in guideline for further information about the
 Interface View
 --------------
 
-On the feature level only *logical interfaces* shall be displayed. This means that only logical names shall be provided for both the interface and the operations within. Those *logical interfaces* shall be connected to component interfaces on the module view.
-
-.. logic_arc_int:: Logical Interface 1
-   :id: logic_arc_int__example_feature__archcon_logical_interface_1
-   :security: YES
-   :safety:  ASIL_B
-   :status: valid
-   :satisfies: feat_req__example_feature__archdes_example_req
-
-   .. needarch::
-      :scale: 50
-      :align: center
-
-      {{ draw_interface(need(), needs) }}
+On the feature level only *logical interfaces* shall be displayed. This means that only logical names shall be provided for both the interface and the operations within. Those *logical interfaces* shall be connected to component interfaces on the module view. A rendered logical-interface example is maintained in the
+`module template documentation <https://eclipse-score.github.io/module_template/main/>`__.
 
 SW Module View
 ==============
@@ -197,19 +171,8 @@ Static View
 
 The *component architecture* describes the implementation of the functionalities in a white-box view. It describes the internal structure of SW components and their decomposition. It provides a more detailed information concerning the respective interfaces of a component. If a SW component interacts with a different component it is also included via a *use* relationship in the diagram. An example of the *component architecture* is displayed here:
 
-.. comp_arc_sta:: Component 1 Static View
-   :id: comp_arc_sta__example_feature__archdes_component_concept_1
-   :status: valid
-   :safety: ASIL_B
-   :security: NO
-   :satisfies: comp_req__example_feature__archex_example_req
-   :belongs_to: comp__component_example_1
-
-   .. needarch::
-      :scale: 50
-      :align: center
-
-      {{ draw_component(need(), needs) }}
+A full rendered component-architecture example is maintained in the
+`module template documentation <https://eclipse-score.github.io/module_template/main/>`__.
 
 The decomposition is optional and relies on the complexity of the component. Thus there is no graphic representation required for it.
 In all views the components which are marked as ASIL_B related are drawn in red color.
@@ -234,21 +197,8 @@ Following scenarios should be included:
 Interface View
 --------------
 
-The component interface view shows the actual interfaces of the component. Also links to their corresponding logical interfaces are displayed in this view:
-
-.. real_arc_int:: Component Interface 1
-   :id: real_arc_int__example_feature__archdes_component_interface_1
-   :status: valid
-   :safety: ASIL_B
-   :security: NO
-   :satisfies: comp_req__example_feature__archex_example_req
-   :language: cpp
-
-   .. needarch::
-      :scale: 50
-      :align: center
-
-      {{ draw_interface(need(), needs)}}
+The component interface view shows the actual interfaces of the component. Also links to their corresponding logical interfaces are displayed in this view. A rendered component-interface example is maintained in the
+`module template documentation <https://eclipse-score.github.io/module_template/main/>`__.
 
 Platform View
 =============
@@ -471,7 +421,8 @@ Here are some excerpts of UML diagrams made from the requirements of that file.
 Feature Architecture
 ^^^^^^^^^^^^^^^^^^^^
 
-The following section is an example, how an `Feature <https://eclipse-score.github.io/score/main/features/index.html>`_ looks like and how the architecture of an Feature is described. Please note that components with an "ASIL_B" safety rating are highlighted with red borders in the diagram (e.g., "Component 1").
+The following section links to the rendered feature example that is now maintained in the
+`module template documentation <https://eclipse-score.github.io/module_template/main/>`__.
 
 .. feat:: Feature Name
    :id: feat__feature_name_example
@@ -523,7 +474,8 @@ The following section is an example, how an `Feature <https://eclipse-score.gith
 Component Architecture
 ^^^^^^^^^^^^^^^^^^^^^^
 
-The following section is an example, how an component looks like and how the detail design of an component is described. Please note that components with an "ASIL_B" safety rating are highlighted with red borders in the diagram (e.g., "Component 1").
+The rendered component examples are maintained in the
+`module template documentation <https://eclipse-score.github.io/module_template/main/>`__.
 
 .. comp_arc_sta:: Component Static View - Rendered Example
    :id: comp_arc_sta__example_feature__component_getstrt
@@ -588,6 +540,9 @@ Besides storing the output it is also possible to display the generated PlantUML
 
 Debug example for component architecture:
 
+See the rendered debug example in the
+`module template documentation <https://eclipse-score.github.io/module_template/main/>`__.
+
 .. comp_arc_sta:: Component Static View - Rendered Debug Example
    :id: comp_arc_sta__example_feature__component_getstrt_debug
    :status: valid
@@ -630,22 +585,8 @@ To make *needuml* work we have to replace the *need()* call with a different fun
          }
          CM -> LI1: EXTRA_LINKAGE_MANUALLY_ADDED
 
-.. 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
-   :security: NO
-   :uses: logic_arc_int__example_feature__archex_logical_interface_1
-   :satisfies: comp_req__example_feature__archex_example_req
-   :belongs_to: comp__component_example_1
-
-   .. needarch::
-
-         {{ draw_component( needs.get('comp__component_example_1'), needs ) }}
-
-         component "Component Manual" as CM {
-         }
-         CM -> logic_arc_int__example_feature__archex_logical_interface_1: EXTRA_LINKAGE_MANUALLY_ADDED
+See the rendered manual-edit example in the
+`module template documentation <https://eclipse-score.github.io/module_template/main/>`__.
 
 You can add any layout or additional configuration you want before you call the *draw_xyz*.
 

process/process_areas/architecture_design/guidance/architecture_process_reqs.rst

@@ -25,7 +25,7 @@ Architectural Model
    :status: valid
    :tags: manual_prio_1
    :complies: std_req__iso26262__support_6431, std_req__iso26262__support_6432
-   :derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
+   :satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
 
    For architecture design a model based approach should be used. The model shall consist of different architectural elements.
 
@@ -34,7 +34,7 @@ Architectural Model
    :status: valid
    :tags: done_automation
    :complies: std_req__iso26262__support_6431, std_req__iso26262__support_6432, std_req__iso26262__software_743
-   :derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
+   :satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
 
    The architectural elements shall be hierarchically structured on two levels:
 
@@ -46,7 +46,7 @@ Architectural Model
    :status: valid
    :tags: done_automation
    :complies: std_req__iso26262__support_6431, std_req__iso26262__support_6432, std_req__aspice_40__iic-01-03, std_req__aspice_40__iic-01-50
-   :derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
+   :satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
 
    Following architectural elements shall be defined on the respective hierarchical level:
 
@@ -76,7 +76,7 @@ Architectural Model
    :status: valid
    :tags: done_automation
    :complies: std_req__iso26262__support_6431, std_req__iso26262__support_6432
-   :derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
+   :satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
 
    For modeling the viewpoints following relations shall be used:
 
@@ -95,7 +95,7 @@ Architectural Views
    :status: valid
    :tags: manual_prio_1
    :complies: std_req__iso26262__support_6432, std_req__iso26262__software_742, std_req__aspice_40__SWE-2-BP1, std_req__aspice_40__SWE-2-BP2
-   :derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
+   :satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
 
    The architecture shall be shown on following views on each architectural level:
 
@@ -113,7 +113,7 @@ Attributes of Architectural Elements
    :status: valid
    :tags: manual_prio_1, attribute, mandatory
    :complies: std_req__iso26262__support_6425, std_req__iso26262__support_6432
-   :derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
+   :satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
 
    Each architectural element shall have a unique ID. It shall be in a format which is also human readable and consists of
 
@@ -127,7 +127,7 @@ Attributes of Architectural Elements
    :id: gd_req__arch_attr_security
    :status: valid
    :tags: manual_prio_1, attribute, mandatory
-   :derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
+   :satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
 
    Each architectural element shall have a security relevance identifier:
 
@@ -139,7 +139,7 @@ Attributes of Architectural Elements
    :status: valid
    :tags: manual_prio_1, attribute, mandatory
    :complies: std_req__iso26262__support_6421, std_req__iso26262__support_6425, std_req__iso26262__software_746
-   :derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
+   :satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
 
    Each architectural element shall have a automotive safety integrity level (ASIL) identifier:
 
@@ -151,7 +151,7 @@ Attributes of Architectural Elements
    :status: valid
    :tags: manual_prio_1, attribute, mandatory
    :complies: std_req__iso26262__support_6425
-   :derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
+   :satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
 
    Each architectural element shall have a status:
 
@@ -166,7 +166,7 @@ Traceability to Requirements and AoU
    :status: valid
    :tags: manual_prio_1, attribute, mandatory
    :complies: std_req__iso26262__support_6425, std_req__aspice_40__SWE-2-BP4
-   :derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
+   :satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
 
    Each architectural view (feature/comp_arc_sta, feature/comp_arc_dyn) and interface (logic/real_arc_int) shall be linked to a requirement.
 
@@ -175,7 +175,7 @@ Traceability to Requirements and AoU
    :status: valid
    :tags: manual_prio_1, attribute, mandatory
    :complies: std_req__iso26262__support_6425, std_req__aspice_40__SWE-2-BP4
-   :derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
+   :satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
 
    Each architectural static view (feature/comp_arc_sta) shall be linked to AoUs if the element (feature/comp) fulfills these.
 
@@ -184,7 +184,7 @@ Traceability to Requirements and AoU
    :status: valid
    :tags: manual_prio_2
    :complies: std_req__iso26262__support_6432, std_req__aspice_40__SWE-2-BP4
-   :derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
+   :satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
 
    Requirements shall be fulfilled by an architectural element on the corresponding level.
 
@@ -203,7 +203,7 @@ Checks for Architectural Design
    :id: gd_req__arch_attr_mandatory
    :status: valid
    :tags: prio_1_automation, attribute, check
-   :derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
+   :satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
 
    It shall be checked if all mandatory attributes for each architectural element are provided by the user. For all elements following attributes shall be mandatory:
 
@@ -217,7 +217,7 @@ Checks for Architectural Design
    :id: gd_req__arch_linkage_safety
    :status: valid
    :tags: prio_1_automation, attribute, check
-   :derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
+   :satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
    :complies: std_req__aspice_40__SWE-2-BP4
 
    It shall be checked that every valid safety architectural element is linked according to the defined model :need:`gd_req__arch_build_blocks_corr`.
@@ -226,7 +226,7 @@ Checks for Architectural Design
    :id: gd_req__arch_linkage_safety_trace
    :status: valid
    :tags: prio_1_automation, attribute, check
-   :derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
+   :satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
    :complies: std_req__iso26262__software_746, std_req__iso26262__software_748
 
    It shall be checked that valid safety architectural elements (Safety!=QM) can only be linked against valid safety architectural elements.
@@ -235,15 +235,15 @@ Checks for Architectural Design
    :id: gd_req__arch_linkage_security_trace
    :status: valid
    :tags: prio_2_automation, attribute, check
-   :derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
+   :satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
 
    It shall be checked that security relevant architectural elements (Security==YES) can only be linked against security relevant architectural elements.
 
 .. gd_req:: Check of Architecture linkage requirement
    :id: gd_req__arch_linkage_requirement
    :status: valid
    :tags: prio_1_automation, attribute, check
-   :derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
+   :satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
 
    It shall be checked that each architectural element (safety!=QM) is linked against at least one safety requirement (safety!=QM).
    It shall be checked that architectural elements with safety=QM are not linked against safety requirements (safety!=QM).
@@ -252,7 +252,7 @@ Checks for Architectural Design
    :id: gd_req__arch_linkage_requirement_type
    :status: valid
    :tags: prio_3_automation, attribute, check
-   :derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
+   :satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
 
    It shall be checked that requirements of a respective type can only be linked to architectural elements according to following traceability:
 
@@ -263,7 +263,7 @@ Checks for Architectural Design
    :id: gd_req__arch_linkage_aou
    :status: valid
    :tags: prio_2_automation, attribute, check
-   :derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
+   :satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
 
    It shall be checked that architectural static view (feature/comp_arc_sta) are not linked to its own AoU
    ("own" means the AoU linked as "mitigated_by" to the Safety/Security Analysis linked via "violates" to the element,
@@ -273,14 +273,14 @@ Checks for Architectural Design
    :id: gd_req__arch_consistency_interf
    :status: valid
    :tags: prio_2_automation, model, check
-   :derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
+   :satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
 
    It shall be checked if any interface referred by the features (link from Feature to Logical Arc. Interfaces must be defined and exists) is matched by an "implements" link in the Module (from component to Logical Arc. Interface). Additionally it shall be checked if the feature architecture are linked against at least one logical architectural interface.
 
 .. gd_req:: Check of Architecture consistency in dynamic architecture
    :id: gd_req__arch_consistency_dynamic
    :status: valid
    :tags: prio_3_automation, model, check
-   :derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
+   :satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
 
    It shall be checked if all SW components which are mentioned in the dynamic architecture views are defined in the static architecture.