update further descriptions on use of comp and feat

RolandJentschETAS · RolandJentschETAS · commit 49a6f9e34033 · 2025-12-18T11:34:09.000+01:00
diff --git a/process/folder_templates/features/feature_name/architecture/index.rst b/process/folder_templates/features/feature_name/architecture/index.rst
@@ -75,6 +75,7 @@ Static Architecture
    :includes: logic_arc_int__feature_name__interface_name
    :consists_of: comp__component_name
 
+   General Feature Description
 
 .. feat_arc_sta:: Static View
    :id: feat_arc_sta__feature_name__static_view
@@ -100,7 +101,7 @@ Dynamic Architecture
    :status: invalid
    :fulfils: feat_req__feature_name__some_title
 
-   put here a sequence diagram
+   Put here a sequence diagram
 
 Logical Interfaces
 ------------------
@@ -111,6 +112,8 @@ Logical Interfaces
    :safety: ASIL_B
    :status: invalid
 
+   General Interface Description
+
    .. needarch::
       :scale: 50
       :align: center
@@ -124,6 +127,8 @@ Logical Interfaces
    :status: invalid
    :included_by: logic_arc_int__feature_name__interface_name
 
+   General Operation Description
+
 Module Viewpoint
 ----------------
 
@@ -155,7 +160,7 @@ They will be replaced by linking the proper SW component definitions in the used
    :implements: logic_arc_int__feature_name__interface_name
 
 .. note::
-   Architecture can be split into multiple files, it is an High level architecture_design
+   Architecture can be split into multiple files, it is an high level architecture design
    which can be shown without actual c++/rust interfaces and data types
    and there will be link to lower level architecture till code to get actual api descriptions.
 
diff --git a/process/folder_templates/features/feature_name/requirements/index.rst b/process/folder_templates/features/feature_name/requirements/index.rst
@@ -55,7 +55,7 @@ Requirements
    :satisfies: stkh_req__requirements__template
    :status: invalid
 
-   The Feature shall do xyz to the user to bring him to this condition at this time
+   The Feature shall do xyz to the user to bring him to this condition at this time.
 
    Note: (optional, not to be verified)
 
@@ -66,7 +66,7 @@ Requirements
    :safety: ASIL_B
    :status: invalid
 
-   The Feature User shall do xyz to use the feature safely
+   The Feature User shall do xyz to use the feature safely.
 
 .. attention::
     The above directives must be updated according to your feature requirements.
diff --git a/process/folder_templates/features/feature_name/safety_analysis/dfa.rst b/process/folder_templates/features/feature_name/safety_analysis/dfa.rst
@@ -49,7 +49,7 @@ Dependent Failure Initiators
        :sufficient: <yes|no>
        :status: <valid|invalid>
 
- .. note::   argument is inside the 'content'. Therefore content is mandatory
+ .. note::   Argument is inside the 'content'. Therefore content is mandatory.
 
 .. attention::
     The above directive must be updated according to your feature DFA.
diff --git a/process/folder_templates/features/feature_name/safety_analysis/fmea.rst b/process/folder_templates/features/feature_name/safety_analysis/fmea.rst
@@ -50,7 +50,7 @@ Failure Mode List
        :sufficient: <yes|no>
        :status: <valid|invalid>
 
- .. note::   argument is inside the 'content'. Therefore content is mandatory
+ .. note::   Argument is inside the 'content'. Therefore content is mandatory.
 
 .. attention::
     The above directive must be updated according to your feature FMEA.
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
@@ -102,7 +102,7 @@ Dynamic Architecture
    :status: invalid
    :fulfils: comp_req__component_name__some_title
 
-   put here a sequence diagram
+   Put here a sequence diagram
 
 
 Interfaces
@@ -128,7 +128,7 @@ Lower Level Components
    :fulfils: comp_req__component_name__some_title
    :implements: logic_arc_int__feature_name__interface_name
 
-   no architecture but detailed design
+   No architecture but detailed design
 
 .. note::
    Architecture can be split into multiple files. At component level the public interfaces to be used by the user and tester to be shown.
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
@@ -62,6 +62,17 @@ Requirements
 
    The Component User shall do xyz to use the component safely
 
+.. aou_req:: Another Title
+   :id: aou_req__component_name__another_title
+   :reqtype: Process
+   :security: YES
+   :safety: ASIL_B
+   :status: invalid
+   :tags: environment
+
+   The Component shall only be used in a xyz environment to ensure its proper functioning.
+
+
 .. attention::
     The above directives must be updated according to your feature requirements.
 
diff --git a/process/folder_templates/modules/module_name/component_name/docs/safety_analysis/dfa.rst b/process/folder_templates/modules/module_name/component_name/docs/safety_analysis/dfa.rst
@@ -49,7 +49,7 @@ Dependent Failure Initiators
        :sufficient: <yes|no>
        :status: <valid|invalid>
 
-.. note::   argument is inside the 'content'. Therefore content is mandatory
+.. note::   Argument is inside the 'content'. Therefore content is mandatory.
 
 .. attention::
     The above directive must be updated according to your component DFA.
diff --git a/process/folder_templates/platform/safety_analysis/platform_dfa.rst b/process/folder_templates/platform/safety_analysis/platform_dfa.rst
@@ -51,7 +51,7 @@ Dependent Failure Initiators
        :mitigation_issue: <ID from Issue Tracker>
        :sufficient: <yes|no>
        :status: <valid|invalid>
-.. note::   argument is inside the 'content'. Therefore content is mandatory
+.. note::   Argument is inside the 'content'. Therefore content is mandatory.
 
 .. attention::
     The above directive must be updated according to the platform DFA.
diff --git a/process/process_areas/architecture_design/_assets/architecture_modeling_example.rst b/process/process_areas/architecture_design/_assets/architecture_modeling_example.rst
@@ -22,7 +22,17 @@ This chapter only serves as an example how an architecture could be modeled in *
 Feature Architecture File
 =========================
 
-.. feat_arc_sta:: Feature 1
+.. feat:: Feature 1
+   :id: feat__example_feature
+   :security: YES
+   :safety: QM
+   :status: valid
+   :includes: logic_arc_int__example_feature__archdes_logical_interface_1, logic_arc_int__example_feature__archdes_logical_interface_2
+   :consists_of: comp__component_example1
+
+   This is the example feature.
+
+.. feat_arc_sta:: Feature 1 Static View
    :id: feat_arc_sta__example_feature__archdes_static
    :security: YES
    :safety: QM
@@ -145,7 +155,16 @@ Module Viewpoint
 Component Architecure File(s)
 =============================
 
-.. comp_arc_sta:: Component 1
+.. comp:: Component 1
+   :id: comp__component_example1
+   :security: YES
+   :safety: ASIL_B
+   :status: invalid
+   :implements: logic_arc_int__feature_name__interface_name
+
+   Example Component 1 description.
+
+.. comp_arc_sta:: Component 1 Static View
    :id: comp_arc_sta__example_feature__archdes_component_1
    :status: valid
    :safety: ASIL_B
@@ -161,7 +180,7 @@ Component Architecure File(s)
 
       {{ draw_component(need(), needs) }}
 
-.. comp_arc_sta:: Component 3
+.. comp_arc_sta:: Component 3 Static View
    :id: comp_arc_sta__example_feature__archdes_component_3
    :status: valid
    :safety: QM
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
diff --git a/process/process_areas/architecture_design/architecture_concept.rst b/process/process_areas/architecture_design/architecture_concept.rst
@@ -277,30 +277,25 @@ The *static view* shows the *building blocks* of the architecture. It shall be c
 
 .. list-table:: Definition of the static architectural elements
    :header-rows: 1
-   :widths: 15,35,35
+   :widths: 15,35
 
    * - Element
      - Sphinx Needs Directive
-     - Code Template
    * - Feature Architecture
      - feat_arc_sta
-     - feat_arc_sta_t
    * - Component Architecture
      - comp_arc_sta
-     - comp_arc_sta_t
 
 To represent the CI build tool module (for example a `Bazel Modules <https://bazel.build/external/module>`_) an additional container (or package) is introduced. It can only contain components:
 
 .. list-table:: Definition of the static module view
    :header-rows: 1
-   :widths: 15,35,35
+   :widths: 15,35
 
    * - Element
      - Sphinx Needs Directive
-     - Code Template
    * - Module View
      - mod_view_sta
-     - mod_view_sta_t
 
 Dynamic view
 ============
@@ -311,17 +306,14 @@ The dynamic view shall be modeled partly in Sphinx Needs and PlantUML. The compo
 
 .. list-table:: Definition of the dynamic architectural elements
    :header-rows: 1
-   :widths: 15,35,35
+   :widths: 15,35
 
    * - Element
      - Sphinx Needs Directive
-     - Code Template
    * - Dynamic Feature Architecture
      - feat_arc_dyn
-     - feat_arc_sta_t
    * - Dynamic Component Architecture
      - comp_arc_dyn
-     - comp_arc_dyn_t
 
 Interface view
 ==============
@@ -330,20 +322,16 @@ The *interface view* focuses on the interfaces of the components and shows the o
 
 .. list-table:: Definition of the architectural elements
    :header-rows: 1
-   :widths: 15,35,35
+   :widths: 15,35
 
    * - (Logical) Interface
      - logic_arc_int
-     - logic_arc_int_t
    * - (Logical) Interface Operation
      - logic_arc_int_op
-     - logic_arc_int_op_t
    * - (Real) Interface
      - real_arc_int
-     - real_arc_int_t
    * - (Real) Interface Operation
      - real_arc_int_op
-     - real_arc_int_op_t
 
 Relations between the architectural elements
 ============================================
diff --git a/process/process_areas/architecture_design/guidance/architecture_guideline.rst b/process/process_areas/architecture_design/guidance/architecture_guideline.rst
@@ -112,20 +112,16 @@ Based on the concept description a model of the feature architecture should be d
 
 .. list-table:: Architectural Elements of the Feature Architecture
    :header-rows: 1
-   :widths: 10,30,30
+   :widths: 10,30
 
    * - Element
      - Sphinx directive
-     - VS Code Template
    * - Feature Architecture
-     - feat_arc_sta, feat_arc_dyn
-     - feat_arc_sta_t, feat_arc_dyn_t
+     - feat, feat_arc_sta, feat_arc_dyn
    * - Logical Interface
      - logic_arc_int
-     - logic_arc_int_t
    * - Logical Interface Operation
      - logic_arc_int_op
-     - logic_arc_int_op_t
 
 The relations of the static elements are described in :ref:`metamodel_architectural_design`.
 
@@ -187,20 +183,16 @@ According to the architecture design description the model for the component arc
 
 .. list-table:: Architectural Elements of the Component Architecture
    :header-rows: 1
-   :widths: 10,30,30
+   :widths: 10,30
 
    * - Element
      - Sphinx directive
-     - VS Code Template
    * - Component Architecture
-     - comp_arc_sta, comp_arc_dyn
-     - comp_arc_sta_t, comp_arc_dyn_t
+     - comp, comp_arc_sta, comp_arc_dyn
    * - (Real) Interface
      - real_arc_int
-     - real_arc_int_t
    * - (Real) Interface Operation
      - real_arc_int_op
-     - real_arc_int_op_t
 
 The relations of the static elements are described in :ref:`metamodel_architectural_design`.
 
diff --git a/process/process_areas/architecture_design/guidance/architecture_process_reqs.rst b/process/process_areas/architecture_design/guidance/architecture_process_reqs.rst
@@ -67,6 +67,7 @@ Architectural Model
      * Interface Operation (real_arc_int_op)
 
    * Module
+
      * SW Module (mod)
 
 
