diff --git a/docs/features/baselibs/docs/requirements/chklst_req_inspection.rst b/docs/features/baselibs/docs/requirements/chklst_req_inspection.rst index 31e26909857..e5335c41fd3 100644 --- a/docs/features/baselibs/docs/requirements/chklst_req_inspection.rst +++ b/docs/features/baselibs/docs/requirements/chklst_req_inspection.rst @@ -1,6 +1,6 @@ .. # ******************************************************************************* - # Copyright (c) 2025 Contributors to the Eclipse Foundation + # Copyright (c) 2025-2026 Contributors to the Eclipse Foundation # # See the NOTICE file(s) distributed with this work for additional # information regarding copyright ownership. @@ -15,7 +15,7 @@ .. document:: Baselibs Requirements Inspection Checklist :id: doc__baselibs_req_inspection - :status: draft + :status: valid :safety: ASIL_B :security: YES :realizes: wp__requirements_inspect @@ -24,127 +24,128 @@ Requirement Inspection Checklist ================================ - **Purpose** - - The purpose of this requirement inspection checklist is to collect the topics to be checked during requirements inspection. - - **Conduct** - - As described in the concept :need:`doc_concept__wp_inspections` the following "inspection roles" are expected to be filled: - - - author: these are the persons who did the last commits on the requirements in scope (can be derived from version mgt tool) - - reviewer: these are all persons committing into this inspection document or giving a pull request verdict on it (can be derived from version mgt tool) - - moderator: only needed for conflict resolution between author and reviewers, is the safety manager, security manager or quality manager called in as a reviewer (can be derived from version mgt tool) - - test expert: - - **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 formulation 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 requirement formulation 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* ? - - If at the time of the inspection the requirement has already some implementation, the answer is yes. This can be checked via traces, but also :need:`gd_req__req_attr_impl` shows this. In case the requirement has no implementation 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 created. Do those cover the requirement? - - - - - - - * - REQ_03_02 - - For feature/component 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*? - - This checkpoint 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 code execution will be consuming a lot of time, 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 input data use and setting of output data for these interfaces. Are all output values defined? - - - - - - - * - REQ_07_01 - - Is the *safety* attribute set correctly? - - Derived requirements are checked automatically, see :need:`gd_req__req_linkage_safety`. But for the top level requirements (and also all AoU) this needs to be checked manually for correctness. - - - - - - - * - 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). For feature/component requirements this checklist item is supported by automated check: "Every requirement which satisfies a requirement with security attribute set to YES inherits this". But the feature/component requirements/architecture may additionally also be subject to a Software Security Criticality Analysis (process is TBD). - - - - - - - * - REQ_08_01 - - Is the requirement *verifiable*? - - If at the time of the inspection already tests are created for the requirement, the answer is yes. This can be checked via traces, but also :need:`gd_req__req_attr_test_covered` shows this. In case the requirement is not sufficiently traced to test cases already, a test expert is invited to the inspection to give their opinion whether the requirement is formulated in a way that supports test development and the available test infrastructure is sufficient to perform the test. - - - - - - - * - REQ_09_01 - - For stakeholder requirements: Do those cover assumed safety mechanisms needed by the hardware and system? - - Note that stakeholder requirements covering safety mechanisms come from rationales, whereas feature/component requirements are covering safety mechanisms coming from :need:`gd_chklst__safety_analysis` - - - - - - - * - REQ_09_02 - - For feature/component 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. - - - - - - +Purpose +------- + +The purpose of this requirement inspection checklist is to collect the topics to be checked during requirements inspection. + +Conduct +------- + +As described in the concept :need:`doc_concept__wp_inspections` the following "inspection roles" are expected to be filled: + +- content responsible (author): ``_ +- reviewer: ``_ +- moderator: ``_ +- test expert: ``_ + +Checklist +--------- + +It is mandatory to fill in the "passed" column with "yes" or "no" for each checklist item and additionally to add in the remarks why it is passed or not passed. +In case of "no" an issue link to the issue tracking system has to be added in the last column (if not solved in the same issue). +See also :need:`doc_concept__wp_inspections` for further information about reviews in general and inspection in particular. + +.. 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 formulation 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 requirement formulation 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* ? + - If at the time of the inspection the requirement has already some implementation, the answer is yes. This can be checked via traces, but also :need:`gd_req__req_attr_impl` shows this. In case the requirement has no implementation 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 + - 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. Is the description of the requirement consistent with all its attributes (if not already part of another check, e.g. does the title fit?). + - + - + - + * - REQ_05_01 + - Do the software requirements consider *timing constraints*? + - This checkpoint 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 code execution will be consuming a lot of time, 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 input data use and setting of output data for these interfaces. Are all output values defined? + - + - + - + * - REQ_07_01 + - Is the *safety* attribute set correctly? + - Derived requirements are checked automatically, see :need:`gd_req__req_linkage_safety`. But for the top level requirements (and also all AoU) this needs to be checked manually for correctness. + - + - + - + * - REQ_07_02 + - Is the *security* attribute set correctly? + - For feature requirements this checklist item is supported by automated check: "Every requirement which satisfies a stakeholder requirement with security attribute set to YES inherits this". But the feature requirements/architecture may additionally also be subject to a :need:`wp__feature_security_analysis` + - + - + - + * - REQ_08_01 + - Is the requirement *verifiable*? + - If at the time of the inspection already tests are created for the requirement, the answer is yes. This can be checked via traces, but also :need:`gd_req__req_attr_test_covered` shows this. In case the requirement is not sufficiently traced to test cases already, a test expert is invited to the inspection to give their opinion whether the requirement is formulated in a way that supports test development and the available test infrastructure is sufficient to perform the test. + - + - + - + * - REQ_08_02 + - Is the requirement verifiable by design or code review in case it is not feasibly testable? + - In very rare cases a requirement may not be verifiable by test cases, for example a specific non-functional requirement. In this case a requirement analysis verifies the requirement by design/code review. If such a requirement is in scope of this inspection, please check this here and link to the respective review record. A test expert is invited to the inspection to confirm their opinion that the requirement is not testable. + - + - + - + * - REQ_09_01 + - Do the feature 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. + - + - + - Note: If a Review ID is not applicable for your requirement, then state ""n/a" in status and comment accordingly in remarks. For example "no stakeholder requirement (no rationale needed)" @@ -163,7 +164,7 @@ The following requirements in "valid" state and with "inspected" tag set are in And also the following AoUs in "valid" state and with "inspected" tag set (for these please answer the questions above as if the AoUs are requirements, except questions REQ_03_01 and REQ_03_02): .. needtable:: - :filter: docname is not None and "baselibs" in docname and "requirements" in docname and status == "valid" + :filter: docname is not None and "baselibs" in docname and "requirements" in docname and "features" in docname and status == "valid" :style: table :types: aou_req :tags: baselibs diff --git a/docs/features/baselibs/docs/requirements/index.rst b/docs/features/baselibs/docs/requirements/index.rst index b0efbd47dc4..1b8fd73076d 100644 --- a/docs/features/baselibs/docs/requirements/index.rst +++ b/docs/features/baselibs/docs/requirements/index.rst @@ -1,6 +1,6 @@ .. # ******************************************************************************* - # Copyright (c) 2025 Contributors to the Eclipse Foundation + # Copyright (c) 2025-2026 Contributors to the Eclipse Foundation # # See the NOTICE file(s) distributed with this work for additional # information regarding copyright ownership. @@ -17,7 +17,7 @@ Requirements .. document:: Baselibs Requirements :id: doc__baselibs_requirements - :status: draft + :status: valid :safety: ASIL_B :security: YES :realizes: wp__requirements_feat @@ -29,6 +29,7 @@ Requirements :safety: QM :satisfies: stkh_req__functional_req__base_libraries :status: valid + :tags: inspected The base libraries shall include core software utilities and common infrastructure components needed by multiple platform modules. @@ -39,6 +40,7 @@ Requirements :safety: ASIL_B :satisfies: stkh_req__functional_req__base_libraries, stkh_req__dependability__automotive_safety :status: valid + :tags: inspected The base libraries shall implement functionality necessary to support safety-relevant platform components up to ASIL-B for selected functionalities. @@ -49,6 +51,7 @@ Requirements :safety: ASIL_B :satisfies: stkh_req__functional_req__base_libraries, stkh_req__dev_experience__prog_languages, stkh_req__dependability__automotive_safety :status: valid + :tags: inspected The base libraries shall provide APIs for C++, Rust, or both, depending on the requirements of consuming platform components. @@ -89,6 +92,7 @@ Requirements :safety: ASIL_B :satisfies: stkh_req__functional_req__base_libraries :status: valid + :tags: inspected The base libraries shall provide a JSON-Library with parsing functionality. @@ -99,6 +103,7 @@ Requirements :safety: QM :satisfies: stkh_req__functional_req__base_libraries :status: valid + :valid_from: v1.0.0 The base libraries shall provide a FlatBuffers-Library with serialization, read access, and structural verification of FlatBuffers data. @@ -113,6 +118,7 @@ Requirements :safety: ASIL_B :satisfies: stkh_req__functional_req__base_libraries :status: valid + :tags: inspected The base libraries shall provide error handling mechanisms that enable development without relying on C++ exceptions. @@ -123,6 +129,7 @@ Requirements :safety: ASIL_B :satisfies: stkh_req__functional_req__base_libraries :status: valid + :tags: inspected The base libraries shall provide a container library offering additional container types not present in the C++ standard library. @@ -133,6 +140,7 @@ Requirements :safety: ASIL_B :satisfies: stkh_req__functional_req__base_libraries :status: valid + :tags: inspected The base libraries shall provide bit manipulation utilities for low-level operations on integral types. @@ -143,6 +151,7 @@ Requirements :safety: ASIL_B :satisfies: stkh_req__functional_req__base_libraries, stkh_req__dependability__automotive_safety :status: valid + :tags: inspected The base libraries shall provide a filesystem library with file and directory manipulation functionality. @@ -163,6 +172,7 @@ Requirements :safety: ASIL_B :satisfies: stkh_req__functional_req__base_libraries :status: valid + :tags: inspected The base libraries shall provide a library for parallel execution of C++ callables with thread pool management.