Skip to content

Commit 405d75b

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

22 files changed

Lines changed: 198 additions & 202 deletions

File tree

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

Lines changed: 14 additions & 7 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

@@ -80,17 +80,24 @@ The live feature architecture template snippets are maintained in the
8080

8181
.. code-block:: rst
8282
83+
.. feat:: Feature Name
84+
:id: feat__feature_name
85+
:security: YES
86+
:safety: ASIL_B
87+
:status: invalid
88+
:includes: logic_arc_int__feature_name__interface_name1
89+
90+
General Feature Description
91+
8392
.. feat_arc_sta:: Feature Static View
8493
:id: feat_arc_sta__feature_name__static_view
8594
:security: YES
8695
:safety: ASIL_B
8796
:status: invalid
88-
:satisfies: feat_req__feature_name__some_title
97+
:fulfils: feat_req__feature_name__some_title
8998
:includes: logic_arc_int__feature_name__interface_name1
9099
:belongs_to: feat__feature_name
91100
92-
General Feature Description
93-
94101
.. needarch::
95102
:scale: 50
96103
:align: center
@@ -107,7 +114,7 @@ Dynamic Architecture
107114
:security: YES
108115
:safety: ASIL_B
109116
:status: invalid
110-
:satisfies: feat_req__feature_name__some_title
117+
:fulfils: feat_req__feature_name__some_title
111118
:belongs_to: feat__feature_name
112119
113120
Put here a sequence diagram
@@ -122,7 +129,7 @@ Logical Interfaces
122129
:security: YES
123130
:safety: ASIL_B
124131
:status: invalid
125-
:satisfies: feat_req__feature_name__some_title
132+
:fulfils: feat_req__feature_name__some_title
126133
127134
General Interface Description
128135

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: 4 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::
@@ -452,6 +452,8 @@ The following section links to the rendered feature example that is now maintain
452452
Component Architecture
453453
^^^^^^^^^^^^^^^^^^^^^^
454454

455+
The following section is an example, how an component looks like and how the detail design of an component is described. Please note that components with an "ASIL_B" safety rating are highlighted with red borders in the diagram (e.g., "Component 1").
456+
455457
The rendered component examples are maintained in the
456458
`module template documentation <https://eclipse-score.github.io/module_template/main/>`__.
457459

@@ -462,7 +464,7 @@ The rendered component examples are maintained in the
462464
:status: valid
463465
:safety: ASIL_B
464466
:security: NO
465-
:satisfies: comp_req__example_feature__archex_example_req
467+
:fulfils: comp_req__example_feature__archex_example_req
466468
:belongs_to: comp__component_component_getstrt
467469
468470
.. needarch::

0 commit comments

Comments
 (0)