Skip to content

Commit 65ab6c5

Browse files
committed
Add artifacts for requirements analysis
Resolves: eclipse-score/score#577 Signed-off-by: Philipp Ahmann <[email protected]>
1 parent cef1744 commit 65ab6c5

File tree

7 files changed

+123
-1
lines changed

7 files changed

+123
-1
lines changed

process/folder_templates/features/feature_name/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,3 +194,4 @@ Footnotes
194194
safety_analysis/fmea.rst
195195
safety_analysis/dfa.rst
196196
safety_planning/index.rst
197+
verification/req_analysis.rst
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
..
2+
# *******************************************************************************
3+
# Copyright (c) 2025 Contributors to the Eclipse Foundation
4+
#
5+
# See the NOTICE file(s) distributed with this work for additional
6+
# information regarding copyright ownership.
7+
#
8+
# This program and the accompanying materials are made available under the
9+
# terms of the Apache License Version 2.0 which is available at
10+
# https://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# SPDX-License-Identifier: Apache-2.0
13+
# *******************************************************************************
14+
15+
.. _feature_req_analysis_template:
16+
17+
Requirement Analysis
18+
####################
19+
20+
.. document:: [Your Feature Name] Requirement Analysis
21+
:id: doc__feature_name_req_analysis
22+
:status: draft
23+
:safety: ASIL_B
24+
:security: YES
25+
:realizes: wp__verification_req_analysis
26+
:tags: template
27+
28+
.. attention::
29+
The above directive must be updated according to your Feature.
30+
31+
- Modify ``Your Feature Name`` to be your Feature Name
32+
- Modify ``id`` to be your Feature Name in upper snake case preceded by ``doc__`` and succeeded by ``_req_analysis``
33+
- Adjust ``status`` to be ``valid``
34+
- Adjust ``safety`` and ``tags`` according to your needs
35+
36+
37+
Rational
38+
--------

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,3 +183,4 @@ Footnotes
183183
requirements/chklst_req_inspection.rst
184184
safety_analysis/fmea.rst
185185
safety_analysis/dfa.rst
186+
verification/req_analysis.rst
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
..
2+
# *******************************************************************************
3+
# Copyright (c) 2025 Contributors to the Eclipse Foundation
4+
#
5+
# See the NOTICE file(s) distributed with this work for additional
6+
# information regarding copyright ownership.
7+
#
8+
# This program and the accompanying materials are made available under the
9+
# terms of the Apache License Version 2.0 which is available at
10+
# https://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# SPDX-License-Identifier: Apache-2.0
13+
# *******************************************************************************
14+
15+
.. _component_req_analysis_template:
16+
17+
Requirement Analysis
18+
####################
19+
20+
.. document:: [Your Component Name] Requirement Analysis
21+
:id: doc__component_name_req_analysis
22+
:status: draft
23+
:safety: ASIL_B
24+
:security: YES
25+
:realizes: wp__verification_req_analysis
26+
:tags: template
27+
28+
.. attention::
29+
The above directive must be updated according to your Component.
30+
31+
- Modify ``Your Component Name`` to be your Component Name
32+
- Modify ``id`` to be your Component Name in upper snake case preceded by ``doc__`` and succeeded by ``_req_analysis``
33+
- Adjust ``status`` to be ``valid``
34+
- Adjust ``safety`` and ``tags`` according to your needs
35+
36+
37+
Rational
38+
--------

process/process_areas/verification/verification_concept.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ stakeholder requirements as stakeholder requirements describe the platform behav
167167

168168
Note that all the above tests shall only link to requirements of type "Functional" and "Interface".
169169
The verification of requirements of types "Process" and "Non-Functional" will be done via Analysis,
170-
which is a verification method still to be defined. ``[TODO: Link to Analysis process once available. See ticket #577]``
170+
which is a verification method described in :need:`wf__verification_req_analysis`.
171171

172172
Requirements always include Assumptions Of Use.
173173

process/process_areas/verification/verification_workflows.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,35 @@ For a detailed explanation of workflows and their role within the process model,
111111
The tests are automatically executed as part of the CI after PR merge.
112112
In case of changes at inputs, the workflow need to be executed again as part of maintenance.
113113

114+
.. workflow:: Perform/Maintain Requirements Analysis
115+
:id: wf__verification_req_analysis
116+
:status: valid
117+
:tags: verification
118+
:responsible: rl__contributor
119+
:approved_by: rl__committer, rl__testing_community
120+
:supported_by: rl__safety_manager, rl__testing_community
121+
:input: wp__feature_arch, wp__requirements_feat, wp__requirements_feat_aou,
122+
wp__component_arch, wp__requirements_comp, wp__requirements_comp_aou,
123+
wp__sw_implementation, wp__verification_plan
124+
:output: wp__verification_req_analysis
125+
:contains: gd_req__verification_link_tests, gd_req__verification_independence, gd_guidl__verification_specification
126+
:has: doc_concept__verification_process, doc_getstrt__verification_process
127+
128+
This only applies in the special case that some requirements cannot be feasibly tested.
129+
130+
In such cases – and only such cases – it is acceptable to indicate in the Requirements Analysis Report
131+
that not a test but a review shall verify the correct implementation of the related requirement.
132+
To signal this special situation to the test engineers (who do not need to specify a test case for the related requirement then),
133+
one or both of the following fixed texts shall be entered in the Requirements Analysis Report:
134+
135+
Tag: **Covered-by-design-review.**
136+
The fulfillment of this requirement shall be verified as part of feature/component design reviews
137+
(for feature/component requirements) respective software architectural design or software detailed design reviews.
138+
139+
Tag: **Covered-by-code-review.**
140+
The fulfillment of this requirement shall be verified as part of code reviews.
141+
142+
114143
.. workflow:: Create Verification Plan
115144
:id: wf__verification_plan
116145
:status: valid

process/process_areas/verification/verification_workproducts.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,21 @@ Component
145145
The compiled tests run against the actual source code compiled for the component or reference integration and their
146146
targeted HW architecture (e.g. arm64 or x86).
147147

148+
.. workproduct:: Requirement Analysis
149+
:id: wp__verification_req_analysis
150+
:status: valid
151+
:complies: std_wp__iso26262__software_951
152+
153+
Requirement Analysis is performed for non-functional requirements (NFRs) which cannot be (feasibly) tested.
154+
As example performance requirements may not be functional requirements, but they still can be tested.
155+
Though, some requirements cannot be feasibly tested in such cases – and only such cases – it is acceptable
156+
to perform a requirements analysis.
157+
158+
This work product provides the evidence about the NFR for the project.
159+
160+
Note, that there is also the DerivationTechnique named "requirements-analysis" which can be used for "requirements-based" TestTypes.
161+
It is described in :ref:`verification_concept_types_methods`.
162+
148163
Inspection
149164
**********
150165

0 commit comments

Comments
 (0)