Create Req Inspection Template in Folders

process/folder_templates/features/feature_name/index.rst

@@ -187,6 +187,7 @@ Footnotes
    :hidden:
 
    requirements/index.rst
+   requirements/chklst_req_inspection.rst
    architecture/index.rst
    safety_planning/index.rst
    safety_analysis/fmea.rst

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

@@ -0,0 +1,160 @@
+..
+   # *******************************************************************************
+   # Copyright (c) 2025 Contributors to the Eclipse Foundation
+   #
+   # See the NOTICE file(s) distributed with this work for additional
+   # information regarding copyright ownership.
+   #
+   # This program and the accompanying materials are made available under the
+   # terms of the Apache License Version 2.0 which is available at
+   # https://www.apache.org/licenses/LICENSE-2.0
+   #
+   # SPDX-License-Identifier: Apache-2.0
+   # *******************************************************************************
+
+
+.. document:: [Your Feature Name] Requirements Inspection Checklist
+   :id: doc__feature_name_req_inspection
+   :status: draft
+   :safety: ASIL_B
+   :realizes: wp__requirements_inspect
+   :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 ``_req_inspection``
+    - Adjust ``status`` to be ``valid``
+    - Adjust ``safety`` and ``tags`` according to your needs
+
+[Your Feature Name] Requirement Inspection Checklist
+======================================================
+
+   **Purpose**
+   The purpose of this requirement inspection checklist is to collect the topics to be checked during requirements inspection.
+
+   **Checklist**
+
+   .. list-table:: Feature Requirement Inspection Checklist
+      :header-rows: 1
+      :widths: 10,30,50,6,6,8
+
+      * - Review ID
+        - Acceptance Criteria
+        - Guidance
+        - Passed
+        - Remarks
+        - Issue link
+      * - REQ_01_01
+        - Is the requirement sentence template used?
+        - see :need:`gd_temp__req_formulation`, this includes the use of "shall".
+        -
+        -
+        -
+      * - REQ_02_01
+        - Is the requirement description *comprehensible* ?
+        - If you think the requirement is hard to understand, comment here.
+        -
+        -
+        -
+      * - REQ_02_02
+        - Is the requirement description *unambiguous* ?
+        - Especially search for "weak words" like "about", "etc.", "relevant" and others (see the internet documentation on this). This check shall be supported by tooling.
+        -
+        -
+        -
+      * - REQ_02_03
+        - Is the requirement description *atomic* ?
+        - A good way to think about this is to consider if the requirement may be tested by one (positive) test case or needs more of these. The sentence template should also avoid being non-atomic already. Note that there are cases where also non-atomic requirements are the better ones, for example if those are better understandable.
+        -
+        -
+        -
+      * - REQ_02_04
+        - Is the requirement description *feasible* ?
+        - Expectation is that at the time of the inspection the requirement has already some implementation. This can be checked via traces, but also :need:`gd_req__req_attr_impl` shows this. In case the requirement is not mature enough at the time of inspection (i.e. not implemented at least as "proof-of-concept"), a development expert should be invited to the Pull-Request review to explicitly check this item.
+        -
+        -
+        -
+      * - REQ_02_05
+        - Is the requirement description *independent from implementation* ?
+        - This checkpoint should improve requirements definition in the sense that the "what" is described and not the "how" - the latter should be described in architecture/design derived from the requirement. But there can also be a good reason for this, for example we would require using a file format like JSON and even specify the formatting standard already on stakeholder requirement level because we want to be compatible. A finding in this checkpoint does not mean there is a safety problem in the requirement.
+        -
+        -
+        -
+      * - REQ_03_01
+        - For stakeholder requirements: Is the *rationale* correct?
+        - Rationales explain why the top level requirements were invented. Do those cover the requirement?
+        -
+        -
+        -
+      * - REQ_03_02
+        - For other requirements: Is the *linkage to the parent requirement* correct?
+        - Linkage to correct levels and ASIL attributes is checked automatically, but it needs checking if the child requirement implements (at least) a part of the parent requirement.
+        -
+        -
+        -
+      * - REQ_04_01
+        - Is the requirement *internally and externally consistent*?
+        - Does the requirement contradict other requirements within the same or higher levels? One may restrict the search to the feature for component requirements, for features to other features using same components.
+        -
+        -
+        -
+      * - REQ_05_01
+        - Do the software requirements consider *timing constraints of the parent requirement*?
+        - This bullet point encourages to think about timing constraints even if those are not explicitly mentioned in the parent requirement. If the reviewer of a requirement already knows or suspects that the implementation will be time consuming, one should think of the expectation of a "user".
+        -
+        -
+        -
+      * - REQ_06_01
+        - Does the Requirement consider *external interfaces*?
+        - The SW platform's external interfaces (to the user) are defined in the Feature Architecture, so the Feature and Component Requirements should determine the data consumed and set on these interfaces. Are output values completely defined?
+        -
+        -
+        -
+      * - REQ_07_01
+        - Is the *ASIL Attribute* set correctly?
+        - Derived requirements are checked automatically, see :need:`gd_req__req_linkage_safety`. But for the top level requirements this needs to be checked for correctness. Also AoU from external components need check for correct ASIL as those are the "origin" of safety requirements towards the SW platform.
+        -
+        -
+        -
+      * - REQ_07_02
+        - Is the attribute *security* set correctly?
+        - Stakeholder requirements security attribute should be set based on Threat Analysis and Risk Assessment (TARA) (process is TBD). Checklist item is supported by automated check: "Every requirement which satisfies a requirement with security attribute set to YES inherits this". Expectation is that the feature/component requirements/architecture may also be subject to a Software Security Criticality Analysis (process is TBD).
+        -
+        -
+        -
+      * - REQ_08_01
+        - Is the requirement *verifiable*?
+        - Expectation is that at the time of the inspection already tests are created for the requirement. This can be checked via traces, but also :need:`gd_req__req_attr_test_covered` shows this. In case the requirement is not mature enough at the time of inspection (i.e. missing test cases), a test expert should be invited to the Pull-Request review to explicitly check this item.
+        -
+        -
+        -
+      * - REQ_09_01
+        - For stakeholder requirements: Do those cover assumed safety mechanisms needed by the hardware and system?
+        - Note that the feature/component requirements also cover safety mechanisms in case those are needed to mitigate failures found during :need:`gd_chklst__safety_analysis`
+        -
+        -
+        -
+      * - REQ_09_02
+        - For other requirements: Do the requirements defining a safety mechanism contain the error reaction leading to a safe state?
+        - Alternatively to the safe state there could also be "repair" mechanisms. Also do not forget to consider REQ_05_01 for these.
+        -
+        -
+        -
+
+
+.. attention::
+    The above checklist entries must be filled according to your component requirements in scope.
+    Also the need links mentioned in the checklist must be renamed to PROCESS_<old id> to point to the process documentation.
+
+The following (valid) requirements are in the scope of this inspection:
+
+.. needtable::
+   :filter: "feature_name" in docname and "requirements" in docname and docname is not None
+   :style: table
+   :types: feat_req
+   :tags: feature_name
+   :columns: id;status;tags
+   :colwidths: 25,25,25
+   :sort: title

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

@@ -174,6 +174,7 @@ Footnotes
    :hidden:
 
    requirements/index.rst
+   requirements/chklst_req_inspection.rst
    architecture/index.rst
    detailed_design/index.rst
    safety_analysis/fmea.rst

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

@@ -0,0 +1,160 @@
+..
+   # *******************************************************************************
+   # Copyright (c) 2025 Contributors to the Eclipse Foundation
+   #
+   # See the NOTICE file(s) distributed with this work for additional
+   # information regarding copyright ownership.
+   #
+   # This program and the accompanying materials are made available under the
+   # terms of the Apache License Version 2.0 which is available at
+   # https://www.apache.org/licenses/LICENSE-2.0
+   #
+   # SPDX-License-Identifier: Apache-2.0
+   # *******************************************************************************
+
+
+.. document:: [Your Component Name] Requirements Inspection Checklist
+   :id: doc__component_name_req_inspection
+   :status: draft
+   :safety: ASIL_B
+   :realizes: wp__requirements_inspect
+   :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 ``_req_inspection``
+    - Adjust ``status`` to be ``valid``
+    - Adjust ``safety`` and ``tags`` according to your needs
+
+[Your Component Name] Requirement Inspection Checklist
+======================================================
+
+   **Purpose**
+   The purpose of this requirement inspection checklist is to collect the topics to be checked during requirements inspection.
+
+   **Checklist**
+
+   .. list-table:: Component Requirement Inspection Checklist
+      :header-rows: 1
+      :widths: 10,30,50,6,6,8
+
+      * - Review ID
+        - Acceptance Criteria
+        - Guidance
+        - Passed
+        - Remarks
+        - Issue link
+      * - REQ_01_01
+        - Is the requirement sentence template used?
+        - see :need:`gd_temp__req_formulation`, this includes the use of "shall".
+        -
+        -
+        -
+      * - REQ_02_01
+        - Is the requirement description *comprehensible* ?
+        - If you think the requirement is hard to understand, comment here.
+        -
+        -
+        -
+      * - REQ_02_02
+        - Is the requirement description *unambiguous* ?
+        - Especially search for "weak words" like "about", "etc.", "relevant" and others (see the internet documentation on this). This check shall be supported by tooling.
+        -
+        -
+        -
+      * - REQ_02_03
+        - Is the requirement description *atomic* ?
+        - A good way to think about this is to consider if the requirement may be tested by one (positive) test case or needs more of these. The sentence template should also avoid being non-atomic already. Note that there are cases where also non-atomic requirements are the better ones, for example if those are better understandable.
+        -
+        -
+        -
+      * - REQ_02_04
+        - Is the requirement description *feasible* ?
+        - Expectation is that at the time of the inspection the requirement has already some implementation. This can be checked via traces, but also :need:`gd_req__req_attr_impl` shows this. In case the requirement is not mature enough at the time of inspection (i.e. not implemented at least as "proof-of-concept"), a development expert should be invited to the Pull-Request review to explicitly check this item.
+        -
+        -
+        -
+      * - REQ_02_05
+        - Is the requirement description *independent from implementation* ?
+        - This checkpoint should improve requirements definition in the sense that the "what" is described and not the "how" - the latter should be described in architecture/design derived from the requirement. But there can also be a good reason for this, for example we would require using a file format like JSON and even specify the formatting standard already on stakeholder requirement level because we want to be compatible. A finding in this checkpoint does not mean there is a safety problem in the requirement.
+        -
+        -
+        -
+      * - REQ_03_01
+        - For stakeholder requirements: Is the *rationale* correct?
+        - Rationales explain why the top level requirements were invented. Do those cover the requirement?
+        -
+        -
+        -
+      * - REQ_03_02
+        - For other requirements: Is the *linkage to the parent requirement* correct?
+        - Linkage to correct levels and ASIL attributes is checked automatically, but it needs checking if the child requirement implements (at least) a part of the parent requirement.
+        -
+        -
+        -
+      * - REQ_04_01
+        - Is the requirement *internally and externally consistent*?
+        - Does the requirement contradict other requirements within the same or higher levels? One may restrict the search to the feature for component requirements, for features to other features using same components.
+        -
+        -
+        -
+      * - REQ_05_01
+        - Do the software requirements consider *timing constraints of the parent requirement*?
+        - This bullet point encourages to think about timing constraints even if those are not explicitly mentioned in the parent requirement. If the reviewer of a requirement already knows or suspects that the implementation will be time consuming, one should think of the expectation of a "user".
+        -
+        -
+        -
+      * - REQ_06_01
+        - Does the Requirement consider *external interfaces*?
+        - The SW platform's external interfaces (to the user) are defined in the Feature Architecture, so the Feature and Component Requirements should determine the data consumed and set on these interfaces. Are output values completely defined?
+        -
+        -
+        -
+      * - REQ_07_01
+        - Is the *ASIL Attribute* set correctly?
+        - Derived requirements are checked automatically, see :need:`gd_req__req_linkage_safety`. But for the top level requirements this needs to be checked for correctness. Also AoU from external components need check for correct ASIL as those are the "origin" of safety requirements towards the SW platform.
+        -
+        -
+        -
+      * - REQ_07_02
+        - Is the attribute *security* set correctly?
+        - Stakeholder requirements security attribute should be set based on Threat Analysis and Risk Assessment (TARA) (process is TBD). Checklist item is supported by automated check: "Every requirement which satisfies a requirement with security attribute set to YES inherits this". Expectation is that the feature/component requirements/architecture may also be subject to a Software Security Criticality Analysis (process is TBD).
+        -
+        -
+        -
+      * - REQ_08_01
+        - Is the requirement *verifiable*?
+        - Expectation is that at the time of the inspection already tests are created for the requirement. This can be checked via traces, but also :need:`gd_req__req_attr_test_covered` shows this. In case the requirement is not mature enough at the time of inspection (i.e. missing test cases), a test expert should be invited to the Pull-Request review to explicitly check this item.
+        -
+        -
+        -
+      * - REQ_09_01
+        - For stakeholder requirements: Do those cover assumed safety mechanisms needed by the hardware and system?
+        - Note that the feature/component requirements also cover safety mechanisms in case those are needed to mitigate failures found during :need:`gd_chklst__safety_analysis`
+        -
+        -
+        -
+      * - REQ_09_02
+        - For other requirements: Do the requirements defining a safety mechanism contain the error reaction leading to a safe state?
+        - Alternatively to the safe state there could also be "repair" mechanisms. Also do not forget to consider REQ_05_01 for these.
+        -
+        -
+        -
+
+
+.. attention::
+    The above checklist entries must be filled according to your component requirements in scope.
+    Also the need links mentioned in the checklist must be renamed to PROCESS_<old id> to point to the process documentation.
+
+The following (valid) requirements are in the scope of this inspection:
+
+.. needtable::
+   :filter: "component_name" in docname and "requirements" in docname and docname is not None
+   :style: table
+   :types: comp_req
+   :tags: component_name
+   :columns: id;status;tags
+   :colwidths: 25,25,25
+   :sort: title

process/folder_templates/modules/module_name/docs/safety_mgt/module_safety_plan.rst

@@ -340,7 +340,7 @@ Component Architecture Status
 -----------------------------
 
 .. needtable::
-   :filter: "component_name" in docname and "requirements" in docname and docname is not None
+   :filter: "component_name" in docname and "architecture" in docname and docname is not None
    :style: table
    :types: comp_arc_sta; comp_arc_dyn
    :tags: component_name