Repository navigation
[FuSa] Separate trigger and system change impact analyses - #1442
devashridatta-dotcom wants to merge 58 commits into
Conversation
18744d4 to
d8fd642
Compare
d8fd642 to
d60c650
Compare
kestewart
left a comment
There was a problem hiding this comment.
Need to make a couple of decisions to remove ambiguity.
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
nicpappler
left a comment
There was a problem hiding this comment.
ChangeImpactAnalysis needs more rework, that we have to discuss in the meetings. Also we need to make sure that the ChangeTrigger can really represent all information sources that might trigger a change. Maybe make it an Element instead of an Artifact. The impact analysis description also has to move somewhere else, it is crowding now the FunctionalSafety.md file.
|
Updated after the latest FuSa discussion:
PR #1443 has also been aligned so the examples no longer use \�pprovedBy. |
|
@kestewart @nicpappler could you please re-review PR #1442 for approval/merge? The branch is now clean and both checks are passing. I updated the PR after the FuSa discussion to keep the scope narrow:
If this scope looks acceptable, could you approve so we can merge PR #1442 and continue the Decision work separately? |
chuckwolber
left a comment
There was a problem hiding this comment.
I think this document is attempting to do two things at once. I recommend splitting it up. See comments for more detail.
| An AnalysisTrigger does not assert that a change is required. It records why a | ||
| SystemImpactAnalysis is opened so the analysis can determine whether affected | ||
| elements need to be added, removed, revised, verified, or left unchanged. |
There was a problem hiding this comment.
I think you managed to hit all the possibilities, but would it make more sense to speak more generally to avoid interpretation errors?
| An AnalysisTrigger does not assert that a change is required. It records why a | |
| SystemImpactAnalysis is opened so the analysis can determine whether affected | |
| elements need to be added, removed, revised, verified, or left unchanged. | |
| An AnalysisTrigger does not assert that a change is required. It records why a | |
| SystemImpactAnalysis is opened so the analysis can determine whether the design | |
| needs to be modified. |
| When the source is already represented by a more specific SPDX Artifact, that | ||
| existing element can be used as input to the SystemImpactAnalysis. For example, | ||
| a CVE can be represented using /Security/Vulnerability, which is a subclass of | ||
| /Core/Artifact and can carry an externalIdentifier with externalIdentifierType | ||
| `cve`. |
There was a problem hiding this comment.
This feels like it is out of scope for an analysis trigger description. Should it be moved to the SystemImpactAnalysis description?
| The authoritative record for the trigger can be referenced using inherited | ||
| /Core/externalRef or /Core/externalIdentifier values. For example, the trigger | ||
| can point to an FAA report, CAPA record, QMS record, Jira issue, ServiceNow | ||
| ticket, or other externally managed record without duplicating that system's | ||
| contents in SPDX. |
There was a problem hiding this comment.
I think there should be more detail when it comes to referencing an external system of record. Possibly even modeling how specific systems of record like Jira would be referenced.
| SystemImpactAnalysis represents the documented analysis of one or more analysis | ||
| triggers against SPDX elements. |
There was a problem hiding this comment.
Which SPDX elements are you referring to? Would it work to just remove that part?
| SystemImpactAnalysis represents the documented analysis of one or more analysis | |
| triggers against SPDX elements. | |
| SystemImpactAnalysis represents the documented analysis of one or more analysis | |
| triggers. |
| A SystemImpactAnalysis can be linked to one or more AnalysisTrigger elements | ||
| using a /Core/Relationship with relationshipType `hasInput`, from the | ||
| SystemImpactAnalysis to each AnalysisTrigger. This keeps the source or reason | ||
| for the analysis separate from the analysis that determines impact. |
There was a problem hiding this comment.
| A SystemImpactAnalysis can be linked to one or more AnalysisTrigger elements | |
| using a /Core/Relationship with relationshipType `hasInput`, from the | |
| SystemImpactAnalysis to each AnalysisTrigger. This keeps the source or reason | |
| for the analysis separate from the analysis that determines impact. | |
| A SystemImpactAnalysis can be linked to one or more AnalysisTrigger elements | |
| using a /Core/Relationship with relationshipType `hasInput`, from the | |
| SystemImpactAnalysis to each AnalysisTrigger. A SystemImpactAnalysis is | |
| expected to have many triggers, and each trigger may be associated with more | |
| than one SystemImpactAnalysis. |
| The /Core/rationale property describes the overall reason, scope, or conclusion | ||
| for the SystemImpactAnalysis. When a more detailed decision record is needed, |
There was a problem hiding this comment.
Reason, scope, and conclusion are different things. Should there be different properties for each?
| If a SystemImpactAnalysis uses the `duplicate` status, that status describes | ||
| the lifecycle state of the analysis itself. A separate decision record, when | ||
| used, can capture the agent or process decision that closed the analysis as a | ||
| duplicate and can link to the analysis that already covers the trigger or scope. |
There was a problem hiding this comment.
Why does duplicate warrant a special description here? What property would be marked duplicate? What other values can that property take on? Where are the descriptions for those other values?
|
|
||
| ## Summary | ||
|
|
||
| Describes a system impact analysis. |
There was a problem hiding this comment.
This document appears to attempt to do two different things - assess the systemic impact of one or more triggers, and assess the systemic impact of added/removed/modified elements. The two are not the same. I recommend splitting this out into two separate documents:
- SystemImpactAnalysis - Assess the impact of one or more triggers. This may or may not lead to systemic change.
- SystemChangeImpactAnalysis - Assess the impact of one or more changes (add/removed/modified elements) to a system.
| - impactedElement | ||
| - type: /Core/Element | ||
| - minCount: 0 | ||
| - addedElement | ||
| - type: /Core/Element | ||
| - minCount: 0 | ||
| - modifiedElement | ||
| - type: /Core/Element | ||
| - minCount: 0 | ||
| - removedElement | ||
| - type: /Core/Element | ||
| - minCount: 0 |
There was a problem hiding this comment.
See comment at the top - I do not believe these belong in this document.
chuckwolber
left a comment
There was a problem hiding this comment.
I have lots more to add, but this should get us started. I will add additional elements found in DO-178C and @nicpappler will cover Automotive and other industries.
| @@ -0,0 +1,65 @@ | |||
| SPDX-License-Identifier: Community-Spec-1.0 | |||
|
|
|||
| # SystemChangeImpactAnalysis | |||
There was a problem hiding this comment.
We should change the name to SystemChangeAccomplishmentSummary.
There was a problem hiding this comment.
From DO-178C, "The Software Accomplishment Summary is the primary data item for showing compliance with the Plan for Software Aspects of Certification (PSAC). This summary should include..."
- System Overview
- Description of the system's functions.
- Allocation of functions to hardware and software.
- The architecture.
- Processors used.
- Hardware/software interfaces.
- Safety features.
- Software Overview - Describes software functions with an emphasis on safety and partitioning (time/space) concepts used.
- Certification Considerations - Restates certification considerations described in PSAC.
- Software Life Cycle - (Additional details TBD) Summarize the actual software life cycle.
- Software planning process.
- Software development process - requirements, design, coding, and integration.
- Software verification process, configuration management process, quality assurance process, certification liaison process.
- Software Life Cycle Data
- Additional Considerations - Additional considerations that may warrant the attention of the cert authority.
- Supplier Oversight - If suppliers were used, describes how supplier processes and outputs comply with plans and standards.
- Software Identification - Identifies software by part number and version.
- Software Characteristics - Executable object code size, timing margins including worst-case execution time, memory margins, resource limitations, and the means used for measuring each characteristic.
- Change History - Summary of software changes with attention to changes made due to failures affecting safety.
- Software Status - Summary of problem reports unresolved at time of release. This is essentially "known issues". Includes:
- Description of each problem.
- Any associated errors.
- Functional limitations.
- Operational restrictions.
- Potential adverse effects on safety.
- Justifications for allowing the problem report to remain open.
- Details of mitigating actions that have been, or need to be, carried out.
- Compliance Statement - Statement of compliance to the SAS and a summary of methods used to demonstrate compliance with criteria specified in software plans. Addresses decisions made by cert authorities and deviations from software plans and standards.
All sections should also characterize areas that deviate from the system overview described in the PSAC.
There was a problem hiding this comment.
@chuckwolber Just to clarify, I'll interpret this as renaming the existing SystemChangeImpactAnalysis class to SystemChangeAccomplishmentSummary and incorporating the DO-178C Software Accomplishment Summary concepts into its description, rather than introducing a separate class
Summary
Updates the FunctionalSafety model to distinguish between analyzing system impact and documenting the accomplishment of system changes.
Model
AnalysisTriggeridentifies an event, finding, report, or condition that prompts an analysis.SystemImpactAnalysisassesses one or more triggers or source artifacts and may conclude that no change is required.SystemChangeAccomplishmentSummarydocuments the accomplishment of actual or proposed system changes and supporting assurance evidence.System Change Accomplishment Summary
The renamed class incorporates concepts from the DO-178C Software Accomplishment Summary (SAS), including:
These concepts are provided as cross-domain documentation guidance. They do not assert DO-178C compliance or introduce mandatory SAS-specific properties.
Existing SPDX elements and relationships are reused for supporting evidence.
No additional classes are introduced as part of this change.