Merge pull request #2325 from eclipse-score/aschemmel-tech-module-safety-status

Modules safety plan status updates

Author: masc2023

docs/index.rst

@@ -94,7 +94,7 @@ Project structure and processes
       ^^^
       Read about our project and organization structure in the
       :ref:`Project Handbook <pmp>`.
-      And learn how we deal with :need:`doc__platform_safety_plan` or care about :need:`doc__verification_plan`.
+      And learn how we deal with :need:`doc__score_platform_safety_plan` or care about :need:`doc__verification_plan`.
 
 .. dropdown:: Click to see the complete sitemap
 

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

@@ -328,3 +328,6 @@ Assumptions of Use
 
    It shall be ensured that all safety relevant events/fields in the service type,
    are the same in all configurations.
+
+.. needextend:: "__communication_" in id
+   :+tags: communication

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

@@ -15,8 +15,6 @@
 Module Safety Plan
 ******************
 
-.. note:: Document header
-
 .. document:: Communication Safety Plan
    :id: doc__communication_safety_plan
    :status: draft
@@ -29,7 +27,7 @@ Module Safety Plan
 Functional Safety Management Context
 ====================================
 
-This Safety Plan adds to the :need:`doc__platform_safety_plan` all the module development relevant work products needed for ISO 26262 conformity.
+This Safety Plan adds to the :need:`doc__score_platform_safety_plan` all the module development relevant work products needed for ISO 26262 conformity.
 
 Functional Safety Management Scope
 ==================================
@@ -55,7 +53,7 @@ Functional Safety Management Roles
 Tailoring
 =========
 
-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.
+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.
 
 - Excluded for this module are additionally the following work products (and their related requirements):
 
@@ -77,72 +75,52 @@ Module Work products List
         * - Work product Id
           - Link to process
           - Process status
-          - Link to issue
           - Link to WP
-          - WP status
 
         * - :need:`wp__module_safety_plan`
           - :need:`gd_guidl__saf_plan_definitions`
           - :ndf:`copy('status', need_id='gd_guidl__saf_plan_definitions')`
-          - n/a
           - this document
-          - see above
 
         * - :need:`wp__module_safety_package`
           - :need:`gd_guidl__saf_package`
           - :ndf:`copy('status', need_id='gd_guidl__saf_package')`
-          - n/a
           - this document (including the linked documentation)
-          - see above (and below)
 
         * - :need:`wp__fdr_reports` (module Safety Plan)
           - :need:`gd_chklst__safety_plan`
           - :ndf:`copy('status', need_id='gd_chklst__safety_plan')`
-          - <Link to issue>
           - :need:`doc__communication_safety_plan_fdr`
-          - :ndf:`copy('status', need_id='doc__communication_safety_plan_fdr')`
 
         * - :need:`wp__fdr_reports` (module Safety Package)
           - :need:`gd_chklst__safety_package`
           - :ndf:`copy('status', need_id='gd_chklst__safety_package')`
-          - <Link to issue>
           - :need:`doc__communication_safety_package_fdr`
-          - :ndf:`copy('status', need_id='doc__communication_safety_package_fdr')`
 
         * - :need:`wp__fdr_reports` (module's Safety Analyses & DFA)
-          - Safety Analysis FDR tbd
-          - <automated>
+          - :need:`gd_chklst__safety_analysis`
+          - :ndf:`copy('status', need_id='gd_chklst__safety_analysis')`
           - tailored
-          - n/a
-          - n/a
 
         * - :need:`wp__audit_report`
           - performed by external experts
           - n/a
-          - `#77 <https://github.com/eclipse-score/process_description/issues/77>`_
           - <Link to WP>
-          - <WP status (manual)>
 
         * - :need:`wp__module_safety_manual`
           - :need:`gd_temp__safety_manual`
           - :ndf:`copy('status', need_id='gd_temp__safety_manual')`
-          - <Link to issue>
           - :need:`doc__communication_safety_manual`
-          - :ndf:`copy('status', need_id='doc__communication_safety_manual')`
 
         * - :need:`wp__verification_module_ver_report`
           - :need:`gd_temp__mod_ver_report`
           - :ndf:`copy('status', need_id='gd_temp__mod_ver_report')`
-          - <Link to issue>
           - :need:`doc__communication_verification_report`
-          - :ndf:`copy('status', need_id='doc__communication_verification_report')`
 
         * - :need:`wp__module_sw_release_note`
           - :need:`gd_temp__rel_mod_rel_note`
           - :ndf:`copy('status', need_id='gd_temp__rel_mod_rel_note')`
-          - `#1925 <https://github.com/eclipse-score/score/issues/1925>`_
           - :need:`doc__communication_release_note`
-          - :ndf:`copy('status', need_id='doc__communication_release_note')`
 
 Component lola Work products List
 ---------------------------------
@@ -153,90 +131,109 @@ Component lola Work products List
         * - Work product Id
           - Link to process
           - Process status
-          - Link to issue
           - Link to WP
-          - WP/doc status
 
         * - :need:`wp__requirements_comp`
           - :need:`gd_temp__req_comp_req`
           - :ndf:`copy('status', need_id='gd_temp__req_comp_req')`
-          - n/a
-          - `lola trlc <https://github.com/eclipse-score/communication/blob/main/score/mw/com/requirements/component_requirements/component_requirements_ipc.trlc>`_
-          - valid
+          - :need:`doc__lola_requirements`
 
         * - :need:`wp__requirements_comp_aou`
           - :need:`gd_temp__req_aou_req`
           - :ndf:`copy('status', need_id='gd_temp__req_aou_req')`
-          - `#1987 <https://github.com/eclipse-score/score/pull/1987>`_
-          - `lola/aou <https://github.com/eclipse-score/score/docs/modules/communication/docs/requirements/aou_req.rst>`_
-          - in progress
+          - :need:`doc__communication_aou`
 
         * - :need:`wp__requirements_inspect`
           - :need:`gd_chklst__req_inspection`
           - :ndf:`copy('status', need_id='gd_chklst__req_inspection')`
           - tailored
-          - n/a
-          - n/a
 
         * - :need:`wp__component_arch`
           - :need:`gd_temp__arch_comp`
           - :ndf:`copy('status', need_id='gd_temp__arch_comp')`
-          - n/a
           - :need:`doc__lola_architecture`
-          - :ndf:`copy('status', need_id='doc__lola_architecture')`
 
         * - :need:`wp__sw_arch_verification`
           - :need:`gd_chklst__arch_inspection_checklist`
           - :ndf:`copy('status', need_id='gd_chklst__arch_inspection_checklist')`
           - tailored
-          - n/a
-          - n/a
 
         * - :need:`wp__sw_component_fmea`
           - :need:`gd_temp__comp_saf_fmea`
           - :ndf:`copy('status', need_id='gd_temp__comp_saf_fmea')`
-          - <Link to issue>
           - :need:`doc__lola_fmea`
-          - :ndf:`copy('status', need_id='doc__lola_fmea')`
 
         * - :need:`wp__sw_component_dfa`
           - :need:`gd_temp__comp_saf_dfa`
           - :ndf:`copy('status', need_id='gd_temp__comp_saf_dfa')`
-          - <Link to issue>
           - :need:`doc__lola_dfa`
-          - :ndf:`copy('status', need_id='doc__lola_dfa')`
 
         * - :need:`wp__sw_implementation`
           - :need:`gd_guidl__implementation`
           - :ndf:`copy('status', need_id='gd_guidl__implementation')`
-          - n/a
-          - `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>`_
-          - valid
+          - `lola/.h/.cpp <https://github.com/eclipse-score/communication/blob/main/score/mw/com>`_, :need:`doc__lola_detailed_design`
 
         * - :need:`wp__verification_sw_unit_test`
           - :need:`gd_guidl__verification_guide`
           - :ndf:`copy('status', need_id='gd_guidl__verification_guide')`
-          - n/a
           - `lola/test.cpp <https://github.com/eclipse-score/communication/blob/main/score/mw/com>`_
-          - valid
 
         * - :need:`wp__sw_implementation_inspection`
           - :need:`gd_chklst__impl_inspection_checklist`
           - :ndf:`copy('status', need_id='gd_chklst__impl_inspection_checklist')`
-          - n/a
           - External process
-          - n/a
 
         * - :need:`wp__verification_comp_int_test`
           - :need:`gd_guidl__verification_guide`
           - :ndf:`copy('status', need_id='gd_guidl__verification_guide')`
-          - <Link to issue>
           - <Link to WP>
-          - <automated>
 
         * - :need:`wp__sw_component_class`
           - :need:`gd_guidl__component_classification`
           - :ndf:`copy('status', need_id='gd_guidl__component_classification')`
-          - n/a
           - :need:`doc__lola_comp_class`
-          - :ndf:`copy('status', need_id='doc__lola_comp_class')`
+
+Module Safety Package
+=====================
+
+To create the safety package (according to :need:`gd_guidl__saf_package`) the following
+documents and work products status have to go to "valid" (after the relevant verification were performed).
+
+Module Documents Status
+-----------------------
+
+For all the work product documents the status can be seen by following the "Link to WP".
+A summary of the status is also documented in the project's documentation management plan.
+
+See :ref:`documents_docs_modules_communication_docs`
+
+Component Documents Status
+--------------------------
+
+For all the work product documents the status can be seen by following the "Link to WP".
+A summary of the status is also documented in the project's documentation management plan.
+
+See :ref:`documents_docs_modules_communication_components`
+
+Component Requirements Status
+-----------------------------
+
+not documented as needs, `lola trlc <https://github.com/eclipse-score/communication/blob/main/score/mw/com/requirements/component_requirements/component_requirements_ipc.trlc>`_
+shows no status attribute
+
+Component AoU Status
+--------------------
+
+.. needtable::
+   :filter: "communication" in docname and "requirements" in docname and docname is not None
+   :style: table
+   :types: aou_req
+   :tags: communication
+   :columns: id;status;tags
+   :colwidths: 25,25,25
+   :sort: title
+
+Component Architecture Status
+-----------------------------
+
+see document link :need:`doc__lola_architecture` (as above)