Skip to content

Commit c9cd499

Browse files
authored
Merge pull request #123 from eclipse-score/update_tlm
update tool management according audit findings
2 parents 45209da + 9fc20d4 commit c9cd499

File tree

7 files changed

+132
-38
lines changed

7 files changed

+132
-38
lines changed

process/process_areas/platform_management/platform_management_workflow.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Workflow Platform Management
2525
:approved_by: rl__process_community
2626
:supported_by: rl__safety_manager, rl__security_manager, rl__quality_manager
2727
:input: wp__policies, wp__issue_track_system
28-
:output: wp__platform_mgmt, wp__project_mgt, wp__document_mgt_plan, wp__config_mgt_plan, wp__prm_plan
28+
:output: wp__platform_mgmt, wp__project_mgt, wp__document_mgt_plan, wp__config_mgt_plan, wp__prm_plan, wp__tlm_plan
2929
:contains: gd_temp__platform__mgmt_plan, gd_guidl__platform__mgmt_plan, gd_guidl__documentation, gd_chklst__documentation__review, gd_temp__documentation
3030
:has: doc_concept__platform__process, doc_getstrt__platform__process
3131

process/process_areas/tool_management/guidance/tool_management_reqs.rst

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,29 @@ Tool Verification Report Attributes
4646
* released
4747
* rejected
4848

49+
.. gd_req:: Tool attribute:: version
50+
:id: gd_req__tool__attr_version
51+
:status: valid
52+
:tags: manual, tool_management, attribute, mandatory
53+
:satisfies: wf__tool__create_tool_verification_report
54+
:complies: std_req__iso26262__support_1141, std_req__aspice_40__SUP-8-BP1
55+
56+
Each Tool Verification Report shall have a version:
57+
58+
* v.X.Y.Z (major, minor, patch)
59+
60+
.. gd_req:: Tool attribute:: tcl
61+
:id: gd_req__tool__attr_tcl
62+
:status: valid
63+
:tags: manual, tool_management, attribute, mandatory
64+
:satisfies: wf__tool__create_tool_verification_report
65+
:complies: std_req__iso26262__support_1141, std_req__aspice_40__SUP-8-BP1
66+
67+
Each Tool Verification Report shall have a tool confidence level:
68+
69+
* LOW
70+
* HIGH
71+
4972
.. gd_req:: Tool attribute:: safety affected
5073
:id: gd_req__tool__attr_safety_affected
5174
:status: valid
@@ -55,8 +78,8 @@ Tool Verification Report Attributes
5578

5679
Each Tool Verification Report shall have a safety relevance identifier:
5780

58-
* Yes
59-
* No
81+
* YES
82+
* NO
6083

6184
.. gd_req:: Tool attribute:: security affected
6285
:id: gd_req__tool__attr_security_affected
@@ -67,8 +90,8 @@ Tool Verification Report Attributes
6790

6891
Each Tool Verification Report shall have a security relevance identifier:
6992

70-
* Yes
71-
* No
93+
* YES
94+
* NO
7295

7396

7497
Tool Verification Report Checks

process/process_areas/tool_management/guidance/tool_management_template.rst

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,21 +23,28 @@ Tool Verification Report Template
2323
:complies: std_req__iso26262__support_1141, std_req__iso26262__support_1142, std_req__iso26262__support_1143, std_req__iso26262__support_11441, std_req__iso26262__support_11442, std_req__iso26262__support_11451, std_req__iso26262__support_11452, std_req__iso26262__support_11453, std_req__iso26262__support_11454, std_req__iso26262__support_11461, std_req__iso26262__support_11462, std_req__isosae21434__org_management_5451, std_req__aspice_40__SUP-8-BP1, std_req__aspice_40__SUP-8-BP2
2424

2525

26-
[Your Tool Name]
27-
----------------
26+
.. note:: Tool Verification Report header
2827

29-
.. note:: Document header
30-
31-
| .. document:: [Your Tool Name]
28+
| .. doc_tool:: [Your Tool Name]
3229
| :id: doc__tool__tool_name_version
33-
| :status: draft
34-
| :safety_affected: YES
35-
| :scurity_affected: YES
30+
| :status: [draft | evaluated | qualified | released | rejected]
31+
| :version: vX.Y.Z
32+
| :tcl: [LOW | HIGH]
33+
| :safety_affected: [YES | NO]
34+
| :security_affected: [YES | NO]
35+
| :realizes: PROCESS_wp__tool_verification_report
3636
| :tags: tool_management
3737
3838
.. attention::
3939
The above directive must be updated according to your tool.
4040

41+
An example of a Tool Verification Report can be find here:
42+
`Example Tool Verification Report <https://eclipse-score.github.io/score/main/score_tools/doc_as_code.html#doc_tool__doc_as_code>`_
43+
44+
45+
[Your Tool Name] Verification Report
46+
------------------------------------
47+
4148
Identification
4249
--------------
4350
[Identify the tool]

process/process_areas/tool_management/tool_management_concept.rst

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ Concept Description
2121
:tags: tool_management
2222

2323
In this section a concept for the Tool Management will be discussed. Inputs for this concepts
24-
are the requirements of ISO2 6262 Part-8, Clause 11, ASPICE PAM 4.0, SUP.8 and
25-
ISO SAE 21434 Clause 5, 5.4.5 additionally including the requirements of the different stakeholders
26-
for the Tool Management process.
24+
are the requirements of ISO 26262 Part-8, Clause 11, ASPICE PAM 4.0, SUP.8 and
25+
ISO/SAE 21434 Clause 5, 5.4.5 additionally including the requirements of the different stakeholders
26+
for the Tool Management Process.
2727

2828
Key concept
2929
***********
30-
In general all Tools to generate the S-CORE product must be identified. As it is a S-CORE objective
31-
to use Tools wherever applicable to generate any kind of work products, the selection criteria for
32-
any Tool including OSS Tools must include therefore the determination of the Tool Confidence Level
30+
In general all tools to generate the project product must be identified. As it is a project objective
31+
to use tools wherever applicable to generate any kind of work product, the selection criteria for
32+
any tool including OSS tools must include therefore the determination of the Tool Confidence Level
3333
`(TCL) <https://www.validas.de/publications/automotive2012.pdf>`_ for the tool under consideration.
3434

3535
Based on the resulting TCL additional Tool Qualification activities may required.
@@ -48,7 +48,7 @@ Stakeholders for the Tool Management
4848
#. :need:`Contributor <rl__contributor>`
4949
:need:`Infrastructure, Tooling Community <rl__infrastructure_tooling_community>`
5050

51-
* Contributes tooling, infrastructure elements to grow and mature the **S-CORE** development environment
51+
* Contributes tooling, infrastructure elements to grow and mature the project development environment
5252

5353
#. :need:`Safety Manager<rl__safety_manager>`, :need:`Security Manager <rl__security_manager>`,
5454
:need:`Committer <rl__committer>`
@@ -62,7 +62,7 @@ Also requirements of standards need to be taken into consideration:
6262

6363
* ISO 26262
6464
* ASPICE
65-
* ISO SAE 21434
65+
* ISO/SAE 21434
6666

6767
Required documentation
6868
**********************
@@ -74,8 +74,9 @@ Activities for Tool Management
7474
******************************
7575

7676
The main work product is the :need:`Tool Verification Report <wp__tool_verification_report>`.
77-
Thus the workflow :need:`Create Tool Verification Report <wf__tool__create_tool_verification_report>`
78-
applies.
77+
This work product is created and maintained until it is released. It contains the tool
78+
evaluation results as well as the qualification results, if applicable.
79+
For each tool the :ref:`Workflows <tlm_workflows>` applies.
7980

8081

8182
Attributes for Tool Management

process/process_areas/tool_management/tool_management_getstrt.rst

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,23 @@ Getting Started
2020
:status: valid
2121
:tags: tool_management
2222

23-
In case you want to use a tool within **S-CORE** consider to:
23+
This document describes the steps to evaluate tools and qualify them according to
24+
ISO 26262 and ISO/SAE 21434 as used standards in the project.
2425

25-
* Check the tool list first: :need:`platform_tool_list <wp__tlm_plan>`. If the tool is already there and covers the intended use case, no further activity is needed
26-
* Make yourself familiar with the development and supporting process descriptions in :ref:`process_description`
27-
* Make yourself familiar with the relevant sections of the `Platform Management Plan <REPLACE_doc__platform_mgt_plan>`, here especially with `Tool Management Plan <REPLACE_doc__platform_tool_management_plan>`
28-
* If the tool is not on the list or does not cover the intended uses cases, continue with creation of a Tool Verification Report according to :need:`wf__tool__create_tool_verification_report`
29-
* In case of any questions, contact the :need:`Technical Lead <rl__technical_lead>`
26+
Therefore guidelines :need:`gd_temp__tool_management__verif_rpt_template` and a
27+
:need:`doc_concept__tool__process` are available.
28+
29+
30+
General Workflow
31+
****************
32+
33+
The workflows are defined in the :ref:`tlm_workflows` section.
34+
35+
For every tool identified, the following workflows are executed:
36+
37+
* Create tool verification report according to :need:`wf__tool__create_tool_verification_report`
38+
* Evaluate tool and update tool verification report according to :need:`wf__tool__evaluate_tool`
39+
* Qualify tool and update tool verification report according to :need:`wf__tool__qualify_tool`
40+
* Approve tool verification report according to :need:`wf__tool__approve_tool_verification_report`
41+
42+
In addition create a tool management plan as part of the platform management plan according to :need:`wf__platform__cr_mt_platform_mgmt_plan`.

process/process_areas/tool_management/tool_management_workflow.rst

Lines changed: 58 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,23 +21,73 @@ Workflow Tool Management
2121
:id: wf__tool__create_tool_verification_report
2222
:status: valid
2323
:responsible: rl__contributor
24-
:approved_by: rl__committer, rl__safety_manager, rl__security_manager,
25-
:supported_by: rl__technical_lead, rl__module_lead, rl__infrastructure_tooling_community
24+
:approved_by: rl__committer
25+
:supported_by: rl__safety_manager, rl__security_manager, rl__infrastructure_tooling_community
2626
:input: wp__issue_track_system, wp__tlm_plan
2727
:output: wp__tool_verification_report
2828
:contains: gd_temp__tool_management__verif_rpt_template, gd_chklst__tool__cr_review
2929
:has: doc_concept__tool__process, doc_getstrt__tool__process
3030

31-
The Tool Verification Report is created during identification of a tool in status draft.
31+
The Tool Verification Report is created during identification of a tool in status
32+
draft.
3233

33-
Each identified tool is evaluated and if applicable, qualified. During evaluation and
34-
qualification the Tool Verification Report is updated and the status is set accordingly to
35-
evaluated or qualified.
34+
For creating the Tool Verification Report the content of the linked template shall
35+
be used.
3636

37-
Finally the Tool Verification Report is verified and approved, and thus set to status released.
37+
.. workflow:: Evaluate Tool and Update Tool Verification Report
38+
:id: wf__tool__evaluate_tool
39+
:status: valid
40+
:responsible: rl__contributor
41+
:approved_by: rl__committer, rl__safety_manager, rl__security_manager
42+
:supported_by: rl__infrastructure_tooling_community
43+
:input: wp__tool_verification_report
44+
:output: wp__tool_verification_report
45+
:contains: gd_temp__tool_management__verif_rpt_template, gd_chklst__tool__cr_review
46+
:has: doc_concept__tool__process, doc_getstrt__tool__process
47+
48+
Each identified tool is evaluated. During evaluation the Tool Verification Report
49+
is updated accordingly.
50+
After successful evaluation the status of the Tool Verification Report
51+
is set to evaluated.
52+
53+
The successful evaluation shall contain a statement, if the tool shall be qualified
54+
or not.
55+
56+
If tool qualification is not needed, the next step is :need:`wf__tool__approve_tool_verification_report`
57+
otherwise continue with :need:`wf__tool__qualify_tool`.
58+
59+
.. workflow:: Qualify Tool and Update Tool Verification Report
60+
:id: wf__tool__qualify_tool
61+
:status: valid
62+
:responsible: rl__contributor
63+
:approved_by: rl__committer, rl__safety_manager, rl__security_manager
64+
:supported_by: rl__infrastructure_tooling_community
65+
:input: wp__tool_verification_report
66+
:output: wp__tool_verification_report
67+
:contains: gd_temp__tool_management__verif_rpt_template, gd_chklst__tool__cr_review
68+
:has: doc_concept__tool__process, doc_getstrt__tool__process
69+
70+
The identified tool is qualified, if applicable. During qualification the Tool
71+
Verification Report is updated accordingly.
72+
After successful qualification the status of the Tool Verification Report
73+
is set to qualified.
74+
75+
.. workflow:: Approve Tool Verification Report
76+
:id: wf__tool__approve_tool_verification_report
77+
:status: valid
78+
:responsible: rl__safety_manager, rl__security_manager
79+
:approved_by: rl__technical_lead, rl__module_lead
80+
:supported_by: rl__infrastructure_tooling_community
81+
:input: wp__tool_verification_report
82+
:output: wp__tool_verification_report
83+
:contains: gd_temp__tool_management__verif_rpt_template, gd_chklst__tool__cr_review
84+
:has: doc_concept__tool__process, doc_getstrt__tool__process
3885

39-
For creating the Tool Verification Report the content of the linked template be used.
86+
Finally the Tool Verification Report is verified and approved, and thus the status
87+
is set to released.
4088

89+
If the verification is not successful or due to any other reason, e.g. the tool is
90+
not needed any more as planned, the tool verification may also rejected at this point.
4191

4292
.. needextend:: docname is not None and "process_areas/tool_management" in docname
4393
:+tags: tool_management

process/process_areas/tool_management/tool_management_workproducts.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Work Products Tool Management
3131
In addition security topics must be considered, as tool user manuals, access control for tools,
3232
proper tool documentation, guidelines, protection against malware introduction, etc.
3333

34-
Based on TCL the appropriate qualification methods shall be applied. For S-CORE
34+
Based on TCL the appropriate qualification methods shall be applied. For the project
3535
the method **validation of software tool** must be used.
3636

3737

0 commit comments

Comments
 (0)