Skip to content

Commit c555629

Browse files
committed
Revert gd_req/arch links per review, add satisfied_by for requirements
1 parent 09e30ff commit c555629

22 files changed

Lines changed: 190 additions & 190 deletions

File tree

process/folder_templates/features/feature_name/architecture/index.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,14 @@ Requirements
5454
.. needtable:: Overview of Feature Requirements
5555
:style: table
5656
:columns: title;id
57-
:filter: search("feat_arch_sta__archdes$", "satisfies_back")
57+
:filter: search("feat_arch_sta__archdes$", "fulfils_back")
5858
:colwidths: 70,30
5959
6060
6161
.. needtable:: Overview of Feature Requirements
6262
:style: table
6363
:columns: title;id
64-
:filter: search("feat_arch_sta__archdes$", "satisfies_back")
64+
:filter: search("feat_arch_sta__archdes$", "fulfils_back")
6565
:colwidths: 70,30
6666

6767

@@ -85,7 +85,7 @@ The live feature architecture template snippets are maintained in the
8585
:security: YES
8686
:safety: ASIL_B
8787
:status: invalid
88-
:satisfies: feat_req__feature_name__some_title
88+
:fulfils: feat_req__feature_name__some_title
8989
:includes: logic_arc_int__feature_name__interface_name1
9090
:belongs_to: feat__feature_name
9191
@@ -107,7 +107,7 @@ Dynamic Architecture
107107
:security: YES
108108
:safety: ASIL_B
109109
:status: invalid
110-
:satisfies: feat_req__feature_name__some_title
110+
:fulfils: feat_req__feature_name__some_title
111111
:belongs_to: feat__feature_name
112112
113113
Put here a sequence diagram
@@ -122,7 +122,7 @@ Logical Interfaces
122122
:security: YES
123123
:safety: ASIL_B
124124
:status: invalid
125-
:satisfies: feat_req__feature_name__some_title
125+
:fulfils: feat_req__feature_name__some_title
126126
127127
General Interface Description
128128

process/folder_templates/features/feature_name/requirements/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Feature Requirements
4545
:valid_from: v0.0.1
4646
:valid_until: v1.0.1
4747
:status: invalid
48-
:belongs_to: feat__feature_name
48+
:satisfied_by: feat__feature_name
4949
5050
The Feature shall do xyz to the user to bring him to this condition at this time.
5151
@@ -66,7 +66,7 @@ Feature Requirements
6666
The above directives must be updated according to your feature requirements.
6767

6868
- Replace the example content by the real content for your first requirement (according to :need:`gd_guidl__req_engineering`)
69-
- Set ``belongs_to`` with a link to feature ID
69+
- Set ``satisfied_by`` with a link to feature ID
7070
- Set ``reqtype`` with a link to the right value (<Functional|Interface|Process|Non-Functional>)
7171
- Set ``satisfies`` with a link to the right stakeholder requirement
7272
- Adjust ``safety`` and ``security`` to the right value (ASIL B/QM; YES/NO)

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Requirements Linked to Component Architecture
4545
.. needtable:: Overview of Component Requirements
4646
:style: table
4747
:columns: title;id
48-
:filter: search("comp_arch_sta__archdes$", "satisfies_back")
48+
:filter: search("comp_arch_sta__archdes$", "fulfils_back")
4949
:colwidths: 70,30
5050
5151
Description
@@ -93,7 +93,7 @@ The live component architecture template is maintained in the
9393
:status: invalid
9494
:belongs_to: comp__component_name_template
9595
:uses: logic_arc_int__feature_name__interface_name1
96-
:satisfies: comp_req__component_name__some_title
96+
:fulfils: comp_req__component_name__some_title
9797
9898
.. needarch::
9999
:scale: 50
@@ -112,7 +112,7 @@ Dynamic Architecture
112112
:safety: ASIL_B
113113
:status: invalid
114114
:belongs_to: comp__component_name_template
115-
:satisfies: comp_req__component_name__some_title
115+
:fulfils: comp_req__component_name__some_title
116116
117117
Put here a sequence diagram
118118
@@ -126,7 +126,7 @@ Interfaces
126126
:id: real_arc_int__<component>__<Title>
127127
:security: <YES|NO>
128128
:safety: <QM|ASIL_B>
129-
:satisfies: <link to component requirement id>
129+
:fulfils: <link to component requirement id>
130130
:language: cpp
131131
132132
Internal Components
@@ -139,7 +139,7 @@ Internal Components
139139
:status: invalid
140140
:safety: ASIL_B
141141
:security: YES
142-
:satisfies: comp_req__component_name__some_title
142+
:fulfils: comp_req__component_name__some_title
143143
:belongs_to: comp__component_name_template
144144
145145
No architecture but detailed design

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Component Requirements
4646
:safety: ASIL_B
4747
:derived_from: feat_req__feature_name__some_title
4848
:status: invalid
49-
:belongs_to: comp__component_name_template
49+
:satisfied_by: comp__component_name_template
5050
5151
The Component shall do xyz to another component to bring it to this condition at this time
5252
@@ -57,7 +57,7 @@ Component Requirements
5757

5858
- Replace the example content by the real content for your first requirement
5959
- Set ``satistifes`` with links to Feature requirements
60-
- Set ``belongs_to`` with a link to the right Component id
60+
- Set ``satisfied_by`` with a link to the right Component id
6161
- Set ``safety`` and ``security`` to the right value
6262
- Set the status to valid and start the review/merge process
6363
- Add other needed requirements for your component

process/general_concepts/score_review_concept.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ Process Requirements
187187
:status: valid
188188
:tags: prio_1_automation, general
189189
:complies: std_req__iso26262__support_6433, std_req__iso26262__software_7414
190-
:derived_from: wf__monitor_verify_requirements
190+
:satisfies: wf__monitor_verify_requirements
191191

192192
The version of a requirement shall not change by an inspection.
193193

@@ -200,7 +200,7 @@ Process Requirements
200200
:status: draft
201201
:tags: general
202202
:complies: std_req__iso26262__support_6433, std_req__iso26262__software_7414
203-
:derived_from: wf__mr_vy_arch
203+
:satisfies: wf__mr_vy_arch
204204

205205
The version of architecture element shall not change by an inspection.
206206

@@ -215,7 +215,7 @@ Process Requirements
215215
:status: valid
216216
:tags: prio_2_automation, general
217217
:complies: std_req__iso26262__support_6433, std_req__iso26262__software_7414, std_req__iso26262__software_942
218-
:derived_from: wf__monitor_verify_requirements, wf__mr_vy_arch
218+
:satisfies: wf__monitor_verify_requirements, wf__mr_vy_arch
219219

220220
For every pull request that modifies a work product subject to inspection,
221221
a pull‑request template containing the applicable inspection checklist items shall be provided.
@@ -227,7 +227,7 @@ Process Requirements
227227
:status: valid
228228
:tags: prio_2_automation, general
229229
:complies: std_req__iso26262__support_6433, std_req__iso26262__software_7414
230-
:derived_from: wf__monitor_verify_requirements, wf__mr_vy_arch
230+
:satisfies: wf__monitor_verify_requirements, wf__mr_vy_arch
231231

232232
It shall be checked that only a PR with the inspection checklist filled out can set a status to valid(inspected).
233233

@@ -236,6 +236,6 @@ Process Requirements
236236
:status: valid
237237
:tags: prio_2_automation, general
238238
:complies: std_req__iso26262__support_6433, std_req__iso26262__software_7414
239-
:derived_from: wf__monitor_verify_requirements, wf__mr_vy_arch
239+
:satisfies: wf__monitor_verify_requirements, wf__mr_vy_arch
240240

241241
It shall be checked that the status is reset to valid whenever a requirement is modified (changes version).

process/process_areas/architecture_design/architecture_concept.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -440,7 +440,7 @@ The following section links to the rendered feature example that is now maintain
440440
:safety: QM
441441
:status: valid
442442
:includes: logic_arc_int__example_feature__archex_logical_interface_1, logic_arc_int__example_feature__archex_logical_interface_2
443-
:satisfies: feat_req__example_feature__archdes_example_req
443+
:fulfils: feat_req__example_feature__archdes_example_req
444444
:belongs_to: feat__example_feature
445445
446446
.. needarch::
@@ -462,7 +462,7 @@ The rendered component examples are maintained in the
462462
:status: valid
463463
:safety: ASIL_B
464464
:security: NO
465-
:satisfies: comp_req__example_feature__archex_example_req
465+
:fulfils: comp_req__example_feature__archex_example_req
466466
:belongs_to: comp__component_component_getstrt
467467
468468
.. needarch::

process/process_areas/architecture_design/guidance/architecture_process_reqs.rst

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Architectural Model
2525
:status: valid
2626
:tags: manual_prio_1
2727
:complies: std_req__iso26262__support_6431, std_req__iso26262__support_6432
28-
:derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
28+
:satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
2929

3030
For architecture design a model based approach should be used. The model shall consist of different architectural elements.
3131

@@ -34,7 +34,7 @@ Architectural Model
3434
:status: valid
3535
:tags: done_automation
3636
:complies: std_req__iso26262__support_6431, std_req__iso26262__support_6432, std_req__iso26262__software_743
37-
:derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
37+
:satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
3838

3939
The architectural elements shall be hierarchically structured on two levels:
4040

@@ -46,7 +46,7 @@ Architectural Model
4646
:status: valid
4747
:tags: done_automation
4848
:complies: std_req__iso26262__support_6431, std_req__iso26262__support_6432, std_req__aspice_40__iic-01-03, std_req__aspice_40__iic-01-50
49-
:derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
49+
:satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
5050

5151
Following architectural elements shall be defined on the respective hierarchical level:
5252

@@ -76,7 +76,7 @@ Architectural Model
7676
:status: valid
7777
:tags: done_automation
7878
:complies: std_req__iso26262__support_6431, std_req__iso26262__support_6432
79-
:derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
79+
:satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
8080

8181
For modeling the viewpoints following relations shall be used:
8282

@@ -95,7 +95,7 @@ Architectural Views
9595
:status: valid
9696
:tags: manual_prio_1
9797
:complies: std_req__iso26262__support_6432, std_req__iso26262__software_742, std_req__aspice_40__SWE-2-BP1, std_req__aspice_40__SWE-2-BP2
98-
:derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
98+
:satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
9999

100100
The architecture shall be shown on following views on each architectural level:
101101

@@ -113,7 +113,7 @@ Attributes of Architectural Elements
113113
:status: valid
114114
:tags: manual_prio_1, attribute, mandatory
115115
:complies: std_req__iso26262__support_6425, std_req__iso26262__support_6432
116-
:derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
116+
:satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
117117

118118
Each architectural element shall have a unique ID. It shall be in a format which is also human readable and consists of
119119

@@ -127,7 +127,7 @@ Attributes of Architectural Elements
127127
:id: gd_req__arch_attr_security
128128
:status: valid
129129
:tags: manual_prio_1, attribute, mandatory
130-
:derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
130+
:satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
131131

132132
Each architectural element shall have a security relevance identifier:
133133

@@ -139,7 +139,7 @@ Attributes of Architectural Elements
139139
:status: valid
140140
:tags: manual_prio_1, attribute, mandatory
141141
:complies: std_req__iso26262__support_6421, std_req__iso26262__support_6425, std_req__iso26262__software_746
142-
:derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
142+
:satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
143143

144144
Each architectural element shall have a automotive safety integrity level (ASIL) identifier:
145145

@@ -151,7 +151,7 @@ Attributes of Architectural Elements
151151
:status: valid
152152
:tags: manual_prio_1, attribute, mandatory
153153
:complies: std_req__iso26262__support_6425
154-
:derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
154+
:satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
155155

156156
Each architectural element shall have a status:
157157

@@ -166,7 +166,7 @@ Traceability to Requirements and AoU
166166
:status: valid
167167
:tags: manual_prio_1, attribute
168168
:complies: std_req__iso26262__support_6425, std_req__aspice_40__SWE-2-BP4
169-
:derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
169+
:satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
170170

171171
Architectural views (feature/comp_arc_sta, feature/comp_arc_dyn) and interfaces (logic/real_arc_int)
172172
should be linked to a requirement on the corresponding level.
@@ -181,7 +181,7 @@ Traceability to Requirements and AoU
181181
:status: valid
182182
:tags: manual_prio_1, attribute
183183
:complies: std_req__iso26262__support_6425, std_req__aspice_40__SWE-2-BP4
184-
:derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
184+
:satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
185185

186186
Architectural elements (feat_arc_sta, comp) shall be linked to AoUs if the element fulfills these.
187187

@@ -190,7 +190,7 @@ Traceability to Requirements and AoU
190190
:status: valid
191191
:tags: manual_prio_1
192192
:complies: std_req__iso26262__support_6432, std_req__aspice_40__SWE-2-BP4
193-
:derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
193+
:satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
194194

195195
Requirements shall be satisfied by an architectural element on the corresponding level.
196196

@@ -209,7 +209,7 @@ Checks for Architectural Design
209209
:id: gd_req__arch_attr_mandatory
210210
:status: valid
211211
:tags: prio_1_automation, attribute, check
212-
:derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
212+
:satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
213213

214214
It shall be checked if all mandatory attributes for each architectural element are provided by the user. For all elements following attributes shall be mandatory:
215215

@@ -223,7 +223,7 @@ Checks for Architectural Design
223223
:id: gd_req__arch_linkage_safety
224224
:status: valid
225225
:tags: prio_1_automation, attribute, check
226-
:derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
226+
:satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
227227
:complies: std_req__aspice_40__SWE-2-BP4
228228

229229
It shall be checked that every valid safety architectural element is linked according to the defined model :need:`gd_req__arch_build_blocks_corr`.
@@ -232,7 +232,7 @@ Checks for Architectural Design
232232
:id: gd_req__arch_linkage_safety_trace
233233
:status: valid
234234
:tags: prio_1_automation, attribute, check
235-
:derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
235+
:satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
236236
:complies: std_req__iso26262__software_746, std_req__iso26262__software_748
237237

238238
It shall be checked that valid safety architectural elements (Safety!=QM) can only be linked against valid safety architectural elements.
@@ -241,15 +241,15 @@ Checks for Architectural Design
241241
:id: gd_req__arch_linkage_security_trace
242242
:status: valid
243243
:tags: prio_2_automation, attribute, check
244-
:derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
244+
:satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
245245

246246
It shall be checked that security relevant architectural elements (Security==YES) can only be linked against security relevant architectural elements.
247247

248248
.. gd_req:: Check of Architecture linkage requirement
249249
:id: gd_req__arch_linkage_requirement
250250
:status: valid
251251
:tags: prio_1_automation, attribute, check
252-
:derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
252+
:satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
253253

254254
It shall be checked that each architectural element (safety!=QM) is linked against at least one safety requirement (safety!=QM).
255255
It shall be checked that architectural elements with safety=QM are not linked against safety requirements (safety!=QM).
@@ -258,7 +258,7 @@ Checks for Architectural Design
258258
:id: gd_req__arch_linkage_requirement_type
259259
:status: valid
260260
:tags: prio_3_automation, attribute, check
261-
:derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
261+
:satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
262262

263263
It shall be checked that requirements of a respective type can only be linked to architectural elements according to following traceability:
264264

@@ -269,7 +269,7 @@ Checks for Architectural Design
269269
:id: gd_req__arch_linkage_aou
270270
:status: valid
271271
:tags: prio_2_automation, attribute, check
272-
:derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
272+
:satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
273273

274274
It shall be checked that architectural static view (feature/comp_arc_sta) are not linked to its own AoU
275275
("own" means the AoU linked as "mitigated_by" to the Safety/Security Analysis linked via "violates" to the element,
@@ -279,14 +279,14 @@ Checks for Architectural Design
279279
:id: gd_req__arch_consistency_interf
280280
:status: valid
281281
:tags: prio_2_automation, model, check
282-
:derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
282+
:satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
283283

284284
It shall be checked if any interface referred by the features (link from Feature to Logical Arc. Interfaces must be defined and exists) is matched by an "implements" link in the Module (from component to Logical Arc. Interface). Additionally it shall be checked if the feature architecture are linked against at least one logical architectural interface.
285285

286286
.. gd_req:: Check of Architecture consistency in dynamic architecture
287287
:id: gd_req__arch_consistency_dynamic
288288
:status: valid
289289
:tags: prio_3_automation, model, check
290-
:derived_from: wf__cr_mt_featarch, wf__cr_mt_comparch
290+
:satisfies: wf__cr_mt_featarch, wf__cr_mt_comparch
291291

292292
It shall be checked if all SW components which are mentioned in the dynamic architecture views are defined in the static architecture.

0 commit comments

Comments
 (0)