issue_2501_addition_of_missing_safety_docs_templates by attifunel · Pull Request #574 · eclipse-score/process_description

attifunel · 2026-02-18T12:51:24Z

As per #2501, missing safety specific documentation templates were added

github-actions · 2026-02-18T13:24:59Z

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

Correct one duplicated entry as copy-paste issue for safety_analysis_fdr Signed-off-by: Philipp Ahmann <Philipp.Ahmann@de.bosch.com>

masc2023 · 2026-02-18T17:38:25Z

process/folder_templates/platform/docs/verification/platform_verification_report.rst

+   # SPDX-License-Identifier: Apache-2.0
+   # *******************************************************************************
+
+Verification Report


Align with

#542

Discussed this with @aschemmel-tech: possible conflicts with that other PR will be solved later. Agree?

process/folder_templates/platform/docs/verification/platform_verification_report.rst

masc2023

In general,align with #542, Structure for Folder and Headings, e.g. Platform should be used

process/folder_templates/platform/docs/verification/platform_verification_report.rst

process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst

process/folder_templates/platform/docs/safety_mgt/platform_safety_plan_fdr.rst

process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst

masc2023 · 2026-02-18T17:42:13Z

process/folder_templates/platform/docs/safety_mgt/index.rst

+   # SPDX-License-Identifier: Apache-2.0
+   # *******************************************************************************
+
+Safety Management


if you introduce here a new folder, why not move also Safety Planning here Platform DFA, etc. align with Security, that we can have there also a subfolder, Verification Report can stay on top level as well Stakeholder Requirements

I aligned with Module Directories

Can you please move the safety Plan template also in this folder?

yes please (and delete the old folder "safety_planning")

hmhmhm... Platform safety plan template was embedded in the "index.rst" of the specific directory, something I needed some time to sort out. I removed directory there and created a new file here with the right name

Should be compliant with your requests now. Can you check?

process/folder_templates/platform/docs/verification/platform_verification_report.rst

masc2023 · 2026-02-19T07:05:02Z

process/folder_templates/platform/docs/safety_mgt/index.rst

+   # SPDX-License-Identifier: Apache-2.0
+   # *******************************************************************************
+
+Safety Management


Can you please move the safety Plan template also in this folder?

process/folder_templates/platform/docs/safety_mgt/platform_dfa.rst

process/folder_templates/platform/index.rst

process/folder_templates/platform/docs/safety_mgt/platform_dfa.rst

process/folder_templates/platform/docs/verification/platform_verification_report.rst

aschemmel-tech · 2026-02-19T13:59:41Z

process/folder_templates/platform/docs/safety_mgt/index.rst

+   # SPDX-License-Identifier: Apache-2.0
+   # *******************************************************************************
+
+Safety Management


yes please (and delete the old folder "safety_planning")

process/folder_templates/platform/docs/safety_mgt/platform_safety_plan_fdr.rst

process/folder_templates/platform/docs/safety_mgt/platform_safety_package_fdr.rst

aschemmel-tech

See inline comments and:

add release/release_note.rst (platform release note template from release/guidance)
add manual/safety_manual.rst (from https://eclipse-score.github.io/process_description/main/folder_templates/modules/module_name/docs/manual/safety_manual.html)
add requirements/index.rst (create stakeholder requirements document template, similar to the one for feature requirements)

attifunel · 2026-02-24T10:21:22Z

See inline comments and:

add release/release_note.rst (platform release note template from release/guidance)

add manual/safety_manual.rst (from https://eclipse-score.github.io/process_description/main/folder_templates/modules/module_name/docs/manual/safety_manual.html)

add requirements/index.rst (create stakeholder requirements document template, similar to the one for feature requirements)

Should I deleted the template in guidance then?

process/folder_templates/platform/docs/safety_mgt/platform_safety_plan.rst

masc2023 · 2026-02-24T15:50:08Z

@attifunel , you have still merge conflicts, please resolve them first

attifunel · 2026-02-24T16:14:55Z

@attifunel , you have still merge conflicts, please resolve them first

I'm having issues in displaying them... they refer to a deleted file

aschemmel-tech

see inline comments

aschemmel-tech · 2026-02-25T14:55:52Z

process/folder_templates/modules/module_name/docs/verification/module_verification_report.rst


 **5. Software component qualification verification report**
       - Contains the needed verification results if for some components a qualification of pre-developed SW is performed.



The "now deleted" part of gd_temp_mod_ver_report had two more headings (6. & 7.) - please add those.

aschemmel-tech · 2026-02-25T15:01:23Z

process/folder_templates/platform/docs/verification/platform_verification_report.rst

+   :realizes: wp__verification_platform_ver_report
+   :tags: template
+
+   **Place the document header here following the definitions in template


Please align with doc__module_name_verification_report : The header is already present above, missing is the ".. attention::" section (adapted to the platform document).

aschemmel-tech · 2026-02-25T15:05:25Z

process/folder_templates/modules/module_name/docs/release/release_note.rst

 |  ----------------------
 |  This release note is based on the verification as documented in module verification report
-|  :need:`doc__module_name_verification_report`.
+|  :need:`gd_temp__mod_ver_report`.


That makes no sense - we do not want to link to a template here but to a document (containing the module's verification resuts). Maybe you want to add a remark that the "module_name" string should be replaced by the module's name.

aschemmel-tech

Inline comments plus: stakeholder requirements document template still missing?

aschemmel-tech · 2026-02-25T15:12:38Z

process/folder_templates/platform/docs/release/release_note.rst

+   # SPDX-License-Identifier: Apache-2.0
+   # *******************************************************************************
+
+Platform Release Note Template


please remove "Template"

aschemmel-tech · 2026-02-25T15:16:47Z

process/folder_templates/platform/docs/release/release_note.rst

+   :realizes: wp__platform_sw_release_note
+   :tags: template
+
+   |  Platform Release Notes


please make it look like the module template: add "attention" section, remove indentation

aschemmel-tech · 2026-02-25T15:25:38Z

process/folder_templates/platform/docs/safety_mgt/platform_safety_manual.rst

+   :status: draft
+   :safety: ASIL_B
+   :security: NO
+   :realizes: wp__module_safety_manual


wrong WP linked

aschemmel-tech · 2026-02-25T15:26:08Z

process/folder_templates/platform/docs/safety_mgt/platform_safety_manual.rst

+Assumed Platform Safety Requirements
+------------------------------------
+| For the Platform the following safety related stakeholder requirements are assumed to define the top level functionality (purpose) of the 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. For the platform all are relevant.>**


should remove reference to module

aschemmel-tech · 2026-02-25T15:26:50Z

process/folder_templates/platform/docs/safety_mgt/platform_safety_manual.rst

+
+Introduction/Scope
+------------------
+


text missing here, for example could link to a platform architecture picture

aschemmel-tech · 2026-02-25T15:29:19Z

process/folder_templates/platform/docs/safety_mgt/platform_safety_manual.rst

+
+Safety concept of the SEooC
+---------------------------
+| **<Describe here the safety concept incl. which faults are taken care of, reactions of the implemented functions under anomalous operating conditions ... if this is not already documented sufficiently in the feature documentation "safety impact" section of all the features the module is used in.>**


"... if this ..." is only relevant for modules I think.

aschemmel-tech · 2026-02-25T15:29:59Z

process/folder_templates/platform/docs/safety_mgt/platform_safety_manual.rst

+
+Safety Anomalies
+----------------
+| Anomalies (bugs in ASIL SW, detected by testing or by users, which could not be fixed) known before release are documented in the platform/module release notes **<add link to release note>**.


remove "module"

attifunel requested review from PandaeDo, aschemmel-tech, masc2023 and pahmann as code owners February 18, 2026 12:51

attifunel mentioned this pull request Feb 18, 2026

Create missing draft documents eclipse-score/score#2501

Open

attifunel changed the title ~~Addition of missing safety docs templates~~ issue_2501_Addition_of_missing_safety_docs_templates Feb 18, 2026

attifunel changed the title ~~issue_2501_Addition_of_missing_safety_docs_templates~~ issue_2501_addition_of_missing_safety_docs_templates Feb 18, 2026

attifunel added 5 commits February 18, 2026 16:52

2501 attifunel: added missing templates

64933d4

2501 attifunel: added missing templates

f15c6d4

2501 attifunel: fixed index errors

6548948

2501 attifunel fixed hopefully last index error

fabd70c

issue 2501 attifunel fixed TOC conflict

7a74e1b

pahmann force-pushed the attifunel_missing_safety_docs_templates branch from 26e74d8 to 7a74e1b Compare February 18, 2026 16:00

Fix build issues created during merge

0e54cb9

Correct one duplicated entry as copy-paste issue for safety_analysis_fdr Signed-off-by: Philipp Ahmann <Philipp.Ahmann@de.bosch.com>

masc2023 reviewed Feb 18, 2026

View reviewed changes

process/folder_templates/platform/docs/verification/platform_verification_report.rst Outdated Show resolved Hide resolved

masc2023 requested changes Feb 18, 2026

View reviewed changes

attifunel added 3 commits February 18, 2026 19:29

issue 574 attifunel fixed comments from review

0c2c356

issue 2501 attifunel fixed TOC problem

97298f7

issue 2501 attifunel fixed python version in bazel file

5b6a3f0

masc2023 reviewed Feb 19, 2026

View reviewed changes

attifunel added 2 commits February 19, 2026 09:30

issue 2501 attifunel fixed missing link

ed6cc64

issue 2501 attifunel fixing "platform name"-type link

3bb6966

aschemmel-tech reviewed Feb 19, 2026

View reviewed changes

aschemmel-tech requested changes Feb 19, 2026

View reviewed changes

issue 2501 attifunel fixed further comments

4fb3d34

attifunel added 2 commits February 24, 2026 11:55

2501 attifunel fixed further review comments

422dce0

2501 attifunel: fixed build errors

987e20e

masc2023 reviewed Feb 24, 2026

View reviewed changes

process/folder_templates/platform/docs/safety_mgt/platform_safety_plan.rst Show resolved Hide resolved

attifunel added 11 commits February 24, 2026 14:22

2501 attifunel fixed errors and further comments

a4c8721

2501 attifunel try to fix again ref error

72755c3

2501 attifunel try to fix again ref error

5b9d554

2501 attifunel fixed duplicate ver. rep. templates

e0c3d0b

2501 attifunel fixed duplicate ver. rep. templates

d1d955e

2501 fix links from guidance to templates

77ca7ed

2501 fixing wrong links again

e315dde

2501 fixing further indent problems

7c3662c

2501 fixing further indent and links problems

f88b151

2501 fixed copypaste error

919dc34

2501 fixing wrong doc id

e644491

attifunel added 3 commits February 24, 2026 16:54

2501 fixing ambiguity in Safety Analyses

8af722f

2501 some fixes at verification report template

c947aaa

2501 fixed indent error

82b1737

aschemmel-tech requested changes Feb 25, 2026

View reviewed changes


		5. Software component qualification verification report
		- Contains the needed verification results if for some components a qualification of pre-developed SW is performed.


		Introduction/Scope
		------------------

Conversation

attifunel commented Feb 18, 2026

Uh oh!

github-actions bot commented Feb 18, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

masc2023 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

aschemmel-tech left a comment

Choose a reason for hiding this comment

Uh oh!

attifunel commented Feb 24, 2026

Uh oh!

Uh oh!

masc2023 commented Feb 24, 2026

Uh oh!

attifunel commented Feb 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aschemmel-tech left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aschemmel-tech left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

attifunel commented Feb 24, 2026 •

edited

Loading