Skip to content

Commit 66a75f9

Browse files
Improvement: Process requirements alignment
Ref: Resolves: #98
1 parent fa3a308 commit 66a75f9

File tree

22 files changed

+132
-76
lines changed

22 files changed

+132
-76
lines changed

process/general_concepts/score_review_concept.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,7 @@ Process Requirements
156156
.. gd_req:: Storage of pull requests documentation
157157
:id: gd_req__general__pull_request_storage
158158
:status: valid
159+
:tags: general
159160
:complies: std_req__iso26262__support_6433, std_req__iso26262__software_7414
160161
:satisfies: wf__monitor_verify_requirements, wf__mr_vy_arch
161162

@@ -168,6 +169,7 @@ Process Requirements
168169
.. gd_req:: Hash value for inspected requirements
169170
:id: gd_req__general__requirements_hash
170171
:status: valid
172+
:tags: general
171173
:complies: std_req__iso26262__support_6433, std_req__iso26262__software_7414
172174
:satisfies: wf__monitor_verify_requirements, wf__mr_vy_arch
173175

@@ -179,6 +181,7 @@ Process Requirements
179181
.. gd_req:: Checklist templates in pull requests
180182
:id: gd_req__general__checklist_templates
181183
:status: valid
184+
:tags: general
182185
:complies: std_req__iso26262__support_6433, std_req__iso26262__software_7414, std_req__iso26262__software_942
183186
:satisfies: wf__monitor_verify_requirements, wf__mr_vy_arch
184187

@@ -190,6 +193,7 @@ Process Requirements
190193
.. gd_req:: Status Check
191194
:id: gd_req__general__status_check
192195
:status: valid
196+
:tags: general
193197
:complies: std_req__iso26262__support_6433, std_req__iso26262__software_7414
194198
:satisfies: wf__monitor_verify_requirements, wf__mr_vy_arch
195199

process/process_areas/architecture_design/guidance/architecture_process_reqs.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,10 +102,10 @@ Attributes of Architectural Elements
102102
* structural element (e.g. some part of the feature tree, component acronym)
103103
* keyword describing the content of the architectural element
104104

105-
The naming convention is defined here: `REPLACE_doc__naming_conventions`
105+
Check your project's naming conventions (should be called "doc__naming_conventions")
106106

107107
.. gd_req:: Architecture attribute: security
108-
:id: gd_req__arch_attr_security
108+
:id: gd_req__arch__attr_security
109109
:status: valid
110110
:tags: attribute, mandatory
111111

process/process_areas/change_management/change_management_workflow.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Workflow Change Management
2525
:supported_by: rl__technical_lead, rl__module_lead
2626
:input: wp__policies, wp__issue_track_system, wp__feat_request, wp__cmpt_request
2727
:output: wp__issue_track_system, wp__feat_request, wp__cmpt_request
28-
:contains: gd_guidl__change__change_request, gd_temp__change__feature_request, gd_temp__change__component_request, gd_temp__change__impact_analysis, gd_temp__component_classification, gd_req__change__attr_uid, gd_req__change__attr_status, gd_req__change__attr_title, gd_req__change__attr_impact_description, gd_req__change__attr_impact_safety, gd_req__change__attr_impact_security, gd_req__change__attr_types, gd_req__change__attr_affected_wp, gd_req__change__attr_milestone, gd_req__change_tool_impact_analysis
28+
:contains: gd_guidl__change__change_request, gd_temp__change__feature_request, gd_temp__change__component_request, gd_temp__change__impact_analysis, gd_temp__component_classification, gd_req__change__attr_uid, gd_req__change__attr_status, gd_req__change__attr_title, gd_req__change__attr_impact_description, gd_req__change__attr_impact_safety, gd_req__change__attr_impact_security, gd_req__change__attr_types, gd_req__change__attr_affected_wp, gd_req__change__attr_milestone, gd_req__change__tool_impact_analysis
2929
:has: doc_concept__change__process, doc_getstrt__change__process
3030

3131
The Change Request is created and analyzed.
@@ -49,7 +49,7 @@ Workflow Change Management
4949
:supported_by: rl__safety_manager, rl__security_manager, rl__quality_manager
5050
:input: wp__issue_track_system, wp__feat_request, wp__cmpt_request
5151
:output: wp__issue_track_system, wp__feat_request, wp__cmpt_request
52-
:contains: gd_guidl__change__change_request, gd_temp__change__feature_request, gd_temp__change__component_request, gd_temp__change__impact_analysis, gd_temp__component_classification, gd_req__change__attr_uid, gd_req__change__attr_status, gd_req__change__attr_title, gd_req__change__attr_impact_description, gd_req__change__attr_impact_safety, gd_req__change__attr_impact_security, gd_req__change__attr_types, gd_req__change__attr_affected_wp, gd_req__change__attr_milestone, gd_req__change_tool_impact_analysis
52+
:contains: gd_guidl__change__change_request, gd_temp__change__feature_request, gd_temp__change__component_request, gd_temp__change__impact_analysis, gd_temp__component_classification, gd_req__change__attr_uid, gd_req__change__attr_status, gd_req__change__attr_title, gd_req__change__attr_impact_description, gd_req__change__attr_impact_safety, gd_req__change__attr_impact_security, gd_req__change__attr_types, gd_req__change__attr_affected_wp, gd_req__change__attr_milestone, gd_req__change__tool_impact_analysis
5353
:has: doc_concept__change__process, doc_getstrt__change__process
5454

5555
The Change Request is evaluated based on the analysis result either approved, rejected or delayed.

process/process_areas/change_management/guidance/change_management_reqs.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ Change Request Checks
128128
'''''''''''''''''''''
129129

130130
.. gd_req:: Change Requests mandatory attributes provided
131-
:id: gd_req__change_attr_mandatory
131+
:id: gd_req__change__attr_mandatory
132132
:status: valid
133133
:tags: chm, attribute, check
134134
:satisfies: wf__change__cr_an_change_request, wf__change__rv_ap_change_request
@@ -150,7 +150,7 @@ Change Request Traceability Impact Analysis Tool
150150
''''''''''''''''''''''''''''''''''''''''''''''''
151151

152152
.. gd_req:: Change Requests Impact Analysis Tool
153-
:id: gd_req__change_tool_impact_analysis
153+
:id: gd_req__change__tool_impact_analysis
154154
:status: valid
155155
:tags: chm, check, tool
156156
:satisfies: wf__change__cr_an_change_request, wf__change__rv_ap_change_request

process/process_areas/configuration_management/guidance/process_req.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,9 @@ Configuration Management Process Requirements
1616
=============================================
1717

1818
.. gd_req:: Permanent Storage
19-
:id: gd_req__workproducts_storage
19+
:id: gd_req__config__workproducts_storage
2020
:status: valid
21+
:tags: config_mgt
2122
:complies: std_req__iso26262__support_745, std_req__aspice_40__SUP-8-BP8
2223

2324
At least every platform release shall be stored permanently as a collection of text documents
@@ -29,8 +30,9 @@ Configuration Management Process Requirements
2930

3031

3132
.. gd_req:: Baseline Differences
32-
:id: gd_req__baseline_diff
33+
:id: gd_req__config__baseline_diff
3334
:status: valid
35+
:tags: config_mgt,automated
3436
:complies: std_req__iso26262__support_741
3537

3638
It shall be possible to show the differences between two baselines.

process/process_areas/documentation_management/guidance/documentation_process_reqs.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Document Management Process Requirements
1818
========================================
1919

2020
.. gd_req:: Document Types
21-
:id: gd_req__doc_types
21+
:id: gd_req__doc__types
2222
:status: valid
2323
:complies: std_req__iso26262__support_1043
2424

@@ -45,7 +45,7 @@ Document Management Process Requirements
4545

4646

4747
.. gd_req:: Document attributes
48-
:id: gd_req__doc_attributes
48+
:id: gd_req__doc__attributes
4949
:status: valid
5050
:complies: std_req__iso26262__support_1043
5151

@@ -66,7 +66,7 @@ Document Management Process Requirements
6666
* reviewer
6767

6868
.. gd_req:: Document Author
69-
:id: gd_req__doc_author
69+
:id: gd_req__doc__author
7070
:status: valid
7171
:complies: std_req__iso26262__support_1045
7272

@@ -77,16 +77,16 @@ Document Management Process Requirements
7777
documentation build for every commit of the file containing the document.
7878

7979
.. gd_req:: Document Reviewer
80-
:id: gd_req__doc_reviewer
80+
:id: gd_req__doc__reviewer
8181
:status: valid
8282
:complies: std_req__iso26262__support_1043
8383

8484
Documents headers shall contain "reviewer" attribute, which is added during documentation build
8585
and contains only the names of the last PR reviewers, which actually reviewed the file
86-
containing the document, which were not covered by :need:`gd_req__doc_approver`.
86+
containing the document, which were not covered by :need:`gd_req__doc__approver`.
8787

8888
.. gd_req:: Document Approver
89-
:id: gd_req__doc_approver
89+
:id: gd_req__doc__approver
9090
:status: valid
9191
:complies: std_req__iso26262__support_1045
9292

process/process_areas/implementation/guidance/implementation_process_reqs.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Process Requirements
1616
####################
1717

1818
.. gd_req:: Static Diagram for Unit Interactions
19-
:id: gd_req__static_diagram
19+
:id: gd_req__impl__static_diagram
2020
:status: valid
2121
:tags: mandatory
2222
:satisfies: wf__sw_detailed_design
@@ -25,7 +25,7 @@ Process Requirements
2525
The static diagram shall represent the unit and their relationships using UML notations.
2626

2727
.. gd_req:: Dynamic Diagram for Unit Interactions
28-
:id: gd_req__dynamic_diagram
28+
:id: gd_req__impl__dynamic_diagram
2929
:status: valid
3030
:tags: mandatory
3131
:satisfies: wf__sw_detailed_design
@@ -34,7 +34,7 @@ Process Requirements
3434
The dynamic diagram shall represent the unit and their relationships using UML notations.
3535

3636
.. gd_req:: Design to Code Linking
37-
:id: gd_req__design_code_link
37+
:id: gd_req__impl__design_code_link
3838
:status: valid
3939
:tags: mandatory
4040
:satisfies: wf__sw_detailed_design
@@ -48,7 +48,7 @@ Process Requirements
4848

4949

5050
.. gd_req:: Dependency Analysis
51-
:id: gd_req__dependency_analysis
51+
:id: gd_req__impl__dependency_analysis
5252
:status: valid
5353
:satisfies: wf__sw_verify_implementation
5454
:complies: std_req__iso26262__software_942

process/process_areas/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,3 +33,4 @@ Process Areas
3333
safety_management/index.rst
3434
tool_management/index.rst
3535
verification/index.rst
36+
process_management/index.rst
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
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+
.. _process_mgt:
16+
17+
Process Management
18+
##################
19+
20+
Disclaimer: this is not the real content, not even the draft content.
21+
It is used for monitoring/steering our process automation effort.
22+
23+
Automation Status via Process Requirement Table
24+
***********************************************
25+
26+
All process requirements should be labelled with the priorization of automation implementation:
27+
28+
- A label "manual" means nothing to do, because it must be fulfilled manually (e.g. by filling attributes).
29+
- A label "done_automation" means nothing to do, because it already works. Note that in docs-as-code repository there are tool requirements linking to the process requirements with an "Implemented" attribute.
30+
- A label "prio_*_automation" means the prio 1, 2, ... labelled requirement shall be implemented in this order. Prio 1 is everything we need for the re-audit, prio 2 could be done manually as a fallback, prio 3 is nice to have ...
31+
32+
.. needtable::
33+
:style: table
34+
:types: gd_req
35+
:columns: id;status;tags
36+
:colwidths: 25,10,25
37+
:sort: id

process/process_areas/quality_management/guidance/quality_process_reqs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Process Requirements
1616
====================
1717

1818
.. gd_req:: Quality report automated generation
19-
:id: gd_req__qlm_report
19+
:id: gd_req__quality__report
2020
:status: valid
2121
:tags: quality_management
2222
:satisfies: wf__mr_imp_qlm_plan_processes

0 commit comments

Comments
 (0)