Skip to content

Commit 09e30ff

Browse files
committed
remove out-of-scope gd_req and inline example changes
1 parent ce7947a commit 09e30ff

5 files changed

Lines changed: 36 additions & 146 deletions

File tree

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-
:satisfies: wf__monitor_verify_requirements
190+
:derived_from: 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-
:satisfies: wf__mr_vy_arch
203+
:derived_from: 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-
:satisfies: wf__monitor_verify_requirements, wf__mr_vy_arch
218+
:derived_from: 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-
:satisfies: wf__monitor_verify_requirements, wf__mr_vy_arch
230+
:derived_from: 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-
:satisfies: wf__monitor_verify_requirements, wf__mr_vy_arch
239+
:derived_from: 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: 16 additions & 126 deletions
Original file line numberDiff line numberDiff line change
@@ -123,22 +123,8 @@ The feature architecture contain the following views:
123123
Static View
124124
-----------
125125

126-
The first viewpoint is named as *feature architecture*. It displays the SW Components within the SW modules (= dependable elements) which are required to realize the feature including their interactions. Also the *logical interfaces* and the interaction between the feature and the user are included in this view. On this architectural level the feature requirements shall be allocated. An example for the static architecture is shown here:
127-
128-
.. feat_arc_sta:: Feature 1 Architecture
129-
:id: feat_arc_sta__example_feature__feature_1
130-
:security: YES
131-
:safety: QM
132-
:status: valid
133-
:includes: logic_arc_int__example_feature__archex_logical_interface_1, logic_arc_int__example_feature__archex_logical_interface_2
134-
:satisfies: feat_req__example_feature__archdes_example_req
135-
:belongs_to: feat__example_feature
136-
137-
.. needarch::
138-
:scale: 50
139-
:align: center
140-
141-
{{ draw_feature(need(), needs) }}
126+
The first viewpoint is named as *feature architecture*. It displays the SW Components within the SW modules (= dependable elements) which are required to realize the feature including their interactions. Also the *logical interfaces* and the interaction between the feature and the user are included in this view. On this architectural level the feature requirements shall be allocated. A full rendered example for the static architecture is maintained in the
127+
`module template documentation <https://eclipse-score.github.io/module_template/main/>`__.
142128

143129
In all views, the components which are marked as ASIL_B related are drawn with red borders.
144130

@@ -164,20 +150,8 @@ See :ref:`uml_diagram_selection` in guideline for further information about the
164150
Interface View
165151
--------------
166152

167-
On the feature level only *logical interfaces* shall be displayed. This means that only logical names shall be provided for both the interface and the operations within. Those *logical interfaces* shall be connected to component interfaces on the module view.
168-
169-
.. logic_arc_int:: Logical Interface 1
170-
:id: logic_arc_int__example_feature__archcon_logical_interface_1
171-
:security: YES
172-
:safety: ASIL_B
173-
:status: valid
174-
:satisfies: feat_req__example_feature__archdes_example_req
175-
176-
.. needarch::
177-
:scale: 50
178-
:align: center
179-
180-
{{ draw_interface(need(), needs) }}
153+
On the feature level only *logical interfaces* shall be displayed. This means that only logical names shall be provided for both the interface and the operations within. Those *logical interfaces* shall be connected to component interfaces on the module view. A rendered logical-interface example is maintained in the
154+
`module template documentation <https://eclipse-score.github.io/module_template/main/>`__.
181155

182156
SW Module View
183157
==============
@@ -197,19 +171,8 @@ Static View
197171

198172
The *component architecture* describes the implementation of the functionalities in a white-box view. It describes the internal structure of SW components and their decomposition. It provides a more detailed information concerning the respective interfaces of a component. If a SW component interacts with a different component it is also included via a *use* relationship in the diagram. An example of the *component architecture* is displayed here:
199173

200-
.. comp_arc_sta:: Component 1 Static View
201-
:id: comp_arc_sta__example_feature__archdes_component_concept_1
202-
:status: valid
203-
:safety: ASIL_B
204-
:security: NO
205-
:satisfies: comp_req__example_feature__archex_example_req
206-
:belongs_to: comp__component_example_1
207-
208-
.. needarch::
209-
:scale: 50
210-
:align: center
211-
212-
{{ draw_component(need(), needs) }}
174+
A full rendered component-architecture example is maintained in the
175+
`module template documentation <https://eclipse-score.github.io/module_template/main/>`__.
213176

214177
The decomposition is optional and relies on the complexity of the component. Thus there is no graphic representation required for it.
215178
In all views the components which are marked as ASIL_B related are drawn in red color.
@@ -234,21 +197,8 @@ Following scenarios should be included:
234197
Interface View
235198
--------------
236199

237-
The component interface view shows the actual interfaces of the component. Also links to their corresponding logical interfaces are displayed in this view:
238-
239-
.. real_arc_int:: Component Interface 1
240-
:id: real_arc_int__example_feature__archdes_component_interface_1
241-
:status: valid
242-
:safety: ASIL_B
243-
:security: NO
244-
:satisfies: comp_req__example_feature__archex_example_req
245-
:language: cpp
246-
247-
.. needarch::
248-
:scale: 50
249-
:align: center
250-
251-
{{ draw_interface(need(), needs)}}
200+
The component interface view shows the actual interfaces of the component. Also links to their corresponding logical interfaces are displayed in this view. A rendered component-interface example is maintained in the
201+
`module template documentation <https://eclipse-score.github.io/module_template/main/>`__.
252202

253203
Platform View
254204
=============
@@ -471,29 +421,8 @@ Here are some excerpts of UML diagrams made from the requirements of that file.
471421
Feature Architecture
472422
^^^^^^^^^^^^^^^^^^^^
473423

474-
The following section is an example, how an `Feature <https://eclipse-score.github.io/score/main/features/index.html>`_ looks like and how the architecture of an Feature is described. Please note that components with an "ASIL_B" safety rating are highlighted with red borders in the diagram (e.g., "Component 1").
475-
476-
.. feat:: Feature Name
477-
:id: feat__feature_name_example
478-
:security: YES
479-
:safety: ASIL_B
480-
:status: invalid
481-
:includes: logic_arc_int__example_feature__archex_logical_interface_1
482-
483-
.. feat_arc_sta:: Feature Static Architecture View - Rendered Example
484-
:id: feat_arc_sta__example_feature__archdes_getstrt
485-
:security: YES
486-
:safety: QM
487-
:status: valid
488-
:includes: logic_arc_int__example_feature__archex_logical_interface_1, logic_arc_int__example_feature__archex_logical_interface_2
489-
:satisfies: feat_req__example_feature__archdes_example_req
490-
:belongs_to: feat__example_feature
491-
492-
.. needarch::
493-
:scale: 50
494-
:align: center
495-
496-
{{ draw_feature(need(), needs) }}
424+
The following section links to the rendered feature example that is now maintained in the
425+
`module template documentation <https://eclipse-score.github.io/module_template/main/>`__.
497426

498427
.. code-block:: rst
499428
@@ -523,21 +452,8 @@ The following section is an example, how an `Feature <https://eclipse-score.gith
523452
Component Architecture
524453
^^^^^^^^^^^^^^^^^^^^^^
525454

526-
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").
527-
528-
.. comp_arc_sta:: Component Static View - Rendered Example
529-
:id: comp_arc_sta__example_feature__component_getstrt
530-
:status: valid
531-
:safety: ASIL_B
532-
:security: NO
533-
:satisfies: comp_req__example_feature__archex_example_req
534-
:belongs_to: comp__component_example_1
535-
536-
.. needarch::
537-
:scale: 50
538-
:align: center
539-
540-
{{ draw_component( need(), needs ) }}
455+
The rendered component examples are maintained in the
456+
`module template documentation <https://eclipse-score.github.io/module_template/main/>`__.
541457

542458
.. code-block:: rst
543459
@@ -588,20 +504,8 @@ Besides storing the output it is also possible to display the generated PlantUML
588504
589505
Debug example for component architecture:
590506

591-
.. comp_arc_sta:: Component Static View - Rendered Debug Example
592-
:id: comp_arc_sta__example_feature__component_getstrt_debug
593-
:status: valid
594-
:safety: ASIL_B
595-
:security: NO
596-
:satisfies: comp_req__example_feature__archex_example_req
597-
:belongs_to: comp__component_example_1
598-
599-
.. needarch::
600-
:scale: 50
601-
:align: center
602-
:debug:
603-
604-
{{ draw_component( need(), needs ) }}
507+
See the rendered debug example in the
508+
`module template documentation <https://eclipse-score.github.io/module_template/main/>`__.
605509

606510
.. _manual_addition_uml:
607511

@@ -630,22 +534,8 @@ To make *needuml* work we have to replace the *need()* call with a different fun
630534
}
631535
CM -> LI1: EXTRA_LINKAGE_MANUALLY_ADDED
632536
633-
.. comp_arc_sta:: Component Architecture Static View - Rendered Example Manually Edited
634-
:id: comp_arc_sta__example_feature__component_manual_getstrt
635-
:status: valid
636-
:safety: ASIL_B
637-
:security: NO
638-
:uses: logic_arc_int__example_feature__archex_logical_interface_1
639-
:satisfies: comp_req__example_feature__archex_example_req
640-
:belongs_to: comp__component_example_1
641-
642-
.. needarch::
643-
644-
{{ draw_component( needs.get('comp__component_example_1'), needs ) }}
645-
646-
component "Component Manual" as CM {
647-
}
648-
CM -> logic_arc_int__example_feature__archex_logical_interface_1: EXTRA_LINKAGE_MANUALLY_ADDED
537+
See the rendered manual-edit example in the
538+
`module template documentation <https://eclipse-score.github.io/module_template/main/>`__.
649539

650540
You can add any layout or additional configuration you want before you call the *draw_xyz*.
651541

process/process_areas/process_management/guidance/process_management_templates.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ Templates
175175
:id: gd_req__<process area or abbreviation>_<...>
176176
:status: <draft|valid>
177177
:tags: <process area or abbreviation>
178-
:derived_from: <defined workflow:wf__<...>>, ..., <defined workflow:wf__<...>>
178+
:satisfies: <defined workflow:wf__<...>>, ..., <defined workflow:wf__<...>>
179179
:complies: <standard requirement:std_req__<...>>, ..., <standard requirement:std_req__<...>>
180180
181181

process/process_areas/requirements_engineering/guidance/requirements_templates.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Templates
5858
5959
.. gd_req:: <Title>
6060
:id: gd_req__<process>__<Title>
61-
:derived_from: <link to guidance id>
61+
:satisfies: <link to guidance id>
6262
:complies: <link to standard requirement>
6363
:status: <valid|invalid>
6464
@@ -73,7 +73,7 @@ Templates
7373
:id: tool_req__<tool>__<Title>
7474
:security: <YES|NO>
7575
:safety: <QM|ASIL_B>
76-
:derived_from: <link to process req id>
76+
:satisfies: <link to process req id>
7777
:status: <valid|invalid>
7878
:implemented: <YES|PARTIAL|NO>
7979

0 commit comments

Comments
 (0)