docs: add folder_templates - finding fixes

Ref: closes #1106

Author: aschemmel-tech

process/folder_templates/features/feature_name/architecture/index.rst

@@ -17,6 +17,21 @@
 Feature Architecture
 ====================
 
+.. document:: [Your Feature Name] Architecture
+   :id: doc__feature_name_architecture
+   :status: draft
+   :safety: ASIL_D
+   :realizes: wp__feature_arch
+   :tags: template
+
+.. attention::
+    The above directive must be updated according to your Feature.
+
+    - Modify ``Your Feature Name`` to be your Feature Name
+    - Modify ``id`` to be your Feature Name in upper snake case preceded by ``doc__`` and followed by ``_architecture``
+    - Adjust ``status`` to be ``valid``
+    - Adjust ``safety`` and ``tags`` according to your needs
+
 Overview
 --------
 Brief summary
@@ -106,8 +121,8 @@ The following modules are needed to be defined to be able to draw the static fea
 They will be replaced by linking the proper module definitions in the used module's repositories as soon as those exist.
 
 .. mod_view_sta:: Module Name
-   :id: mod_view_sta__feature_name_module_name
-   :includes: comp_arc_sta__feature_name_component_name
+   :id: mod_view_sta__feature_name__module_name
+   :includes: comp_arc_sta__feature_name__component_name
 
    .. needarch::
       :scale: 50
@@ -122,7 +137,7 @@ The following components are needed to be defined to be able to draw the static
 They will be replaced by linking the proper SW component definitions in the used module's repositories as soon as those exist.
 
 .. comp_arc_sta:: Component Name
-   :id: comp_arc_sta__feature_name_component_name
+   :id: comp_arc_sta__feature_name__component_name
    :safety: ASIL_D
    :security: YES
    :status: invalid
@@ -133,5 +148,8 @@ They will be replaced by linking the proper SW component definitions in the used
    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.
 
-.. needextend:: "feature_name/architecture" in docname
-   :+tags: feature_name
+.. attention::
+    The above directives must be updated according to your feature architecture.
+
+    - Replace the example content by the real content (according to :need:`gd_guidl__arch__design`)
+    - Set the status to valid and start the review/merge process

process/folder_templates/features/feature_name/index.rst

@@ -22,7 +22,8 @@
 .. document:: [Your Feature Name]
    :id: doc__feature_name
    :status: draft
-   :safety: ASIL_B
+   :safety: ASIL_D
+   :realizes: wp__feat_request
    :tags: template
 
 .. attention::
@@ -109,6 +110,7 @@ If applicable, which additional security measures must be implemented to mitigat
      Use Trust Boundary, Defense in Depth Analysis and/or Security Software Critically Analysis,
      Vulnerability Analysis.
      [Methods will be defined later in Process area Security Analysis]
+     These analyses may not be available at the time of creation of the feature (request) but content will be improved iteratively.
 
 Safety Impact
 =============
@@ -126,6 +128,7 @@ If applicable, which additional safety measures must be implemented to mitigate
     .. note::
      Use Dependency Failure Analysis and/or Safety Software Critically Analysis.
      [Methods will be defined later in Process area Safety Analysis]
+     These analyses may not be available at the time of creation of the feature (request) but content will be improved iteratively.
 
 For new feature contributions:
 

process/folder_templates/features/feature_name/requirements/index.rst

@@ -15,15 +15,42 @@
 Requirements
 ############
 
+.. document:: [Your Feature Name] Requirements
+   :id: doc__feature_name_requirements
+   :status: draft
+   :safety: ASIL_D
+   :realizes: wp__requirements__feat
+   :tags: template
+
+.. attention::
+    The above directive must be updated according to your Feature.
+
+    - Modify ``Your Feature Name`` to be your Feature Name
+    - Modify ``id`` to be your Feature Name in upper snake case preceded by ``doc__`` and followed by ``_requirements``
+    - Adjust ``status`` to be ``valid``
+    - Adjust ``safety`` and ``tags`` according to your needs
+
 <Headlines (for the list of requirements if structuring is needed)>
 ===================================================================
 
+.. stkh_req:: Template
+   :id: stkh_req__requirements__template
+   :reqtype: Non-Functional
+   :safety: ASIL_D
+   :rationale: Exists just for the template example
+   :status: invalid
+
+   The platform shall ...
+
+.. attention::
+    The above stakeholder requirement must be removed, it just serves as a link target for this template.
+
 .. feat_req:: Some Title
    :id: feat_req__feature_name__some_title
    :reqtype: Process
    :security: YES
    :safety: ASIL_D
-   :satisfies: stkh_req__requirements__as_code
+   :satisfies: stkh_req__requirements__template
    :status: invalid
 
    The Feature shall do xyz to the user to bring him to this condition at this time
@@ -42,9 +69,9 @@ Requirements
 .. attention::
     The above directives must be updated according to your feature requirements.
 
-    - Replace the example content by the real content for your first requirement
+    - Replace the example content by the real content for your first requirement (according to :need:`gd_guidl__req__engineering`)
     - Set the status to valid and start the review/merge process
     - Add other needed requirements for your feature
 
-.. needextend:: "feature_name/requirements" in docname
+.. needextend:: "feature_name" in id
    :+tags: feature_name

process/folder_templates/features/feature_name/safety_analysis/dfa.rst

@@ -16,6 +16,24 @@
 Dependent Failure Analysis
 ==========================
 
+.. document:: [Your Feature Name] DFA
+   :id: doc__feature_name_dfa
+   :status: draft
+   :safety: ASIL_D
+   :realizes: wp__sw_feature_dfa
+   :tags: template
+
+.. attention::
+    The above directive must be updated according to your Feature.
+
+    - Modify ``Your Feature Name`` to be your Feature Name
+    - Modify ``id`` to be your Feature Name in upper snake case preceded by ``doc__`` and succeeded by ``_dfa``
+    - Adjust ``status`` to be ``valid``
+    - Adjust ``safety`` and ``tags`` according to your needs
+
+Dependent Failure Intitiators
+-----------------------------
+
 .. code-block:: rst
 
    .. feat_saf_dfa:: <Element descriptor>

process/folder_templates/features/feature_name/safety_analysis/fmea.rst

@@ -16,6 +16,24 @@
 Safety Analysis : FMEA
 ======================
 
+.. document:: [Your Feature Name] FMEA
+   :id: doc__feature_name_fmea
+   :status: draft
+   :safety: ASIL_D
+   :realizes: wp__sw_feature_safety_analysis
+   :tags: template
+
+.. attention::
+    The above directive must be updated according to your Feature.
+
+    - Modify ``Your Feature Name`` to be your Feature Name
+    - Modify ``id`` to be your Feature Name in upper snake case preceded by ``doc__`` and succeeded by ``_fmea``
+    - Adjust ``status`` to be ``valid``
+    - Adjust ``safety`` and ``tags`` according to your needs
+
+Failure Mode List
+-----------------
+
 .. code-block:: rst
 
    .. feat_saf_fmea:: <Element descriptor>

process/folder_templates/features/feature_name/safety_planning/index.rst

@@ -17,15 +17,30 @@
 Feature Safety Planning
 =======================
 
-.. list-table:: Feature <feature> Workproducts
+.. document:: [Your Feature Name] Safety WPs
+   :id: doc__feature_name_safety_wp
+   :status: draft
+   :safety: ASIL_D
+   :realizes: wp__platform_safety_plan
+   :tags: template
+
+.. attention::
+    The above directive must be updated according to your Feature.
+
+    - Modify ``Your Feature Name`` to be your Feature Name
+    - Modify ``id`` to be your Module Name in upper snake case preceded by ``doc__`` and succeeded by ``_safety_wp``
+    - Adjust ``status`` to be ``valid``
+    - Adjust ``safety`` and ``tags`` according to your needs
+
+.. list-table:: Feature <feature_name> Workproducts
     :header-rows: 1
 
     * - Workproduct Id
       - Link to process
       - Process status
       - Link to issue
       - Link to WP
-      - WP status
+      - WP/doc status
 
     * - :need:`wp__feat_request`
       - :need:`gd_temp__change__feature_request`
@@ -38,36 +53,36 @@ Feature Safety Planning
       - :need:`gd_temp__req__feat_req`
       - :ndf:`copy('status', need_id='gd_temp__req__feat_req')`
       - <link to issue>
-      - :doc:`../requirements/index`
-      - see below
+      - :need:`doc__feature_name_requirements`
+      - doc :ndf:`copy('status', need_id='doc__feature_name')` & WP below
 
     * - :need:`wp__requirements__feat_aou`
       - :need:`gd_temp__req__aou_req`
       - :ndf:`copy('status', need_id='gd_temp__req__aou_req')`
       - <link to issue>
-      - :doc:`../requirements/index`
-      - see below
+      - :need:`doc__feature_name_requirements`
+      - doc :ndf:`copy('status', need_id='doc__feature_name')` & WP below
 
     * - :need:`wp__feature_arch`
       - :need:`gd_temp__arch__feature`
       - :ndf:`copy('status', need_id='gd_temp__arch__feature')`
       - <link to issue>
-      - :doc:`../architecture/index`
-      - see below
+      - :need:`doc__feature_name_architecture`
+      - doc :ndf:`copy('status', need_id='doc__feature_name_architecture')` & WP below
 
     * - :need:`wp__feature_safety_analysis`
       - <link to process>
       - <automated>
       - <link to issue>
-      - :doc:`../safety_analysis/fmea`
-      - <automated>
+      - :need:`doc__feature_name_fmea`
+      - doc :ndf:`copy('status', need_id='doc__feature_name_fmea')` & WP below
 
     * - :need:`wp__feature_dfa`
       - <Link to process>
       - <Process status>
       - <Link to issue>
-      - :doc:`../safety_analysis/dfa`
-      - <automated>
+      - :need:`doc__feature_name_dfa`
+      - doc :ndf:`copy('status', need_id='doc__feature_name_dfa')` & WP below
 
     * - :need:`wp__requirements__inspect`
       - :need:`gd_chklst__req__inspection`
@@ -90,6 +105,12 @@ Feature Safety Planning
       - <Link to WP>
       - <automated>
 
+.. attention::
+    The above table must be updated according to your feature safety planning.
+
+    - Create and link the issues to plan the work products (according to :need:`gd_guidl__saf_plan_definitions`)
+    - Fill the work producs links and add their status (also possible below) to create the safety package (according to :need:`gd_guidl__saf_package`)
+
 Feature Requirements Status
 ---------------------------
 

process/folder_templates/modules/module_name/component_name/docs/architecture/index.rst

@@ -17,6 +17,21 @@
 Component Architecture
 ======================
 
+.. document:: [Your Component Name] Architecture
+   :id: doc__component_name_architecture
+   :status: draft
+   :safety: ASIL_D
+   :realizes: wp__component_arch
+   :tags: template
+
+.. attention::
+    The above directive must be updated according to your needs.
+
+    - Modify ``Your Component Name`` to be your Component Name
+    - Modify ``id`` to be your Component Name in upper snake case preceded by ``doc__`` and followed by ``_architecture``
+    - Adjust ``status`` to be ``valid``
+    - Adjust ``safety`` and ``tags`` according to your needs
+
 Overview
 --------
 Brief summary
@@ -60,7 +75,7 @@ The components are designed to cover the expectations from the feature architect
    :status: invalid
    :implements: logic_arc_int__feature_name__interface_name
    :fulfils: comp_req__component_name__some_title
-   :includes: comp_arc_sta__component_name_2
+   :includes: comp_arc_sta__component_name__2
 
    .. needarch::
       :scale: 50
@@ -97,7 +112,7 @@ Lower Level Components
 ----------------------
 
 .. comp_arc_sta:: Component Name 2
-   :id: comp_arc_sta__component_name_2
+   :id: comp_arc_sta__component_name__2
    :status: invalid
    :safety: ASIL_D
    :security: YES
@@ -108,5 +123,8 @@ Lower Level Components
 .. 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.
 
-.. needextend:: "module_name/component_name/docs/architecture" in docname
-   :+tags: component_name
+.. attention::
+    The above directives must be updated according to your component architecture.
+
+    - Replace the example content by the real content (according to :need:`gd_guidl__arch__design`)
+    - Set the status to valid and start the review/merge process

process/folder_templates/modules/module_name/component_name/docs/component_classification.rst

@@ -20,13 +20,14 @@ Component Classification
 .. document:: [Your Component Name] Component Classification
    :id: doc__component_name_comp_class
    :status: draft
-   :safety: ASIL_B
+   :safety: ASIL_D
+   :realizes: wp__sw_component_class
    :tags: template
 
 .. attention::
     The above directive must be updated according to your Component.
 
-    - Modify ``document`` to be your Component Name
+    - Modify ``Your Component Name`` to be your Component Name
     - Modify ``id`` to be your Component Name in upper snake case preceded by ``doc__``
     - Adjust ``status`` to be ``valid``
     - Adjust ``safety`` and ``tags`` according to your needs

process/folder_templates/modules/module_name/component_name/docs/index.rst

@@ -22,7 +22,8 @@
 .. document:: [Your Component Name]
    :id: doc__component_name
    :status: draft
-   :safety: ASIL_B
+   :safety: ASIL_D
+   :realizes: wp__cmpt_request
    :tags: template
 
 .. attention::

process/folder_templates/modules/module_name/component_name/docs/requirements/index.rst

@@ -15,6 +15,21 @@
 Requirements
 ############
 
+.. document:: [Your Component Name] Requirements
+   :id: doc__component_name_requirements
+   :status: draft
+   :safety: ASIL_D
+   :realizes: wp__requirements__comp
+   :tags: template
+
+.. attention::
+    The above directive must be updated according to your Component.
+
+    - Modify ``Your Component Name`` to be your Component Name
+    - Modify ``id`` to be your Component Name in upper snake case preceded by ``doc__`` and followed by ``_requirements``
+    - Adjust ``status`` to be ``valid``
+    - Adjust ``safety`` and ``tags`` according to your needs
+
 <Headlines (for the list of requirements if structuring is needed)>
 ===================================================================
 
@@ -49,9 +64,9 @@ Requirements
 .. attention::
     The above directives must be updated according to your feature requirements.
 
-    - Replace the example content by the real content for your first requirement
+    - Replace the example content by the real content for your first requirement (according to :need:`gd_guidl__req__engineering`)
     - Set the status to valid and start the review/merge process
     - Add other needed requirements for your feature
 
-.. needextend:: "module_name/component_name/docs/requirements" in docname
+.. needextend:: "component_name" in id
    :+tags: component_name