Skip to content

Commit 5805673

Browse files
masc2023masc2023
committed
update tool management
Move Tool Verification Report to Template Folder Update Folder according to first example doc-as-code
1 parent 8fd8d55 commit 5805673

File tree

5 files changed

+224
-148
lines changed

5 files changed

+224
-148
lines changed

‎MODULE.bazel‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,4 @@ bazel_dep(name = "score_python_basics", version = "0.3.2")
5858
# Checker rule for CopyRight checks/fixes
5959
bazel_dep(name = "score_cr_checker", version = "0.2.2")
6060
bazel_dep(name = "score_format_checker", version = "0.1.1")
61-
bazel_dep(name = "score_docs_as_code", version = "0.4.3")
61+
bazel_dep(name = "score_docs_as_code", version = "0.4.4")

‎process/folder_templates/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,4 @@ Folder Templates
2424

2525
features/index.rst
2626
modules/index.rst
27+
tools/index.rst

‎process/folder_templates/tools/index.rst‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
..
2+
# *******************************************************************************
3+
# Copyright (c) 2024 Contributors to the Eclipse Foundation
4+
#
5+
# See the NOTICE file(s) distributed with this work for additional
6+
# information regarding copyright ownership.
7+
#
8+
# This program and the accompanying materials are made available under the
9+
# terms of the Apache License Version 2.0 which is available at
10+
# https://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# SPDX-License-Identifier: Apache-2.0
13+
# *******************************************************************************
14+
15+
.. _tools_template:
16+
17+
Tools
18+
=====
19+
20+
.. toctree::
21+
:maxdepth: 1
22+
:glob:
23+
24+
tool_verification_report_template

‎process/folder_templates/tools/tool_verification_report_template.rst‎

Lines changed: 197 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,197 @@
1+
..
2+
# *******************************************************************************
3+
# Copyright (c) 2025 Contributors to the Eclipse Foundation
4+
#
5+
# See the NOTICE file(s) distributed with this work for additional
6+
# information regarding copyright ownership.
7+
#
8+
# This program and the accompanying materials are made available under the
9+
# terms of the Apache License Version 2.0 which is available at
10+
# https://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# SPDX-License-Identifier: Apache-2.0
13+
# *******************************************************************************
14+
15+
Tool Verification Report Template
16+
=================================
17+
18+
.. note:: Tool Verification Report header
19+
20+
.. doc_tool:: [Your Tool Name]
21+
:id: doc_tool__tool_name_version
22+
:status: draft
23+
:version: vX.Y.Z
24+
:tcl: LOW
25+
:safety_affected: YES
26+
:security_affected: YES
27+
:realizes: wp__tool_verification_report
28+
:tags: template, tool_management
29+
30+
.. attention::
31+
The above directive must be updated according to your tool.
32+
33+
The information is used for proper tool identification
34+
35+
Status may (draft, evaluated, qualified, released, rejected)
36+
37+
Safety/Security affected may (YES, NO)
38+
39+
TCL may (LOW, HIGH)
40+
41+
Version may v.MAJOR.MINOR.PATCH
42+
43+
.. note::
44+
An example of a Tool Verification Report can be found here:
45+
`Example Tool Verification Report <https://eclipse-score.github.io/score/main/score_tools/doc_as_code.html#doc_tool__doc_as_code>`_
46+
47+
48+
[Your Tool Name] Verification Report
49+
------------------------------------
50+
51+
52+
Introduction
53+
------------
54+
55+
Scope and purpose
56+
~~~~~~~~~~~~~~~~~
57+
[Describe the scope and purpose of the tool]
58+
59+
May add general use cases, scenarios, etc.
60+
61+
Inputs and outputs
62+
~~~~~~~~~~~~~~~~~~
63+
[Describe here the inputs and outputs of the tool]
64+
65+
May add a figure, if appropriate
66+
67+
.. note::
68+
| .. figure:: _assets/[Your Tool Name].drawio.svg
69+
| :width: 100%
70+
| :align: center
71+
| :alt: [Your Tool Name] overview
72+
73+
| [Your Tool Name] overview
74+
75+
76+
Available information
77+
~~~~~~~~~~~~~~~~~~~~~
78+
[Describe here the available information for the tool]
79+
80+
May also add some general information about the tool
81+
82+
May add links to the public available information, if applicable,
83+
e.g. tools documentation, tracking of tool bugs, user manual, guidelines, etc.
84+
85+
May add some comments to get started or usage information or integration manual
86+
87+
May add tool usage constraints/limitations
88+
89+
90+
Installation and integration
91+
----------------------------
92+
93+
Installation
94+
~~~~~~~~~~~~
95+
[Describe here how to install the tool]
96+
97+
May add where is the tool located?
98+
99+
May add how the tool is configured in order to be used in safe/secure way?
100+
101+
May add access/usage protection required?, execution authority required?
102+
103+
Integration
104+
~~~~~~~~~~~
105+
[Describe here how to integrate the tool in existing toolchain]
106+
107+
May add how the tool works together with other tools?
108+
109+
Environment
110+
~~~~~~~~~~~
111+
[Describe environment and its constraints/limitations]
112+
113+
114+
Evaluation
115+
----------
116+
[Describe here detailed information about the tool evaluation]
117+
118+
Determine the use case for the tool in the project and for each use case
119+
120+
Determine the malfunctions/threats
121+
122+
Determine the tool impact based on the malfunctions/threats
123+
124+
Determine the available safety/security measures
125+
126+
Determine if the impact detection based on safety/security measures are sufficient and
127+
add additional ones, if required
128+
129+
Determine the tool confidence based on tool impact and tool impact detection
130+
131+
Use the table below to document all uses cases and their evaluation. The table has an
132+
example included.
133+
134+
The final Confidence shall be judged on the maximum confidence level of each use case.
135+
136+
137+
.. list-table:: [Your tool name] evaluation
138+
:header-rows: 1
139+
140+
* - Use case Identification
141+
- Use case Description
142+
- Malfunctions
143+
- Impact on safety?
144+
- Impact safety measures available?
145+
- Impact safety detection sufficient?
146+
- Threats
147+
- Impact on security?
148+
- Impact security measures available?
149+
- Impact security detection sufficient?
150+
- Further additional safety measure required?
151+
- Confidence (automatic calculation)
152+
* - 1
153+
- Generate element (requirements, architecture, safety analysis, ...)
154+
- Wrong or missed element may lead to an wrong implementation with any potential error
155+
- yes
156+
- Reviews
157+
- no
158+
- Gain access to modify or run manipulated Doc-as-code or to to modify input files
159+
- yes
160+
- Access control, roles in Github
161+
- yes
162+
- Compare generated text in documentation with original text (#PR)
163+
- low
164+
165+
166+
Result
167+
~~~~~~
168+
Add here final statement, if tool qualification is required or not.
169+
170+
171+
**Optional Section for Tool Qualification**
172+
-------------------------------------------
173+
Based on method: validation of the software tool
174+
175+
176+
Requirements and testing aspects
177+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
178+
[Describe here requirements and their tests from user point of view]
179+
180+
Where are tool requirements defined?
181+
182+
Where are the test cases for the requirements defined?
183+
184+
Where are the requirements coverage documented?
185+
186+
187+
Analysis perspective
188+
~~~~~~~~~~~~~~~~~~~~
189+
[Describe analysis perspective]
190+
191+
Optional:
192+
193+
Where is the architectural design of the tool defined?
194+
195+
Where is the safety analysis for the tool defined?
196+
197+
Where is the security analysis for the tool defined?

‎process/process_areas/tool_management/guidance/tool_management_template.rst‎

Lines changed: 1 addition & 147 deletions
Original file line numberDiff line numberDiff line change
@@ -22,150 +22,4 @@ Tool Verification Report Template
2222
:status: valid
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

25-
26-
.. note:: Tool Verification Report header
27-
28-
| .. doc_tool:: [Your Tool Name]
29-
| :id: doc__tool__tool_name_version
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
36-
| :tags: tool_management
37-
38-
.. attention::
39-
The above directive must be updated according to your tool.
40-
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-
48-
Identification
49-
--------------
50-
[Identify the tool]
51-
52-
E.g. by unique name or UID?
53-
54-
Add the tool version
55-
56-
Add tool verification status (draft, evaluated, qualified) defined?
57-
58-
59-
Introduction
60-
------------
61-
[Describe the scope and purpose of the tool]
62-
63-
May also add some general information about the tool
64-
65-
May add some comments to get started
66-
67-
May add links to the public available information, if applicable.
68-
69-
70-
Use cases
71-
---------
72-
[Describe the use case for the tool in the project]
73-
74-
Add the purposes of the tool (e.g. use cases, scenarios, etc.)
75-
76-
What are the inputs for the tool?
77-
78-
What are the output for the tool?
79-
80-
Add tool usage constraints/limitations
81-
82-
83-
Installation
84-
------------
85-
[Describe here how to install the tool]
86-
87-
How is the tool is configured in order to be used in safe/secure way?
88-
89-
Describe environment and its constraints/limitations
90-
91-
(Constraints/Limitation must cover functional, safety, security)
92-
93-
E.g. version >= x.yz, access/usage protection required?, execution authority required?
94-
95-
May add links to the public available information, if applicable.
96-
97-
98-
Integration
99-
-----------
100-
[Describe here how to integrate the tool in existing toolchain]
101-
102-
How works the tool together ?
103-
104-
Where is the tool located?
105-
106-
How are bugs of the tool tracked?
107-
108-
May add links to the public available information, if applicable.
109-
110-
Add malfunctions which the tool could introduce.
111-
112-
Add threats which the tool could introduce, e.g. unintended, non-authorized use.
113-
114-
115-
Documentation
116-
-------------
117-
[Describe here detailed information about the tool documentation]
118-
119-
Where are the tool documents like User Manual, Guidelines, Erratas, etc. located?
120-
121-
May add links to the public available information, if applicable.
122-
123-
124-
Evaluation
125-
----------
126-
[Describe here detailed information about the tool evaluation]
127-
128-
Determine the tool impact based on the malfunctions/threats
129-
130-
Define safety measures/security controls against the tool malfunctions/threats
131-
132-
Determine the tool error detection based on confidence on the defined safety measures/security controls
133-
134-
Determine the tool confidence level based on tool impact and tool error detection
135-
136-
Determine if tool qualification is required
137-
138-
139-
**Optional Section for Tool Qualification**
140-
-------------------------------------------
141-
Based on method: validation of the software tool
142-
143-
144-
Requirements and testing aspects
145-
--------------------------------
146-
[Describe here requirements and their tests from user point of view]
147-
148-
Where are tool requirements defined?
149-
150-
Where are the test cases for the requirements defined?
151-
152-
Where are the requirements coverage documented?
153-
154-
155-
Usage and analysis perspective
156-
------------------------------
157-
[Describe here usage and analysis perspective]
158-
159-
Where is the tool input and output described?
160-
161-
Where are the use cases of the tool defined?
162-
163-
Where are workflows for the tool defined?
164-
165-
Optional:
166-
167-
Where is the architectural design of the tool defined?
168-
169-
Where is the safety analysis for the tool defined?
170-
171-
Where is the security analysis for the tool defined?
25+
For the content see here: :need:`doc_tool__tool_name_version`

0 commit comments

Comments
 (0)