-
Notifications
You must be signed in to change notification settings - Fork 16
Improvement: add safety analysis checklist to folder templates #457
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
92 changes: 92 additions & 0 deletions
92
...er_templates/modules/module_name/docs/safety_mgt/module_safety_analysis_fdr.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| .. | ||
| # ******************************************************************************* | ||
| # Copyright (c) 2025 Contributors to the Eclipse Foundation | ||
| # | ||
| # See the NOTICE file(s) distributed with this work for additional | ||
| # information regarding copyright ownership. | ||
| # | ||
| # This program and the accompanying materials are made available under the | ||
| # terms of the Apache License Version 2.0 which is available at | ||
| # https://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
|
|
||
|
|
||
| Safety Analysis Checklist | ||
| ========================= | ||
|
|
||
| .. document:: [Your Module Name] Safety Analysis Checklist | ||
| :id: doc__module_name_safety_analysis_fdr | ||
| :status: draft | ||
| :safety: ASIL_B | ||
| :security: YES | ||
| :realizes: wp__fdr_reports | ||
| :tags: template | ||
|
|
||
| .. attention:: | ||
| The above directive must be updated according to your Module. | ||
|
|
||
| - Modify ``Your Module Name`` to be your Module Name | ||
| - Modify ``id`` to be your Module Name in lower snake case preceded by ``doc__`` and followed by ``_safety _analysis_fdr`` | ||
| - Adjust ``status`` to be ``valid`` | ||
| - Adjust ``safety``, ``security`` and ``tags`` according to your needs | ||
|
|
||
|
|
||
| **Purpose** | ||
| The purpose of this Safety Analysis (DFA and FMEA) checklist template is to collect the topics to be checked during verification of the Safety Analysis. | ||
|
|
||
| **Checklist** | ||
|
|
||
| .. list-table:: Safety Analysis Checklist | ||
| :header-rows: 1 | ||
| :widths: 10,30,30,15,8,8 | ||
|
|
||
| * - Review ID | ||
| - Acceptance Criteria | ||
| - Guidance | ||
| - Passed | ||
| - Remarks | ||
| - Issue link | ||
| * - REQ_01_01 | ||
| - Is / are the attribute sufficient set correctly? | ||
| - The mitigations shall have a direct influence ont the violation by prevention, detection or mitigation to reduce the risk to an acceptable level. | ||
| - The mitigations are sufficient. | ||
| - <yes|no> | ||
| - | ||
| * - REQ_01_02 | ||
| - Are the templates for DFA and/or FMEA used? | ||
| - See :ref:`dfa_templates` / :ref:`FMEA_templates` and also :ref:`process_requirements_safety_analysis` | ||
| - Templates are used to generate the DFA or / and FMEA. | ||
| - <yes|no> | ||
| - | ||
| * - REQ_01_03 | ||
| - Were the failure initiators / fault models applied? | ||
| - 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. | ||
| - <yes|no> | ||
| - | ||
| * - REQ_01_04 | ||
| - Are the failure effects clearly and completely described? | ||
| - Use the generic failure effect descriptions and enlarge the description if it's applicable to the considered element. | ||
| - The effects of the failure is described completely. The effect can be recognized easily. | ||
| - <yes|no> | ||
| - | ||
| * - REQ_01_06 | ||
| - Is the attribute "mitigated by" linked correct? | ||
| - Check if the correct failure effect is linked via "mitigated by". | ||
| - The "mitigated by" link is correct. | ||
| - <yes|no> | ||
| - | ||
| * - REQ_01_07 | ||
| - Is the sufficiency of the "mitigated by" (prevention, detection or mitigation) described or can it be recognized easily? | ||
| - The sufficiency of the "mitigated by" is described in the content of the document. It can be recognized easily. | ||
| - The "mitigated by" shows clearly that a fault / failure can be mitigated by the linked requirement by prevention, detection or mitigation. It shall be described in the contend. | ||
| - <yes|no> | ||
| - | ||
| * - 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:`wp__verification_platform_ver_report`. | ||
| - <yes|no> | ||
| - |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
92 changes: 92 additions & 0 deletions
92
process/folder_templates/platform/safety_planning/platform_safety_analysis_fdr.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| .. | ||
| # ******************************************************************************* | ||
| # Copyright (c) 2025 Contributors to the Eclipse Foundation | ||
| # | ||
| # See the NOTICE file(s) distributed with this work for additional | ||
| # information regarding copyright ownership. | ||
| # | ||
| # This program and the accompanying materials are made available under the | ||
| # terms of the Apache License Version 2.0 which is available at | ||
| # https://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
|
|
||
|
|
||
| Safety Analysis Checklist | ||
| ========================= | ||
|
|
||
| .. document:: [Your Platform Name] Safety Analysis Checklist | ||
| :id: doc__platform_name_safety_analysis_fdr | ||
| :status: draft | ||
| :safety: ASIL_B | ||
| :security: YES | ||
| :realizes: wp__fdr_reports | ||
| :tags: template | ||
|
|
||
| .. attention:: | ||
| The above directive must be updated according to your Platform. | ||
|
|
||
| - Modify ``Your Platform Name`` to be your Platform Name | ||
| - Modify ``id`` to be your Platform Name in lower snake case preceded by ``doc__`` and followed by ``_safety _analysis_fdr`` | ||
| - Adjust ``status`` to be ``valid`` | ||
| - Adjust ``safety``, ``security`` and ``tags`` according to your needs | ||
|
|
||
|
|
||
| **Purpose** | ||
| The purpose of this Safety Analysis (DFA and FMEA) checklist template is to collect the topics to be checked during verification of the Safety Analysis. | ||
|
|
||
| **Checklist** | ||
|
|
||
| .. list-table:: Safety Analysis Checklist | ||
| :header-rows: 1 | ||
| :widths: 10,30,30,15,8,8 | ||
|
|
||
| * - Review ID | ||
| - Acceptance Criteria | ||
| - Guidance | ||
| - Passed | ||
| - Remarks | ||
| - Issue link | ||
| * - REQ_01_01 | ||
| - Is / are the attribute sufficient set correctly? | ||
| - The mitigations shall have a direct influence ont the violation by prevention, detection or mitigation to reduce the risk to an acceptable level. | ||
| - The mitigations are sufficient. | ||
| - <yes|no> | ||
| - | ||
| * - REQ_01_02 | ||
| - Are the templates for DFA and/or FMEA used? | ||
| - See :ref:`dfa_templates` / :ref:`FMEA_templates` and also :ref:`process_requirements_safety_analysis` | ||
| - Templates are used to generate the DFA or / and FMEA. | ||
| - <yes|no> | ||
| - | ||
| * - REQ_01_03 | ||
| - Were the failure initiators / fault models applied? | ||
| - 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. | ||
| - <yes|no> | ||
| - | ||
| * - REQ_01_04 | ||
| - Are the failure effects clearly and completely described? | ||
| - Use the generic failure effect descriptions and enlarge the description if it's applicable to the considered element. | ||
| - The effects of the failure is described completely. The effect can be recognized easily. | ||
| - <yes|no> | ||
| - | ||
| * - REQ_01_06 | ||
| - Is the attribute "mitigated by" linked correct? | ||
| - Check if the correct failure effect is linked via "mitigated by". | ||
| - The "mitigated by" link is correct. | ||
| - <yes|no> | ||
| - | ||
| * - REQ_01_07 | ||
| - Is the sufficiency of the "mitigated by" (prevention, detection or mitigation) described or can it be recognized easily? | ||
| - The sufficiency of the "mitigated by" is described in the content of the document. It can be recognized easily. | ||
| - The "mitigated by" shows clearly that a fault / failure can be mitigated by the linked requirement by prevention, detection or mitigation. It shall be described in the contend. | ||
| - <yes|no> | ||
| - | ||
| * - 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:`wp__verification_platform_ver_report`. | ||
| - <yes|no> | ||
| - |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wonder, if need that not to for the platform safety plan?