Skip to content

Comments

issue_2501_created_missing_drafts#2600

Open
attifunel wants to merge 17 commits intoeclipse-score:mainfrom
attifunel:Create_missing_draft_documents
Open

issue_2501_created_missing_drafts#2600
attifunel wants to merge 17 commits intoeclipse-score:mainfrom
attifunel:Create_missing_draft_documents

Conversation

@attifunel
Copy link
Contributor

@attifunel attifunel commented Feb 13, 2026

Creates the documents in the safety plan which previously been "Link to WP" and their according status in "automated"
Use the folder structure as in the templates from the process_description. Missing templates for platform levels, are created from the ones from module level.

Resolves: #2501

@github-actions
Copy link

⚠️ Docs-as-Code version mismatch detected
Please check the CI build logs for details and align the documentation version with the Bazel dependency.

@attifunel attifunel changed the title issue_2501_createx_missing_drafts issue_2501_created_missing_drafts Feb 13, 2026

**Checklist**

Please note that it is mandatory to fill in the "passed" column with "yes" or "no" for each checklist item and additional to add in the remarks why it is passed or not passed. In case of "no" an issue link to the issue tracking system has to be added in the last column. See also :ref:`review_concept` for further information about reviews in general and inspection in particular.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/home/runner/work/score/score/docs/safety/fdr_reports_safety_analyses_DFA.rst:38: WARNING: undefined label: 'review_concept' [ref.ref]
/home/runner/work/score/score/docs/safety/fdr_reports_safety_analyses_DFA.rst:58: WARNING: undefined label: 'doc__platform_dfa' [ref.ref]
/home/runner/work/score/score/docs/safety/fdr_reports_safety_package.rst:41: WARNING: undefined label: 'doc_concept__wp_inspections' [ref.ref]
/home/runner/work/score/score/docs/safety/fdr_reports_safety_platform_safety_plan.rst:40: WARNING: undefined label: 'doc_concept__wp_inspections' [ref.ref]

Only Sphinx-Needs links work across repos but not labels.

-
* - REQ_01_02
- Are the templates for DFA and/or FMEA used?
- See :ref:`doc__platform_dfa`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- See :ref:`doc__platform_dfa`
- See :need:`doc__platform_dfa`

This should work.

@github-actions
Copy link

The created documentation from the pull request is available at: docu-html

@pahmann pahmann marked this pull request as ready for review February 17, 2026 14:50
Copy link
Contributor

@masc2023 masc2023 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All documents seems to be templates, Templates should be in process_description, Template Folder not in SCORE repo

**2. DFA Report**
- List of the performed component DFA, pass/fail with open mitigations

**3. Safety Analysis Report**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FMEA Report, as Safety Analysis in our context is superset including DFA and FMEA

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is already split in DFA and next subchapter Safety Analysis (i.e. FMEAs). I'd keep this structure because they're actually two analyses of very different type

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Compare here, should follow up definition, safety analysis is used as superset including DFA, therefore I woul propose, mention DFA and FMEA or only the superset term
https://eclipse-score.github.io/process_description/main/process_areas/safety_analysis/safety_analysis_concept.html

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the verification report used a template that is not compliant to https://eclipse-score.github.io/process_description//main/process_areas/verification/verification_workproducts.html#wp__verification_platform_ver_report. I will rewrite it accordingly, thanks for the notification

:status: draft
:safety: ASIL_B
:security: NO
:realizes: wp__verification_module_ver_report
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it it the platform verification report, so is these really realizing module verification report? I would assume each module has its own verification report and these is only the platform report

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, I will check

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed thanks

:safety: ASIL_B
:security: NO
:realizes: wp__verification_module_ver_report
:tags: template
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is a template, why is it in SCORE, Templates should be part of process_description Template Folder?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry I will fix it

@attifunel
Copy link
Contributor Author

All documents seems to be templates, Templates should be in process_description, Template Folder not in SCORE repo

They are not templates, but drafts. The explanatory content from the template is kept to help filling the content accordingly.

**2. DFA Report**
- List of the performed component DFA, pass/fail with open mitigations

**3. Safety Analysis Report**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Compare here, should follow up definition, safety analysis is used as superset including DFA, therefore I woul propose, mention DFA and FMEA or only the superset term
https://eclipse-score.github.io/process_description/main/process_areas/safety_analysis/safety_analysis_concept.html

:safety: ASIL_B
:security: NO
:realizes: wp__verification_module_ver_report
:tags: template
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IF it not template, then remove the tag template her and everywhere

@attifunel attifunel marked this pull request as draft February 18, 2026 08:51
@attifunel attifunel marked this pull request as ready for review February 18, 2026 13:53
# *******************************************************************************


Safety Analysis Checklist
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this not called like safety package: Safety Plan Formal Review Report -> Safety Analysis Formal Review Report, realizing anyway this work product?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

Safety Package Formal Review Report
===================================

.. note:: Document header
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove note here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

Safety Plan Formal Review Report
================================

.. note:: Document header
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove note here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

Safety Manual
=============

.. note:: Document header
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove note here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

Assumed Platform Safety Requirements
------------------------------------
| For the S-CORE Platformhe following safety related stakeholder requirements are assumed to define the top level functionality (purpose) of the S-CORE Platform. I.e. from these all the feature and component requirements implemented are derived.
| <List here all the stakeholder requirements, with safety not equal to QM, the module's components requirements are derived from.>
Copy link
Contributor

@masc2023 masc2023 Feb 18, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

May easier to read, if you put this kind of actions List here.. in Bold or Note or Attention, that the user can replace this later or remove it, while this is not any more a template

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done thanks

Assumptions on the Environment
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| Generally the assumption of the project platform SEooC is that it is integrated in a safe system, i.e. the POSIX OS it runs on is qualified and also the HW related failures are taken into account by the system integrator, if not otherwise stated in the module's safety concept.
| <List here all the OS calls the project platform expects to be safe.>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here, list is already there

requirements/index
modules/index
contribute/index
safety/index
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

may move safety behind PMP

Verification Report
===================

.. note:: Document header
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove the note

(can be several levels), passed/failed and completeness verdict, including normal
operation and failure reactions
- The list of requirements may also contain other verification methods like "Analysis"
- Formal evidence about the performed DFA
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Platform DFA, other DFAs are part of Safety Analsis

operation and failure reactions
- The list of requirements may also contain other verification methods like "Analysis"
- Formal evidence about the performed DFA
- Formal evidence about the performed Safety Analyses (if planned)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is planned?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not too clear to me if we plan or not a Platform FMEA. They are not in the Safety Plan

@aschemmel-tech
Copy link
Contributor

The proper way of linking a PR to an issue is to put the number in the Commit message (but not in the headlines):
Resolves: #2501

Copy link
Contributor

@aschemmel-tech aschemmel-tech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See inline comments

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why was the template not used?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would not see this as part of the PMP as it is not about planning. Part of Release? Safety?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can move it to safety

Safety specific documentation for Platform is listed here

.. toctree::

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please do not show the content of the documents. I think you need the sphinx instruction :maxdepth: 1 for this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

requirements/index
modules/index
contribute/index
safety/index
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shall we call this "dependability" instead "safety" and add also the security documents in the future?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My suggestion is to keep safety separated from security

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create missing draft documents

4 participants