Skip to content

Commit 93a82a5

Browse files
Modules safety plans status updates
Resolves: #1304
1 parent 63126ba commit 93a82a5

File tree

10 files changed

+186
-345
lines changed

10 files changed

+186
-345
lines changed

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ Project structure and processes
9494
^^^
9595
Read about our project and organization structure in the
9696
:ref:`Project Handbook <pmp>`.
97-
And learn how we deal with :need:`doc__platform_safety_plan` or care about :need:`doc__verification_plan`.
97+
And learn how we deal with :need:`doc__score_platform_safety_plan` or care about :need:`doc__verification_plan`.
9898

9999
.. dropdown:: Click to see the complete sitemap
100100

docs/modules/baselibs/docs/safety_mgt/module_safety_plan.rst

Lines changed: 64 additions & 148 deletions
Large diffs are not rendered by default.

docs/modules/communication/docs/requirements/aou_req.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -328,3 +328,6 @@ Assumptions of Use
328328

329329
It shall be ensured that all safety relevant events/fields in the service type,
330330
are the same in all configurations.
331+
332+
.. needextend:: "__communication_" in id
333+
:+tags: communication

docs/modules/communication/docs/safety_mgt/module_safety_plan.rst

Lines changed: 52 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Module Safety Plan
2929
Functional Safety Management Context
3030
====================================
3131

32-
This Safety Plan adds to the :need:`doc__platform_safety_plan` all the module development relevant work products needed for ISO 26262 conformity.
32+
This Safety Plan adds to the :need:`doc__score_platform_safety_plan` all the module development relevant work products needed for ISO 26262 conformity.
3333

3434
Functional Safety Management Scope
3535
==================================
@@ -55,7 +55,7 @@ Functional Safety Management Roles
5555
Tailoring
5656
=========
5757

58-
Additional to the tailoring in the SW platform project as defined in the :need:`doc__platform_safety_plan` we define here the additional tailoring on module level.
58+
Additional to the tailoring in the SW platform project as defined in the :need:`doc__score_platform_safety_plan` we define here the additional tailoring on module level.
5959

6060
- Excluded for this module are additionally the following work products (and their related requirements):
6161

@@ -77,72 +77,52 @@ Module Work products List
7777
* - Work product Id
7878
- Link to process
7979
- Process status
80-
- Link to issue
8180
- Link to WP
82-
- WP status
8381

8482
* - :need:`wp__module_safety_plan`
8583
- :need:`gd_guidl__saf_plan_definitions`
8684
- :ndf:`copy('status', need_id='gd_guidl__saf_plan_definitions')`
87-
- n/a
8885
- this document
89-
- see above
9086

9187
* - :need:`wp__module_safety_package`
9288
- :need:`gd_guidl__saf_package`
9389
- :ndf:`copy('status', need_id='gd_guidl__saf_package')`
94-
- n/a
9590
- this document (including the linked documentation)
96-
- see above (and below)
9791

9892
* - :need:`wp__fdr_reports` (module Safety Plan)
9993
- :need:`gd_chklst__safety_plan`
10094
- :ndf:`copy('status', need_id='gd_chklst__safety_plan')`
101-
- <Link to issue>
10295
- :need:`doc__communication_safety_plan_fdr`
103-
- :ndf:`copy('status', need_id='doc__communication_safety_plan_fdr')`
10496

10597
* - :need:`wp__fdr_reports` (module Safety Package)
10698
- :need:`gd_chklst__safety_package`
10799
- :ndf:`copy('status', need_id='gd_chklst__safety_package')`
108-
- <Link to issue>
109100
- :need:`doc__communication_safety_package_fdr`
110-
- :ndf:`copy('status', need_id='doc__communication_safety_package_fdr')`
111101

112102
* - :need:`wp__fdr_reports` (module's Safety Analyses & DFA)
113-
- Safety Analysis FDR tbd
114-
- <automated>
103+
- :need:`gd_chklst__safety_analysis`
104+
- :ndf:`copy('status', need_id='gd_chklst__safety_analysis')`
115105
- tailored
116-
- n/a
117-
- n/a
118106

119107
* - :need:`wp__audit_report`
120108
- performed by external experts
121109
- n/a
122-
- `#77 <https://github.com/eclipse-score/process_description/issues/77>`_
123110
- <Link to WP>
124-
- <WP status (manual)>
125111

126112
* - :need:`wp__module_safety_manual`
127113
- :need:`gd_temp__safety_manual`
128114
- :ndf:`copy('status', need_id='gd_temp__safety_manual')`
129-
- <Link to issue>
130115
- :need:`doc__communication_safety_manual`
131-
- :ndf:`copy('status', need_id='doc__communication_safety_manual')`
132116

133117
* - :need:`wp__verification_module_ver_report`
134118
- :need:`gd_temp__mod_ver_report`
135119
- :ndf:`copy('status', need_id='gd_temp__mod_ver_report')`
136-
- <Link to issue>
137120
- :need:`doc__communication_verification_report`
138-
- :ndf:`copy('status', need_id='doc__communication_verification_report')`
139121

140122
* - :need:`wp__module_sw_release_note`
141123
- :need:`gd_temp__rel_mod_rel_note`
142124
- :ndf:`copy('status', need_id='gd_temp__rel_mod_rel_note')`
143-
- `#1925 <https://github.com/eclipse-score/score/issues/1925>`_
144125
- :need:`doc__communication_release_note`
145-
- :ndf:`copy('status', need_id='doc__communication_release_note')`
146126

147127
Component lola Work products List
148128
---------------------------------
@@ -153,90 +133,109 @@ Component lola Work products List
153133
* - Work product Id
154134
- Link to process
155135
- Process status
156-
- Link to issue
157136
- Link to WP
158-
- WP/doc status
159137

160138
* - :need:`wp__requirements_comp`
161139
- :need:`gd_temp__req_comp_req`
162140
- :ndf:`copy('status', need_id='gd_temp__req_comp_req')`
163-
- n/a
164-
- `lola trlc <https://github.com/eclipse-score/communication/blob/main/score/mw/com/requirements/component_requirements/component_requirements_ipc.trlc>`_
165-
- valid
141+
- :need:`doc__lola_requirements`
166142

167143
* - :need:`wp__requirements_comp_aou`
168144
- :need:`gd_temp__req_aou_req`
169145
- :ndf:`copy('status', need_id='gd_temp__req_aou_req')`
170-
- `#1987 <https://github.com/eclipse-score/score/pull/1987>`_
171-
- `lola/aou <https://github.com/eclipse-score/score/docs/modules/communication/docs/requirements/aou_req.rst>`_
172-
- in progress
146+
- :need:`doc__communication_aou`
173147

174148
* - :need:`wp__requirements_inspect`
175149
- :need:`gd_chklst__req_inspection`
176150
- :ndf:`copy('status', need_id='gd_chklst__req_inspection')`
177151
- tailored
178-
- n/a
179-
- n/a
180152

181153
* - :need:`wp__component_arch`
182154
- :need:`gd_temp__arch_comp`
183155
- :ndf:`copy('status', need_id='gd_temp__arch_comp')`
184-
- n/a
185156
- :need:`doc__lola_architecture`
186-
- :ndf:`copy('status', need_id='doc__lola_architecture')`
187157

188158
* - :need:`wp__sw_arch_verification`
189159
- :need:`gd_chklst__arch_inspection_checklist`
190160
- :ndf:`copy('status', need_id='gd_chklst__arch_inspection_checklist')`
191161
- tailored
192-
- n/a
193-
- n/a
194162

195163
* - :need:`wp__sw_component_fmea`
196164
- :need:`gd_temp__comp_saf_fmea`
197165
- :ndf:`copy('status', need_id='gd_temp__comp_saf_fmea')`
198-
- <Link to issue>
199166
- :need:`doc__lola_fmea`
200-
- :ndf:`copy('status', need_id='doc__lola_fmea')`
201167

202168
* - :need:`wp__sw_component_dfa`
203169
- :need:`gd_temp__comp_saf_dfa`
204170
- :ndf:`copy('status', need_id='gd_temp__comp_saf_dfa')`
205-
- <Link to issue>
206171
- :need:`doc__lola_dfa`
207-
- :ndf:`copy('status', need_id='doc__lola_dfa')`
208172

209173
* - :need:`wp__sw_implementation`
210174
- :need:`gd_guidl__implementation`
211175
- :ndf:`copy('status', need_id='gd_guidl__implementation')`
212-
- n/a
213-
- `lola/.h/.cpp <https://github.com/eclipse-score/communication/blob/main/score/mw/com>`_, `lola/design <https://github.com/eclipse-score/communication/blob/main/score/mw/com/design>`_
214-
- valid
176+
- `lola/.h/.cpp <https://github.com/eclipse-score/communication/blob/main/score/mw/com>`_, :need:`doc__lola_detailed_design`
215177

216178
* - :need:`wp__verification_sw_unit_test`
217179
- :need:`gd_guidl__verification_guide`
218180
- :ndf:`copy('status', need_id='gd_guidl__verification_guide')`
219-
- n/a
220181
- `lola/test.cpp <https://github.com/eclipse-score/communication/blob/main/score/mw/com>`_
221-
- valid
222182

223183
* - :need:`wp__sw_implementation_inspection`
224184
- :need:`gd_chklst__impl_inspection_checklist`
225185
- :ndf:`copy('status', need_id='gd_chklst__impl_inspection_checklist')`
226-
- n/a
227186
- External process
228-
- n/a
229187

230188
* - :need:`wp__verification_comp_int_test`
231189
- :need:`gd_guidl__verification_guide`
232190
- :ndf:`copy('status', need_id='gd_guidl__verification_guide')`
233-
- <Link to issue>
234191
- <Link to WP>
235-
- <automated>
236192

237193
* - :need:`wp__sw_component_class`
238194
- :need:`gd_guidl__component_classification`
239195
- :ndf:`copy('status', need_id='gd_guidl__component_classification')`
240-
- n/a
241196
- :need:`doc__lola_comp_class`
242-
- :ndf:`copy('status', need_id='doc__lola_comp_class')`
197+
198+
Module Safety Package
199+
=====================
200+
201+
To create the safety package (according to :need:`gd_guidl__saf_package`) the following
202+
documents and work products status have to go to "valid" (after the relevant verification were performed).
203+
204+
Module Documents Status
205+
-----------------------
206+
207+
For all the work product documents the status can be seen by following the "Link to WP".
208+
A summary of the status is also documented in the project's documentation management plan.
209+
210+
See :ref:`documents_docs_modules_communication_docs`
211+
212+
Component Documents Status
213+
--------------------------
214+
215+
For all the work product documents the status can be seen by following the "Link to WP".
216+
A summary of the status is also documented in the project's documentation management plan.
217+
218+
See :ref:`documents_docs_modules_communication_components`
219+
220+
Component Requirements Status
221+
-----------------------------
222+
223+
not documented as needs, `lola trlc <https://github.com/eclipse-score/communication/blob/main/score/mw/com/requirements/component_requirements/component_requirements_ipc.trlc>`_
224+
shows no status attribute
225+
226+
Component AoU Status
227+
--------------------
228+
229+
.. needtable::
230+
:filter: "communication" in docname and "requirements" in docname and docname is not None
231+
:style: table
232+
:types: aou_req
233+
:tags: communication
234+
:columns: id;status;tags
235+
:colwidths: 25,25,25
236+
:sort: title
237+
238+
Component Architecture Status
239+
-----------------------------
240+
241+
see document link :need:`doc__lola_architecture` (as above)

0 commit comments

Comments
 (0)