diff --git a/.gitignore b/.gitignore index 94f11a5ae9..5b56c3953a 100644 --- a/.gitignore +++ b/.gitignore @@ -11,6 +11,7 @@ user.bazelrc # docs build artifacts /_build* +docs/ubproject.toml # Vale - editorial style guide .vale.ini diff --git a/MODULE.bazel b/MODULE.bazel index 20c7258868..fb20b05287 100644 --- a/MODULE.bazel +++ b/MODULE.bazel @@ -13,7 +13,7 @@ module( name = "score_platform", - version = "0.4.0", + version = "0.4.1", compatibility_level = 0, ) @@ -73,5 +73,5 @@ bazel_dep(name = "rules_java", version = "8.15.1") # ############################################################################### bazel_dep(name = "score_tooling", version = "1.0.2") -bazel_dep(name = "score_docs_as_code", version = "1.4.0") -bazel_dep(name = "score_process", version = "1.2.1") +bazel_dep(name = "score_docs_as_code", version = "2.0.0") +bazel_dep(name = "score_process", version = "1.3.1") diff --git a/docs/conf.py b/docs/conf.py index 811a1a3167..5690729f59 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -15,7 +15,6 @@ project = "S-CORE" project_url = "https://eclipse-score.github.io/score" -project_prefix = "S-CORE_" version = "0.1" extensions = [ diff --git a/docs/contribute/contribution_request/feature_request.rst b/docs/contribute/contribution_request/feature_request.rst index 52d9ac0b05..b391571b93 100644 --- a/docs/contribute/contribution_request/feature_request.rst +++ b/docs/contribute/contribution_request/feature_request.rst @@ -25,7 +25,7 @@ This Guideline is based on or references following documents: * :ref:`Contribution Guideline ` * :ref:`Change Management Plan ` -* :need:`Feature Template ` +* :need:`Feature Template ` Creation of Feature Request ================================ @@ -82,7 +82,7 @@ First of all, change the status of *Feature Request* to "in Progress" state. *Feature Requests*, that stay in the status "Draft" longer as 4 weeks, will be deleted. Afterwards create a PR with your proposal in the `/docs/features `_ score repository. There you will find currently existing features as subfolders. Please choose the one that fits your *feature request* the most or -create a new subfolder, if none of existing feature match your *feature request*. Please take care, that the PR follows the :need:`Feature Template `. +create a new subfolder, if none of existing feature match your *feature request*. Please take care, that the PR follows the :need:`Feature Template `. You should try to put as much information as possible, as a good exhaustive description is a prerequisite for *feature request* to be accepted. It is important to understand, that *feature request* consists of an GitHub Issue, that is used to track organizational information and diff --git a/docs/contribute/contribution_request/index.rst b/docs/contribute/contribution_request/index.rst index 01dc10d9e0..e8145646b9 100644 --- a/docs/contribute/contribution_request/index.rst +++ b/docs/contribute/contribution_request/index.rst @@ -95,9 +95,9 @@ A Pull Request (**PR**) is the **ONLY** way to contribute **CODE** to the *S-COR The figure below shows a simplified workflow for a PR. -* The contributor (:need:`Contributor `) starts by creating a PR: `Creating a Pull Request (Github Docs) `_. +* The contributor (:need:`Contributor `) starts by creating a PR: `Creating a Pull Request (Github Docs) `_. * Required reviewers will be automatically assigned based on the contributed content (via CODEOWNERS). -* If the content fullfils the review and acceptance criteria, a committer (:need:`Committer `) will approve the *PR* and thus it can be merged. +* If the content fullfils the review and acceptance criteria, a committer (:need:`Committer `) will approve the *PR* and thus it can be merged. .. figure:: _assets/score_contribution_request_simple.drawio.svg :width: 600 @@ -108,7 +108,7 @@ The figure below shows a simplified workflow for a PR. Content in general may contain features, requirements, architectural designs, modules, components, detailed designs, implementations and source code, tests, process descriptions, any documentations, guidelines, tutorials, tools, or infrastructure topics and more of the *S-CORE* project. In case of doubt or for any other input we strongly encourage to open a *GitHub Issue* (:need:`doc__issue_guideline`) first. -The *PR* should provide all required information of the new or changed content. Therefore the *S-CORE* project provides content specific templates, which the contributor (:need:`Contributor `) must use for his *PR* (ToDo link here to the templates overview). Templates may be *PR* templates, *GitHub Issue* templates and also additional document or work product templates. +The *PR* should provide all required information of the new or changed content. Therefore the *S-CORE* project provides content specific templates, which the contributor (:need:`Contributor `) must use for his *PR* (ToDo link here to the templates overview). Templates may be *PR* templates, *GitHub Issue* templates and also additional document or work product templates. The content of any *PR* is the commit content and the description as well as the comments given in GitHub and is kept in a versioned repository, their revision history is the historical record of the PR. @@ -132,23 +132,23 @@ The figure below gives an overview about all the possible steps for a *PR* until Create a PR ----------- -The contributor (:need:`Contributor `) creates a PR. +The contributor (:need:`Contributor `) creates a PR. -Reviewers will be automatically assigned (:need:`Committer `) based on the contributed content (ruleset as defined by the committers). In addition several checks for the contributed content (ToDo: Link to the description of the checks) will be started. +Reviewers will be automatically assigned (:need:`Committer `) based on the contributed content (ruleset as defined by the committers). In addition several checks for the contributed content (ToDo: Link to the description of the checks) will be started. Review and merge a PR --------------------- -A *PR* is reviewed with all content that adds/modifies it. As long as a *PR* requires further work by the contributor (:need:`Contributor `), the *PR* is not approved and thus not merged and further changes are requested. Once the contributor (:need:`Contributor `) considers all review comments as resolved, :need:`Contributor ` can re-request a review. The committer (:need:`Committer `) reviews the *PR* content according the *S-CORE* review and acceptance criteria (ToDo link here to the criteria). -Further the contributor (:need:`Contributor `) must resolve found issues from the automated checks, if they do not pass. +A *PR* is reviewed with all content that adds/modifies it. As long as a *PR* requires further work by the contributor (:need:`Contributor `), the *PR* is not approved and thus not merged and further changes are requested. Once the contributor (:need:`Contributor `) considers all review comments as resolved, :need:`Contributor ` can re-request a review. The committer (:need:`Committer `) reviews the *PR* content according the *S-CORE* review and acceptance criteria (ToDo link here to the criteria). +Further the contributor (:need:`Contributor `) must resolve found issues from the automated checks, if they do not pass. -As long as the *PR* does not meet the defined criteria and the checks does not pass, it will not be approved. If it does not follow the required templates, based on the provided content or the templates are not filled out properly, the committer as reviewer (:need:`Committer `) will place the *PR* to the "Draft" state. +As long as the *PR* does not meet the defined criteria and the checks does not pass, it will not be approved. If it does not follow the required templates, based on the provided content or the templates are not filled out properly, the committer as reviewer (:need:`Committer `) will place the *PR* to the "Draft" state. -It is then the responsibility of the contributor (:need:`Contributor `) to add the missing information and to re-start the contribution by placing the *PR* back for review. +It is then the responsibility of the contributor (:need:`Contributor `) to add the missing information and to re-start the contribution by placing the *PR* back for review. To change from "Draft" to "Open" see `Changing the stage of a pull request (Github Docs) `_. -At any point the contributor (:need:`Contributor `) may decide not to continue with the PR, then the contributor (:need:`Contributor `) just closes the PR. +At any point the contributor (:need:`Contributor `) may decide not to continue with the PR, then the contributor (:need:`Contributor `) just closes the PR. .. _what_is_a_github_issue: diff --git a/docs/contribute/development/development_environment.rst b/docs/contribute/development/development_environment.rst index ad25898e5f..d867a299cd 100644 --- a/docs/contribute/development/development_environment.rst +++ b/docs/contribute/development/development_environment.rst @@ -16,7 +16,7 @@ :id: doc__develop_environment :status: valid :safety: ASIL_B - :realizes: PROCESS_wp__sw_development_plan + :realizes: wp__sw_development_plan .. _setting_up_dev_env: diff --git a/docs/contribute/general/folder.rst b/docs/contribute/general/folder.rst index f526dc9c12..0ff53f8398 100644 --- a/docs/contribute/general/folder.rst +++ b/docs/contribute/general/folder.rst @@ -27,37 +27,37 @@ The following shows the folder structure of the platform repository (ordered alp docs/ -> Global documentation of the platform contribute/ -> Description on how to contribute features/ -> All features of the platform - / -> Features including sub-folders and feature (change) request [:need:`PROCESS_wp__feat_request`] - architecture/ -> Feature architecture [:need:`PROCESS_wp__feature_arch`] - requirements/ -> Feature requirements [:need:`PROCESS_wp__requirements_feat`] - safety_analysis/ -> Safety analysis on feature level [:need:`PROCESS_wp__feature_fmea`], [:need:`PROCESS_wp__feature_dfa`] + / -> Features including sub-folders and feature (change) request [:need:`wp__feat_request`] + architecture/ -> Feature architecture [:need:`wp__feature_arch`] + requirements/ -> Feature requirements [:need:`wp__requirements_feat`] + safety_analysis/ -> Safety analysis on feature level [:need:`wp__feature_fmea`], [:need:`wp__feature_dfa`] safety_planning/ -> Feature specific safety workproducts planning - security_analysis/ -> Security analysis on feature level [:need:`PROCESS_wp__feature_security_analysis`] - verification/ -> Feature verification, consisting of Architecture review [:need:`PROCESS_wp__sw_arch_verification`], - integration_tests/ -> Feature Integration tests [:need:`PROCESS_wp__verification_feat_int_test`] + security_analysis/ -> Security analysis on feature level [:need:`wp__feature_security_analysis`] + verification/ -> Feature verification, consisting of Architecture review [:need:`wp__sw_arch_verification`], + integration_tests/ -> Feature Integration tests [:need:`wp__verification_feat_int_test`] glossary/ -> Glossary of abbreviations used in the platform context introduction/ -> Background, scope and high-level architecture of the platform features manuals/ -> User and integration manual(s) modules/ -> Modules of the SW platform. - platform_management_plan/ -> Overall Platform Management Plan [:need:`PROCESS_wp__platform_mgmt`] + platform_management_plan/ -> Overall Platform Management Plan [:need:`wp__platform_mgmt`] quality/ -> Quality documentation on platform level: - [:need:`PROCESS_wp__qms_report`] + [:need:`wp__qms_report`] requirements/ -> Requirements on platform level - stakeholder/ -> Stakeholder requirements [:need:`PROCESS_wp__requirements_stkh`] + stakeholder/ -> Stakeholder requirements [:need:`wp__requirements_stkh`] tool/ -> Tool requirements (not covered in tool repositories) safety/ -> Safety documentation on platform level (SEooC): - [:need:`PROCESS_wp__platform_dfa`], [:need:`PROCESS_wp__platform_safety_manual`], - [:need:`PROCESS_wp__platform_safety_package`], [:need:`PROCESS_wp__fdr_reports`], - [:need:`PROCESS_wp__audit_report`] - score_releases/ -> [:need:`PROCESS_wp__platform_sw_release_note`] - score_tools/ -> Tool list and [:need:`PROCESS_wp__tool_verification_report`] + [:need:`wp__platform_dfa`], [:need:`wp__platform_safety_manual`], + [:need:`wp__platform_safety_package`], [:need:`wp__fdr_reports`], + [:need:`wp__audit_report`] + score_releases/ -> [:need:`wp__platform_sw_release_note`] + score_tools/ -> Tool list and [:need:`wp__tool_verification_report`] security/ -> Security documentation on platform level: - [:need:`PROCESS_wp__platform_security_manual`], [:need:`PROCESS_wp__platform_security_package`], [:need:`PROCESS_wp__sw_platform_sbom`] + [:need:`wp__platform_security_manual`], [:need:`wp__platform_security_package`], [:need:`wp__sw_platform_sbom`] verification_report/ -> Platform verification report (reporting all platform feature's verifications) - [:need:`PROCESS_wp__verification_platform_ver_report`] + [:need:`wp__verification_platform_ver_report`] - platform_integration_tests/ -> Integration tests on reference hardware verifying stakeholder requirements. [:need:`PROCESS_wp__verification_platform_test`] + platform_integration_tests/ -> Integration tests on reference hardware verifying stakeholder requirements. [:need:`wp__verification_platform_int_test`] tools/ -> Platform tools (not covered in tool repositories) README.md -> Entrypoint of the repository @@ -74,20 +74,20 @@ The modules and components shall follow the folder structure which was presented / -> Folder containing all artifacts corresponding to one module. docs/ -> Documentation of the module manual/ -> Module manual, e.g. integration manual, assumptions of use, - safety manual [:need:`PROCESS_wp__requirements_comp_aou`], - [:need:`PROCESS_wp__module_safety_manual`], - security_manual [:need:`PROCESS_wp__module_security_manual`]. - release/ -> Module release note [:need:`PROCESS_wp__module_sw_release_note`], - safety_mgt/ -> Module safety plan [:need:`PROCESS_wp__module_safety_plan`], - module safety package [:need:`PROCESS_wp__module_safety_package`], - formal documents reviews [:need:`PROCESS_wp__fdr_reports`] - security_mgt/ -> Module security plan [:need:`PROCESS_wp__module_security_plan`], - module securty package [:need:`PROCESS_wp__module_security_package`], - formal documents reviews [:need:`PROCESS_wp__fdr_reports_security`], - module SW bill of material [:need:`PROCESS_wp__sw_module_sbom`] + safety manual [:need:`wp__requirements_comp_aou`], + [:need:`wp__module_safety_manual`], + security_manual [:need:`wp__module_security_manual`]. + release/ -> Module release note [:need:`wp__module_sw_release_note`], + safety_mgt/ -> Module safety plan [:need:`wp__module_safety_plan`], + module safety package [:need:`wp__module_safety_package`], + formal documents reviews [:need:`wp__fdr_reports`] + security_mgt/ -> Module security plan [:need:`wp__module_security_plan`], + module securty package [:need:`wp__module_security_package`], + formal documents reviews [:need:`wp__fdr_reports_security`], + module SW bill of material [:need:`wp__sw_module_sbom`] verification_report/ -> Module verification report - components verifications [:need:`PROCESS_wp__verification_module_ver_report`], - safety analysis formal reviews [:need:`PROCESS_wp__fdr_reports`] + components verifications [:need:`wp__verification_module_ver_report`], + safety analysis formal reviews [:need:`wp__fdr_reports`] / -> Components of the module. Folder containing all artifacts corresponding to one component. @@ -95,21 +95,21 @@ The modules and components shall follow the folder structure which was presented src/ -> Source files of the component consisting of Include files Source Files - Unit tests [:need:`PROCESS_wp__verification_sw_unit_test`] + Unit tests [:need:`wp__verification_sw_unit_test`] Test doubles / -> lower level component following folder structure details/ -> Private implementation details of the component following folder structure docs/ -> Documentation of the component architecture/ -> Component architecture (only if lower level components exist) - [:need:`PROCESS_wp__component_arch`]. - detailed_design/ -> Detailed Design [:need:`PROCESS_wp__sw_implementation`] - requirements/ -> Component requirements [:need:`PROCESS_wp__requirements_comp`] + [:need:`wp__component_arch`]. + detailed_design/ -> Detailed Design [:need:`wp__sw_implementation`] + requirements/ -> Component requirements [:need:`wp__requirements_comp`] safety_analysis/ -> Safety analysis on component level (only if component architecture exists) - [:need:`PROCESS_wp__sw_component_fmea`], [:need:`PROCESS_wp__sw_component_dfa`] + [:need:`wp__sw_component_fmea`], [:need:`wp__sw_component_dfa`] security_analysis/ -> Security analysis on component level (only if component architecture exists) - [:need:`PROCESS_wp__sw_component_security_analysis`] - verification/ -> Component verification, consisting of Architecture review [:need:`PROCESS_wp__sw_arch_verification`], - code inspection [:need:`PROCESS_wp__sw_implementation_inspection`], - integration_tests/ -> Component integration tests [:need:`PROCESS_wp__verification_comp_int_test`] + [:need:`wp__sw_component_security_analysis`] + verification/ -> Component verification, consisting of Architecture review [:need:`wp__sw_arch_verification`], + code inspection [:need:`wp__sw_implementation_inspection`], + integration_tests/ -> Component integration tests [:need:`wp__verification_comp_int_test`] / -> Lower level component following folder structure diff --git a/docs/contribute/general/git.rst b/docs/contribute/general/git.rst index 214a22d407..fd1829f1fd 100644 --- a/docs/contribute/general/git.rst +++ b/docs/contribute/general/git.rst @@ -16,7 +16,7 @@ :id: doc__git_coding_guidelines :status: valid :safety: ASIL_B - :realizes: PROCESS_wp__sw_development_plan + :realizes: wp__sw_development_plan .. _git_guidelines: diff --git a/docs/contribute/general/naming.rst b/docs/contribute/general/naming.rst index 16c97d61fe..198e148dcc 100644 --- a/docs/contribute/general/naming.rst +++ b/docs/contribute/general/naming.rst @@ -16,7 +16,7 @@ :id: doc__naming_conventions :status: valid :safety: ASIL_B - :realizes: PROCESS_wp__sw_development_plan + :realizes: wp__sw_development_plan Naming Conventions ================== diff --git a/docs/contribute/general/release_guide.rst b/docs/contribute/general/release_guide.rst index e291f1dd7a..3a78cb6a8a 100644 --- a/docs/contribute/general/release_guide.rst +++ b/docs/contribute/general/release_guide.rst @@ -143,7 +143,7 @@ This then will give you something similar to this: :alt: Generated Release Notes For an official release (note) you need to consider the :need:`doc__platform_release_management_plan` -and follow the process as in :need:`PROCESS_gd_guidl__rel_management`. +and follow the process as in :need:`gd_guidl__rel_management`. 6. Set Pre-release Status (if applicable) diff --git a/docs/contribute/index.rst b/docs/contribute/index.rst index 2a35c24a0b..15b88d3526 100644 --- a/docs/contribute/index.rst +++ b/docs/contribute/index.rst @@ -16,7 +16,7 @@ :id: doc__contribution_guideline :status: valid :safety: ASIL_B - :realizes: PROCESS_wp__sw_development_plan + :realizes: wp__sw_development_plan .. _contribute: diff --git a/docs/features/communication/ipc/docs/safety_planning/index.rst b/docs/features/communication/ipc/docs/safety_planning/index.rst index 6755c19d15..234c136d4d 100644 --- a/docs/features/communication/ipc/docs/safety_planning/index.rst +++ b/docs/features/communication/ipc/docs/safety_planning/index.rst @@ -30,58 +30,58 @@ Inter-process Communication Safety Work Products - Link to WP - WP status - * - :need:`PROCESS_wp__feat_request` - - :need:`PROCESS_gd_temp__change_feature_request` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__change_feature_request')` + * - :need:`wp__feat_request` + - :need:`gd_temp__change_feature_request` + - :ndf:`copy('status', need_id='gd_temp__change_feature_request')` - `#69 `_ - :need:`doc__com_ipc` - :ndf:`copy('status', need_id='doc__com_ipc')` - * - :need:`PROCESS_wp__requirements_feat` - - :need:`PROCESS_gd_temp__req_feat_req` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__req_feat_req')` + * - :need:`wp__requirements_feat` + - :need:`gd_temp__req_feat_req` + - :ndf:`copy('status', need_id='gd_temp__req_feat_req')` - `#69 `_ - :doc:`../requirements/index` - see below - * - :need:`PROCESS_wp__requirements_feat_aou` - - :need:`PROCESS_gd_temp__req_aou_req` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__req_aou_req')` + * - :need:`wp__requirements_feat_aou` + - :need:`gd_temp__req_aou_req` + - :ndf:`copy('status', need_id='gd_temp__req_aou_req')` - - :doc:`../requirements/index` - see below - * - :need:`PROCESS_wp__feature_arch` - - :need:`PROCESS_gd_temp__arch_feature` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__arch_feature')` + * - :need:`wp__feature_arch` + - :need:`gd_temp__arch_feature` + - :ndf:`copy('status', need_id='gd_temp__arch_feature')` - `#388 `_ - :doc:`../architecture/index` - see below - * - :need:`PROCESS_wp__feature_fmea`, :need:`PROCESS_wp__feature_dfa` + * - :need:`wp__feature_fmea`, :need:`wp__feature_dfa` - - - - - - * - :need:`PROCESS_wp__requirements_inspect` - - :need:`PROCESS_gd_chklst__req_inspection` - - :ndf:`copy('status', need_id='PROCESS_gd_chklst__req_inspection')` + * - :need:`wp__requirements_inspect` + - :need:`gd_chklst__req_inspection` + - :ndf:`copy('status', need_id='gd_chklst__req_inspection')` - - - - * - :need:`PROCESS_wp__sw_arch_verification` - - :need:`PROCESS_gd_chklst__arch_inspection_checklist` - - :ndf:`copy('status', need_id='PROCESS_gd_chklst__arch_inspection_checklist')` + * - :need:`wp__sw_arch_verification` + - :need:`gd_chklst__arch_inspection_checklist` + - :ndf:`copy('status', need_id='gd_chklst__arch_inspection_checklist')` - - - - * - :need:`PROCESS_wp__verification_feat_int_test` - - :need:`PROCESS_gd_guidl__verification_guide` - - :ndf:`copy('status', need_id='PROCESS_gd_guidl__verification_guide')` + * - :need:`wp__verification_feat_int_test` + - :need:`gd_guidl__verification_guide` + - :ndf:`copy('status', need_id='gd_guidl__verification_guide')` - - - diff --git a/docs/features/frameworks/feo/architecture/chklst_arch_inspection.rst b/docs/features/frameworks/feo/architecture/chklst_arch_inspection.rst index e1f35a64cc..5882c09e7e 100644 --- a/docs/features/frameworks/feo/architecture/chklst_arch_inspection.rst +++ b/docs/features/frameworks/feo/architecture/chklst_arch_inspection.rst @@ -47,7 +47,7 @@ Checklist - Issue link * - ARC_01_01 - Is the traceability from software architectural elements to requirements, and other level architectural - elements (e.g. component to interface) established according to the defined :need:`Relations between the architectural elements `? + elements (e.g. component to interface) established according to the defined :need:`Relations between the architectural elements `? - automated - Trace should be checked by Sphinx. Will be removed from checklist once requirement is implemented. - No @@ -79,7 +79,7 @@ Checklist * - ARC_02_02 - Is appropriate and comprehensible operation/interface naming present in the architectural design? - manual - - Check :need:`PROCESS_gd_guidl__arch_design` + - Check :need:`gd_guidl__arch_design` - No - Are these interfaces names, any operations? - `Issue for Findings `_ diff --git a/docs/features/frameworks/feo/architecture/feature_architecture.rst b/docs/features/frameworks/feo/architecture/feature_architecture.rst index 928056f414..161c6dcaef 100644 --- a/docs/features/frameworks/feo/architecture/feature_architecture.rst +++ b/docs/features/frameworks/feo/architecture/feature_architecture.rst @@ -17,7 +17,7 @@ :status: valid :security: NO :safety: ASIL_B - :realizes: PROCESS_wp__feature_arch + :realizes: wp__feature_arch FEO Feature Architecture diff --git a/docs/features/frameworks/feo/requirements/aou_req.rst b/docs/features/frameworks/feo/requirements/aou_req.rst index c1185f831f..3b8bd29f11 100644 --- a/docs/features/frameworks/feo/requirements/aou_req.rst +++ b/docs/features/frameworks/feo/requirements/aou_req.rst @@ -17,7 +17,7 @@ :status: draft :security: NO :safety: ASIL_B - :realizes: PROCESS_wp__requirements_feat_aou + :realizes: wp__requirements_feat_aou FEO Feature Assumption of Use Requirements ========================================== diff --git a/docs/features/frameworks/feo/requirements/chklst_req_inspection.rst b/docs/features/frameworks/feo/requirements/chklst_req_inspection.rst index 69ddda86ef..948477f42e 100644 --- a/docs/features/frameworks/feo/requirements/chklst_req_inspection.rst +++ b/docs/features/frameworks/feo/requirements/chklst_req_inspection.rst @@ -42,7 +42,7 @@ FEO Feature Requirement Inspection Checklist - Issue link * - REQ_01_01 - Is the requirement sentence template used? - - see :need:`PROCESS_gd_temp__req_formulation`, this includes the use of "shall". + - see :need:`gd_temp__req_formulation`, this includes the use of "shall". - No - Reformulate requirements according template, may split as not atomic - `Issue for Findings `_ @@ -66,7 +66,7 @@ FEO Feature Requirement Inspection Checklist - `Issue for Findings `_ * - 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:`PROCESS_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. + - 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. - No - Implementation exists, but currently not traceability is established - `Issue for Findings `_ @@ -108,7 +108,7 @@ FEO Feature Requirement Inspection Checklist - `Issue for Findings `_ * - REQ_07_01 - Is the *ASIL Attribute* set correctly? - - Derived requirements are checked automatically, see :need:`PROCESS_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. + - 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. - Yes - - @@ -120,13 +120,13 @@ FEO Feature Requirement Inspection Checklist - `Issue for Findings `_ * - 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:`PROCESS_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. + - 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. - No - Follow the requirements template to make it verifiable. - `Issue for Findings `_ * - 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:`PROCESS_gd_chklst__safety_analysis` + - 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` - Yes - Not applicable, feature requirements only - diff --git a/docs/features/frameworks/feo/requirements/feature_req.rst b/docs/features/frameworks/feo/requirements/feature_req.rst index deb534f94d..eae28fba8f 100644 --- a/docs/features/frameworks/feo/requirements/feature_req.rst +++ b/docs/features/frameworks/feo/requirements/feature_req.rst @@ -17,7 +17,7 @@ :status: valid :security: NO :safety: ASIL_B - :realizes: PROCESS_wp__requirements_feat + :realizes: wp__requirements_feat FEO Feature Requirements ======================== diff --git a/docs/features/frameworks/feo/safety_analysis/chklst_safety_analysis_inspection.rst b/docs/features/frameworks/feo/safety_analysis/chklst_safety_analysis_inspection.rst index efd550b81d..6e8cafc998 100644 --- a/docs/features/frameworks/feo/safety_analysis/chklst_safety_analysis_inspection.rst +++ b/docs/features/frameworks/feo/safety_analysis/chklst_safety_analysis_inspection.rst @@ -45,13 +45,13 @@ FEO Feature Safety Analysis Checklist - * - REQ_01_02 - Are the templates for DFA and/or FMEA used? - - See :need:`PROCESS_gd_temp__comp_saf_dfa` / :need:`PROCESS_gd_temp__comp_saf_fmea` and also :need:`PROCESS_gd_req__saf_structure` + - See :need:`gd_temp__comp_saf_dfa` / :need:`gd_temp__comp_saf_fmea` and also :need:`gd_req__saf_structure` - Templates are used to generate the DFA or / and FMEA. - - * - REQ_01_03 - Were the failure initiators / fault models applied? - - See :need:`PROCESS_gd_guidl__dfa_failure_initiators` / :need:`PROCESS_gd_guidl__fault_models` + - See :need:`gd_guidl__dfa_failure_initiators` / :need:`gd_guidl__fault_models` - The applicable items of the failure initiators / fault models are used to ensure a structured analysis. For all not applicable items an argument shall be given in the content of the document. - - @@ -76,6 +76,6 @@ FEO Feature Safety Analysis Checklist * - REQ_01_08 - Is the overall result of the safety analysis described in the report? - It shall be shown in the report if the safety analysis are finished and if all artifacts are "valid" and "sufficient". - - The results of the safety analysis are described in the report. The report is available :need:`PROCESS_wp__verification_platform_ver_report`. + - The results of the safety analysis are described in the report. The report is available :need:`wp__verification_platform_ver_report`. - - diff --git a/docs/features/frameworks/feo/safety_analysis/feature_dfa.rst b/docs/features/frameworks/feo/safety_analysis/feature_dfa.rst index e5b761fdb4..8e5600baad 100644 --- a/docs/features/frameworks/feo/safety_analysis/feature_dfa.rst +++ b/docs/features/frameworks/feo/safety_analysis/feature_dfa.rst @@ -18,12 +18,12 @@ :security: NO :safety: ASIL_B :tags: frameworks_feo - :realizes: PROCESS_wp__feature_dfa + :realizes: wp__feature_dfa FEO Feature DFA =============== -For the DFA analysis where the failure initiators :need:`PROCESS_gd_guidl__dfa_failure_initiators` are used. The analysis is done before the platform DFA is done. +For the DFA analysis where the failure initiators :need:`gd_guidl__dfa_failure_initiators` are used. The analysis is done before the platform DFA is done. Safety mechanisms that are used by many features are not considered here, but at the platform DFA. The analysis is only done for the needs of the FEO feature. Dependent Failure Initiators diff --git a/docs/features/frameworks/feo/safety_analysis/feature_fmea.rst b/docs/features/frameworks/feo/safety_analysis/feature_fmea.rst index e627bc3b8a..fe79efa87e 100644 --- a/docs/features/frameworks/feo/safety_analysis/feature_fmea.rst +++ b/docs/features/frameworks/feo/safety_analysis/feature_fmea.rst @@ -18,7 +18,7 @@ :security: NO :safety: ASIL_B :tags: frameworks_feo - :realizes: PROCESS_wp__feature_fmea + :realizes: wp__feature_fmea FEO Feature FMEA ================ diff --git a/docs/features/frameworks/feo/safety_planning/index.rst b/docs/features/frameworks/feo/safety_planning/index.rst index c36c71ea0d..323df5c100 100644 --- a/docs/features/frameworks/feo/safety_planning/index.rst +++ b/docs/features/frameworks/feo/safety_planning/index.rst @@ -21,7 +21,7 @@ FEO Feature Safety Planning :status: valid :security: NO :safety: ASIL_B - :realizes: PROCESS_wp__platform_safety_plan + :realizes: wp__platform_safety_plan :tags: framework_feo @@ -35,72 +35,72 @@ FEO Feature Safety Planning - Link to WP - WP/doc status - * - :need:`PROCESS_wp__feat_request` - - :need:`PROCESS_gd_temp__change_feature_request` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__change_feature_request')` + * - :need:`wp__feat_request` + - :need:`gd_temp__change_feature_request` + - :ndf:`copy('status', need_id='gd_temp__change_feature_request')` - https://github.com/eclipse-score/score/issues/1646 - :need:`doc__frameworks_feo` - :ndf:`copy('status', need_id='doc__frameworks_feo')` - * - :need:`PROCESS_wp__requirements_feat` - - :need:`PROCESS_gd_temp__req_feat_req` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__req_feat_req')` + * - :need:`wp__requirements_feat` + - :need:`gd_temp__req_feat_req` + - :ndf:`copy('status', need_id='gd_temp__req_feat_req')` - https://github.com/eclipse-score/score/issues/1647 - :need:`doc__frameworks_feo_feat_reqs` - :ndf:`copy('status', need_id='doc__frameworks_feo_feat_reqs')` - * - :need:`PROCESS_wp__requirements_feat_aou` - - :need:`PROCESS_gd_temp__req_aou_req` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__req_aou_req')` + * - :need:`wp__requirements_feat_aou` + - :need:`gd_temp__req_aou_req` + - :ndf:`copy('status', need_id='gd_temp__req_aou_req')` - https://github.com/eclipse-score/score/issues/1648 - :need:`doc__frameworks_feo_aou_reqs` - :ndf:`copy('status', need_id='doc__frameworks_feo_aou_reqs')` - * - :need:`PROCESS_wp__feature_arch` - - :need:`PROCESS_gd_temp__arch_feature` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__arch_feature')` + * - :need:`wp__feature_arch` + - :need:`gd_temp__arch_feature` + - :ndf:`copy('status', need_id='gd_temp__arch_feature')` - https://github.com/eclipse-score/score/issues/1649 - :need:`doc__frameworks_feo_feat_arch` - :ndf:`copy('status', need_id='doc__frameworks_feo_feat_arch')` - * - :need:`PROCESS_wp__feature_fmea` - - :need:`PROCESS_gd_temp__feat_saf_fmea` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__feat_saf_fmea')` + * - :need:`wp__feature_fmea` + - :need:`gd_temp__feat_saf_fmea` + - :ndf:`copy('status', need_id='gd_temp__feat_saf_fmea')` - https://github.com/eclipse-score/score/issues/1650 - :need:`doc__frameworks_feo_fmea` - :ndf:`copy('status', need_id='doc__frameworks_feo_fmea')` - * - :need:`PROCESS_wp__feature_dfa` - - :need:`PROCESS_gd_temp__feat_saf_dfa` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__feat_saf_dfa')` + * - :need:`wp__feature_dfa` + - :need:`gd_temp__feat_saf_dfa` + - :ndf:`copy('status', need_id='gd_temp__feat_saf_dfa')` - https://github.com/eclipse-score/score/issues/1651 - :need:`doc__frameworks_feo_dfa` - :ndf:`copy('status', need_id='doc__frameworks_feo_dfa')` - * - :need:`PROCESS_wp__fdr_reports` (Features's Safety Analyses & DFA) - - :need:`PROCESS_gd_chklst__safety_analysis` - - :ndf:`copy('status', need_id='PROCESS_gd_chklst__safety_analysis')` + * - :need:`wp__fdr_reports` (Features's Safety Analyses & DFA) + - :need:`gd_chklst__safety_analysis` + - :ndf:`copy('status', need_id='gd_chklst__safety_analysis')` - https://github.com/eclipse-score/score/issues/1652 - :need:`doc__saf_ana_inspec_frameworks_feo` - :ndf:`copy('status', need_id='doc__saf_ana_inspec_frameworks_feo')` - * - :need:`PROCESS_wp__requirements_inspect` - - :need:`PROCESS_gd_chklst__req_inspection` - - :ndf:`copy('status', need_id='PROCESS_gd_chklst__req_inspection')` + * - :need:`wp__requirements_inspect` + - :need:`gd_chklst__req_inspection` + - :ndf:`copy('status', need_id='gd_chklst__req_inspection')` - https://github.com/eclipse-score/score/issues/1653 - :need:`doc__req_inspection_frameworks_feo` - :ndf:`copy('status', need_id='doc__req_inspection_frameworks_feo')` - * - :need:`PROCESS_wp__sw_arch_verification` - - :need:`PROCESS_gd_chklst__arch_inspection_checklist` - - :ndf:`copy('status', need_id='PROCESS_gd_chklst__arch_inspection_checklist')` + * - :need:`wp__sw_arch_verification` + - :need:`gd_chklst__arch_inspection_checklist` + - :ndf:`copy('status', need_id='gd_chklst__arch_inspection_checklist')` - https://github.com/eclipse-score/score/issues/1654 - :need:`doc__arch_inspection_frameworks_feo` - :ndf:`copy('status', need_id='doc__arch_inspection_frameworks_feo')` - * - :need:`PROCESS_wp__verification_feat_int_test` - - :need:`PROCESS_gd_guidl__verification_guide` - - :ndf:`copy('status', need_id='PROCESS_gd_guidl__verification_guide')` + * - :need:`wp__verification_feat_int_test` + - :need:`gd_guidl__verification_guide` + - :ndf:`copy('status', need_id='gd_guidl__verification_guide')` - https://github.com/eclipse-score/score/issues/1655 - - diff --git a/docs/features/lifecycle/index.rst b/docs/features/lifecycle/index.rst index 77f6593566..c86b8a03d6 100644 --- a/docs/features/lifecycle/index.rst +++ b/docs/features/lifecycle/index.rst @@ -12,8 +12,6 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -.. _chm_feature_templates: - Lifecycle ######### diff --git a/docs/features/orchestration/architecture/index.rst b/docs/features/orchestration/architecture/index.rst index 7dc9e492f8..9c1f2011e0 100644 --- a/docs/features/orchestration/architecture/index.rst +++ b/docs/features/orchestration/architecture/index.rst @@ -20,7 +20,7 @@ Feature Architecture :status: draft :safety: ASIL_B :security: YES - :realizes: PROCESS_wp__feature_arch + :realizes: wp__feature_arch :tags: orchestration diff --git a/docs/features/orchestration/index.rst b/docs/features/orchestration/index.rst index 74b0207a8d..aa42b14052 100644 --- a/docs/features/orchestration/index.rst +++ b/docs/features/orchestration/index.rst @@ -23,7 +23,7 @@ Orchestration :status: valid :safety: ASIL_B :security: YES - :realizes: PROCESS_wp__feat_request + :realizes: wp__feat_request :tags: feature_request, change_management, orchestration diff --git a/docs/features/orchestration/requirements/index.rst b/docs/features/orchestration/requirements/index.rst index 938598ec43..d21c07d8e7 100644 --- a/docs/features/orchestration/requirements/index.rst +++ b/docs/features/orchestration/requirements/index.rst @@ -20,7 +20,7 @@ Requirements :status: valid :safety: ASIL_B :security: YES - :realizes: PROCESS_wp__requirements_feat + :realizes: wp__requirements_feat :tags: orchestration Executor diff --git a/docs/features/orchestration/safety_analysis/dfa.rst b/docs/features/orchestration/safety_analysis/dfa.rst index 54216af92e..259fde2e2a 100644 --- a/docs/features/orchestration/safety_analysis/dfa.rst +++ b/docs/features/orchestration/safety_analysis/dfa.rst @@ -21,7 +21,7 @@ DFA (Dependent Failure Analysis) :status: draft :safety: ASIL_B :security: YES - :realizes: PROCESS_wp__feature_dfa + :realizes: wp__feature_dfa :tags: orchestration diff --git a/docs/features/orchestration/safety_analysis/fmea.rst b/docs/features/orchestration/safety_analysis/fmea.rst index e0dca53e2c..cad67f5f09 100644 --- a/docs/features/orchestration/safety_analysis/fmea.rst +++ b/docs/features/orchestration/safety_analysis/fmea.rst @@ -21,7 +21,7 @@ FMEA (Failure Modes and Effects Analysis) :status: draft :safety: ASIL_B :security: YES - :realizes: PROCESS_wp__feature_fmea + :realizes: wp__feature_fmea :tags: orchestration diff --git a/docs/features/orchestration/safety_planning/index.rst b/docs/features/orchestration/safety_planning/index.rst index 7637b777ba..f6d52dfdbf 100644 --- a/docs/features/orchestration/safety_planning/index.rst +++ b/docs/features/orchestration/safety_planning/index.rst @@ -21,7 +21,7 @@ Feature Safety Planning :status: draft :safety: ASIL_B :security: YES - :realizes: PROCESS_wp__platform_safety_plan + :realizes: wp__platform_safety_plan :tags: orchestration @@ -35,65 +35,65 @@ Feature Safety Planning - Link to WP - WP/doc status - * - :need:`PROCESS_wp__feat_request` - - :need:`PROCESS_gd_temp__change_feature_request` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__change_feature_request')` + * - :need:`wp__feat_request` + - :need:`gd_temp__change_feature_request` + - :ndf:`copy('status', need_id='gd_temp__change_feature_request')` - https://github.com/eclipse-score/score/pull/1293 - :need:`doc__orchestration` - :ndf:`copy('status', need_id='doc__orchestration')` - * - :need:`PROCESS_wp__requirements_feat` - - :need:`PROCESS_gd_temp__req_feat_req` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__req_feat_req')` + * - :need:`wp__requirements_feat` + - :need:`gd_temp__req_feat_req` + - :ndf:`copy('status', need_id='gd_temp__req_feat_req')` - https://github.com/eclipse-score/score/pull/1293 - :need:`doc__orchestration_requirements` - doc :ndf:`copy('status', need_id='doc__orchestration')` & WP below - * - :need:`PROCESS_wp__requirements_feat_aou` - - :need:`PROCESS_gd_temp__req_aou_req` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__req_aou_req')` + * - :need:`wp__requirements_feat_aou` + - :need:`gd_temp__req_aou_req` + - :ndf:`copy('status', need_id='gd_temp__req_aou_req')` - https://github.com/eclipse-score/score/pull/1293 - :need:`doc__orchestration_requirements` - doc :ndf:`copy('status', need_id='doc__orchestration')` & WP below - * - :need:`PROCESS_wp__feature_arch` - - :need:`PROCESS_gd_temp__arch_feature` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__arch_feature')` + * - :need:`wp__feature_arch` + - :need:`gd_temp__arch_feature` + - :ndf:`copy('status', need_id='gd_temp__arch_feature')` - - :need:`doc__orchestration_architecture` - doc :ndf:`copy('status', need_id='doc__orchestration_architecture')` & WP below - * - :need:`PROCESS_wp__feature_fmea` - - :need:`PROCESS_gd_temp__feat_saf_fmea` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__feat_saf_fmea')` + * - :need:`wp__feature_fmea` + - :need:`gd_temp__feat_saf_fmea` + - :ndf:`copy('status', need_id='gd_temp__feat_saf_fmea')` - - :need:`doc__orchestration_fmea` - doc :ndf:`copy('status', need_id='doc__orchestration_fmea')` & WP below - * - :need:`PROCESS_wp__feature_dfa` - - :need:`PROCESS_gd_temp__feat_saf_dfa` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__feat_saf_dfa')` + * - :need:`wp__feature_dfa` + - :need:`gd_temp__feat_saf_dfa` + - :ndf:`copy('status', need_id='gd_temp__feat_saf_dfa')` - - :need:`doc__orchestration_dfa` - doc :ndf:`copy('status', need_id='doc__orchestration_dfa')` & WP below - * - :need:`PROCESS_wp__requirements_inspect` - - :need:`PROCESS_gd_chklst__req_inspection` - - :ndf:`copy('status', need_id='PROCESS_gd_chklst__req_inspection')` + * - :need:`wp__requirements_inspect` + - :need:`gd_chklst__req_inspection` + - :ndf:`copy('status', need_id='gd_chklst__req_inspection')` - n/a - Checklist used in Pull Request Review - n/a - * - :need:`PROCESS_wp__sw_arch_verification` - - :need:`PROCESS_gd_chklst__arch_inspection_checklist` - - :ndf:`copy('status', need_id='PROCESS_gd_chklst__arch_inspection_checklist')` + * - :need:`wp__sw_arch_verification` + - :need:`gd_chklst__arch_inspection_checklist` + - :ndf:`copy('status', need_id='gd_chklst__arch_inspection_checklist')` - n/a - Checklist used in Pull Request Review - n/a - * - :need:`PROCESS_wp__verification_feat_int_test` - - :need:`PROCESS_gd_guidl__verification_guide` - - :ndf:`copy('status', need_id='PROCESS_gd_guidl__verification_guide')` + * - :need:`wp__verification_feat_int_test` + - :need:`gd_guidl__verification_guide` + - :ndf:`copy('status', need_id='gd_guidl__verification_guide')` - - - diff --git a/docs/features/persistency/kvs/architecture/index.rst b/docs/features/persistency/kvs/architecture/index.rst index c8ec9f4a34..750dbdfc11 100644 --- a/docs/features/persistency/kvs/architecture/index.rst +++ b/docs/features/persistency/kvs/architecture/index.rst @@ -22,7 +22,7 @@ Architecture :status: valid :safety: ASIL_B :security: NO - :realizes: PROCESS_wp__feature_arch + :realizes: wp__feature_arch :tags: persistency Overview diff --git a/docs/features/persistency/kvs/index.rst b/docs/features/persistency/kvs/index.rst index c885a2676e..895c739283 100644 --- a/docs/features/persistency/kvs/index.rst +++ b/docs/features/persistency/kvs/index.rst @@ -20,7 +20,7 @@ Key-Value-Storage :status: valid :safety: ASIL_B :security: NO - :realizes: PROCESS_wp__feat_request + :realizes: wp__feat_request :tags: feature_request, persistency .. toctree:: diff --git a/docs/features/persistency/kvs/requirements/chklst_req_inspection.rst b/docs/features/persistency/kvs/requirements/chklst_req_inspection.rst index f91f508d2c..cc83a26fe2 100644 --- a/docs/features/persistency/kvs/requirements/chklst_req_inspection.rst +++ b/docs/features/persistency/kvs/requirements/chklst_req_inspection.rst @@ -12,8 +12,6 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -.. _requirement inspection checklist: - Requirement Inspection Checklist Persistency KVS ================================================ @@ -41,7 +39,7 @@ The purpose of this requirement inspection checklist is to collect the topics to - Issue link * - REQ_01_01 - Is the requirement sentence template used? - - see :need:`PROCESS_gd_temp__req_formulation`, this includes the use of "shall". + - see :need:`gd_temp__req_formulation`, this includes the use of "shall". - Yes - No remarks - https://github.com/eclipse-score/score/issues/960 @@ -65,7 +63,7 @@ The purpose of this requirement inspection checklist is to collect the topics to - https://github.com/eclipse-score/score/issues/960 * - 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:`PROCESS_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. + - 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. - Yes - No remarks - https://github.com/eclipse-score/score/issues/960 @@ -107,7 +105,7 @@ The purpose of this requirement inspection checklist is to collect the topics to - https://github.com/eclipse-score/score/issues/960 * - REQ_07_01 - Is the *ASIL Attribute* set correctly? - - Derived requirements are checked automatically, see :need:`PROCESS_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. + - 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. - Yes - No remarks - https://github.com/eclipse-score/score/issues/960 @@ -119,7 +117,7 @@ The purpose of this requirement inspection checklist is to collect the topics to - https://github.com/eclipse-score/score/issues/960 * - 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:`PROCESS_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. + - 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. - Yes - No remarks - https://github.com/eclipse-score/score/issues/960 diff --git a/docs/features/persistency/kvs/requirements/index.rst b/docs/features/persistency/kvs/requirements/index.rst index d09b7a3ca3..8c61b8edab 100644 --- a/docs/features/persistency/kvs/requirements/index.rst +++ b/docs/features/persistency/kvs/requirements/index.rst @@ -23,7 +23,7 @@ Requirements :status: valid :safety: ASIL_B :security: NO - :realizes: PROCESS_wp__requirements_feat + :realizes: wp__requirements_feat :tags: persistency .. feat_req:: C++ & Rust Interoperability diff --git a/docs/features/persistency/kvs/safety_analysis/dfa.rst b/docs/features/persistency/kvs/safety_analysis/dfa.rst index d655236b9e..85cf942fa8 100644 --- a/docs/features/persistency/kvs/safety_analysis/dfa.rst +++ b/docs/features/persistency/kvs/safety_analysis/dfa.rst @@ -20,10 +20,10 @@ Persistency DFA :status: valid :safety: ASIL_B :security: NO - :realizes: PROCESS_wp__feature_dfa + :realizes: wp__feature_dfa :tags: persistency -For the DFA analysis where the failure initiators :need:`PROCESS_gd_guidl__dfa_failure_initiators` are used. The analysis is done before the platform DFA is done. +For the DFA analysis where the failure initiators :need:`gd_guidl__dfa_failure_initiators` are used. The analysis is done before the platform DFA is done. Safety mechanisms that are used by many features are not considered here, but at the platform DFA. The analysis is only done for the needs of the persistency feature. The components KVS and JSON will also be considered at the platform DFA. No additional violations within the persistency feature are expected. diff --git a/docs/features/persistency/kvs/safety_analysis/fmea.rst b/docs/features/persistency/kvs/safety_analysis/fmea.rst index dc9c7be603..f74923a411 100644 --- a/docs/features/persistency/kvs/safety_analysis/fmea.rst +++ b/docs/features/persistency/kvs/safety_analysis/fmea.rst @@ -20,10 +20,10 @@ Persistency FMEA :status: valid :safety: ASIL_B :security: NO - :realizes: PROCESS_wp__feature_fmea + :realizes: wp__feature_fmea :tags: persistency -For the FMEA analysis where the fault models :need:`PROCESS_gd_guidl__fault_models` are used. +For the FMEA analysis where the fault models :need:`gd_guidl__fault_models` are used. The following fault models doesn't apply to the persistency feature: Fault models diff --git a/docs/features/persistency/kvs/safety_planning/index.rst b/docs/features/persistency/kvs/safety_planning/index.rst index 79bd66329e..1752cfcfad 100644 --- a/docs/features/persistency/kvs/safety_planning/index.rst +++ b/docs/features/persistency/kvs/safety_planning/index.rst @@ -12,8 +12,6 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -.. _feature_safety_wp_template: - Feature Safety Planning ======================= @@ -22,7 +20,7 @@ Feature Safety Planning :status: valid :safety: ASIL_B :security: NO - :realizes: PROCESS_wp__platform_safety_plan + :realizes: wp__platform_safety_plan :tags: persistency @@ -36,65 +34,65 @@ Feature Safety Planning - Link to WP - WP status - * - :need:`PROCESS_wp__feat_request` - - :need:`PROCESS_gd_temp__change_feature_request` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__change_feature_request')` + * - :need:`wp__feat_request` + - :need:`gd_temp__change_feature_request` + - :ndf:`copy('status', need_id='gd_temp__change_feature_request')` - https://github.com/eclipse-score/score/issues/760 - :need:`doc__persistency_kvs` - :ndf:`copy('status', need_id='doc__persistency_kvs')` - * - :need:`PROCESS_wp__requirements_feat` - - :need:`PROCESS_gd_temp__req_feat_req` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__req_feat_req')` + * - :need:`wp__requirements_feat` + - :need:`gd_temp__req_feat_req` + - :ndf:`copy('status', need_id='gd_temp__req_feat_req')` - https://github.com/eclipse-score/score/issues/960 - :ref:`feature_requirements_PersistencyKvs` - valid - * - :need:`PROCESS_wp__requirements_feat_aou` - - :need:`PROCESS_gd_temp__req_aou_req` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__req_aou_req')` + * - :need:`wp__requirements_feat_aou` + - :need:`gd_temp__req_aou_req` + - :ndf:`copy('status', need_id='gd_temp__req_aou_req')` - https://github.com/eclipse-score/score/issues/960 - :ref:`feature_requirements_PersistencyKvs` - valid - * - :need:`PROCESS_wp__feature_arch` - - :need:`PROCESS_gd_temp__arch_feature` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__arch_feature')` + * - :need:`wp__feature_arch` + - :need:`gd_temp__arch_feature` + - :ndf:`copy('status', need_id='gd_temp__arch_feature')` - https://github.com/eclipse-score/score/issues/1020 - :ref:`feature_architecture_PersistencyKvs` - valid - * - :need:`PROCESS_wp__feature_fmea` - - :need:`PROCESS_gd_guidl__safety_analysis` - - :ndf:`copy('status', need_id='PROCESS_gd_guidl__safety_analysis')` + * - :need:`wp__feature_fmea` + - :need:`gd_guidl__safety_analysis` + - :ndf:`copy('status', need_id='gd_guidl__safety_analysis')` - https://github.com/eclipse-score/score/issues/965 - :need:`doc__persistency_fmea` - valid - * - :need:`PROCESS_wp__feature_dfa` - - :need:`PROCESS_gd_guidl__safety_analysis` - - :ndf:`copy('status', need_id='PROCESS_gd_guidl__safety_analysis')` + * - :need:`wp__feature_dfa` + - :need:`gd_guidl__safety_analysis` + - :ndf:`copy('status', need_id='gd_guidl__safety_analysis')` - https://github.com/eclipse-score/score/issues/965 - :need:`doc__persistency_dfa` - valid - * - :need:`PROCESS_wp__requirements_inspect` - - :need:`PROCESS_gd_chklst__req_inspection` - - :ndf:`copy('status', need_id='PROCESS_gd_chklst__req_inspection')` + * - :need:`wp__requirements_inspect` + - :need:`gd_chklst__req_inspection` + - :ndf:`copy('status', need_id='gd_chklst__req_inspection')` - https://github.com/eclipse-score/score/issues/960 - :need:`doc__req_inspection_persistency` - valid - * - :need:`PROCESS_wp__sw_arch_verification` - - :need:`PROCESS_gd_chklst__arch_inspection_checklist` - - :ndf:`copy('status', need_id='PROCESS_gd_chklst__arch_inspection_checklist')` + * - :need:`wp__sw_arch_verification` + - :need:`gd_chklst__arch_inspection_checklist` + - :ndf:`copy('status', need_id='gd_chklst__arch_inspection_checklist')` - https://github.com/eclipse-score/score/issues/1020 - Checklist used in Pull Request Review - n/a - * - :need:`PROCESS_wp__verification_feat_int_test` - - :need:`PROCESS_gd_guidl__verification_guide` - - :ndf:`copy('status', need_id='PROCESS_gd_guidl__verification_guide')` + * - :need:`wp__verification_feat_int_test` + - :need:`gd_guidl__verification_guide` + - :ndf:`copy('status', need_id='gd_guidl__verification_guide')` - https://github.com/eclipse-score/score/issues/964 - Checklist used in Pull Request Review - diff --git a/docs/features/security_crypto/index.rst b/docs/features/security_crypto/index.rst index ee84be2025..e433132a7c 100644 --- a/docs/features/security_crypto/index.rst +++ b/docs/features/security_crypto/index.rst @@ -20,7 +20,7 @@ Security & Cryptography :status: valid :safety: QM :security: YES - :realizes: PROCESS_wp__feat_request + :realizes: wp__feat_request .. toctree:: diff --git a/docs/modules/baselibs/bitmanipulation/docs/index.rst b/docs/modules/baselibs/bitmanipulation/docs/index.rst index 16a96a28d3..4813075f79 100644 --- a/docs/modules/baselibs/bitmanipulation/docs/index.rst +++ b/docs/modules/baselibs/bitmanipulation/docs/index.rst @@ -20,7 +20,7 @@ bitmanipulation :status: draft :safety: ASIL_B :tags: baselibs_bitmanipulation - :realizes: PROCESS_wp__cmpt_request + :realizes: wp__cmpt_request .. toctree:: :hidden: diff --git a/docs/modules/baselibs/bitmanipulation/docs/requirements/index.rst b/docs/modules/baselibs/bitmanipulation/docs/requirements/index.rst index df1b6251fe..67de6bdd46 100644 --- a/docs/modules/baselibs/bitmanipulation/docs/requirements/index.rst +++ b/docs/modules/baselibs/bitmanipulation/docs/requirements/index.rst @@ -22,7 +22,7 @@ Requirements :id: doc__bitmanipulation_requirements :status: draft :safety: ASIL_B - :realizes: PROCESS_wp__requirements_comp + :realizes: wp__requirements_comp :tags: requirements, bitmanipulation Functional Requirements diff --git a/docs/modules/baselibs/containers/docs/index.rst b/docs/modules/baselibs/containers/docs/index.rst index 727fb1ea16..6bf1cd7881 100644 --- a/docs/modules/baselibs/containers/docs/index.rst +++ b/docs/modules/baselibs/containers/docs/index.rst @@ -20,7 +20,7 @@ containers :status: draft :safety: ASIL_B :tags: baselibs_containers - :realizes: PROCESS_wp__cmpt_request + :realizes: wp__cmpt_request .. toctree:: :hidden: diff --git a/docs/modules/baselibs/containers/docs/requirements/index.rst b/docs/modules/baselibs/containers/docs/requirements/index.rst index 9591542110..f3a0545405 100644 --- a/docs/modules/baselibs/containers/docs/requirements/index.rst +++ b/docs/modules/baselibs/containers/docs/requirements/index.rst @@ -19,7 +19,7 @@ Requirements :id: doc__containers_lib_requirements :status: draft :safety: ASIL_B - :realizes: PROCESS_wp__requirements_comp + :realizes: wp__requirements_comp :tags: requirements, containers_library Functional Requirements diff --git a/docs/modules/baselibs/filesystem/docs/requirements/index.rst b/docs/modules/baselibs/filesystem/docs/requirements/index.rst index e45b8941b7..b06ada4fe6 100644 --- a/docs/modules/baselibs/filesystem/docs/requirements/index.rst +++ b/docs/modules/baselibs/filesystem/docs/requirements/index.rst @@ -19,7 +19,7 @@ Requirements :id: doc__filesystem_lib_requirements :status: draft :safety: ASIL_B - :realizes: PROCESS_wp__requirements_comp + :realizes: wp__requirements_comp :tags: requirements, filesystem_library Functional Requirements diff --git a/docs/modules/baselibs/json/docs/architecture/index.rst b/docs/modules/baselibs/json/docs/architecture/index.rst index b60adfed69..1afbe0939f 100644 --- a/docs/modules/baselibs/json/docs/architecture/index.rst +++ b/docs/modules/baselibs/json/docs/architecture/index.rst @@ -19,7 +19,7 @@ JSON Component Architecture :id: doc__json_architecture :status: draft :safety: ASIL_B - :realizes: PROCESS_wp__component_arch + :realizes: wp__component_arch Overview -------- diff --git a/docs/modules/baselibs/json/docs/json_wrapper/requirements/index.rst b/docs/modules/baselibs/json/docs/json_wrapper/requirements/index.rst index 65534150fa..b1e0ea8873 100644 --- a/docs/modules/baselibs/json/docs/json_wrapper/requirements/index.rst +++ b/docs/modules/baselibs/json/docs/json_wrapper/requirements/index.rst @@ -19,7 +19,7 @@ Requirements :id: doc__json_wrapper_requirements :status: valid :safety: ASIL_B - :realizes: PROCESS_wp__requirements_comp + :realizes: wp__requirements_comp Due to low complexity, the requirements of the JSON component were not split into the "sub" components "JSON Wrapper" and "nlohman_json". Reasoning is the low number of requirements (only about ten). diff --git a/docs/modules/baselibs/json/docs/requirements/index.rst b/docs/modules/baselibs/json/docs/requirements/index.rst index 08fc949d5f..d4e6e66950 100644 --- a/docs/modules/baselibs/json/docs/requirements/index.rst +++ b/docs/modules/baselibs/json/docs/requirements/index.rst @@ -19,7 +19,7 @@ Requirements :id: doc__json_requirements :status: draft :safety: ASIL_B - :realizes: PROCESS_wp__requirements_comp + :realizes: wp__requirements_comp General Requirements ==================== diff --git a/docs/modules/baselibs/result/docs/index.rst b/docs/modules/baselibs/result/docs/index.rst index 67f85ac880..610b60d416 100644 --- a/docs/modules/baselibs/result/docs/index.rst +++ b/docs/modules/baselibs/result/docs/index.rst @@ -20,7 +20,7 @@ result :status: draft :safety: ASIL_B :tags: baselibs_result - :realizes: PROCESS_wp__cmpt_request + :realizes: wp__cmpt_request .. toctree:: :hidden: diff --git a/docs/modules/baselibs/result/docs/requirements.rst b/docs/modules/baselibs/result/docs/requirements.rst index 93d62b0b2d..cd4dabdca0 100644 --- a/docs/modules/baselibs/result/docs/requirements.rst +++ b/docs/modules/baselibs/result/docs/requirements.rst @@ -19,7 +19,7 @@ Requirements :id: doc__result_lib_requirements :status: draft :safety: ASIL_B - :realizes: PROCESS_wp__requirements_comp + :realizes: wp__requirements_comp :tags: requirements, result_library Functional Requirements diff --git a/docs/modules/baselibs/utils/docs/index.rst b/docs/modules/baselibs/utils/docs/index.rst index b7b29b265c..8c909d17c5 100644 --- a/docs/modules/baselibs/utils/docs/index.rst +++ b/docs/modules/baselibs/utils/docs/index.rst @@ -20,7 +20,7 @@ utils :status: draft :safety: ASIL_B :tags: baselibs_utils - :realizes: PROCESS_wp__cmpt_request + :realizes: wp__cmpt_request .. toctree:: :hidden: diff --git a/docs/modules/baselibs/utils/docs/requirements/index.rst b/docs/modules/baselibs/utils/docs/requirements/index.rst index 6e8038ea9e..4890461891 100644 --- a/docs/modules/baselibs/utils/docs/requirements/index.rst +++ b/docs/modules/baselibs/utils/docs/requirements/index.rst @@ -19,7 +19,7 @@ Requirements :id: doc__utils_lib_requirements :status: draft :safety: ASIL_B - :realizes: PROCESS_wp__requirements_comp + :realizes: wp__requirements_comp :tags: requirements, utils_library Functional Requirements diff --git a/docs/modules/feo/docs/manual/safety_manual.rst b/docs/modules/feo/docs/manual/safety_manual.rst index 5e9f8f6744..8af000a0e6 100644 --- a/docs/modules/feo/docs/manual/safety_manual.rst +++ b/docs/modules/feo/docs/manual/safety_manual.rst @@ -17,7 +17,7 @@ :status: draft :security: NO :safety: ASIL_B - :realizes: PROCESS_wp__module_safety_manual + :realizes: wp__module_safety_manual :tags: module_feo diff --git a/docs/modules/feo/docs/release/release_note.rst b/docs/modules/feo/docs/release/release_note.rst index 722e46b0af..4d8ddeab94 100644 --- a/docs/modules/feo/docs/release/release_note.rst +++ b/docs/modules/feo/docs/release/release_note.rst @@ -17,7 +17,7 @@ :status: draft :security: NO :safety: ASIL_B - :realizes: PROCESS_wp__module_sw_release_note + :realizes: wp__module_sw_release_note :tags: module_feo diff --git a/docs/modules/feo/docs/safety_mgt/module_safety_package_fdr.rst b/docs/modules/feo/docs/safety_mgt/module_safety_package_fdr.rst index c1ed31ae40..0e0f6cd2dc 100644 --- a/docs/modules/feo/docs/safety_mgt/module_safety_package_fdr.rst +++ b/docs/modules/feo/docs/safety_mgt/module_safety_package_fdr.rst @@ -17,7 +17,7 @@ :status: draft :security: NO :safety: ASIL_B - :realizes: PROCESS_wp__fdr_reports + :realizes: wp__fdr_reports :tags: module_feo FEO Module Safety Package Formal Review Report diff --git a/docs/modules/feo/docs/safety_mgt/module_safety_plan.rst b/docs/modules/feo/docs/safety_mgt/module_safety_plan.rst index 19bd5988ff..b7f4c5ad4a 100644 --- a/docs/modules/feo/docs/safety_mgt/module_safety_plan.rst +++ b/docs/modules/feo/docs/safety_mgt/module_safety_plan.rst @@ -17,7 +17,7 @@ :status: valid :security: NO :safety: ASIL_B - :realizes: PROCESS_wp__module_safety_plan + :realizes: wp__module_safety_plan :tags: module_feo @@ -70,72 +70,72 @@ FEO Module Work Products List - Link to WP - WP status - * - :need:`PROCESS_wp__module_safety_plan` - - :need:`PROCESS_gd_guidl__saf_plan_definitions`, :need:`PROCESS_gd_temp__module_safety_plan` - - :ndf:`copy('status', need_id='PROCESS_gd_guidl__saf_plan_definitions')` + * - :need:`wp__module_safety_plan` + - :need:`gd_guidl__saf_plan_definitions`, :need:`gd_temp__module_safety_plan` + - :ndf:`copy('status', need_id='gd_guidl__saf_plan_definitions')` - https://github.com/eclipse-score/score/issues/1658 - this document - see above - * - :need:`PROCESS_wp__module_safety_package` - - :need:`PROCESS_gd_guidl__saf_package` - - :ndf:`copy('status', need_id='PROCESS_gd_guidl__saf_package')` + * - :need:`wp__module_safety_package` + - :need:`gd_guidl__saf_package` + - :ndf:`copy('status', need_id='gd_guidl__saf_package')` - https://github.com/eclipse-score/score/issues/1659 - this document (including the linked documentation) - see above (and below), safety manual - * - :need:`PROCESS_wp__fdr_reports` (module Safety Plan) - - :need:`PROCESS_gd_chklst__safety_plan` - - :ndf:`copy('status', need_id='PROCESS_gd_chklst__safety_plan')` + * - :need:`wp__fdr_reports` (module Safety Plan) + - :need:`gd_chklst__safety_plan` + - :ndf:`copy('status', need_id='gd_chklst__safety_plan')` - https://github.com/eclipse-score/score/issues/1660 - :need:`doc__feo_safety_plan_fdr` - :ndf:`copy('status', need_id='doc__feo_safety_plan_fdr')` - * - :need:`PROCESS_wp__fdr_reports` (module Safety Package) - - :need:`PROCESS_gd_chklst__safety_package` - - :ndf:`copy('status', need_id='PROCESS_gd_chklst__safety_package')` + * - :need:`wp__fdr_reports` (module Safety Package) + - :need:`gd_chklst__safety_package` + - :ndf:`copy('status', need_id='gd_chklst__safety_package')` - https://github.com/eclipse-score/score/issues/1660 - :need:`doc__feo_safety_package_fdr` - :ndf:`copy('status', need_id='doc__feo_safety_package_fdr')` - * - :need:`PROCESS_wp__fdr_reports` (module's Safety Analyses & DFA) - - :need:`PROCESS_gd_chklst__safety_analysis` - - :ndf:`copy('status', need_id='PROCESS_gd_chklst__safety_analysis')` + * - :need:`wp__fdr_reports` (module's Safety Analyses & DFA) + - :need:`gd_chklst__safety_analysis` + - :ndf:`copy('status', need_id='gd_chklst__safety_analysis')` - https://github.com/eclipse-score/score/issues/1660 - :need:`doc__safety_analysis_inspection_component_feo` - :ndf:`copy('status', need_id='doc__safety_analysis_inspection_component_feo')` - * - :need:`PROCESS_wp__audit_report` + * - :need:`wp__audit_report` - performed by external experts - n/a - https://github.com/eclipse-score/score/issues/1661 - - - * - :need:`PROCESS_wp__module_sw_build_config` - - :need:`PROCESS_gd_temp__software_development_plan` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__software_development_plan')` + * - :need:`wp__module_sw_build_config` + - :need:`gd_temp__software_development_plan` + - :ndf:`copy('status', need_id='gd_temp__software_development_plan')` - https://github.com/eclipse-score/score/issues/1662 - - - * - :need:`PROCESS_wp__module_safety_manual` - - :need:`PROCESS_gd_temp__safety_manual` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__safety_manual')` + * - :need:`wp__module_safety_manual` + - :need:`gd_temp__safety_manual` + - :ndf:`copy('status', need_id='gd_temp__safety_manual')` - https://github.com/eclipse-score/score/issues/1663 - :need:`doc__feo_safety_manual` - :ndf:`copy('status', need_id='doc__feo_safety_manual')` - * - :need:`PROCESS_wp__verification_module_ver_report` - - :need:`PROCESS_gd_temp__mod_ver_report` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__mod_ver_report')` + * - :need:`wp__verification_module_ver_report` + - :need:`gd_temp__mod_ver_report` + - :ndf:`copy('status', need_id='gd_temp__mod_ver_report')` - https://github.com/eclipse-score/score/issues/1665 - :need:`doc__feo_verification_report` - :ndf:`copy('status', need_id='doc__feo_verification_report')` - * - :need:`PROCESS_wp__module_sw_release_note` - - :need:`PROCESS_gd_temp__rel_mod_rel_note` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__rel_mod_rel_note')` + * - :need:`wp__module_sw_release_note` + - :need:`gd_temp__rel_mod_rel_note` + - :ndf:`copy('status', need_id='gd_temp__rel_mod_rel_note')` - https://github.com/eclipse-score/score/issues/1666 - :need:`doc__feo_release_note` - :ndf:`copy('status', need_id='doc__feo_release_note')` @@ -153,91 +153,91 @@ FEO Component Work Products List - Link to WP - WP/doc status - * - :need:`PROCESS_wp__requirements_comp` - - :need:`PROCESS_gd_temp__req_comp_req` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__req_comp_req')` + * - :need:`wp__requirements_comp` + - :need:`gd_temp__req_comp_req` + - :ndf:`copy('status', need_id='gd_temp__req_comp_req')` - https://github.com/eclipse-score/score/issues/1668 - :need:`doc__component_feo_requirements` - doc :ndf:`copy('status', need_id='doc__component_feo_requirements')` & WP below - * - :need:`PROCESS_wp__requirements_comp_aou` - - :need:`PROCESS_gd_temp__req_aou_req` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__req_aou_req')` + * - :need:`wp__requirements_comp_aou` + - :need:`gd_temp__req_aou_req` + - :ndf:`copy('status', need_id='gd_temp__req_aou_req')` - https://github.com/eclipse-score/score/issues/1669 - :need:`doc__component_feo_aou_reqs` - doc :ndf:`copy('status', need_id='doc__component_feo_aou_reqs')` & WP below - * - :need:`PROCESS_wp__requirements_inspect` - - :need:`PROCESS_gd_chklst__req_inspection` - - :ndf:`copy('status', need_id='PROCESS_gd_chklst__req_inspection')` + * - :need:`wp__requirements_inspect` + - :need:`gd_chklst__req_inspection` + - :ndf:`copy('status', need_id='gd_chklst__req_inspection')` - https://github.com/eclipse-score/score/issues/1670 - :need:`doc__req_inspection_component_feo` - doc :ndf:`copy('status', need_id='doc__req_inspection_component_feo')` - * - :need:`PROCESS_wp__component_arch` - - :need:`PROCESS_gd_temp__arch_comp` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__arch_comp')` + * - :need:`wp__component_arch` + - :need:`gd_temp__arch_comp` + - :ndf:`copy('status', need_id='gd_temp__arch_comp')` - https://github.com/eclipse-score/score/issues/1671 - :need:`doc__component_feo_architecture` - doc :ndf:`copy('status', need_id='doc__component_feo_architecture')` & WP below - * - :need:`PROCESS_wp__sw_arch_verification` - - :need:`PROCESS_gd_chklst__arch_inspection_checklist` - - :ndf:`copy('status', need_id='PROCESS_gd_chklst__arch_inspection_checklist')` + * - :need:`wp__sw_arch_verification` + - :need:`gd_chklst__arch_inspection_checklist` + - :ndf:`copy('status', need_id='gd_chklst__arch_inspection_checklist')` - https://github.com/eclipse-score/score/issues/1672 - :need:`doc__arch_inspection_component_feo` - doc :ndf:`copy('status', need_id='doc__arch_inspection_component_feo')` - * - :need:`PROCESS_wp__sw_component_fmea` - - :need:`PROCESS_gd_temp__comp_saf_fmea` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__comp_saf_fmea')` + * - :need:`wp__sw_component_fmea` + - :need:`gd_temp__comp_saf_fmea` + - :ndf:`copy('status', need_id='gd_temp__comp_saf_fmea')` - https://github.com/eclipse-score/score/issues/1673 - :need:`doc__component_feo_fmea` - doc :ndf:`copy('status', need_id='doc__component_feo_fmea')` & WP below - * - :need:`PROCESS_wp__sw_component_dfa` - - :need:`PROCESS_gd_temp__comp_saf_fmea` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__comp_saf_fmea')` + * - :need:`wp__sw_component_dfa` + - :need:`gd_temp__comp_saf_fmea` + - :ndf:`copy('status', need_id='gd_temp__comp_saf_fmea')` - https://github.com/eclipse-score/score/issues/1674 - :need:`doc__component_feo_dfa` - doc :ndf:`copy('status', need_id='doc__component_feo_dfa')` & WP below - * - :need:`PROCESS_wp__sw_implementation` - - :need:`PROCESS_gd_guidl__implementation` - - :ndf:`copy('status', need_id='PROCESS_gd_guidl__implementation')` + * - :need:`wp__sw_implementation` + - :need:`gd_guidl__implementation` + - :ndf:`copy('status', need_id='gd_guidl__implementation')` - https://github.com/eclipse-score/score/issues/1675 - - - * - :need:`PROCESS_wp__verification_sw_unit_test` - - :need:`PROCESS_gd_guidl__verification_guide` - - :ndf:`copy('status', need_id='PROCESS_gd_guidl__verification_guide')` + * - :need:`wp__verification_sw_unit_test` + - :need:`gd_guidl__verification_guide` + - :ndf:`copy('status', need_id='gd_guidl__verification_guide')` - https://github.com/eclipse-score/score/issues/1676 - - - * - :need:`PROCESS_wp__sw_implementation_inspection` - - :need:`PROCESS_gd_chklst__impl_inspection_checklist` - - :ndf:`copy('status', need_id='PROCESS_gd_chklst__impl_inspection_checklist')` + * - :need:`wp__sw_implementation_inspection` + - :need:`gd_chklst__impl_inspection_checklist` + - :ndf:`copy('status', need_id='gd_chklst__impl_inspection_checklist')` - https://github.com/eclipse-score/score/issues/1677 - :need:`doc__impl_inspection_component_feo` - :ndf:`copy('status', need_id='doc__impl_inspection_component_feo')` - * - :need:`PROCESS_wp__verification_comp_int_test` - - :need:`PROCESS_gd_guidl__verification_guide` - - :ndf:`copy('status', need_id='PROCESS_gd_guidl__verification_guide')` + * - :need:`wp__verification_comp_int_test` + - :need:`gd_guidl__verification_guide` + - :ndf:`copy('status', need_id='gd_guidl__verification_guide')` - https://github.com/eclipse-score/score/issues/1667 - - - * - :need:`PROCESS_wp__sw_component_class` - - :need:`PROCESS_gd_guidl__component_classification` - - :ndf:`copy('status', need_id='PROCESS_gd_guidl__component_classification')` + * - :need:`wp__sw_component_class` + - :need:`gd_guidl__component_classification` + - :ndf:`copy('status', need_id='gd_guidl__component_classification')` - https://github.com/eclipse-score/score/issues/1679 - :need:`doc__feo_comp_class` - :ndf:`copy('status', need_id='doc__feo_comp_class')` -Note: In case the component is a new development, :need:`PROCESS_wp__sw_component_class` shall be removed from the above list (and also from the folders). +Note: In case the component is a new development, :need:`wp__sw_component_class` shall be removed from the above list (and also from the folders). In case an OSS element is used in the module, part 6 has to be filled out, depending on the component classification results. OSS (sub-)component qualification plan @@ -256,47 +256,47 @@ If the OSS element is classified as a - Link to issue - Reasoning for tailoring - * - :need:`PROCESS_wp__requirements_comp` + * - :need:`wp__requirements_comp` - - Always needed (for Q and QR classification) and also improves process Id 2 - * - :need:`PROCESS_wp__requirements_comp_aou` + * - :need:`wp__requirements_comp_aou` - - Always needed (for Q and QR classification) and also improves process Id 5 - * - :need:`PROCESS_wp__requirements_inspect` + * - :need:`wp__requirements_inspect` - n/a - Checklist used in Pull Request Review - * - :need:`PROCESS_wf__cr_mt_comparch` + * - :need:`wf__cr_mt_comparch` - - - * - :need:`PROCESS_wp__sw_component_fmea` + * - :need:`wp__sw_component_fmea` - - - * - :need:`PROCESS_wp__sw_arch_verification` + * - :need:`wp__sw_arch_verification` - - - * - :need:`PROCESS_wp__sw_implementation` + * - :need:`wp__sw_implementation` - n/a - If source code is modified, this is not a OSS qualification any more. - * - :need:`PROCESS_wp__verification_sw_unit_test` + * - :need:`wp__verification_sw_unit_test` - - - * - :need:`PROCESS_wp__sw_implementation_inspection` + * - :need:`wp__sw_implementation_inspection` - - - * - :need:`PROCESS_wp__verification_comp_int_test` + * - :need:`wp__verification_comp_int_test` - - Always needed (for Q and QR classification) - * - :need:`PROCESS_wp__sw_component_class` + * - :need:`wp__sw_component_class` - - Always needed as basis for tailoring. diff --git a/docs/modules/feo/docs/safety_mgt/module_safety_plan_fdr.rst b/docs/modules/feo/docs/safety_mgt/module_safety_plan_fdr.rst index 97a05d3510..de54412ec2 100644 --- a/docs/modules/feo/docs/safety_mgt/module_safety_plan_fdr.rst +++ b/docs/modules/feo/docs/safety_mgt/module_safety_plan_fdr.rst @@ -17,7 +17,7 @@ :status: draft :security: NO :safety: ASIL_B - :realizes: PROCESS_wp__fdr_reports + :realizes: wp__fdr_reports :tags: module_feo FEO Module Safety Plan Formal Review Report diff --git a/docs/modules/feo/docs/verification/module_verification_report.rst b/docs/modules/feo/docs/verification/module_verification_report.rst index 9147ffa6a2..4896002db5 100644 --- a/docs/modules/feo/docs/verification/module_verification_report.rst +++ b/docs/modules/feo/docs/verification/module_verification_report.rst @@ -17,13 +17,13 @@ :status: draft :security: NO :safety: ASIL_B - :realizes: PROCESS_wp__verification_module_ver_report + :realizes: wp__verification_module_ver_report :tags: module_template FEO Module Verification Report ============================== -This verification report is based on the :need:`PROCESS_gd_temp__verification_plan`. +This verification report is based on the :need:`gd_temp__verification_plan`. It covers all the components of the above stated module. Verification Report contains: diff --git a/docs/modules/feo/feo/docs/architecture/chklst_arch_inspection.rst b/docs/modules/feo/feo/docs/architecture/chklst_arch_inspection.rst index fd2e08bdca..1f32a52a88 100644 --- a/docs/modules/feo/feo/docs/architecture/chklst_arch_inspection.rst +++ b/docs/modules/feo/feo/docs/architecture/chklst_arch_inspection.rst @@ -47,7 +47,7 @@ Checklist - Issue link * - ARC_01_01 - Is the traceability from software architectural elements to requirements, and other level architectural - elements (e.g. component to interface) established according to the defined :need:`Relations between the architectural elements `? + elements (e.g. component to interface) established according to the defined :need:`Relations between the architectural elements `? - automated - Trace should be checked by Sphinx. Will be removed from checklist once requirement is implemented. - @@ -79,7 +79,7 @@ Checklist * - ARC_02_02 - Is appropriate and comprehensible operation/interface naming present in the architectural design? - manual - - Check :need:`PROCESS_gd_guidl__arch_design` + - Check :need:`gd_guidl__arch_design` - - - diff --git a/docs/modules/feo/feo/docs/architecture/component_architecture.rst b/docs/modules/feo/feo/docs/architecture/component_architecture.rst index f92c3ef8b5..dd15a51f28 100644 --- a/docs/modules/feo/feo/docs/architecture/component_architecture.rst +++ b/docs/modules/feo/feo/docs/architecture/component_architecture.rst @@ -17,7 +17,7 @@ :status: draft :security: NO :safety: ASIL_B - :realizes: PROCESS_wp__component_arch + :realizes: wp__component_arch :tags: component_feo FEO Component Architecture diff --git a/docs/modules/feo/feo/docs/component_classification.rst b/docs/modules/feo/feo/docs/component_classification.rst index d569f57290..cfb30aaa1d 100644 --- a/docs/modules/feo/feo/docs/component_classification.rst +++ b/docs/modules/feo/feo/docs/component_classification.rst @@ -18,7 +18,7 @@ :status: draft :security: NO :safety: ASIL_B - :realizes: PROCESS_wp__sw_component_class + :realizes: wp__sw_component_class :tags: component_feo Component Classification diff --git a/docs/modules/feo/feo/docs/detailed_design/chklst_dd_inspection.rst b/docs/modules/feo/feo/docs/detailed_design/chklst_dd_inspection.rst index 1fe4b9574c..2525f6fb49 100644 --- a/docs/modules/feo/feo/docs/detailed_design/chklst_dd_inspection.rst +++ b/docs/modules/feo/feo/docs/detailed_design/chklst_dd_inspection.rst @@ -46,7 +46,7 @@ Checklist - Issue link * - IMPL_01_01 - Is the design according to guidelines? - - see :need:`PROCESS_gd_temp__detailed_design` and :need:`PROCESS_doc_concept__imp_concept` + - see :need:`gd_temp__detailed_design` and :need:`doc_concept__imp_concept` (e.g. are the views done with the proposed UML diagrams) - - diff --git a/docs/modules/feo/feo/docs/detailed_design/component_detailed_design.rst b/docs/modules/feo/feo/docs/detailed_design/component_detailed_design.rst index 2e81e22a72..1eff9afff4 100644 --- a/docs/modules/feo/feo/docs/detailed_design/component_detailed_design.rst +++ b/docs/modules/feo/feo/docs/detailed_design/component_detailed_design.rst @@ -17,7 +17,7 @@ :status: draft :security: NO :safety: ASIL_B - :realizes: PROCESS_wp__sw_implementation + :realizes: wp__sw_implementation :tags: component_feo FEO Component Detailed Design diff --git a/docs/modules/feo/feo/docs/index.rst b/docs/modules/feo/feo/docs/index.rst index b3c2b7363a..fac36c9c5c 100644 --- a/docs/modules/feo/feo/docs/index.rst +++ b/docs/modules/feo/feo/docs/index.rst @@ -16,7 +16,7 @@ :id: doc__feo :status: draft :safety: ASIL_B - :realizes: PROCESS_wp__cmpt_request + :realizes: wp__cmpt_request :tags: component_feo FEO Component @@ -59,7 +59,7 @@ Specification .. note:: A CR shall specify the component requirements as part of our platform/project. - Thereby the :need:`PROCESS_rl__module_lead` will approve these requirements as part of accepting the CR (e.g. merging the PR with the CR). + Thereby the :need:`rl__module_lead` will approve these requirements as part of accepting the CR (e.g. merging the PR with the CR). @@ -110,7 +110,7 @@ For new feature/component contributions: [What is the expected classification of the contribution?] .. note:: - Use the component classification method here to classify your component, if it shall to be used in a safety context: :need:`PROCESS_gd_temp__component_classification`. + Use the component classification method here to classify your component, if it shall to be used in a safety context: :need:`gd_temp__component_classification`. License Impact ============== diff --git a/docs/modules/feo/feo/docs/requirements/aou_req.rst b/docs/modules/feo/feo/docs/requirements/aou_req.rst index 7d23538229..a854d46778 100644 --- a/docs/modules/feo/feo/docs/requirements/aou_req.rst +++ b/docs/modules/feo/feo/docs/requirements/aou_req.rst @@ -17,7 +17,7 @@ :status: valid :security: NO :safety: ASIL_B - :realizes: PROCESS_wp__requirements_comp_aou + :realizes: wp__requirements_comp_aou :tags: component_feo FEO Component Assumption of Use Requirements diff --git a/docs/modules/feo/feo/docs/requirements/chklst_req_inspection.rst b/docs/modules/feo/feo/docs/requirements/chklst_req_inspection.rst index 38747fd458..d19eb830f1 100644 --- a/docs/modules/feo/feo/docs/requirements/chklst_req_inspection.rst +++ b/docs/modules/feo/feo/docs/requirements/chklst_req_inspection.rst @@ -42,7 +42,7 @@ FEO Component Requirement Inspection Checklist - Issue link * - REQ_01_01 - Is the requirement sentence template used? - - see :need:`PROCESS_gd_temp__req_formulation`, this includes the use of "shall". + - see :need:`gd_temp__req_formulation`, this includes the use of "shall". - - - @@ -66,7 +66,7 @@ FEO Component Requirement Inspection Checklist - * - 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:`PROCESS_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. + - 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. - - - @@ -108,7 +108,7 @@ FEO Component Requirement Inspection Checklist - * - REQ_07_01 - Is the *ASIL Attribute* set correctly? - - Derived requirements are checked automatically, see :need:`PROCESS_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. + - 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. - - - @@ -120,13 +120,13 @@ FEO Component Requirement Inspection Checklist - * - 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:`PROCESS_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. + - 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:`PROCESS_gd_chklst__safety_analysis` + - 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` - - - diff --git a/docs/modules/feo/feo/docs/requirements/component_requirements.rst b/docs/modules/feo/feo/docs/requirements/component_requirements.rst index a263f9172e..43fb461f0f 100644 --- a/docs/modules/feo/feo/docs/requirements/component_requirements.rst +++ b/docs/modules/feo/feo/docs/requirements/component_requirements.rst @@ -17,7 +17,7 @@ :status: draft :security: NO :safety: ASIL_B - :realizes: PROCESS_wp__requirements_comp + :realizes: wp__requirements_comp :tags: component_feo FEO Component Requirements diff --git a/docs/modules/feo/feo/docs/safety_analysis/chklst_safety_analysis_inspection.rst b/docs/modules/feo/feo/docs/safety_analysis/chklst_safety_analysis_inspection.rst index efa8d51710..4e4f7b79a5 100644 --- a/docs/modules/feo/feo/docs/safety_analysis/chklst_safety_analysis_inspection.rst +++ b/docs/modules/feo/feo/docs/safety_analysis/chklst_safety_analysis_inspection.rst @@ -45,13 +45,13 @@ FEO Component Safety Analysis Checklist - * - REQ_01_02 - Are the templates for DFA and/or FMEA used? - - See :need:`PROCESS_gd_temp__comp_saf_dfa` / :need:`PROCESS_gd_temp__comp_saf_fmea` and also :need:`PROCESS_gd_req__saf_structure` + - See :need:`gd_temp__comp_saf_dfa` / :need:`gd_temp__comp_saf_fmea` and also :need:`gd_req__saf_structure` - Templates are used to generate the DFA or / and FMEA. - - * - REQ_01_03 - Were the failure initiators / fault models applied? - - See :need:`PROCESS_gd_guidl__dfa_failure_initiators` / :need:`PROCESS_gd_guidl__fault_models` + - See :need:`gd_guidl__dfa_failure_initiators` / :need:`gd_guidl__fault_models` - The applicable items of the failure initiators / fault models are used to ensure a structured analysis. For all not applicable items an argument shall be given in the content of the document. - - @@ -76,6 +76,6 @@ FEO Component Safety Analysis Checklist * - REQ_01_08 - Is the overall result of the safety analysis described in the report? - It shall be shown in the report if the safety analysis are finished and if all artifacts are "valid" and "sufficient". - - The results of the safety analysis are described in the report. The report is available :need:`PROCESS_wp__verification_platform_ver_report`. + - The results of the safety analysis are described in the report. The report is available :need:`wp__verification_platform_ver_report`. - - diff --git a/docs/modules/feo/feo/docs/safety_analysis/component_dfa.rst b/docs/modules/feo/feo/docs/safety_analysis/component_dfa.rst index 9e9a92fdde..a178ccae3a 100644 --- a/docs/modules/feo/feo/docs/safety_analysis/component_dfa.rst +++ b/docs/modules/feo/feo/docs/safety_analysis/component_dfa.rst @@ -17,7 +17,7 @@ :status: draft :security: NO :safety: ASIL_B - :realizes: PROCESS_wp__sw_component_dfa + :realizes: wp__sw_component_dfa :tags: coponent_feo diff --git a/docs/modules/feo/feo/docs/safety_analysis/component_fmea.rst b/docs/modules/feo/feo/docs/safety_analysis/component_fmea.rst index caa422734e..f18b06917d 100644 --- a/docs/modules/feo/feo/docs/safety_analysis/component_fmea.rst +++ b/docs/modules/feo/feo/docs/safety_analysis/component_fmea.rst @@ -17,7 +17,7 @@ :status: draft :security: NO :safety: ASIL_B - :realizes: PROCESS_wp__sw_component_fmea + :realizes: wp__sw_component_fmea :tags: component_feo diff --git a/docs/modules/orchestrator/executor/docs/architecture/executor.rst b/docs/modules/orchestrator/executor/docs/architecture/executor.rst index 7a36748a10..b3c03d7a04 100644 --- a/docs/modules/orchestrator/executor/docs/architecture/executor.rst +++ b/docs/modules/orchestrator/executor/docs/architecture/executor.rst @@ -20,7 +20,7 @@ Component Architecture :status: valid :safety: ASIL_B :security: YES - :realizes: PROCESS_wp__component_arch + :realizes: wp__component_arch :tags: orchestration, executor .. comp_arc_sta:: Executor diff --git a/docs/modules/orchestrator/executor/docs/index.rst b/docs/modules/orchestrator/executor/docs/index.rst index 1f8b34e9e3..50d5ad597c 100644 --- a/docs/modules/orchestrator/executor/docs/index.rst +++ b/docs/modules/orchestrator/executor/docs/index.rst @@ -8,7 +8,7 @@ Executor :status: valid :safety: ASIL_B :security: YES - :realizes: PROCESS_wp__cmpt_request + :realizes: wp__cmpt_request :tags: orchestration, executor Component Documents diff --git a/docs/modules/orchestrator/orchestrator/docs/architecture/orchestrator.rst b/docs/modules/orchestrator/orchestrator/docs/architecture/orchestrator.rst index 7235b142f1..1f2a48c9ef 100644 --- a/docs/modules/orchestrator/orchestrator/docs/architecture/orchestrator.rst +++ b/docs/modules/orchestrator/orchestrator/docs/architecture/orchestrator.rst @@ -21,7 +21,7 @@ Component Architecture :status: valid :safety: ASIL_B :security: YES - :realizes: PROCESS_wp__component_arch + :realizes: wp__component_arch :tags: orchestration, orchestrator .. comp_arc_sta:: Orchestrator diff --git a/docs/modules/orchestrator/orchestrator/docs/index.rst b/docs/modules/orchestrator/orchestrator/docs/index.rst index 58cfb1eb08..a410d019d9 100644 --- a/docs/modules/orchestrator/orchestrator/docs/index.rst +++ b/docs/modules/orchestrator/orchestrator/docs/index.rst @@ -8,7 +8,7 @@ Orchestrator :status: valid :safety: ASIL_B :security: YES - :realizes: PROCESS_wp__cmpt_request + :realizes: wp__cmpt_request :tags: orchestration, orchestrator Component Documents diff --git a/docs/modules/persistency/docs/manual/safety_manual.rst b/docs/modules/persistency/docs/manual/safety_manual.rst index df06a185e3..b2515225fd 100644 --- a/docs/modules/persistency/docs/manual/safety_manual.rst +++ b/docs/modules/persistency/docs/manual/safety_manual.rst @@ -21,7 +21,7 @@ Safety Manual :safety: ASIL_B :security: NO :tags: persistency - :realizes: PROCESS_wp__module_safety_manual + :realizes: wp__module_safety_manual Introduction/Scope ------------------ diff --git a/docs/modules/persistency/docs/release/release_note.rst b/docs/modules/persistency/docs/release/release_note.rst index cd9be065dd..e966523ce9 100644 --- a/docs/modules/persistency/docs/release/release_note.rst +++ b/docs/modules/persistency/docs/release/release_note.rst @@ -20,7 +20,7 @@ Release Note :status: valid :safety: ASIL_B :security: NO - :realizes: PROCESS_wp__module_sw_release_note + :realizes: wp__module_sw_release_note :tags: persistency | Module Name: Persistency diff --git a/docs/modules/persistency/docs/safety_mgt/module_safety_package_fdr.rst b/docs/modules/persistency/docs/safety_mgt/module_safety_package_fdr.rst index 4be9ed3a7a..678f4e756a 100644 --- a/docs/modules/persistency/docs/safety_mgt/module_safety_package_fdr.rst +++ b/docs/modules/persistency/docs/safety_mgt/module_safety_package_fdr.rst @@ -20,7 +20,7 @@ Safety Package Formal Review Report :status: valid :safety: ASIL_B :security: NO - :realizes: PROCESS_wp__fdr_reports + :realizes: wp__fdr_reports :tags: persistency **1. Purpose** diff --git a/docs/modules/persistency/docs/safety_mgt/module_safety_plan.rst b/docs/modules/persistency/docs/safety_mgt/module_safety_plan.rst index a71ac99ffd..c7c2da4eb3 100644 --- a/docs/modules/persistency/docs/safety_mgt/module_safety_plan.rst +++ b/docs/modules/persistency/docs/safety_mgt/module_safety_plan.rst @@ -20,13 +20,13 @@ Module Safety Plan :status: valid :safety: ASIL_B :security: NO - :realizes: PROCESS_wp__module_safety_plan + :realizes: wp__module_safety_plan :tags: persistency Functional Safety Management Context ==================================== -This Safety Plan adds to the :need:`PROCESS_gd_guidl__saf_plan_definitions` all the module development relevant workproducts needed for ISO 26262 conformity. +This Safety Plan adds to the :need:`gd_guidl__saf_plan_definitions` all the module development relevant workproducts needed for ISO 26262 conformity. Functional Safety Management Scope ================================== @@ -46,7 +46,7 @@ Functional Safety Management Roles Tailoring ========= -Additional to the tailoring in the SW platform project as defined in the :need:`PROCESS_gd_guidl__saf_plan_definitions` we define here the additional tailoring on module level. +Additional to the tailoring in the SW platform project as defined in the :need:`gd_guidl__saf_plan_definitions` we define here the additional tailoring on module level. | - Excluded for this module are additionally the following workproducts (and their related requirements): | - No work products excluded @@ -69,72 +69,72 @@ Module Workproducts List - Link to WP - WP status - * - :need:`PROCESS_wp__module_safety_plan` - - :need:`PROCESS_gd_guidl__saf_plan_definitions` - - :ndf:`copy('status', need_id='PROCESS_gd_guidl__saf_plan_definitions')` + * - :need:`wp__module_safety_plan` + - :need:`gd_guidl__saf_plan_definitions` + - :ndf:`copy('status', need_id='gd_guidl__saf_plan_definitions')` - https://github.com/eclipse-score/score/issues/952?issue=eclipse-score%7Cscore%7C963 - this document - valid - * - :need:`PROCESS_wp__module_safety_package` - - :need:`PROCESS_gd_guidl__saf_package` - - :ndf:`copy('status', need_id='PROCESS_gd_guidl__saf_package')` + * - :need:`wp__module_safety_package` + - :need:`gd_guidl__saf_package` + - :ndf:`copy('status', need_id='gd_guidl__saf_package')` - https://github.com/eclipse-score/score/issues/952?issue=eclipse-score%7Cscore%7C963 - this document (including the linked documentation) - valid - * - :need:`PROCESS_wp__fdr_reports` (module Safety Plan) - - :need:`PROCESS_gd_chklst__safety_plan` - - :ndf:`copy('status', need_id='PROCESS_gd_chklst__safety_plan')` + * - :need:`wp__fdr_reports` (module Safety Plan) + - :need:`gd_chklst__safety_plan` + - :ndf:`copy('status', need_id='gd_chklst__safety_plan')` - https://github.com/eclipse-score/score/issues/952?issue=eclipse-score%7Cscore%7C963 - :need:`doc__persistency_safety_plan_fdr` - :ndf:`copy('status', need_id='doc__persistency_safety_plan_fdr')` - * - :need:`PROCESS_wp__fdr_reports` (module Safety Package) - - :need:`PROCESS_gd_chklst__safety_package` - - :ndf:`copy('status', need_id='PROCESS_gd_chklst__safety_package')` + * - :need:`wp__fdr_reports` (module Safety Package) + - :need:`gd_chklst__safety_package` + - :ndf:`copy('status', need_id='gd_chklst__safety_package')` - https://github.com/eclipse-score/score/issues/952?issue=eclipse-score%7Cscore%7C963 - :need:`doc__persistency_safety_package_fdr` - :ndf:`copy('status', need_id='doc__persistency_safety_package_fdr')` - * - :need:`PROCESS_wp__fdr_reports` (module's Safety Analyses & DFA) - - :need:`PROCESS_gd_guidl__safety_analysis` - - :ndf:`copy('status', need_id='PROCESS_gd_guidl__safety_analysis')` + * - :need:`wp__fdr_reports` (module's Safety Analyses & DFA) + - :need:`gd_guidl__safety_analysis` + - :ndf:`copy('status', need_id='gd_guidl__safety_analysis')` - https://github.com/eclipse-score/score/issues/952?issue=eclipse-score%7Cscore%7C965 - :need:`doc__persistency_kvs_fmea` - :ndf:`copy('status', need_id='doc__persistency_kvs_fmea')` - * - :need:`PROCESS_wp__audit_report` + * - :need:`wp__audit_report` - performed by external experts - n/a - - - - * - :need:`PROCESS_wp__module_sw_build_config` - - `PROCESS_gd_temp__software_development_plan` - - `copy('status', need_id='PROCESS_doc__software_development_plan')` + * - :need:`wp__module_sw_build_config` + - `gd_temp__software_development_plan` + - `copy('status', need_id='doc__software_development_plan')` - - - - * - :need:`PROCESS_wp__module_safety_manual` - - :need:`PROCESS_gd_temp__safety_manual` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__safety_manual')` + * - :need:`wp__module_safety_manual` + - :need:`gd_temp__safety_manual` + - :ndf:`copy('status', need_id='gd_temp__safety_manual')` - https://github.com/eclipse-score/score/issues/952?issue=eclipse-score%7Cscore%7C963 - :need:`doc__persistency_safety_manual` - :ndf:`copy('status', need_id='doc__persistency_safety_manual')` - * - :need:`PROCESS_wp__verification_module_ver_report` - - :need:`PROCESS_gd_temp__mod_ver_report` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__mod_ver_report')` + * - :need:`wp__verification_module_ver_report` + - :need:`gd_temp__mod_ver_report` + - :ndf:`copy('status', need_id='gd_temp__mod_ver_report')` - https://github.com/eclipse-score/score/issues/952?issue=eclipse-score%7Cscore%7C964 - :need:`doc__persistency_verification_report` - :ndf:`copy('status', need_id='doc__persistency_verification_report')` - * - :need:`PROCESS_wp__module_sw_release_note` - - :need:`PROCESS_gd_temp__rel_mod_rel_note` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__rel_mod_rel_note')` + * - :need:`wp__module_sw_release_note` + - :need:`gd_temp__rel_mod_rel_note` + - :ndf:`copy('status', need_id='gd_temp__rel_mod_rel_note')` - - :need:`doc__persistency_release_note` - :ndf:`copy('status', need_id='doc__persistency_release_note')` @@ -152,91 +152,91 @@ Component Workproducts List - Link to WP - WP/doc status - * - :need:`PROCESS_wp__requirements_comp` - - :need:`PROCESS_gd_temp__req_comp_req` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__req_comp_req')` + * - :need:`wp__requirements_comp` + - :need:`gd_temp__req_comp_req` + - :ndf:`copy('status', need_id='gd_temp__req_comp_req')` - https://github.com/eclipse-score/score/issues/952?issue=eclipse-score%7Cscore%7C960 - :need:`doc__persistency_kvs_requirements` - :ndf:`copy('status', need_id='doc__persistency_kvs_requirements')` & WP below - * - :need:`PROCESS_wp__requirements_comp_aou` - - :need:`PROCESS_gd_temp__req_aou_req` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__req_aou_req')` + * - :need:`wp__requirements_comp_aou` + - :need:`gd_temp__req_aou_req` + - :ndf:`copy('status', need_id='gd_temp__req_aou_req')` - https://github.com/eclipse-score/score/issues/952?issue=eclipse-score%7Cscore%7C960 - :need:`doc__persistency_kvs_requirements` - :ndf:`copy('status', need_id='doc__persistency_kvs_requirements')` & WP below - * - :need:`PROCESS_wp__requirements_inspect` - - :need:`PROCESS_gd_chklst__req_inspection` - - :ndf:`copy('status', need_id='PROCESS_gd_chklst__req_inspection')` + * - :need:`wp__requirements_inspect` + - :need:`gd_chklst__req_inspection` + - :ndf:`copy('status', need_id='gd_chklst__req_inspection')` - n/a - Checklist used in Pull Request Review - n/a - * - :need:`PROCESS_wp__component_arch` - - :need:`PROCESS_gd_temp__arch_comp` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__arch_comp')` + * - :need:`wp__component_arch` + - :need:`gd_temp__arch_comp` + - :ndf:`copy('status', need_id='gd_temp__arch_comp')` - https://github.com/eclipse-score/score/issues/952?issue=eclipse-score%7Cscore%7C1020 - :need:`doc__persistency_kvs_architecture` - :ndf:`copy('status', need_id='doc__persistency_kvs_architecture')` & WP below - * - :need:`PROCESS_wp__sw_arch_verification` - - :need:`PROCESS_gd_chklst__arch_inspection_checklist` - - :ndf:`copy('status', need_id='PROCESS_gd_chklst__arch_inspection_checklist')` + * - :need:`wp__sw_arch_verification` + - :need:`gd_chklst__arch_inspection_checklist` + - :ndf:`copy('status', need_id='gd_chklst__arch_inspection_checklist')` - n/a - Checklist used in Pull Request Review - n/a - * - :need:`PROCESS_wp__sw_component_fmea` - - :need:`PROCESS_wp__sw_component_fmea` - - :ndf:`copy('status', need_id='PROCESS_gd_guidl__safety_analysis')` + * - :need:`wp__sw_component_fmea` + - :need:`wp__sw_component_fmea` + - :ndf:`copy('status', need_id='gd_guidl__safety_analysis')` - https://github.com/eclipse-score/score/issues/952?issue=eclipse-score%7Cscore%7C965 - :need:`doc__persistency_kvs_fmea` - :ndf:`copy('status', need_id='doc__persistency_kvs_fmea')` & WP below - * - :need:`PROCESS_wp__sw_component_dfa` - - :need:`PROCESS_wp__sw_component_dfa` - - :ndf:`copy('status', need_id='PROCESS_gd_guidl__safety_analysis')` + * - :need:`wp__sw_component_dfa` + - :need:`wp__sw_component_dfa` + - :ndf:`copy('status', need_id='gd_guidl__safety_analysis')` - https://github.com/eclipse-score/score/issues/952?issue=eclipse-score%7Cscore%7C965 - :need:`doc__persistency_kvs_dfa` - :ndf:`copy('status', need_id='doc__persistency_kvs_dfa')` & WP below - * - :need:`PROCESS_wp__sw_implementation` - - :need:`PROCESS_gd_guidl__implementation` - - :ndf:`copy('status', need_id='PROCESS_gd_guidl__implementation')` + * - :need:`wp__sw_implementation` + - :need:`gd_guidl__implementation` + - :ndf:`copy('status', need_id='gd_guidl__implementation')` - https://github.com/eclipse-score/score/issues/952?issue=eclipse-score%7Cscore%7C961 - - - * - :need:`PROCESS_wp__verification_sw_unit_test` - - :need:`PROCESS_gd_guidl__verification_guide` - - :ndf:`copy('status', need_id='PROCESS_gd_guidl__verification_guide')` + * - :need:`wp__verification_sw_unit_test` + - :need:`gd_guidl__verification_guide` + - :ndf:`copy('status', need_id='gd_guidl__verification_guide')` - https://github.com/eclipse-score/score/issues/952?issue=eclipse-score%7Cscore%7C964 - - - * - :need:`PROCESS_wp__sw_implementation_inspection` - - :need:`PROCESS_gd_chklst__impl_inspection_checklist` - - :ndf:`copy('status', need_id='PROCESS_gd_chklst__impl_inspection_checklist')` + * - :need:`wp__sw_implementation_inspection` + - :need:`gd_chklst__impl_inspection_checklist` + - :ndf:`copy('status', need_id='gd_chklst__impl_inspection_checklist')` - n/a - Checklist used in Pull Request Review - n/a - * - :need:`PROCESS_wp__verification_comp_int_test` - - :need:`PROCESS_gd_guidl__verification_guide` - - :ndf:`copy('status', need_id='PROCESS_gd_guidl__verification_guide')` + * - :need:`wp__verification_comp_int_test` + - :need:`gd_guidl__verification_guide` + - :ndf:`copy('status', need_id='gd_guidl__verification_guide')` - https://github.com/eclipse-score/score/issues/952?issue=eclipse-score%7Cscore%7C964 - - - * - :need:`PROCESS_wp__sw_component_class` - - :need:`PROCESS_gd_guidl__component_classification` - - :ndf:`copy('status', need_id='PROCESS_gd_guidl__component_classification')` + * - :need:`wp__sw_component_class` + - :need:`gd_guidl__component_classification` + - :ndf:`copy('status', need_id='gd_guidl__component_classification')` - https://github.com/eclipse-score/score/issues/952?issue=eclipse-score%7Cscore%7C963 - :need:`doc__persistency_component_classification` - :ndf:`copy('status', need_id='doc__persistency_component_classification')` -Note: In case the component is a new development, :need:`PROCESS_wp__sw_component_class` shall be removed from the above list (and also from the folders). +Note: In case the component is a new development, :need:`wp__sw_component_class` shall be removed from the above list (and also from the folders). In case an OSS element is used in the module, part 6 has to be filled out. OSS (sub-)component qualification plan @@ -255,47 +255,47 @@ If the OSS element is classified as a - Link to issue - Reasoning for tailoring - * - :need:`PROCESS_wp__requirements_comp` + * - :need:`wp__requirements_comp` - https://github.com/eclipse-score/score/issues/952?issue=eclipse-score%7Cscore%7C960 - Always needed (for Q and QR classification) and also improves process Id 2 - * - :need:`PROCESS_wp__requirements_comp_aou` + * - :need:`wp__requirements_comp_aou` - https://github.com/eclipse-score/score/issues/952?issue=eclipse-score%7Cscore%7C960 - Always needed (for Q and QR classification) and also improves process Id 5 - * - :need:`PROCESS_wp__requirements_inspect` + * - :need:`wp__requirements_inspect` - n/a - Checklist used in Pull Request Review - * - :need:`PROCESS_wf__cr_mt_comparch` + * - :need:`wf__cr_mt_comparch` - - - * - :need:`PROCESS_wp__sw_component_fmea` + * - :need:`wp__sw_component_fmea` - https://github.com/eclipse-score/score/issues/952?issue=eclipse-score%7Cscore%7C965 - - * - :need:`PROCESS_wp__sw_arch_verification` + * - :need:`wp__sw_arch_verification` - https://github.com/eclipse-score/score/issues/952?issue=eclipse-score%7Cscore%7C964 - - * - :need:`PROCESS_wp__sw_implementation` + * - :need:`wp__sw_implementation` - n/a - If source code is modified, this is not a OSS qualification any more. - * - :need:`PROCESS_wp__verification_sw_unit_test` + * - :need:`wp__verification_sw_unit_test` - https://github.com/eclipse-score/score/issues/952?issue=eclipse-score%7Cscore%7C964 - - * - :need:`PROCESS_wp__sw_implementation_inspection` + * - :need:`wp__sw_implementation_inspection` - https://github.com/eclipse-score/score/issues/952?issue=eclipse-score%7Cscore%7C961 - - * - :need:`PROCESS_wp__verification_comp_int_test` + * - :need:`wp__verification_comp_int_test` - https://github.com/eclipse-score/score/issues/952?issue=eclipse-score%7Cscore%7C964 - Always needed (for Q and QR classification) - * - :need:`PROCESS_wp__sw_component_class` + * - :need:`wp__sw_component_class` - https://github.com/eclipse-score/score/issues/952?issue=eclipse-score%7Cscore%7C963 - Always needed as basis for tailoring. diff --git a/docs/modules/persistency/docs/safety_mgt/module_safety_plan_fdr.rst b/docs/modules/persistency/docs/safety_mgt/module_safety_plan_fdr.rst index 2bdee0487e..23f90f2c36 100644 --- a/docs/modules/persistency/docs/safety_mgt/module_safety_plan_fdr.rst +++ b/docs/modules/persistency/docs/safety_mgt/module_safety_plan_fdr.rst @@ -20,7 +20,7 @@ Safety Plan Formal Review Report :status: valid :safety: ASIL_B :security: NO - :realizes: PROCESS_wp__fdr_reports + :realizes: wp__fdr_reports :tags: persistency **1. Purpose** diff --git a/docs/modules/persistency/docs/verification/module_verification_report.rst b/docs/modules/persistency/docs/verification/module_verification_report.rst index 28d230ab2d..a00ca26e61 100644 --- a/docs/modules/persistency/docs/verification/module_verification_report.rst +++ b/docs/modules/persistency/docs/verification/module_verification_report.rst @@ -20,7 +20,7 @@ Verification Report :status: valid :safety: ASIL_B :security: NO - :realizes: PROCESS_wp__verification_module_ver_report + :realizes: wp__verification_module_ver_report :tags: persistency diff --git a/docs/modules/persistency/json/docs/component_classification.rst b/docs/modules/persistency/json/docs/component_classification.rst index 7f5046718c..4350716ae2 100644 --- a/docs/modules/persistency/json/docs/component_classification.rst +++ b/docs/modules/persistency/json/docs/component_classification.rst @@ -20,7 +20,7 @@ Component Classification :status: valid :safety: ASIL_B :security: NO - :realizes: PROCESS_wp__sw_component_class + :realizes: wp__sw_component_class :tags: feature_persistency | Classification of Tiny JSON diff --git a/docs/modules/persistency/json/docs/index.rst b/docs/modules/persistency/json/docs/index.rst index 8b25c6d065..e974fadc78 100644 --- a/docs/modules/persistency/json/docs/index.rst +++ b/docs/modules/persistency/json/docs/index.rst @@ -27,7 +27,7 @@ Tiny JSON :status: valid :safety: ASIL_B :security: NO - :realizes: PROCESS_wp__cmpt_request + :realizes: wp__cmpt_request :tags: template diff --git a/docs/modules/persistency/kvs/docs/architecture/index.rst b/docs/modules/persistency/kvs/docs/architecture/index.rst index 5a74588a2b..e04f5bdbfe 100644 --- a/docs/modules/persistency/kvs/docs/architecture/index.rst +++ b/docs/modules/persistency/kvs/docs/architecture/index.rst @@ -22,7 +22,7 @@ Architecture :status: valid :safety: ASIL_B :security: NO - :realizes: PROCESS_wp__component_arch + :realizes: wp__component_arch Overview -------- @@ -118,5 +118,5 @@ Lower Level Components .. attention:: The above directives must be updated according to your component architecture. - - Replace the example content by the real content (according to :need:`PROCESS_gd_guidl__arch_design`) + - 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 diff --git a/docs/modules/persistency/kvs/docs/index.rst b/docs/modules/persistency/kvs/docs/index.rst index 15a829e165..aa04dcb5c1 100644 --- a/docs/modules/persistency/kvs/docs/index.rst +++ b/docs/modules/persistency/kvs/docs/index.rst @@ -22,7 +22,7 @@ KVS (Key Value Store) :status: valid :safety: ASIL_B :security: NO - :realizes: PROCESS_wp__cmpt_request + :realizes: wp__cmpt_request :tags: Persistency KVS Abstract @@ -79,7 +79,7 @@ Specification .. note:: A CR shall specify the component requirements as part of our platform/project. - Thereby the :need:`PROCESS_rl__module_lead` will approve these requirements as part of accepting the CR (e.g. merging the PR with the CR). + Thereby the :need:`rl__module_lead` will approve these requirements as part of accepting the CR (e.g. merging the PR with the CR). Backwards Compatibility diff --git a/docs/modules/persistency/kvs/docs/requirements/index.rst b/docs/modules/persistency/kvs/docs/requirements/index.rst index 9e18fb63c7..d237cea3e1 100644 --- a/docs/modules/persistency/kvs/docs/requirements/index.rst +++ b/docs/modules/persistency/kvs/docs/requirements/index.rst @@ -20,7 +20,7 @@ Requirements :status: valid :safety: ASIL_B :security: NO - :realizes: PROCESS_wp__requirements_comp + :realizes: wp__requirements_comp .. comp_req:: Key Naming :id: comp_req__persistency__key_naming diff --git a/docs/modules/persistency/kvs/docs/safety_analysis/dfa.rst b/docs/modules/persistency/kvs/docs/safety_analysis/dfa.rst index a97200b049..491a48c43d 100644 --- a/docs/modules/persistency/kvs/docs/safety_analysis/dfa.rst +++ b/docs/modules/persistency/kvs/docs/safety_analysis/dfa.rst @@ -21,7 +21,7 @@ Dependent Failure Analysis :status: valid :safety: ASIL_B :security: NO - :realizes: PROCESS_wp__sw_component_dfa + :realizes: wp__sw_component_dfa :tags: Persistency KVS Because there is no sub-components in KVS, the results of the FMEA are the same as on feature level :need:`doc__persistency_dfa`. diff --git a/docs/modules/persistency/kvs/docs/safety_analysis/fmea.rst b/docs/modules/persistency/kvs/docs/safety_analysis/fmea.rst index 1080819166..7cf42304cd 100644 --- a/docs/modules/persistency/kvs/docs/safety_analysis/fmea.rst +++ b/docs/modules/persistency/kvs/docs/safety_analysis/fmea.rst @@ -21,7 +21,7 @@ Safety Analysis: FMEA :status: valid :safety: ASIL_B :security: NO - :realizes: PROCESS_wp__sw_component_fmea + :realizes: wp__sw_component_fmea :tags: Persistency KVS Because there is no sub-components in KVS, the results of the FMEA are the same as on feature level :need:`doc__persistency_fmea`. diff --git a/docs/platform_management_plan/change_management.rst b/docs/platform_management_plan/change_management.rst index 612ec76ff9..bd9b68b3ac 100644 --- a/docs/platform_management_plan/change_management.rst +++ b/docs/platform_management_plan/change_management.rst @@ -18,14 +18,14 @@ :safety: ASIL_B :security: YES :tags: platform_management - :realizes: PROCESS_wp__chm_plan + :realizes: wp__chm_plan .. _change_mgmt_plan: Change Management / Change Management Plan ------------------------------------------ -This document implements parts of the :need:`PROCESS_wp__platform_mgmt`. +This document implements parts of the :need:`wp__platform_mgmt`. Purpose +++++++ @@ -73,7 +73,7 @@ Requests within **S-CORE**. The next figure gives an overview, how Change Requests are realized in **S-CORE**. An ISSUE and PR is used to create a Change Request including required attributes as defined in -:need:`PROCESS_gd_req__change_attr_uid`. +:need:`gd_req__change_attr_uid`. .. figure:: _assets/score_change_request_overview_simple.drawio.svg :width: 100% @@ -82,9 +82,9 @@ is used to create a Change Request including required attributes as defined in Change Request Simple Overview -Therefore the Change Template :need:`PROCESS_gd_temp__change_feature_request` or -:need:`PROCESS_gd_temp__change_component_request` shall be used. -In addition :need:`Impact Analysis Template ` should be +Therefore the Change Template :need:`gd_temp__change_feature_request` or +:need:`gd_temp__change_component_request` shall be used. +In addition :need:`Impact Analysis Template ` should be used, if applicable. .. note:: @@ -117,30 +117,30 @@ Changes are clustered in the following types: - Description - Infrastructure * - Feature - - Created by :need:`Contributor ` to change requirements and work products, new feature + - Created by :need:`Contributor ` to change requirements and work products, new feature - ISSUE with label ``feature_request`` * - Feature Modification - - Created by :need:`Contributor ` to change requirements and work products, scope change + - Created by :need:`Contributor ` to change requirements and work products, scope change - ISSUE with label ``feature_modification`` * - Component - - Created by :need:`Contributor ` to change requirements and work products, new component + - Created by :need:`Contributor ` to change requirements and work products, new component - ISSUE with label ``component_request`` * - Component Modification - - Created by :need:`Contributor ` to change requirements and work products, scope change + - Created by :need:`Contributor ` to change requirements and work products, scope change - ISSUE with label ``component_modification`` Change Request Traceability Impact Analysis requires the following tools: -:need:`[[title]] ` +:need:`[[title]] ` Change Request Attributes ^^^^^^^^^^^^^^^^^^^^^^^^^ -:need:`PROCESS_gd_req__change_attr_uid` are implemented as follows: +:need:`gd_req__change_attr_uid` are implemented as follows: -:need:`[[title]] ` is identical to the ISSUE number. +:need:`[[title]] ` is identical to the ISSUE number. -:need:`[[title]] ` is defined by the combination of the ISSUE +:need:`[[title]] ` is defined by the combination of the ISSUE state, the state in the Projects dashboard view and the PR status. .. list-table:: Change Status @@ -172,30 +172,30 @@ state, the state in the Projects dashboard view and the PR status. - na - na -:need:`[[title]] ` is identical to the ISSUE title. +:need:`[[title]] ` is identical to the ISSUE title. -:need:`[[title]] ` is initially provided in the +:need:`[[title]] ` is initially provided in the Description and Impact analysis part of the ISSUE. Further detailed analysis results are part of the linked PR, provided as part of the feature/request templates. Further information about detailed implementation can be provided in the Realize part of the ISSUE. -:need:`[[title]] `, -:need:`[[title]] ` are provided in the Safety or +:need:`[[title]] `, +:need:`[[title]] ` are provided in the Safety or Security relevance part of the ISSUE. Combinations of them are allowed. If nothing is selected, Quality is relevant by default. Use the ASIL classification part of the ISSUE to document the ASIL level concerned, e.g. ASIL_B. -:need:`[[title]] ` is provided in the Change Request Type +:need:`[[title]] ` is provided in the Change Request Type part of the ISSUE, further in the linked PR for feature or component request. -:need:`[[title]] ` is initially provided in the +:need:`[[title]] ` is initially provided in the Affected work products part of the ISSUE. Further detailed affected work products are part of the linked PR or other ISSUEs. -:need:`[[title]] ` is provided in the Expected Implementation +:need:`[[title]] ` is provided in the Expected Implementation Version part of the ISSUE. Optionally the Milestone part of the ISSUE can be set. @@ -213,7 +213,7 @@ In general, every Change Request follows the following steps: * 3. Initiate the implementation of the Change Request and track it to closure (yellow color) * 4. Close Change Request (purple color) -:need:`PROCESS_gd_guidl__change_change_request` can give additional help. +:need:`gd_guidl__change_change_request` can give additional help. **To 1. Create the Change Request:** @@ -231,10 +231,10 @@ The description of the ISSUE may give a brief description and impact analysis of change. The details are part of the Feature/Component Request and Impact Analysis provided by a PR, which is linked to the ISSUE in status ``Draft`` or ``Open``. -For a new Feature/Component Request the provided templates :need:`Feature Request`, -or :need:`Component Request` must be used. For a +For a new Feature/Component Request the provided templates :need:`Feature Request`, +or :need:`Component Request` must be used. For a modification of an existing Feature/Component, update the existing work products. -Further add here the :need:`Impact Analysis Template ` +Further add here the :need:`Impact Analysis Template ` and fill it out accordingly, if applicable. The description of the ISSUE may give a brief description of the affected work products and also @@ -265,8 +265,8 @@ set the ISSUE status to ``Closed as not planned``. **To 2. Analyze the Change Request:** -The Change Request is reviewed and analyzed from the :need:`Committer ` and the -review results are resolved by the :need:`Contributor `. The results +The Change Request is reviewed and analyzed from the :need:`Committer ` and the +review results are resolved by the :need:`Contributor `. The results are documented in the ISSUE and/or linked PR. As long as the information is not sufficient, the related ISSUE is kept in status ``Open`` and Projects status ``Todo``, means ``in review``. @@ -276,7 +276,7 @@ ISSUE status is kept ``Open`` and the Projects status is set to ``In Progress``. The decision, if the change request is accepted or rejected must be documented. Safety/Security experts must confirm or disconfirm, if safety/security relevance is set correctly. -:need:`PROCESS_gd_chklst__change_cr_review` can help to verify whether the information is complete. +:need:`gd_chklst__change_cr_review` can help to verify whether the information is complete. Otherwise, if the change requested is not accepted, the change request is rejected. To reject the Change Request: Change Request status: ``rejected`` set the ISSUE status to ``Closed as not planned``. @@ -284,7 +284,7 @@ Change Request: Change Request status: ``rejected`` set the ISSUE status to ``Cl **To 3. Initiate the implementation of the Change Request and track it to closure:** -:need:`Contributor ` starts all required activities to implement the +:need:`Contributor ` starts all required activities to implement the change request. These may include further planning activities by creating ISSUEs and required PRs. All additional ISSUEs or PRs created to implement are linked to the Change Request ISSUE to enable monitoring of the activities. @@ -292,8 +292,8 @@ monitoring of the activities. All activities defined are tracked until closure, means that all linked ISSUEs or PRs are closed or merged, respectively. -If all are closed or merged :need:`Contributor ` sets Projects status to -``Done`` to trigger the final review from the :need:`Committer ` to close +If all are closed or merged :need:`Contributor ` sets Projects status to +``Done`` to trigger the final review from the :need:`Committer ` to close the Change Request. The Change Request may also rejected in this phase, then the ISSUE status is set to @@ -302,13 +302,13 @@ The Change Request may also rejected in this phase, then the ISSUE status is set **To 4. Close Change Request :** -:need:`Committer ` checks finally if the change request is completely +:need:`Committer ` checks finally if the change request is completely implemented. In this case all linked ISSUEs or PRs are closed or merged, respectively. Especially the verification measures must be checked for their effectiveness and the argumentation is convincing. -:need:`PROCESS_gd_chklst__change_cr_review` can help to verify whether it can be closed. +:need:`gd_chklst__change_cr_review` can help to verify whether it can be closed. The realization parts of the Change Request are reviewed according the checklists of the affected work products. Verification of the realization parts must be successful. diff --git a/docs/platform_management_plan/config_management.rst b/docs/platform_management_plan/config_management.rst index f6fa32c532..acbb1f861a 100644 --- a/docs/platform_management_plan/config_management.rst +++ b/docs/platform_management_plan/config_management.rst @@ -18,7 +18,7 @@ :safety: ASIL_B :security: YES :tags: platform_management - :realizes: PROCESS_wp__config_mgt_plan + :realizes: wp__config_mgt_plan Config management / Configuration Management Plan ------------------------------------------------- @@ -46,7 +46,7 @@ Goal of this plan is to describe * how to backup and recover (including long term storage) * how to report the configuration status -note: for definition of "configuration items" check :need:`PROCESS_doc_concept__configuration_process` +note: for definition of "configuration items" check :need:`doc_concept__configuration_process` Approach @@ -65,9 +65,9 @@ I.e. in Concept Phase, Development Phase and Maintenance. Identification and Properties ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Each work product is identified by its sphinx-needs Id, this includes documents identified as such (by the document header as defined in :need:`PROCESS_gd_temp__documentation`). +Each work product is identified by its sphinx-needs Id, this includes documents identified as such (by the document header as defined in :need:`gd_temp__documentation`). The complete list of project documents is defined in the :need:`doc__documentation_mgt_plan`. -Ids are checked for uniqueness, see :need:`PROCESS_gd_req__configuration_uid`. +Ids are checked for uniqueness, see :need:`gd_req__configuration_uid`. sphinx-needs is also used to document the work products properties/attributes defined in the process area descriptions. The work products are stored in text or code files (these are identified by their filenames) within GitHub repositories. There is one `platform repository `_ and one repository for each module. @@ -97,9 +97,9 @@ For other artifacts: these are pulled into S-CORE integration repository by fork Control and Modification ^^^^^^^^^^^^^^^^^^^^^^^^ -Files or new work products contained in them are created in local branches by the :need:`Contributor ` +Files or new work products contained in them are created in local branches by the :need:`Contributor ` and shared for review and incorporation into the main branch via GitHub pull-requests, -which are after their acceptance merged by the :need:`Committer `. The same applies for changes in existing configuration items. +which are after their acceptance merged by the :need:`Committer `. The same applies for changes in existing configuration items. All modifications (differences between before and after) are documented in the pull-requests and are the main input to the pull-request reviews. See also :need:`doc__platform_change_management_plan`. @@ -115,7 +115,7 @@ Branches are used as a means of parallel development. In the S-CORE project the * main branch - a "remote" branch (named "main") which contains all the latest file versions checked by CI, reviewed, accepted and merged. * release branch - a "remote" branch derived from main branch which is used to prepare a release, no functional code changes are allowed, only bug fixes and verification based improvements. - Only the technical lead is allowed to approve a merge into a release branch. The branch name is given as defined in :need:`PROCESS_doc_concept__rel_process`. + Only the technical lead is allowed to approve a merge into a release branch. The branch name is given as defined in :need:`doc_concept__rel_process`. The "remote" branch is not "local" to the developer but resides on the "remote" GitHub server. @@ -139,7 +139,7 @@ Backup and Recovery ^^^^^^^^^^^^^^^^^^^ Backup and recovery are covered by the Eclipse Foundation hosting the GitHub service for S-CORE. -For the long term storage, additional measures are taken, see :need:`PROCESS_gd_req__config_workproducts_storage` +For the long term storage, additional measures are taken, see :need:`gd_req__config_workproducts_storage` Status and Reporting @@ -148,7 +148,7 @@ Status and Reporting Work products defined in our processes have "status" attributes. These are used to communicate to all the stakeholders. The main communication means is a document list containing all documents including their status. This list is part of the Documentation Management Plan :need:`doc__documentation_mgt_plan` as part of the Platform Management Plan, -as defined in :need:`PROCESS_gd_guidl__documentation`. +as defined in :need:`gd_guidl__documentation`. Completeness of the configuration items (within a baseline) is checked at least for every release against the list of planned documents, which is also part of the Documentation Management Plan. diff --git a/docs/platform_management_plan/documentation_management.rst b/docs/platform_management_plan/documentation_management.rst index 65987ab7eb..a626d757e5 100644 --- a/docs/platform_management_plan/documentation_management.rst +++ b/docs/platform_management_plan/documentation_management.rst @@ -18,7 +18,7 @@ :safety: ASIL_B :security: YES :tags: platform_management - :realizes: PROCESS_wp__document_mgt_plan + :realizes: wp__document_mgt_plan Documentation Management Plan ----------------------------- @@ -345,7 +345,7 @@ planned for release v0.5, are listed. .. for need in needs.filter_types(["document"]): .. if "template" in need["tags"] and "PROCESS" in need["id"] and "feature_name" in need["id"]: -.. act_id = need["id"].replace("PROCESS_doc__feature_name", "") +.. act_id = need["id"].replace("doc__feature_name", "") .. i = 0 @@ -380,7 +380,7 @@ planned for release v0.5, are listed. .. for need in needs.filter_types(["document"]): .. if "template" in need["tags"] and "PROCESS" in need["id"] and "feature_name" in need["id"]: -.. act_id = need["id"].replace("PROCESS_doc__feature_name", "") +.. act_id = need["id"].replace("doc__feature_name", "") .. i = 0 @@ -415,7 +415,7 @@ docs/features/baselibs for need in needs.filter_types(["document"]): if "template" in need["tags"] and "PROCESS" in need["id"] and "feature_name" in need["id"]: - act_id = need["id"].replace("PROCESS_doc__feature_name", "") + act_id = need["id"].replace("doc__feature_name", "") i = 0 @@ -450,7 +450,7 @@ docs/features/communication for need in needs.filter_types(["document"]): if "template" in need["tags"] and "PROCESS" in need["id"] and "feature_name" in need["id"]: - act_id = need["id"].replace("PROCESS_doc__feature_name", "") + act_id = need["id"].replace("doc__feature_name", "") i = 0 @@ -485,7 +485,7 @@ docs/features/communication .. for need in needs.filter_types(["document"]): .. if "template" in need["tags"] and "PROCESS" in need["id"] and "feature_name" in need["id"]: -.. act_id = need["id"].replace("PROCESS_doc__feature_name", "") +.. act_id = need["id"].replace("doc__feature_name", "") .. i = 0 @@ -520,7 +520,7 @@ docs/features/frameworks for need in needs.filter_types(["document"]): if "template" in need["tags"] and "PROCESS" in need["id"] and "feature_name" in need["id"]: - act_id = need["id"].replace("PROCESS_doc__feature_name", "") + act_id = need["id"].replace("doc__feature_name", "") i = 0 @@ -555,7 +555,7 @@ docs/features/frameworks .. for need in needs.filter_types(["document"]): .. if "template" in need["tags"] and "PROCESS" in need["id"] and "feature_name" in need["id"]: -.. act_id = need["id"].replace("PROCESS_doc__feature_name", "") +.. act_id = need["id"].replace("doc__feature_name", "") .. i = 0 @@ -590,7 +590,7 @@ docs/features/frameworks .. for need in needs.filter_types(["document"]): .. if "template" in need["tags"] and "PROCESS" in need["id"] and "feature_name" in need["id"]: -.. act_id = need["id"].replace("PROCESS_doc__feature_name", "") +.. act_id = need["id"].replace("doc__feature_name", "") .. i = 0 @@ -625,7 +625,7 @@ docs/features/frameworks .. for need in needs.filter_types(["document"]): .. if "template" in need["tags"] and "PROCESS" in need["id"] and "feature_name" in need["id"]: -.. act_id = need["id"].replace("PROCESS_doc__feature_name", "") +.. act_id = need["id"].replace("doc__feature_name", "") .. i = 0 @@ -660,7 +660,7 @@ docs/features/orchestration for need in needs.filter_types(["document"]): if "template" in need["tags"] and "PROCESS" in need["id"] and "feature_name" in need["id"]: - act_id = need["id"].replace("PROCESS_doc__feature_name", "") + act_id = need["id"].replace("doc__feature_name", "") i = 0 @@ -695,7 +695,7 @@ docs/features/persistency for need in needs.filter_types(["document"]): if "template" in need["tags"] and "PROCESS" in need["id"] and "feature_name" in need["id"]: - act_id = need["id"].replace("PROCESS_doc__feature_name", "") + act_id = need["id"].replace("doc__feature_name", "") i = 0 @@ -730,7 +730,7 @@ docs/features/persistency .. for need in needs.filter_types(["document"]): .. if "template" in need["tags"] and "PROCESS" in need["id"] and "feature_name" in need["id"]: -.. act_id = need["id"].replace("PROCESS_doc__feature_name", "") +.. act_id = need["id"].replace("doc__feature_name", "") .. i = 0 @@ -771,7 +771,7 @@ docs/modules/baselibs/docs for need in needs.filter_types(["document"]): if "template" in need["tags"] and "PROCESS" in need["id"] and "module_name" in need["id"]: - act_id = need["id"].replace("PROCESS_doc__module_name", "") + act_id = need["id"].replace("doc__module_name", "") i = 0 @@ -807,7 +807,7 @@ docs/modules/communication/docs for need in needs.filter_types(["document"]): if "template" in need["tags"] and "PROCESS" in need["id"] and "module_name" in need["id"]: - act_id = need["id"].replace("PROCESS_doc__module_name", "") + act_id = need["id"].replace("doc__module_name", "") i = 0 @@ -843,7 +843,7 @@ docs/modules/feo/docs for need in needs.filter_types(["document"]): if "template" in need["tags"] and "PROCESS" in need["id"] and "module_name" in need["id"]: - act_id = need["id"].replace("PROCESS_doc__module_name", "") + act_id = need["id"].replace("doc__module_name", "") i = 0 @@ -879,7 +879,7 @@ docs/modules/feo/docs .. for need in needs.filter_types(["document"]): .. if "template" in need["tags"] and "PROCESS" in need["id"] and "module_name" in need["id"]: -.. act_id = need["id"].replace("PROCESS_doc__module_name", "") +.. act_id = need["id"].replace("doc__module_name", "") .. i = 0 @@ -915,7 +915,7 @@ docs/modules/logging/docs for need in needs.filter_types(["document"]): if "template" in need["tags"] and "PROCESS" in need["id"] and "module_name" in need["id"]: - act_id = need["id"].replace("PROCESS_doc__module_name", "") + act_id = need["id"].replace("doc__module_name", "") i = 0 @@ -951,7 +951,7 @@ docs/modules/os/docs for need in needs.filter_types(["document"]): if "template" in need["tags"] and "PROCESS" in need["id"] and "module_name" in need["id"]: - act_id = need["id"].replace("PROCESS_doc__module_name", "") + act_id = need["id"].replace("doc__module_name", "") i = 0 @@ -987,7 +987,7 @@ docs/modules/persistency/docs for need in needs.filter_types(["document"]): if "template" in need["tags"] and "PROCESS" in need["id"] and "module_name" in need["id"]: - act_id = need["id"].replace("PROCESS_doc__module_name", "") + act_id = need["id"].replace("doc__module_name", "") i = 0 @@ -1023,7 +1023,7 @@ docs/modules/tracing/docs for need in needs.filter_types(["document"]): if "template" in need["tags"] and "PROCESS" in need["id"] and "module_name" in need["id"]: - act_id = need["id"].replace("PROCESS_doc__module_name", "") + act_id = need["id"].replace("doc__module_name", "") i = 0 @@ -1082,7 +1082,7 @@ docs/modules/baselibs/components for need in needs.filter_types(["document"]): if "template" in need["tags"] and "PROCESS" in need["id"] and "component_name" in need["id"]: - act_id = need["id"].replace("PROCESS_doc__component_name", "") + act_id = need["id"].replace("doc__component_name", "") i = 0 @@ -1136,7 +1136,7 @@ docs/modules/communication/components for need in needs.filter_types(["document"]): if "template" in need["tags"] and "PROCESS" in need["id"] and "component_name" in need["id"]: - act_id = need["id"].replace("PROCESS_doc__component_name", "") + act_id = need["id"].replace("doc__component_name", "") i = 0 @@ -1190,7 +1190,7 @@ docs/modules/feo/components for need in needs.filter_types(["document"]): if "template" in need["tags"] and "PROCESS" in need["id"] and "component_name" in need["id"]: - act_id = need["id"].replace("PROCESS_doc__component_name", "") + act_id = need["id"].replace("doc__component_name", "") i = 0 @@ -1244,7 +1244,7 @@ docs/modules/feo/components .. for need in needs.filter_types(["document"]): .. if "template" in need["tags"] and "PROCESS" in need["id"] and "component_name" in need["id"]: -.. act_id = need["id"].replace("PROCESS_doc__component_name", "") +.. act_id = need["id"].replace("doc__component_name", "") .. i = 0 @@ -1298,7 +1298,7 @@ docs/modules/logging/components for need in needs.filter_types(["document"]): if "template" in need["tags"] and "PROCESS" in need["id"] and "component_name" in need["id"]: - act_id = need["id"].replace("PROCESS_doc__component_name", "") + act_id = need["id"].replace("doc__component_name", "") i = 0 @@ -1352,7 +1352,7 @@ docs/modules/os/components for need in needs.filter_types(["document"]): if "template" in need["tags"] and "PROCESS" in need["id"] and "component_name" in need["id"]: - act_id = need["id"].replace("PROCESS_doc__component_name", "") + act_id = need["id"].replace("doc__component_name", "") i = 0 @@ -1406,7 +1406,7 @@ docs/modules/persistency/components for need in needs.filter_types(["document"]): if "template" in need["tags"] and "PROCESS" in need["id"] and "component_name" in need["id"]: - act_id = need["id"].replace("PROCESS_doc__component_name", "") + act_id = need["id"].replace("doc__component_name", "") i = 0 @@ -1460,7 +1460,7 @@ docs/modules/tracing/components for need in needs.filter_types(["document"]): if "template" in need["tags"] and "PROCESS" in need["id"] and "component_name" in need["id"]: - act_id = need["id"].replace("PROCESS_doc__component_name", "") + act_id = need["id"].replace("doc__component_name", "") i = 0 diff --git a/docs/platform_management_plan/index.rst b/docs/platform_management_plan/index.rst index e3a23a4ced..37853df095 100644 --- a/docs/platform_management_plan/index.rst +++ b/docs/platform_management_plan/index.rst @@ -16,7 +16,7 @@ :id: doc__platform_mgt_plan :status: draft :safety: ASIL_B - :realizes: PROCESS_wp__platform_mgmt + :realizes: wp__platform_mgmt :tags: platform_management Platform Management Plan diff --git a/docs/platform_management_plan/problem_resolution.rst b/docs/platform_management_plan/problem_resolution.rst index 2ae3371845..a641e2f480 100644 --- a/docs/platform_management_plan/problem_resolution.rst +++ b/docs/platform_management_plan/problem_resolution.rst @@ -18,12 +18,12 @@ :safety: ASIL_B :security: YES :tags: platform_management - :realizes: PROCESS_wp__prm_plan + :realizes: wp__prm_plan Problem Resolution / Problem Resolution Plan -------------------------------------------- -This document implements parts of the :need:`PROCESS_wp__platform_mgmt`. +This document implements parts of the :need:`wp__platform_mgmt`. Purpose +++++++ @@ -64,14 +64,14 @@ problem reported within **S-CORE**. The next figure gives an overview, how problems are created in **S-CORE**. An ISSUE is used to create a problem report including required attributes as defined in the -:need:`Problem Process Requirements `. +:need:`Problem Process Requirements `. .. figure:: _assets/score_problem_resolution_overview.drawio.svg :width: 100% :align: center :alt: Problem Resolution Overview -Therefore the Problem Template :need:`PROCESS_gd_temp__problem_template` shall be used. +Therefore the Problem Template :need:`gd_temp__problem_template` shall be used. .. note:: The template is automatically included in the ISSUE **Problem Report**. @@ -86,9 +86,9 @@ Problem Resolution Attributes ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The Problem Problem Resolution Process Requirements are implemented as follows: -:need:`[[title]] ` is identical to the ISSUE number. +:need:`[[title]] ` is identical to the ISSUE number. -:need:`[[title]] ` is defined by the combination of the ISSUE state +:need:`[[title]] ` is defined by the combination of the ISSUE state and the state in the Projects dashboard view. The PR status is also used, if applicable. .. list-table:: Problem Status @@ -120,9 +120,9 @@ and the state in the Projects dashboard view. The PR status is also used, if app - na - na -:need:`[[title]] ` is identical to the ISSUE title. +:need:`[[title]] ` is identical to the ISSUE title. -:need:`[[title]] ` is provided in the Description +:need:`[[title]] ` is provided in the Description part of the ISSUE. Add here the root cause and impact of the problem. Optionally state, who has to be informed or notified, if applicable, e.g. Safety Manager of a feature. @@ -135,15 +135,15 @@ part of the ISSUE. To provide solutions, use the Solution part of the ISSUE. -:need:`[[title]] ` is provided in the analysis +:need:`[[title]] ` is provided in the analysis results part of the ISSUE. State here, if the problem is accepted or rejected. Safety/Security experts must confirm or disconfirm, if safety/security is affected is set correctly -:need:`[[title]] ` are provided in the Assignees part of +:need:`[[title]] ` are provided in the Assignees part of the ISSUE. In addition you can use pre-defined labels for Communities or Feature Teams (Feature Owner) (under discussion, compare https://github.com/eclipse-score/score/issues/870). -:need:`[[title]] ` is provided in the Classification +:need:`[[title]] ` is provided in the Classification part of the ISSUE. Select one of provided identifiers: .. list-table:: Problem Classification @@ -162,8 +162,8 @@ part of the ISSUE. Select one of provided identifiers: - ``blocker`` -:need:`[[title]] `, -:need:`[[title]] ` are provided in the Category +:need:`[[title]] `, +:need:`[[title]] ` are provided in the Category part of the ISSUE. Combinations of them are allowed. If nothing is selected, Quality is affected by default. @@ -171,7 +171,7 @@ Combinations of them are allowed. If nothing is selected, Quality is affected by Use the ASIL classification part of the ISSUE to document the ASIL level concerned, e.g. ASIL_B. -:need:`[[title]] ` is provided in the Expected Closure +:need:`[[title]] ` is provided in the Expected Closure Version part of the ISSUE. Optionally the Milestone part of the ISSUE can be set. @@ -187,7 +187,7 @@ In general, every Problem Resolution follows the following steps: * 3. Initiate the implementation of the Problem Resolution and track it to closure (yellow color) * 3. Close Problem Resolution (purple color) -:need:`PROCESS_gd_guidl__problem_problem` can give additional help. +:need:`gd_guidl__problem_problem` can give additional help. **To 1. Create the Problem Report:** @@ -221,8 +221,8 @@ set the ISSUE status to ``Closed as not planned``. **To 2. Analyze the Problem Report:** -The Problem Report is reviewed and analyzed from the :need:`Committer ` and the -review results are resolved by the :need:`Contributor `. The results +The Problem Report is reviewed and analyzed from the :need:`Committer ` and the +review results are resolved by the :need:`Contributor `. The results are documented in the ISSUE. As long as the information is not sufficient, the related ISSUE is kept in status ``Open`` and Projects status ``Todo``, means ``in review``. @@ -232,10 +232,10 @@ ISSUE status is kept ``Open`` and the Projects status is set to ``In Progress``. The decision, if the problem is accepted or rejected must be documented. Safety/Security experts must confirm or disconfirm, if safety/security is affected is set correctly. -:need:`PROCESS_gd_chklst__problem_cr_review` can help to verify whether the information is complete. +:need:`gd_chklst__problem_cr_review` can help to verify whether the information is complete. -In case affected parties need to be informed :need:`Technical Lead ` or -:need:`Module Lead ` will notify them, either updating the Assignees or +In case affected parties need to be informed :need:`Technical Lead ` or +:need:`Module Lead ` will notify them, either updating the Assignees or adding labels for community or feature teams. Otherwise, if no Problem Resolution is planned, the problem is rejected. To reject the Problem @@ -244,7 +244,7 @@ Report: Problem status: ``rejected`` set the ISSUE status to ``Closed as not pla **To 3. Initiate and Monitor the Problem Resolution:** -:need:`Contributor ` starts all required activities to resolve the problem. +:need:`Contributor ` starts all required activities to resolve the problem. These may include starting Change Requests or in general planning activities by creating ISSUEs and required PRs. @@ -254,8 +254,8 @@ monitoring of the activities. All activities defined are tracked until closure, means that all linked ISSUEs or PRs are closed or merged, respectively. -If all are closed or merged :need:`Contributor ` sets Projects status to -``Done`` to trigger the final review from the :need:`Committer ` to close +If all are closed or merged :need:`Contributor ` sets Projects status to +``Done`` to trigger the final review from the :need:`Committer ` to close the Problem Resolution. The Problem Resolution may also rejected in this phase, then the ISSUE status is set to @@ -263,13 +263,13 @@ The Problem Resolution may also rejected in this phase, then the ISSUE status is **To 4. Close the Problem Resolution:** -:need:`Committer ` checks finally if the problem is completely resolved. In +:need:`Committer ` checks finally if the problem is completely resolved. In this case all linked ISSUEs or PRs are closed or merged, respectively. Especially the solution measures must be checked for their effectiveness and the argumentation is convincing. -:need:`PROCESS_gd_chklst__problem_cr_review` can help to verify whether it can be closed. +:need:`gd_chklst__problem_cr_review` can help to verify whether it can be closed. If this is the case the ISSUE status is set to ``Closed``, otherwise the Projects status is set back to ``In Progress``. diff --git a/docs/platform_management_plan/project_management.rst b/docs/platform_management_plan/project_management.rst index 19888fbb2e..ef5c0c3fa6 100644 --- a/docs/platform_management_plan/project_management.rst +++ b/docs/platform_management_plan/project_management.rst @@ -17,7 +17,7 @@ :status: draft :safety: ASIL_B :security: YES - :realizes: PROCESS_wp__project_mgt + :realizes: wp__project_mgt :tags: platform_management Project management plan diff --git a/docs/platform_management_plan/quality_management.rst b/docs/platform_management_plan/quality_management.rst index 8eb3011c8c..fac7d1161b 100644 --- a/docs/platform_management_plan/quality_management.rst +++ b/docs/platform_management_plan/quality_management.rst @@ -20,7 +20,7 @@ Quality Management / Platform Quality Management Plan :status: valid :safety: ASIL_B :security: YES - :realizes: PROCESS_wp__qms_plan + :realizes: wp__qms_plan :tags: platform_management Purpose @@ -37,9 +37,9 @@ of the workflows. Statement of Independence ------------------------- -The :need:`PROCESS_rl__quality_manager` provides support to the project by consulting on quality improvements +The :need:`rl__quality_manager` provides support to the project by consulting on quality improvements for the project/platform product. The Quality Manager is independent of the product delivery process. The quality report -is approved by the :need:`PROCESS_rl__project_lead`. +is approved by the :need:`rl__project_lead`. .. image:: _assets/score_project_organisation.drawio.svg :width: 900 @@ -122,37 +122,37 @@ Objectives and scope - :need:`stkh_req__dependability__automotive_safety`, :doc:`../requirements/stakeholder/index` - 100% of the Platform process audit has be done for every release - Delta audit allowed to achieve 100% - - Ensured by the process quality management, :need:`PROCESS_wf__exe_pltprocess_audit` - Platform process audit is available + - Ensured by the process quality management, :need:`wf__exe_pltprocess_audit` - Platform process audit is available * - 2 - One process conformance check for every feature release - :need:`stkh_req__dependability__automotive_safety`, :doc:`../requirements/stakeholder/index` - One process conformance check has been done for every stable feature release - Feature is released as experimental - - Ensured by the process quality and tool management, :need:`PROCESS_wp__qms_report` - Process conformance is available + - Ensured by the process quality and tool management, :need:`wp__qms_report` - Process conformance is available * - 3 - Only quality-assured project/platform work products are delivered to the community - :need:`stkh_req__dependability__automotive_safety`, :doc:`../requirements/stakeholder/index` - 100% of project/platform work products are quality-assured - Feature is released as experimental - - Ensured by the process quality and tool management, :need:`PROCESS_wp__verification_platform_ver_report` - Work products contain the verification of the quality assurance + - Ensured by the process quality and tool management, :need:`wp__verification_platform_ver_report` - Work products contain the verification of the quality assurance * - 4 - Only quality-assured project/platform releases are delivered to the community - :need:`stkh_req__dependability__automotive_safety`, :doc:`../requirements/stakeholder/index` - 100% of project/platform releases delivered to the community are quality-assured - Feature is released as experimental - - Ensured by the process release management, :need:`PROCESS_wp__platform_sw_release_note` contain the verification and approval of the quality-assurance + - Ensured by the process release management, :need:`wp__platform_sw_release_note` contain the verification and approval of the quality-assurance * - 5 - - Only quality-trained personnel are part of the :need:`PROCESS_rl__committer` + - Only quality-trained personnel are part of the :need:`rl__committer` - :need:`stkh_req__dependability__automotive_safety`, :doc:`../requirements/stakeholder/index` - - 100% of personnel are trained as per committer role description in :need:`PROCESS_rl__committer` + - 100% of personnel are trained as per committer role description in :need:`rl__committer` - None - - Ensured by the process platform management, :need:`PROCESS_wp__training_path` contain the training material and evidences for conducted trainings + - Ensured by the process platform management, :need:`wp__training_path` contain the training material and evidences for conducted trainings * - 6 - No overdue quality assurance closure activities - :need:`stkh_req__dependability__automotive_safety`, :doc:`../requirements/stakeholder/index` - 100% of the quality improvement, non-conformance issues are closed - None - - Ensured by the process quality management, :need:`PROCESS_wp__issue_track_system` contain improvements and non-conformance + - Ensured by the process quality management, :need:`wp__issue_track_system` contain improvements and non-conformance 3.4 Work Product Quality Goals @@ -221,7 +221,8 @@ The project roles are defined in the processes and are aligned to Eclipse roles. **Skills** -The main quality related project roles are the :need:`PROCESS_rl__quality_manager` and the :need:`PROCESS_rl__project_lead`. These also have to have +The main quality related project roles are the :need:`rl__quality_manager` and the :need:`rl__project_lead`. These also have to have + the (Eclipse) committer role. As defined in `Committer Training `_ the committers are elected in a meritocratic manner, meaning those have to show their skills and understanding of the project processes in several previous pull requests. @@ -231,18 +232,19 @@ his knowledge in quality SW development by: - by attending the project's ASPICE 4.0 SW management and development training. -The successful checking of the committers' skills and the independent roles is ensured by the :need:`PROCESS_rl__project_lead` -and :need:`PROCESS_rl__quality_manager` who record/check this in the role assignment document. +The successful checking of the committers' skills and the independent roles is ensured by the :need:`rl__project_lead` +and :need:`rl__quality_manager` who record/check this in the role assignment document. -.. note:: The identity of the committer by applying the GitHub digital signature mechanism will be used to confirm the authenticity of the :need:`PROCESS_rl__quality_manager` role for the approvals +.. note:: The identity of the committer by applying the GitHub digital signature mechanism will be used to confirm the authenticity of the :need:`rl__quality_manager` role for the approvals 4 Quality Management Planning ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 4.1 Quality Resources """""""""""""""""""""" -Dedicated :need:`PROCESS_rl__quality_manager` are elected, following a methodology as done for the committers, which means in a meritocratic manner on project level. -The :need:`PROCESS_rl__quality_manager`, supported by the :need:`PROCESS_rl__project_lead`, and all other stakeholders, +Dedicated :need:`rl__quality_manager` are elected, following a methodology as done for the committers, which means in a meritocratic manner on project level. + +The :need:`rl__quality_manager`, supported by the :need:`rl__project_lead`, and all other stakeholders, will ensure that quality activities are actively planned, developed, analyzed, verified, tested, and managed throughout the life cycle of the project. Resources and milestones are planned in Github Issues for all activities. Resource and @@ -268,19 +270,19 @@ Ad-hoc quality related meetings are set up for clarification topics. **Reporting** -The quality management status :need:`PROCESS_wp__qms_report` is reported as defined in the platform management plan. +The quality management status :need:`wp__qms_report` is reported as defined in the platform management plan. **Escalation** -If needed a escalation can be done in three steps. First :need:`PROCESS_rl__quality_manager` shall escalate to -the :need:`PROCESS_rl__project_lead`. Then to the project lead circle, documented in :need:`doc__project_mgt_plan`. +If needed a escalation can be done in three steps. First :need:`rl__quality_manager` shall escalate to +the :need:`rl__project_lead`. Then to the project lead circle, documented in :need:`doc__project_mgt_plan`. Finally to the Eclipse Foundation if the rules of the Eclipse handbook are not followed. **Examples for valid escalation causes are:** -- Conflict between :need:`PROCESS_rl__quality_manager` and :need:`PROCESS_rl__committer` regarding quality issues. +- Conflict between :need:`rl__quality_manager` and :need:`rl__committer` regarding quality issues. - Quality issues cannot be resolved on feature level or with the available resources. -- There are conflicting points of view between the :need:`PROCESS_rl__project_lead`, :need:`PROCESS_rl__safety_manager`, :need:`PROCESS_rl__security_manager` and the :need:`PROCESS_rl__quality_manager`. +- There are conflicting points of view between the :need:`rl__project_lead`, :need:`rl__safety_manager`, :need:`rl__security_manager` and the :need:`rl__quality_manager`. 4.3 Quality Management Specifics ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -294,155 +296,155 @@ None * - Workproduct Id - Link to WP - * - :need:`PROCESS_wp__chm_plan` + * - :need:`wp__chm_plan` - :ref:`project_documents_list` - * - :need:`PROCESS_wp__cmpt_request` + * - :need:`wp__cmpt_request` - :ref:`documents_docs_modules_components` - * - :need:`PROCESS_wp__component_arch` + * - :need:`wp__component_arch` - :ref:`documents_docs_modules_components` - * - :need:`PROCESS_wp__document_mgt_plan` + * - :need:`wp__document_mgt_plan` - :ref:`project_documents_list` - * - :need:`PROCESS_wp__fdr_reports` + * - :need:`wp__fdr_reports` - :ref:`documents_docs_modules` - * - :need:`PROCESS_wp__feat_request` + * - :need:`wp__feat_request` - :ref:`documents_docs_features` - * - :need:`PROCESS_wp__feature_arch` + * - :need:`wp__feature_arch` - :ref:`documents_docs_features` - * - :need:`PROCESS_wp__feature_dfa` + * - :need:`wp__feature_dfa` - :ref:`documents_docs_features` - * - :need:`PROCESS_wp__module_safety_manual` + * - :need:`wp__module_safety_manual` - :ref:`documents_docs_modules` - * - :need:`PROCESS_wp__module_safety_package` + * - :need:`wp__module_safety_package` - :ref:`documents_docs_modules` - * - :need:`PROCESS_wp__module_safety_plan` + * - :need:`wp__module_safety_plan` - :ref:`documents_docs_modules` - * - :need:`PROCESS_wp__module_sw_release_note` + * - :need:`wp__module_sw_release_note` - :ref:`documents_docs_modules` - * - :need:`PROCESS_wp__module_sw_release_plan` + * - :need:`wp__module_sw_release_plan` - :ref:`documents_docs_modules` - * - :need:`PROCESS_wp__platform_dfa` + * - :need:`wp__platform_dfa` - :ref:`project_documents_list` - * - :need:`PROCESS_wp__platform_safety_manual` + * - :need:`wp__platform_safety_manual` - :ref:`project_documents_list` - * - :need:`PROCESS_wp__platform_safety_plan` + * - :need:`wp__platform_safety_plan` - :ref:`project_documents_list` - * - :need:`PROCESS_wp__platform_safety_package` + * - :need:`wp__platform_safety_package` - :ref:`project_documents_list` - * - :need:`PROCESS_wp__platform_sw_build_config` + * - :need:`wp__platform_sw_build_config` - :ref:`project_documents_list` - * - :need:`PROCESS_wp__platform_sw_release_note` + * - :need:`wp__platform_sw_release_note` - :ref:`project_documents_list` - * - :need:`PROCESS_wp__platform_sw_release_plan` + * - :need:`wp__platform_sw_release_plan` - :ref:`project_documents_list` - * - :need:`PROCESS_wp__prm_plan` + * - :need:`wp__prm_plan` - :ref:`project_documents_list` - * - :need:`PROCESS_wp__process_description` - - :need:`PROCESS_wp__process_description` + * - :need:`wp__process_description` + - :need:`wp__process_description` - * - :need:`PROCESS_wp__process_impr_report` + * - :need:`wp__process_impr_report` - :ref:`project_documents_list` - * - :need:`PROCESS_wp__process_strategy` - - :need:`PROCESS_wp__process_strategy` + * - :need:`wp__process_strategy` + - :need:`wp__process_strategy` - * - :need:`PROCESS_wp__project_mgt` + * - :need:`wp__project_mgt` - :ref:`project_documents_list` - * - :need:`PROCESS_wp__qms_plan` + * - :need:`wp__qms_plan` - :ref:`project_documents_list` - * - :need:`PROCESS_wp__qms_report` + * - :need:`wp__qms_report` - :ref:`project_documents_list` - * - :need:`PROCESS_wp__requirements_comp` + * - :need:`wp__requirements_comp` - :ref:`documents_docs_modules_components` - * - :need:`PROCESS_wp__requirements_comp_aou` + * - :need:`wp__requirements_comp_aou` - :ref:`documents_docs_modules_components` - * - :need:`PROCESS_wp__requirements_feat` + * - :need:`wp__requirements_feat` - :ref:`documents_docs_features` - * - :need:`PROCESS_wp__requirements_feat_aou` + * - :need:`wp__requirements_feat_aou` - :ref:`documents_docs_features` - * - :need:`PROCESS_wp__requirements_inspect` + * - :need:`wp__requirements_inspect` - :ref:`project_documents_list`, :ref:`documents_docs_modules` - * - :need:`PROCESS_wp__requirements_stkh` + * - :need:`wp__requirements_stkh` - :ref:`project_documents_list` - * - :need:`PROCESS_wp__sw_arch_verification` + * - :need:`wp__sw_arch_verification` - :ref:`project_documents_list`, :ref:`documents_docs_modules` - * - :need:`PROCESS_wp__sw_component_class` + * - :need:`wp__sw_component_class` - :ref:`documents_docs_modules_components` - * - :need:`PROCESS_wp__sw_component_dfa` + * - :need:`wp__sw_component_dfa` - :ref:`documents_docs_modules_components` - * - :need:`PROCESS_wp__sw_component_fmea` + * - :need:`wp__sw_component_fmea` - :ref:`documents_docs_modules_components` - * - :need:`PROCESS_wp__sw_component_dfa` + * - :need:`wp__sw_component_dfa` - :ref:`documents_docs_modules_components` - * - :need:`PROCESS_wp__sw_development_plan` + * - :need:`wp__sw_development_plan` - :ref:`project_documents_list` - * - :need:`PROCESS_wp__sw_implementation` + * - :need:`wp__sw_implementation` - :ref:`documents_docs_modules_components` - * - :need:`PROCESS_wp__sw_implementation_inspection` + * - :need:`wp__sw_implementation_inspection` - :ref:`documents_docs_modules_components` - * - :need:`PROCESS_wp__tailoring` + * - :need:`wp__tailoring` - :ref:`project_documents_list`, :ref:`documents_docs_features`, :ref:`documents_docs_modules_components` - * - :need:`PROCESS_wp__tlm_plan` + * - :need:`wp__tlm_plan` - :ref:`project_documents_list` - * - :need:`PROCESS_wp__tool_verification_report` + * - :need:`wp__tool_verification_report` - :ref:`project_documents_list` - * - :need:`PROCESS_wp__verification_comp_int_test` + * - :need:`wp__verification_comp_int_test` - :ref:`documents_docs_modules_components` - * - :need:`PROCESS_wp__verification_feat_int_test` + * - :need:`wp__verification_feat_int_test` - :ref:`documents_docs_features` - * - :need:`PROCESS_wp__verification_module_ver_report` + * - :need:`wp__verification_module_ver_report` - :ref:`documents_docs_modules` - * - :need:`PROCESS_wp__verification_plan` + * - :need:`wp__verification_plan` - :ref:`project_documents_list`, :ref:`documents_docs_features`, :ref:`documents_docs_modules_components` - * - :need:`PROCESS_wp__verification_platform_test` + * - :need:`wp__verification_platform_int_test` - :ref:`project_documents_list` - * - :need:`PROCESS_wp__verification_platform_ver_report` + * - :need:`wp__verification_platform_ver_report` - :ref:`project_documents_list` - * - :need:`PROCESS_wp__verification_sw_unit_test` + * - :need:`wp__verification_sw_unit_test` - :ref:`documents_docs_modules_components` diff --git a/docs/platform_management_plan/release_management.rst b/docs/platform_management_plan/release_management.rst index 50a6f286cf..28f999e00e 100644 --- a/docs/platform_management_plan/release_management.rst +++ b/docs/platform_management_plan/release_management.rst @@ -22,7 +22,7 @@ Release management Plan ----------------------- -This document implements parts of the :need:`PROCESS_wp__platform_mgmt`. +This document implements parts of the :need:`wp__platform_mgmt`. Purpose +++++++ @@ -64,14 +64,14 @@ defined in :need:`doc__project_mgt_plan`. * **Experimental** means that the development artifacts needed for the safety package work products may be incomplete. These releases are done during development phase to be able to sync between the module repositories. * **Official** means that the processes are fully executed to produce all work products and are documented - with a release note as in :need:`PROCESS_gd_temp__rel_plat_rel_note` or :need:`PROCESS_gd_temp__rel_mod_rel_note`. + with a release note as in :need:`gd_temp__rel_plat_rel_note` or :need:`gd_temp__rel_mod_rel_note`. For an official release also consider `Eclipse Project Handbook - Releases `_. Release Planning and Execution ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Generally release planning and execution is described in :need:`PROCESS_wf__rel_mod_rel_note` process. +Generally release planning and execution is described in :need:`wf__rel_mod_rel_note` process. It is part of project planning and therefore also documented with the same means. Generally a Release is planned as an issue linked to a milestone in the `GitHub Milestone Planning `_. And this issue is closed by merging a pull request which creates/updates a release note. diff --git a/docs/platform_management_plan/safety_management.rst b/docs/platform_management_plan/safety_management.rst index f6249b6249..79ec8014d9 100644 --- a/docs/platform_management_plan/safety_management.rst +++ b/docs/platform_management_plan/safety_management.rst @@ -17,7 +17,7 @@ :status: draft :safety: ASIL_B :security: NO - :realizes: PROCESS_wp__platform_safety_plan,PROCESS_wp__tailoring + :realizes: wp__platform_safety_plan,wp__tailoring :tags: platform_management Safety management / Platform Safety Plan @@ -70,7 +70,7 @@ Regarding the platform specifics: The SW platform functionality consists of features, which are based on a set of requirements and are developed in parallel. These features are developed into SW components contained in "modules", which are another set of SEooCs (initiated by a change request). -A template exists to guide this: :need:`PROCESS_gd_temp__module_safety_plan`. +A template exists to guide this: :need:`gd_temp__module_safety_plan`. Tailoring ^^^^^^^^^ @@ -83,13 +83,13 @@ Tailoring of safety activities: The following ISO 26262 defined safety work products are not relevant for the S-CORE SW platform development: -* Because these are in responsibility of the system integrator: :need:`PROCESS_std_wp__iso26262__management_751`, - :need:`PROCESS_std_wp__iso26262__system_652`, :need:`PROCESS_std_wp__iso26262__system_653`, :need:`PROCESS_std_wp__iso26262__system_654`, - :need:`PROCESS_std_wp__iso26262__system_655`, :need:`PROCESS_std_wp__iso26262__system_656`, :need:`PROCESS_std_wp__iso26262__system_657`, - :need:`PROCESS_std_wp__iso26262__system_751`, :need:`PROCESS_std_wp__iso26262__system_752`, :need:`PROCESS_std_wp__iso26262__system_851`, - :need:`PROCESS_std_wp__iso26262__system_852` +* Because these are in responsibility of the system integrator: :need:`std_wp__iso26262__management_751`, + :need:`std_wp__iso26262__system_652`, :need:`std_wp__iso26262__system_653`, :need:`std_wp__iso26262__system_654`, + :need:`std_wp__iso26262__system_655`, :need:`std_wp__iso26262__system_656`, :need:`std_wp__iso26262__system_657`, + :need:`std_wp__iso26262__system_751`, :need:`std_wp__iso26262__system_752`, :need:`std_wp__iso26262__system_851`, + :need:`std_wp__iso26262__system_852` - Note that stakeholder requirements (:need:`PROCESS_std_wp__iso26262__system_651`) are in scope of the project, + Note that stakeholder requirements (:need:`std_wp__iso26262__system_651`) are in scope of the project, to be able to cover System and HW related failures which are usually covered by SW (e.g. end to end protection for ECU external communication). But those are the "Assumed Technical Safety Requirements" of the SW platform SEooC and do not need to be tested by SEooC supplier. I.e. the system testing is out of scope. Note that S-CORE will implement platform test of stakeholder requirements for demonstration, @@ -99,36 +99,36 @@ The following ISO 26262 defined safety work products are not relevant for the S But if these are sufficiently also covering the TSRs must be analyzed and decided by the user. * Also tailored out is the SW testing on the target, as the S-CORE project can only test on reference HW - (part of SW integration testing). So these are not relevant: :need:`PROCESS_std_wp__iso26262__software_1151`, :need:`PROCESS_std_wp__iso26262__software_1152` + (part of SW integration testing). So these are not relevant: :need:`std_wp__iso26262__software_1151`, :need:`std_wp__iso26262__software_1152` -* Because there is no calibration used for the S-CORE SW platform components, only configuration: :need:`PROCESS_std_wp__iso26262__software_app_c_52`, - :need:`PROCESS_std_wp__iso26262__software_app_c_54`, :need:`PROCESS_std_wp__iso26262__software_app_c_57` +* Because there is no calibration used for the S-CORE SW platform components, only configuration: :need:`std_wp__iso26262__software_app_c_52`, + :need:`std_wp__iso26262__software_app_c_54`, :need:`std_wp__iso26262__software_app_c_57` * Because distributed development is not how the project is organized. All contributors are seen as part of the project team. - When used, OSS components are qualified and external SEooCs are integrated in the project scope: :need:`PROCESS_std_wp__iso26262__support_551`, - :need:`PROCESS_std_wp__iso26262__support_552`, :need:`PROCESS_std_wp__iso26262__support_553`, :need:`PROCESS_std_wp__iso26262__support_554`, :need:`PROCESS_std_wp__iso26262__support_555` + When used, OSS components are qualified and external SEooCs are integrated in the project scope: :need:`std_wp__iso26262__support_551`, + :need:`std_wp__iso26262__support_552`, :need:`std_wp__iso26262__support_553`, :need:`std_wp__iso26262__support_554`, :need:`std_wp__iso26262__support_555` -* Because in the S-CORE SW platform HW elements are out of scope: :need:`PROCESS_std_wp__iso26262__support_1351`, :need:`PROCESS_std_wp__iso26262__support_1352`, :need:`PROCESS_std_wp__iso26262__support_1353` +* Because in the S-CORE SW platform HW elements are out of scope: :need:`std_wp__iso26262__support_1351`, :need:`std_wp__iso26262__support_1352`, :need:`std_wp__iso26262__support_1353` -* Because in the S-CORE SW platform a proven in use argument will not be applied: :need:`PROCESS_std_wp__iso26262__support_1451`, :need:`PROCESS_std_wp__iso26262__support_1452` +* Because in the S-CORE SW platform a proven in use argument will not be applied: :need:`std_wp__iso26262__support_1451`, :need:`std_wp__iso26262__support_1452` -* Because in the S-CORE SW platform interfacing of out of scope of ISO 26262 applications is not planned: :need:`PROCESS_std_wp__iso26262__support_1551` +* Because in the S-CORE SW platform interfacing of out of scope of ISO 26262 applications is not planned: :need:`std_wp__iso26262__support_1551` -* Because in the S-CORE SW platform integration of safety-related systems not developed according to ISO 26262 is not planned: :need:`PROCESS_std_wp__iso26262__support_1651` +* Because in the S-CORE SW platform integration of safety-related systems not developed according to ISO 26262 is not planned: :need:`std_wp__iso26262__support_1651` -* Because in the S-CORE SW platform no ASIL decomposition is planned: :need:`PROCESS_std_wp__iso26262__analysis_551`, :need:`PROCESS_std_wp__iso26262__analysis_552` +* Because in the S-CORE SW platform no ASIL decomposition is planned: :need:`std_wp__iso26262__analysis_551`, :need:`std_wp__iso26262__analysis_552` * Because HSI is coming from HW (and systems) engineering which are not part of S-CORE and the standard only asks for refinement during SW development. As the input is missing, there is nothing to refine. Expectations towards the HW/Environment are covered by AoUs. Additionally S-CORE only provides reference HW integration, - so every user of the platform would have to redo the effort anyway: :need:`PROCESS_std_wp__iso26262__software_652` + so every user of the platform would have to redo the effort anyway: :need:`std_wp__iso26262__software_652` -* Because the SW platform is not an safety item but an element: :need:`PROCESS_std_wp__iso26262__management_651` +* Because the SW platform is not an safety item but an element: :need:`std_wp__iso26262__management_651` But also some activities based on requirements defining what has to be done to create a workproduct which is in scope of the S-CORE platform are tailored: -* Because those are not relevant for ASIL_B: :need:`PROCESS_std_req__iso26262__system_6423`, - :need:`PROCESS_std_req__iso26262__system_6424`, :need:`PROCESS_std_req__iso26262__system_6425` +* Because those are not relevant for ASIL_B: :need:`std_req__iso26262__system_6423`, + :need:`std_req__iso26262__system_6424`, :need:`std_req__iso26262__system_6425` Approach ++++++++ @@ -195,9 +195,9 @@ One important aspect to this is, that we ensure the identity of the committer by Functional Safety Resources ^^^^^^^^^^^^^^^^^^^^^^^^^^^ -A dedicated safety manager is elected by :need:`PROCESS_rl__project_lead` for all the S-CORE SEooCs development. +A dedicated safety manager is elected by :need:`rl__project_lead` for all the S-CORE SEooCs development. -The safety manager, supported by the project manager (i.e. the :need:`PROCESS_rl__technical_lead`), will ensure that +The safety manager, supported by the project manager (i.e. the :need:`rl__technical_lead`), will ensure that safety activities are actively planned, developed, analyzed, verified and tested and managed throughout the life cycle of the project. As all the implementation of safety functions takes place within module development, there is a safety manager appointed in the module's safety plan. @@ -227,15 +227,15 @@ To exchange general information and to clarify general topics the following comm The safety management status is reported in the Technical Lead Circle Meeting which is defined in :need:`doc__project_mgt_plan`. The status report is based on safety plans work product lists (see below) and verification reports on platform and module level: -* :need:`PROCESS_wp__platform_safety_plan` -* :need:`PROCESS_wp__module_safety_plan` -* :need:`PROCESS_wp__verification_platform_ver_report` -* :need:`PROCESS_wp__verification_module_ver_report` +* :need:`wp__platform_safety_plan` +* :need:`wp__module_safety_plan` +* :need:`wp__verification_platform_ver_report` +* :need:`wp__verification_module_ver_report` *Escalation* -* :need:`PROCESS_rl__safety_manager` to :need:`PROCESS_rl__technical_lead` -* :need:`PROCESS_rl__technical_lead` to :need:`PROCESS_rl__project_lead` +* :need:`rl__safety_manager` to :need:`rl__technical_lead` +* :need:`rl__technical_lead` to :need:`rl__project_lead` Examples for valid escalation causes are: @@ -245,7 +245,7 @@ Examples for valid escalation causes are: Functional Safety Management Life Cycle ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The safety lifecycle of the S-CORE project is initiated at the project set-up and driven and maintained by the safety manager supported by the :need:`PROCESS_rl__process_community`. +The safety lifecycle of the S-CORE project is initiated at the project set-up and driven and maintained by the safety manager supported by the :need:`rl__process_community`. Note that the Eclipse Foundation also defines `project phases `_. Eclipse definition is more about the process maturity for the whole project, if we are in Mature Phase, we latest will have the project lifecycle as defined in our process description. Nevertheless, Safety Development and even Safety Case release is independent from Mature and Incubation Phase as the completeness and appropriateness of the platform process and artifacts @@ -255,11 +255,11 @@ Functional Safety Requirements ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Requirement Engineering is defined in the process description. See :need:`doc__project_mgt_plan`. -The application of ISO 26262 standards requirements is realized by defining process guidances and matching those to the ISO 26262 requirements (see e.g. for example :need:`PROCESS_gd_req__safety_doc_status`). +The application of ISO 26262 standards requirements is realized by defining process guidances and matching those to the ISO 26262 requirements (see e.g. for example :need:`gd_req__safety_doc_status`). Functional Safety Schedule ^^^^^^^^^^^^^^^^^^^^^^^^^^ -The schedule is defined in section "Platform Safety Plan" below, but also within each module safety plan. See linked issues below and in :need:`PROCESS_gd_temp__module_safety_plan`. +The schedule is defined in section "Platform Safety Plan" below, but also within each module safety plan. See linked issues below and in :need:`gd_temp__module_safety_plan`. Functional Safety Development ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -275,7 +275,7 @@ The platform management plan defines :doc:`tool_management` Functional Safety Work Products ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The work products relevant for a module development is defined within each module safety management plan. See :need:`PROCESS_gd_temp__module_safety_plan`. +The work products relevant for a module development is defined within each module safety management plan. See :need:`gd_temp__module_safety_plan`. Generic project wide work products are defined below. Functional Safety Quality Criteria @@ -298,172 +298,172 @@ Functional Safety Management SW Platform Work Products - Link to WP - WP status - * - :need:`PROCESS_wp__policies` + * - :need:`wp__policies` - n/a (comes from outside the project) - n/a - n/a - `Eclipse Foundation Project Handbook: `_ - RELEASED - * - :need:`PROCESS_wp__training_path` + * - :need:`wp__training_path` - n/a - n/a - n/a - not open sourced - to be shown to assessor - * - :need:`PROCESS_wp__qms_plan` - - :need:`PROCESS_wf__platform_cr_mt_platform_mgmt_plan` - - :ndf:`copy('status', need_id='PROCESS_wf__platform_cr_mt_platform_mgmt_plan')` + * - :need:`wp__qms_plan` + - :need:`wf__platform_cr_mt_platform_mgmt_plan` + - :ndf:`copy('status', need_id='wf__platform_cr_mt_platform_mgmt_plan')` - `#316 `_ - :doc:`quality_management` - not started - * - :need:`PROCESS_wp__issue_track_system` + * - :need:`wp__issue_track_system` - :doc:`index` - :ndf:`copy('status', need_id='doc__platform_mgt_plan')` - n/a - `Project issues `_ - established - * - :need:`PROCESS_wp__platform_mgmt` - - :need:`PROCESS_wf__platform_cr_mt_platform_mgmt_plan` - - :ndf:`copy('status', need_id='PROCESS_wf__platform_cr_mt_platform_mgmt_plan')` + * - :need:`wp__platform_mgmt` + - :need:`wf__platform_cr_mt_platform_mgmt_plan` + - :ndf:`copy('status', need_id='wf__platform_cr_mt_platform_mgmt_plan')` - `#540 `_ - :doc:`index` - :ndf:`copy('status', need_id='doc__platform_mgt_plan')` - * - :need:`PROCESS_wp__process_description` - - :need:`PROCESS_wf__def_app_process_description` - - :ndf:`copy('status', need_id='PROCESS_wf__def_app_process_description')` + * - :need:`wp__process_description` + - :need:`wf__def_app_process_description` + - :ndf:`copy('status', need_id='wf__def_app_process_description')` - `Process community issues `_ - `Process description `_ - - * - :need:`PROCESS_wp__process_impr_report` - - :need:`PROCESS_wf__mon_imp_process_description` - - :ndf:`copy('status', need_id='PROCESS_wf__mon_imp_process_description')` + * - :need:`wp__process_impr_report` + - :need:`wf__mon_imp_process_description` + - :ndf:`copy('status', need_id='wf__mon_imp_process_description')` - - - - * - :need:`PROCESS_wp__process_strategy` - - :need:`PROCESS_wf__cr_mt_process_mgt_strategy` - - :ndf:`copy('status', need_id='PROCESS_wf__cr_mt_process_mgt_strategy')` + * - :need:`wp__process_strategy` + - :need:`wf__cr_mt_process_mgt_strategy` + - :ndf:`copy('status', need_id='wf__cr_mt_process_mgt_strategy')` - `#232 `_ - `Process community issues `_ - - * - :need:`PROCESS_wp__platform_safety_plan` - - :need:`PROCESS_gd_guidl__saf_plan_definitions` - - :ndf:`copy('status', need_id='PROCESS_gd_guidl__saf_plan_definitions')` + * - :need:`wp__platform_safety_plan` + - :need:`gd_guidl__saf_plan_definitions` + - :ndf:`copy('status', need_id='gd_guidl__saf_plan_definitions')` - `#381 `_ - this document - see above - * - :need:`PROCESS_wp__platform_safety_package` - - :need:`PROCESS_gd_guidl__saf_package` - - :ndf:`copy('status', need_id='PROCESS_gd_guidl__saf_package')` + * - :need:`wp__platform_safety_package` + - :need:`gd_guidl__saf_package` + - :ndf:`copy('status', need_id='gd_guidl__saf_package')` - - - - * - :need:`PROCESS_wp__fdr_reports` (platform Safety Plan) - - :need:`PROCESS_gd_chklst__safety_plan` - - :ndf:`copy('status', need_id='PROCESS_gd_chklst__safety_plan')` + * - :need:`wp__fdr_reports` (platform Safety Plan) + - :need:`gd_chklst__safety_plan` + - :ndf:`copy('status', need_id='gd_chklst__safety_plan')` - - - - * - :need:`PROCESS_wp__fdr_reports` (platform Safety Package) - - :need:`PROCESS_gd_chklst__safety_package` - - :ndf:`copy('status', need_id='PROCESS_gd_chklst__safety_package')` + * - :need:`wp__fdr_reports` (platform Safety Package) + - :need:`gd_chklst__safety_package` + - :ndf:`copy('status', need_id='gd_chklst__safety_package')` - - - - * - :need:`PROCESS_wp__fdr_reports` (feature's Safety Analyses & DFA) + * - :need:`wp__fdr_reports` (feature's Safety Analyses & DFA) - Safety Analysis FDR tbd - - - - - * - :need:`PROCESS_wp__audit_report` + * - :need:`wp__audit_report` - performed by external experts - n/a - `#470 `_ - - intermediate - * - :need:`PROCESS_wp__feature_dfa` + * - :need:`wp__feature_dfa` - - - - - - * - :need:`PROCESS_wp__platform_sw_build_config` + * - :need:`wp__platform_sw_build_config` - :need:`doc__software_development_plan` - :ndf:`copy('status', need_id='doc__software_development_plan')` - - - - * - :need:`PROCESS_wp__platform_safety_manual` - - :need:`PROCESS_gd_temp__safety_manual` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__safety_manual')` + * - :need:`wp__platform_safety_manual` + - :need:`gd_temp__safety_manual` + - :ndf:`copy('status', need_id='gd_temp__safety_manual')` - - - - * - :need:`PROCESS_wp__platform_sw_release_note` - - :need:`PROCESS_gd_temp__rel_plat_rel_note` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__rel_plat_rel_note')` + * - :need:`wp__platform_sw_release_note` + - :need:`gd_temp__rel_plat_rel_note` + - :ndf:`copy('status', need_id='gd_temp__rel_plat_rel_note')` - - - - * - :need:`PROCESS_wp__verification_platform_ver_report` - - :need:`PROCESS_gd_temp__mod_ver_report` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__mod_ver_report')` + * - :need:`wp__verification_platform_ver_report` + - :need:`gd_temp__mod_ver_report` + - :ndf:`copy('status', need_id='gd_temp__mod_ver_report')` - - - - * - :need:`PROCESS_wp__requirements_stkh` - - :need:`PROCESS_gd_temp__req_stkh_req` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__req_stkh_req')` + * - :need:`wp__requirements_stkh` + - :need:`gd_temp__req_stkh_req` + - :ndf:`copy('status', need_id='gd_temp__req_stkh_req')` - n/a (done already) - :ref:`stakeholder_requirements` - - * - :need:`PROCESS_wp__sw_development_plan` - - :need:`PROCESS_wf__platform_cr_mt_platform_mgmt_plan` - - :ndf:`copy('status', need_id='PROCESS_wf__platform_cr_mt_platform_mgmt_plan')` + * - :need:`wp__sw_development_plan` + - :need:`wf__platform_cr_mt_platform_mgmt_plan` + - :ndf:`copy('status', need_id='wf__platform_cr_mt_platform_mgmt_plan')` - `#583 `_ - :need:`doc__software_development_plan` - :ndf:`copy('status', need_id='doc__software_development_plan')` - * - :need:`PROCESS_wp__verification_plan` - - :need:`PROCESS_wf__platform_cr_mt_platform_mgmt_plan` - - :ndf:`copy('status', need_id='PROCESS_wf__platform_cr_mt_platform_mgmt_plan')` + * - :need:`wp__verification_plan` + - :need:`wf__platform_cr_mt_platform_mgmt_plan` + - :ndf:`copy('status', need_id='wf__platform_cr_mt_platform_mgmt_plan')` - `#611 `_ - :need:`doc__verification_plan` - :ndf:`copy('status', need_id='doc__verification_plan')` - * - :need:`PROCESS_wp__tool_verification_report` + * - :need:`wp__tool_verification_report` - :need:`doc__platform_tool_management_plan` - :ndf:`copy('status', need_id='doc__platform_tool_management_plan')` - - - - * - :need:`PROCESS_wp__tailoring` (generic) - - :need:`PROCESS_gd_guidl__saf_plan_definitions` - - :ndf:`copy('status', need_id='PROCESS_gd_guidl__saf_plan_definitions')` + * - :need:`wp__tailoring` (generic) + - :need:`gd_guidl__saf_plan_definitions` + - :ndf:`copy('status', need_id='gd_guidl__saf_plan_definitions')` - `#307 `_ - - :need:`PROCESS_std_req__iso26262__management_5421` & :need:`doc__platform_safety_plan` + - :need:`std_req__iso26262__management_5421` & :need:`doc__platform_safety_plan` - valid diff --git a/docs/platform_management_plan/security_management.rst b/docs/platform_management_plan/security_management.rst index 2fee1ca7cf..dadf6c3a82 100644 --- a/docs/platform_management_plan/security_management.rst +++ b/docs/platform_management_plan/security_management.rst @@ -17,15 +17,12 @@ :status: draft :safety: ASIL_B :security: YES - :realizes: PROCESS_wp__platform_security_plan, PROCESS_wp__tailoring + :realizes: wp__platform_security_plan, wp__tailoring :tags: platform_management Security management / Platform Security Plan -------------------------------------------- -WARNING: Security Management Process is NOT released yet, so links to Process_description using -`PROCESS_`... will not work yet, thus commented out. After releasing, document must be updated. - Purpose +++++++ @@ -74,7 +71,7 @@ Regarding the platform specifics: The SW platform functionality consists of features, which are based on a set of requirements and are developed in parallel. These features are developed into SW components contained in "modules", which are another set of OoCs (initiated by a change request). -A template exists to guide this: :need:`PROCESS_gd_temp__module_security_plan`. +A template exists to guide this: :need:`gd_temp__module_security_plan`. Tailoring ^^^^^^^^^ @@ -87,14 +84,14 @@ Tailoring of security activities: The following ISO SAE 21434 defined security work products are not relevant for the S-CORE SW platform development: -Because Eclipse OSS project handbook applies and all content is public: :need:`PROCESS_std_wp__isosae21434__org_management_551`, +Because Eclipse OSS project handbook applies and all content is public: :need:`std_wp__isosae21434__org_management_551`, -Because these are in responsibility of the system integrator: :need:`PROCESS_std_wp__isosae21434__org_management_551`, -:need:`PROCESS_std_wp__isosae21434__org_management_555`, :need:`PROCESS_std_wp__isosae21434__prj_management_653`, -:need:`PROCESS_std_wp__isosae21434__assessment_15331`, :need:`PROCESS_std_wp__isosae21434__assessment_15332`, -:need:`PROCESS_std_wp__isosae21434__assessment_15431`, :need:`PROCESS_std_wp__isosae21434__assessment_15531` +Because these are in responsibility of the system integrator: :need:`std_wp__isosae21434__org_management_551`, +:need:`std_wp__isosae21434__org_management_555`, :need:`std_wp__isosae21434__prj_management_653`, +:need:`std_wp__isosae21434__assessment_15331`, :need:`std_wp__isosae21434__assessment_15332`, +:need:`std_wp__isosae21434__assessment_15431`, :need:`std_wp__isosae21434__assessment_15531` -Summary: :need:`PROCESS_wp__tailoring` links to all the work products which are tailored out in the platform security plan, +Summary: :need:`wp__tailoring` links to all the work products which are tailored out in the platform security plan, to be able to demonstrate completeness in `REPLACE_external_standards` @@ -166,9 +163,9 @@ The `Eclipse Foundation Security Policy `_. Eclipse definition is more about the process maturity for the whole project, if we are in Mature Phase, we latest will have the project lifecycle as defined in our process description. Nevertheless, Security Development and even Security Package release is independent from Mature and Incubation Phase as the completeness and appropriateness of the platform process and artifacts @@ -232,7 +229,7 @@ The application of ISO SAE 21434 standards requirements is realized by defining Security Schedule ^^^^^^^^^^^^^^^^^ -The schedule is defined in section "Platform Security Plan" below, but also within each module security plan. See linked issues below and in need:`PROCESS_gd_temp__module_security_plan`. +The schedule is defined in section "Platform Security Plan" below, but also within each module security plan. See linked issues below and in need:`gd_temp__module_security_plan`. Security SW Development ^^^^^^^^^^^^^^^^^^^^^^^ @@ -248,7 +245,7 @@ The platform management plan defines :doc:`tool_management` Security Work Products ^^^^^^^^^^^^^^^^^^^^^^ -The work products relevant for a module development is defined within each module security management plan. See :need:`PROCESS_gd_temp__module_security_plan`. +The work products relevant for a module development is defined within each module security management plan. See :need:`gd_temp__module_security_plan`. Generic project wide work products are defined below. Security Quality Criteria @@ -271,162 +268,162 @@ Security Management SW Platform Work Products - Link to WP - WP status - * - :need:`PROCESS_wp__training_path` + * - :need:`wp__training_path` - n/a - n/a - n/a - not open sourced - to be shown to assessor - * - :need:`PROCESS_wp__platform_mgmt` - - :need:`PROCESS_wf__platform_cr_mt_platform_mgmt_plan` - - :ndf:`copy('status', need_id='PROCESS_wf__platform_cr_mt_platform_mgmt_plan')` + * - :need:`wp__platform_mgmt` + - :need:`wf__platform_cr_mt_platform_mgmt_plan` + - :ndf:`copy('status', need_id='wf__platform_cr_mt_platform_mgmt_plan')` - `#540 `_ - :doc:`index` - :ndf:`copy('status', need_id='doc__platform_mgt_plan')` - * - :need:`PROCESS_wp__qms_plan` - - :need:`PROCESS_wf__platform_cr_mt_platform_mgmt_plan` - - :ndf:`copy('status', need_id='PROCESS_wf__platform_cr_mt_platform_mgmt_plan')` + * - :need:`wp__qms_plan` + - :need:`wf__platform_cr_mt_platform_mgmt_plan` + - :ndf:`copy('status', need_id='wf__platform_cr_mt_platform_mgmt_plan')` - `#316 `_ - :doc:`quality_management` - not started - * - :need:`PROCESS_wp__platform_security_plan` - - :need:`PROCESS_gd_guidl__security_plan_definitions` - - :ndf:`copy('status', need_id='PROCESS_gd_guidl__security_plan_definitions')` + * - :need:`wp__platform_security_plan` + - :need:`gd_guidl__security_plan_definitions` + - :ndf:`copy('status', need_id='gd_guidl__security_plan_definitions')` - `#TBD `_ - this document - see above - * - :need:`PROCESS_wp__platform_security_package` - - :need:`PROCESS_gd_guidl__security_package` - - :ndf:`copy('status', need_id='PROCESS_gd_guidl__security_package')` + * - :need:`wp__platform_security_package` + - :need:`gd_guidl__security_package` + - :ndf:`copy('status', need_id='gd_guidl__security_package')` - - - - * - :need:`PROCESS_wp__issue_track_system` + * - :need:`wp__issue_track_system` - :doc:`index` - :ndf:`copy('status', need_id='doc__platform_mgt_plan')` - n/a - `Project issues `_ - established - * - :need:`PROCESS_wp__process_description` - - :need:`PROCESS_wf__def_app_process_description` - - :ndf:`copy('status', need_id='PROCESS_wf__def_app_process_description')` + * - :need:`wp__process_description` + - :need:`wf__def_app_process_description` + - :ndf:`copy('status', need_id='wf__def_app_process_description')` - `Process community issues `_ - `REPLACE_process_description` - - * - :need:`PROCESS_wp__process_impr_report` - - :need:`PROCESS_wf__mon_imp_process_description` - - :ndf:`copy('status', need_id='PROCESS_wf__mon_imp_process_description')` + * - :need:`wp__process_impr_report` + - :need:`wf__mon_imp_process_description` + - :ndf:`copy('status', need_id='wf__mon_imp_process_description')` - - - - * - :need:`PROCESS_wp__process_strategy` - - :need:`PROCESS_wf__cr_mt_process_mgt_strategy` - - :ndf:`copy('status', need_id='PROCESS_wf__cr_mt_process_mgt_strategy')` + * - :need:`wp__process_strategy` + - :need:`wf__cr_mt_process_mgt_strategy` + - :ndf:`copy('status', need_id='wf__cr_mt_process_mgt_strategy')` - `#232 `_ - `Process community issues `_ - - * - :need:`PROCESS_wp__fdr_reports_security` (platform Security Plan) - - :need:`PROCESS_gd_chklst__security_plan` - - :ndf:`copy('status', need_id='PROCESS_gd_chklst__security_plan')` + * - :need:`wp__fdr_reports_security` (platform Security Plan) + - :need:`gd_chklst__security_plan` + - :ndf:`copy('status', need_id='gd_chklst__security_plan')` - - - - * - :need:`PROCESS_wp__fdr_reports_security` (platform Security Package) - - :need:`PROCESS_gd_chklst__security_package` - - :ndf:`copy('status', need_id='PROCESS_gd_chklst__security_package')` + * - :need:`wp__fdr_reports_security` (platform Security Package) + - :need:`gd_chklst__security_package` + - :ndf:`copy('status', need_id='gd_chklst__security_package')` - - - - * - :need:`PROCESS_wp__fdr_reports_security` (feature's Security Analyses) + * - :need:`wp__fdr_reports_security` (feature's Security Analyses) - Security Analysis FDR tbd - - - - - * - :need:`PROCESS_wp__audit_report_security` + * - :need:`wp__audit_report_security` - performed by external experts - n/a - `#TBD1 `_ - - currently tailored out - * - :need:`PROCESS_wp__platform_sw_build_config` + * - :need:`wp__platform_sw_build_config` - :need:`doc__software_development_plan` - :ndf:`copy('status', need_id='doc__software_development_plan')` - - - - * - :need:`PROCESS_wp__platform_security_manual` - - :need:`PROCESS_gd_temp__security_manual` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__security_manual')` + * - :need:`wp__platform_security_manual` + - :need:`gd_temp__security_manual` + - :ndf:`copy('status', need_id='gd_temp__security_manual')` - - - - * - :need:`PROCESS_wp__platform_sw_release_note` + * - :need:`wp__platform_sw_release_note` - :doc:`release_management` - not started - - - - * - :need:`PROCESS_wp__verification_platform_ver_report` - - :need:`PROCESS_gd_temp__mod_ver_report` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__mod_ver_report')` + * - :need:`wp__verification_platform_ver_report` + - :need:`gd_temp__mod_ver_report` + - :ndf:`copy('status', need_id='gd_temp__mod_ver_report')` - - - - * - :need:`PROCESS_wp__requirements_stkh` - - :need:`PROCESS_gd_temp__req_stkh_req` - - :ndf:`copy('status', need_id='PROCESS_gd_temp__req_stkh_req')` + * - :need:`wp__requirements_stkh` + - :need:`gd_temp__req_stkh_req` + - :ndf:`copy('status', need_id='gd_temp__req_stkh_req')` - n/a (done already) - :ref:`stakeholder_requirements` - - * - :need:`PROCESS_wp__sw_development_plan` - - :need:`PROCESS_wf__platform_cr_mt_platform_mgmt_plan` - - :ndf:`copy('status', need_id='PROCESS_wf__platform_cr_mt_platform_mgmt_plan')` + * - :need:`wp__sw_development_plan` + - :need:`wf__platform_cr_mt_platform_mgmt_plan` + - :ndf:`copy('status', need_id='wf__platform_cr_mt_platform_mgmt_plan')` - - :doc:`software_development` - not started - * - :need:`PROCESS_wp__verification_plan` - - :need:`PROCESS_wf__platform_cr_mt_platform_mgmt_plan` - - :ndf:`copy('status', need_id='PROCESS_wf__platform_cr_mt_platform_mgmt_plan')` + * - :need:`wp__verification_plan` + - :need:`wf__platform_cr_mt_platform_mgmt_plan` + - :ndf:`copy('status', need_id='wf__platform_cr_mt_platform_mgmt_plan')` - - :doc:`software_verification` - not started - * - :need:`PROCESS_wp__tool_verification_report` + * - :need:`wp__tool_verification_report` - :doc:`tool_management` - not started - - - - * - :need:`PROCESS_wp__tailoring` (generic) - - :need:`PROCESS_gd_guidl__security_plan_definitions` - - :ndf:`copy('status', need_id='PROCESS_gd_guidl__security_plan_definitions')` + * - :need:`wp__tailoring` (generic) + - :need:`gd_guidl__security_plan_definitions` + - :ndf:`copy('status', need_id='gd_guidl__security_plan_definitions')` - `#TBD2 `_ - `REPLACEstandard_iso26262` & :need:`doc__platform_safety_plan` - valid - * - :need:`PROCESS_wp__sw_platform_sbom` - - :need:`PROCESS_wf__cr_mt_security_sbom` + * - :need:`wp__sw_platform_sbom` + - :need:`wf__cr_mt_security_sbom` - not started - - @@ -435,7 +432,7 @@ Security Management SW Platform Work Products Security Management Feature Specific Work Products ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -See feature tree documents (created by using :need:`PROCESS_gd_temp__feature_security_wp`): +See feature tree documents (created by using :need:`gd_temp__feature_security_wp`): diff --git a/docs/platform_management_plan/software_development.rst b/docs/platform_management_plan/software_development.rst index f28646e24a..32f1710f30 100644 --- a/docs/platform_management_plan/software_development.rst +++ b/docs/platform_management_plan/software_development.rst @@ -21,7 +21,7 @@ Software Development :status: draft :safety: ASIL_B :security: YES - :realizes: PROCESS_wp__sw_development_plan + :realizes: wp__sw_development_plan :tags: platform_management Purpose @@ -49,13 +49,13 @@ Design and programming language For specifying **Detailed Design** (like for the Architecture) a mixture of UML diagrams and natural language is used. Additionally for the Detailed Design linking to code, Doxygen style comments are used. -This is described in :need:`PROCESS_doc_concept__imp_concept` and guided by :need:`PROCESS_gd_temp__detailed_design` +This is described in :need:`doc_concept__imp_concept` and guided by :need:`gd_temp__detailed_design` As required in :need:`stkh_req__dev_experience__prog_languages`, S-CORE allows the use of two programming languages: **C++ with the language set of C++17** - in case additional elements from C++20 are needed this will be considered by -:need:`PROCESS_rl__safety_manager`, :need:`PROCESS_rl__security_manager` and :need:`PROCESS_rl__quality_manager` -and based on their analysis decided by the technical lead circle (:need:`PROCESS_rl__technical_lead`). +:need:`rl__safety_manager`, :need:`rl__security_manager` and :need:`rl__quality_manager` +and based on their analysis decided by the technical lead circle (:need:`rl__technical_lead`). **Rust - in "Edition" ** - selection of language edition has still to be done in the S-CORE project. For the Rust code of ASIL rated units the "safe subset" shall be used (which is checked by the compiler by configuration of #![forbid(unsafe_code)] in lib.rs) @@ -65,7 +65,7 @@ C language is allowed in incubation phase, as long it is compilable be the selec Design guideline ^^^^^^^^^^^^^^^^ -The design guideline is defined in :need:`PROCESS_doc_concept__imp_concept` and :need:`PROCESS_gd_guidl__implementation`. +The design guideline is defined in :need:`doc_concept__imp_concept` and :need:`gd_guidl__implementation`. API guideline ^^^^^^^^^^^^^ diff --git a/docs/platform_management_plan/software_verification.rst b/docs/platform_management_plan/software_verification.rst index e4979fa853..60c1c391f5 100644 --- a/docs/platform_management_plan/software_verification.rst +++ b/docs/platform_management_plan/software_verification.rst @@ -18,7 +18,7 @@ :safety: ASIL_B :security: YES :tags: platform_management - :realizes: PROCESS_wp__verification_plan + :realizes: wp__verification_plan Software verification ********************* @@ -31,8 +31,8 @@ an overview by linking to other relevant sources and provide further information activities. Main purpose of this document is to show the objectives, approaches, and strategies that are defined to contribute to -the overall quality of the software project. The target groups of this document are mainly :need:`PROCESS_rl__contributor` -and :need:`PROCESS_rl__committer`. +the overall quality of the software project. The target groups of this document are mainly :need:`rl__contributor` +and :need:`rl__committer`. Objectives and scope ==================== @@ -72,7 +72,7 @@ Schedules --------- The integration of software elements is driven by change requests and their respective -:need:`PROCESS_doc_getstrt__change_process` model. The contribution of a feature itself implies that it gets fully +:need:`doc_getstrt__change_process` model. The contribution of a feature itself implies that it gets fully verified. Approach @@ -100,7 +100,7 @@ The following types of integrations are applicable: #. **New software elements** get integrated according to the :need:`doc__contr_guideline` #. **Fixes of defects** get integrated based on their prioritization described by the :doc:`problem_resolution`. -#. **Changes** get integrated based on the :need:`PROCESS_wf__change_create_cr` and will follow +#. **Changes** get integrated based on the :need:`wf__change_create_cr` and will follow the :need:`doc__pull_request_guideline` as any other artifact. Levels of integration and verification @@ -128,7 +128,7 @@ There are the following different levels of integration and verification defined **Note:** These three levels translate to the levels of ISO 26262 part 6 clauses 9 to 11. The platform testing will be executed by the integrator. S-Core project only executes tests on reference hardware. These tests serve as an optional base for the integrator and will also be part of the - :need:`PROCESS_wp__verification_platform_ver_report`, but more on an informative character. The full scope + :need:`wp__verification_platform_ver_report`, but more on an informative character. The full scope of clause 11 is tailored out accordingly for S-Core. Practically, this means S-CORE will implement platform test of stakeholder requirements for demonstration, but these are not intended to completely covering all stakeholder requirements. @@ -143,7 +143,7 @@ applicable level. Another column defines if a respective method is supposed to b QM or ASIL B relevant. Automated test cases should contain further information about which methods have been applied. The corresponding -guidance is given here: :need:`PROCESS_gd_guidl__verification_guide`. The identifier of the respective +guidance is given here: :need:`gd_guidl__verification_guide`. The identifier of the respective method is to be used as meta data (*TestType* and *DerivationTechnique*). .. list-table:: Software verification methods (TestType) @@ -192,7 +192,7 @@ For QM software some of the methods may be executed with less rigor compared to These may be interface testing or resource usage evaluation, in case there is an argument for sufficient freedom from interference with safety critical software parts. -Static code analysis is part of the :need:`PROCESS_wp__sw_implementation`. +Static code analysis is part of the :need:`wp__sw_implementation`. As an additional measure the resource usage evaluation ``resource-usage`` should also be considered for level 3 testing as this is the level executed also on reference hardware with the integrated @@ -312,22 +312,22 @@ Further quality goals are defined in section :doc:`quality_management`. Coverage of detailed design ^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Beside :need:`PROCESS_wp__verification_comp_int_test` and :need:`PROCESS_wp__verification_sw_unit_test` the +Beside :need:`wp__verification_comp_int_test` and :need:`wp__verification_sw_unit_test` the following aspects define the coverage of detailed design. - Statement/Branch/Path coverage as defined by their specific thresholds - Static analysis and Linting -- :need:`PROCESS_wp__sw_implementation_inspection` for safety-critical implementation +- :need:`wp__sw_implementation_inspection` for safety-critical implementation Coverage of architectural design ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Beside :need:`PROCESS_wp__verification_comp_int_test` and :need:`PROCESS_wp__verification_feat_int_test` the +Beside :need:`wp__verification_comp_int_test` and :need:`wp__verification_feat_int_test` the following aspects define the coverage of the architectural design. -- :need:`PROCESS_wp__sw_arch_verification` - done by walkthrough (QM) or inspection (safety-critical parts) -- :need:`PROCESS_wp__sw_component_fmea` and :need:`PROCESS_wp__sw_component_dfa` for safety-critical parts -- :need:`PROCESS_wp__feature_fmea` and :need:`PROCESS_wp__feature_dfa` for safety-critical parts +- :need:`wp__sw_arch_verification` - done by walkthrough (QM) or inspection (safety-critical parts) +- :need:`wp__sw_component_fmea` and :need:`wp__sw_component_dfa` for safety-critical parts +- :need:`wp__feature_fmea` and :need:`wp__feature_dfa` for safety-critical parts Each architectural element has at least one test case linked with attribute "fully verified" or multiple test cases with attribute "partially verified". @@ -343,7 +343,7 @@ Test development The verification steps as well as the development of test cases is done along with the implementation of code. A full automation of tests should be achieved and the derived test cases should contain meta -data that gives further information as defined in :need:`PROCESS_gd_req__verification_link_tests`. The list of +data that gives further information as defined in :need:`gd_req__verification_link_tests`. The list of relevant work products is shown above (as part of the development of the product). The different environments that can be used for the test development are defined below. @@ -351,9 +351,9 @@ The different environments that can be used for the test development are defined Pre-existing test cases ^^^^^^^^^^^^^^^^^^^^^^^ -The recommendations according to the :need:`PROCESS_gd_guidl__verification_guide` for pre-existing test +The recommendations according to the :need:`gd_guidl__verification_guide` for pre-existing test cases is followed. Any pre-existing test case (e.g. from OSS components) is reviewed and adopted -to follow the :need:`PROCESS_gd_guidl__verification_specification` and :need:`PROCESS_gd_req__verification_link_tests`. +to follow the :need:`gd_guidl__verification_specification` and :need:`gd_req__verification_link_tests`. Test execution and result analysis ---------------------------------- @@ -373,9 +373,9 @@ Work products and traceability The traceability between verification relevant work products is one of the defined objectives. An overall overview of the different work products and their relationship is given in project -context - see :need:`PROCESS_wp__verification_plan`. +context - see :need:`wp__verification_plan`. -The work products are related to verification can be found in :need:`PROCESS_wp__verification_plan`. +The work products are related to verification can be found in :need:`wp__verification_plan`. The link between a test specification and the respective requirement or design specification is given by the identifier of the reference annotated to the verification specification. @@ -387,43 +387,43 @@ Roles ----- In general, the different roles of this project are defined within the Process documentation: -:need:`PROCESS_rl__project_lead`. The following roles are crucial to comply with the aspects defined in this +:need:`rl__project_lead`. The following roles are crucial to comply with the aspects defined in this document: -#. The :need:`PROCESS_rl__contributor` needs to make sure that the objectives of the software integration and verification are +#. The :need:`rl__contributor` needs to make sure that the objectives of the software integration and verification are fulfilled when contributing to the project. -#. The :need:`PROCESS_rl__committer` needs to verify that the contributor has fulfilled the expected objectives. +#. The :need:`rl__committer` needs to verify that the contributor has fulfilled the expected objectives. -In this way roles are followed as defined in :need:`PROCESS_doc_concept__verification_process`. +In this way roles are followed as defined in :need:`doc_concept__verification_process`. Independence of verification ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -As there are no separated roles for a software developer and test developer with :need:`PROCESS_rl__contributor` and -:need:`PROCESS_rl__committer` it is important to achieve independence. This is done by having different +As there are no separated roles for a software developer and test developer with :need:`rl__contributor` and +:need:`rl__committer` it is important to achieve independence. This is done by having different people responsible for the test implementation and the actual code which gets tested. -The following test level fall in the responsibility of the :need:`PROCESS_rl__testing_community`: +The following test level fall in the responsibility of the :need:`rl__testing_community`: -* :need:`PROCESS_wp__verification_comp_int_test` -* :need:`PROCESS_wp__verification_feat_int_test` -* :need:`PROCESS_wp__verification_platform_test` +* :need:`wp__verification_comp_int_test` +* :need:`wp__verification_feat_int_test` +* :need:`wp__verification_platform_int_test` -Still a :need:`PROCESS_rl__contributor` of one function in a component doesn't prevent them from writing tests +Still a :need:`rl__contributor` of one function in a component doesn't prevent them from writing tests for other functions they do not own. -Independence is achieved by the establishment of :need:`PROCESS_rl__testing_community` performing reviews. +Independence is achieved by the establishment of :need:`rl__testing_community` performing reviews. -The following test level fall in the responsibility of the :need:`PROCESS_rl__contributor`: +The following test level fall in the responsibility of the :need:`rl__contributor`: -* :need:`PROCESS_wp__verification_sw_unit_test` +* :need:`wp__verification_sw_unit_test` -Unit tests can be the developed by the same :need:`PROCESS_rl__contributor` who also contributed the unit code. -A level of independence is achieved as the review process demands to have a review by a :need:`PROCESS_rl__committer` -different to the author of a Pull Request. This is also described in process requirement :need:`PROCESS_gd_req__verification_independence`. +Unit tests can be the developed by the same :need:`rl__contributor` who also contributed the unit code. +A level of independence is achieved as the review process demands to have a review by a :need:`rl__committer` +different to the author of a Pull Request. This is also described in process requirement :need:`gd_req__verification_independence`. -Note that, each :need:`PROCESS_rl__contributor` of the project acts in a publicly visible space where also +Note that, each :need:`rl__contributor` of the project acts in a publicly visible space where also others see the contribution and have the possibility to perform additional reviews independent from -the :need:`PROCESS_rl__committer` and :need:`PROCESS_rl__testing_community`. +the :need:`rl__committer` and :need:`rl__testing_community`. Tools ----- diff --git a/docs/platform_management_plan/tool_management.rst b/docs/platform_management_plan/tool_management.rst index a82fb12973..70822f4dfe 100644 --- a/docs/platform_management_plan/tool_management.rst +++ b/docs/platform_management_plan/tool_management.rst @@ -18,13 +18,13 @@ :safety: ASIL_B :security: YES :tags: platform_management - :realizes: PROCESS_wp__tlm_plan + :realizes: wp__tlm_plan Tool Management/ Tool Management Plan ------------------------------------- -This document implements parts of the :need:`PROCESS_wp__platform_mgmt`. +This document implements parts of the :need:`wp__platform_mgmt`. Purpose +++++++ @@ -57,7 +57,7 @@ Approach Tool Management Attributes ^^^^^^^^^^^^^^^^^^^^^^^^^^ -:need:`PROCESS_gd_req__tool_attr_uid` are implemented as follows: +:need:`gd_req__tool_attr_uid` are implemented as follows: Identification @@ -70,21 +70,21 @@ The most important tools are stored in one GitHub repository, But in general Tool can be stored all over the place. -For each Tool the :need:`PROCESS_gd_temp__tool_management_verif_rpt_template` shall be used to document +For each Tool the :need:`gd_temp__tool_management_verif_rpt_template` shall be used to document the relevant information. -:need:`PROCESS_gd_chklst__tool_cr_review` shall be used to check that all relevant information is considered. +:need:`gd_chklst__tool_cr_review` shall be used to check that all relevant information is considered. The configuration of tools is part of the :need:`doc__config_mgt_plan`. -The output after this stage is the :need:`PROCESS_wp__tool_verification_report` in status: `identified`. +The output after this stage is the :need:`wp__tool_verification_report` in status: `identified`. Evaluation ^^^^^^^^^^ The tool confidence level (TCL) must be determined as outlined in the -:need:`PROCESS_doc_concept__tool_process`. +:need:`doc_concept__tool_process`. Step-by-Step guide: @@ -119,7 +119,7 @@ level is determined to "LOW", otherwise "HIGH". In case the tool confidence level is "LOW", tool qualification is required. -The output after this stage is the :need:`PROCESS_wp__tool_verification_report` in status: `evaluated`. +The output after this stage is the :need:`wp__tool_verification_report` in status: `evaluated`. Qualification ^^^^^^^^^^^^^ @@ -133,26 +133,26 @@ Specify test cases and tests to verify the requirements and generate a test repo Update the Tool Verification Report accordingly to document the outcomes. For the generation of requirements, verification and analyses the existing processes as defined -in the :need:`PROCESS_wp__platform_mgmt` shall be used. +in the :need:`wp__platform_mgmt` shall be used. In detail: -* Use :need:`PROCESS_wf__req_comp_req` to create requirements for the software tool and :need:`PROCESS_wf__monitor_verify_requirements` for the verification +* Use :need:`wf__req_comp_req` to create requirements for the software tool and :need:`wf__monitor_verify_requirements` for the verification -* Use :need:`PROCESS_wf__verification_comp_int_test` to test the requirements for the software tool and :need:`PROCESS_wf__verification_mod_ver_report` to report +* Use :need:`wf__verification_comp_int_test` to test the requirements for the software tool and :need:`wf__verification_mod_ver_report` to report * If applicable, use for the Analyses: (to be added, after Safety/Security Analyses have been merged) -The output after this stage is the :need:`PROCESS_wp__tool_verification_report` in status: `qualified`. +The output after this stage is the :need:`wp__tool_verification_report` in status: `qualified`. Approval ^^^^^^^^ Finally the tool may accepted for the S-CORE project. Thus the Tool Verification Report after this -stage is the :need:`PROCESS_wp__tool_verification_report` in status: `released`. +stage is the :need:`wp__tool_verification_report` in status: `released`. If not, the tool is rejected, thus Tool Verification Report after this -stage is the :need:`PROCESS_wp__tool_verification_report` in status: `rejected`. +stage is the :need:`wp__tool_verification_report` in status: `rejected`. Tailoring ^^^^^^^^^ @@ -161,10 +161,10 @@ Tailoring of safety activities for confidence in the use of software tools: The following ISO 26262 defined safety requirements are not relevant for the S-CORE SW platform development, as they are not used: -:need:`PROCESS_std_req__iso26262__support_11471`, :need:`PROCESS_std_req__iso26262__support_11472`, -:need:`PROCESS_std_req__iso26262__support_11473`, :need:`PROCESS_std_req__iso26262__support_11474`, -:need:`PROCESS_std_req__iso26262__support_11481`, :need:`PROCESS_std_req__iso26262__support_11482`, -:need:`PROCESS_std_req__iso26262__support_11483` +:need:`std_req__iso26262__support_11471`, :need:`std_req__iso26262__support_11472`, +:need:`std_req__iso26262__support_11473`, :need:`std_req__iso26262__support_11474`, +:need:`std_req__iso26262__support_11481`, :need:`std_req__iso26262__support_11482`, +:need:`std_req__iso26262__support_11483` Tool List diff --git a/docs/requirements/platform_assumptions/index.rst b/docs/requirements/platform_assumptions/index.rst index 03f6785b38..458c871374 100644 --- a/docs/requirements/platform_assumptions/index.rst +++ b/docs/requirements/platform_assumptions/index.rst @@ -22,7 +22,7 @@ SW Platform Assumptions :status: draft :security: YES :safety: ASIL_B - :realizes: PROCESS_wp__platform_sw_aou + :realizes: wp__requirements_sw_platform_aou Assumptions on Environment -------------------------- diff --git a/docs/score_releases/platform_release_note.rst b/docs/score_releases/platform_release_note.rst index 37a24eb18b..ceb61558a0 100644 --- a/docs/score_releases/platform_release_note.rst +++ b/docs/score_releases/platform_release_note.rst @@ -21,7 +21,7 @@ Platform Release Notes :id: doc__platform_release_note :status: draft :safety: ASIL_B - :realizes: PROCESS_wp__platform_sw_release_note + :realizes: wp__platform_sw_release_note | Platform Name: [S-CORE] | Release Tag: v0.5.0 diff --git a/docs/score_tools/doc_as_code.rst b/docs/score_tools/doc_as_code.rst index 0951ba4bed..028aaf17b9 100644 --- a/docs/score_tools/doc_as_code.rst +++ b/docs/score_tools/doc_as_code.rst @@ -19,7 +19,7 @@ :tcl: LOW :safety_affected: YES :security_affected: YES - :realizes: PROCESS_wp__tool_verification_report + :realizes: wp__tool_verification_report :tags: tool_management