Skip to content

Commit 5a6d33d

Browse files
Merge pull request eclipse-score#184 from eclipse-score/change_to_das_v130
Upgrade Doc-as-code and initial setup of process management
2 parents 32d519a + 33ce7fc commit 5a6d33d

21 files changed

+886
-107
lines changed

MODULE.bazel

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,4 +50,4 @@ bazel_dep(name = "buildifier_prebuilt", version = "8.2.0.2")
5050
###############################################################################
5151
bazel_dep(name = "aspect_rules_lint", version = "1.5.3")
5252
bazel_dep(name = "score_tooling", version = "1.0.2")
53-
bazel_dep(name = "score_docs_as_code", version = "1.2.0")
53+
bazel_dep(name = "score_docs_as_code", version = "1.3.0")

process/index.rst

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@
1414
1515
.. _process_description:
1616

17-
Process
18-
=======
17+
Process description
18+
===================
1919

20-
Processes are the basis to describe the way of working within the S-CORE project.
20+
Processes are the basis to describe the way of working within a project.
2121

2222
Introduction
2323
------------
@@ -31,20 +31,20 @@ Introduction
3131

3232
Process Model
3333
-------------
34-
The S-CORE process model is described by workflows, executed by roles and is creating work products.
34+
The project process model is described by workflows, executed by roles and is creating work products.
3535
Workflow activities are supported by guidances.
3636

3737
.. figure:: _assets/score_process_area_overview.drawio.svg
3838
:width: 100%
3939
:align: center
40-
:alt: Process area overview for **S-CORE** platform
40+
:alt: Process area overview for the **Project**
4141

42-
Process area overview for **S-CORE** platform
42+
Process area overview for **Project**
4343

4444
General Concepts
4545
~~~~~~~~~~~~~~~~
4646

47-
General concepts like traceability of work products, life cycle model, buidling blocks can be found here:
47+
General concepts like traceability of work products, life cycle model, building blocks can be found here:
4848

4949
.. toctree::
5050
:maxdepth: 1
@@ -54,7 +54,7 @@ General concepts like traceability of work products, life cycle model, buidling
5454
Process Areas
5555
~~~~~~~~~~~~~
5656

57-
The process description for the S-CORE project (e.g. requirements, architecture, safety management) can be found here:
57+
The process description for the project (e.g. requirements, architecture, safety management) can be found here:
5858

5959
.. toctree::
6060
:maxdepth: 1
@@ -64,6 +64,8 @@ The process description for the S-CORE project (e.g. requirements, architecture,
6464
Process Role definition
6565
~~~~~~~~~~~~~~~~~~~~~~~
6666

67+
General roles not part of any process area.
68+
6769
.. toctree::
6870
:maxdepth: 1
6971

@@ -72,6 +74,8 @@ Process Role definition
7274
Work Products
7375
~~~~~~~~~~~~~
7476

77+
General work products not part of any process area and work product overview list.
78+
7579
.. toctree::
7680
:maxdepth: 1
7781

@@ -80,6 +84,8 @@ Work Products
8084
Workflows
8185
~~~~~~~~~
8286

87+
General workflows not part of any process area and workflow overview list.
88+
8389
.. toctree::
8490
:maxdepth: 1
8591

@@ -88,7 +94,7 @@ Workflows
8894
Standards
8995
---------
9096

91-
The the standard references the S-CORE project's processes are derived from can be found here:
97+
The the standard references the project's processes are derived from can be found here:
9298

9399
.. toctree::
94100
:maxdepth: 1

process/introduction/_assets/score_process_model.drawio.svg

Lines changed: 1 addition & 1 deletion
Loading

process/process_areas/index.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212
# SPDX-License-Identifier: Apache-2.0
1313
# *******************************************************************************
1414
15+
.. _process_areas:
16+
1517
Process Areas
1618
#############
1719

@@ -26,6 +28,7 @@ Process Areas
2628
implementation/index.rst
2729
platform_management/index.rst
2830
problem_resolution/index.rst
31+
process_management/index.rst
2932
quality_management/index.rst
3033
release_management/index.rst
3134
requirements_engineering/index.rst
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
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+
Guidance
16+
########
17+
18+
.. toctree::
19+
:maxdepth: 1
20+
21+
process_management_guideline
22+
process_management_templates
23+
process_management_reqs
Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
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+
16+
Guideline
17+
#########
18+
19+
.. gd_guidl:: Process Management Guideline
20+
:id: gd_guidl__process_management
21+
:status: valid
22+
:tags: process_management
23+
:complies: std_req__iso26262__management_5421, std_req__iso26262__management_5422, std_req__aspice_40__gp-311
24+
25+
This document describes the general guidances for Process Management based on the concept which is defined :need:`[[title]]<doc_concept__process_management>`.
26+
27+
General Hints
28+
=============
29+
30+
The detailed implementation of all process areas defined in the process description for
31+
the project shall be described in the
32+
:ref:`Workflow Platform Management <workflow_platform_management>`.
33+
34+
Templates
35+
---------
36+
37+
The process and strategy description shall use the following templates:
38+
:ref:`process_management_templates`.
39+
40+
Requirements
41+
------------
42+
43+
For the process descriptions the following mandatory requirements exist:
44+
45+
.. needtable:: Overview of mandatory process description requirements
46+
:tags: process_management
47+
:filter: "mandatory" in tags and "attribute" in tags and "process_management" in tags and is_external == False
48+
:style: table
49+
:columns: title
50+
:colwidths: 30
51+
52+
53+
.. _workflow_process_management_requirements:
54+
55+
56+
Activities for Process Management
57+
=================================
58+
59+
This section describes in detail which steps need to be performed for the process
60+
Management.
61+
62+
.. list-table:: Activities for Process Management
63+
:header-rows: 1
64+
:widths: 10,60,30,30
65+
66+
* - Step
67+
- Description
68+
- Responsible
69+
- Approver
70+
* - :ref:`1. <pm_create_maintain_strategy>`
71+
- Create/Maintain Process Management Strategy
72+
- :need:`[[title]] <rl__contributor>`
73+
- :need:`[[title]] <rl__process_community>`
74+
* - :ref:`2. <pm_define_approve_process_description>`
75+
- Define/Approve Process Description
76+
- :need:`[[title]] <rl__contributor>`
77+
- :need:`[[title]] <rl__process_community>`
78+
* - :ref:`3. <pm_monitor_improve_process>`
79+
- Monitor/Control Process Implementation
80+
- :need:`[[title]] <rl__contributor>`
81+
- :need:`[[title]] <rl__process_community>`
82+
83+
84+
.. _pm_create_maintain_strategy:
85+
86+
Create/Maintain Process Strategy
87+
--------------------------------
88+
89+
:need:`[[title]] <rl__contributor>` (as author, submitter) creates and maintains the
90+
process management strategy. They create Pull request (PR) for contributions.
91+
92+
The potential contribution is discussed during the public Process Community Meetings
93+
or standard pull request reviews and if decided to implement,
94+
:need:`[[title]] <rl__process_community>` approves the Pull Request to include
95+
the contribution in the process strategy.
96+
97+
98+
.. _pm_define_approve_process_description:
99+
100+
Define/Approve Process Description
101+
----------------------------------
102+
103+
:need:`[[title]] <rl__contributor>` (as author, submitter) creates and maintains the
104+
process description. They create Pull request (PR) for contributions.
105+
106+
The potential contribution is discussed during the public Process Community Meetings
107+
or standard pull request reviews and if decided to implement,
108+
:need:`[[title]] <rl__process_community>` approves the Pull Request to include
109+
the contribution in the process description.
110+
111+
.. _pm_monitor_improve_process:
112+
113+
Monitor/Improve Process
114+
-----------------------
115+
116+
If potential improvements are detected, the :need:`[[title]] <rl__contributor>` triggers
117+
an ISSUE for improvement by using the
118+
`Issue Template Improvement <https://github.com/eclipse-score/process_description/blob/main/.github/ISSUE_TEMPLATE/2-improvement.yml>`_.
119+
120+
The potential improvement is discussed during the public Process Community Meetings
121+
and if decided to implement, a pull request to follow :ref:`pm_create_maintain_strategy`
122+
or :ref:`pm_define_approve_process_description` must be created.
Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
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_management_requirements:
16+
17+
18+
Process Requirements
19+
====================
20+
21+
22+
.. gd_req:: Process Model Building Blocks
23+
:id: gd_req__process_management_build_blocks
24+
:status: valid
25+
:tags: done_automation, attribute, mandatory
26+
:satisfies: wf__cr_mt_process_mgt_strategy, wf__def_app_process_description, wf__mon_imp_process_description
27+
:complies: std_req__iso26262__management_5421, std_req__iso26262__management_5422, std_req__aspice_40__gp-311
28+
29+
The process model building blocks are defined. Compare also the process model
30+
overview here: :ref:`processes_introduction`.
31+
32+
Following building blocks are defined:
33+
34+
* Workflow
35+
* Work Product
36+
* Role (includes Team)
37+
38+
Additionally there shall be the following additions for workflows:
39+
40+
* Getting Started
41+
* Concept
42+
* Guidance
43+
44+
Additionally there shall be the following details for guidance:
45+
46+
* Guideline
47+
* Template
48+
* Checklist
49+
* Method
50+
* Process Requirements
51+
52+
Additionally there shall be the following additions for standard compliance:
53+
54+
* Standard Work Products
55+
* Standard Requirements
56+
57+
Additionally there shall be the following additions to allow deployment examples or
58+
templates for later deployment for work products:
59+
60+
* Document
61+
62+
63+
Process Building Blocks Attributes
64+
----------------------------------
65+
66+
.. gd_req:: Building blocks attributes
67+
:id: gd_req__process_management_build_blocks_attr
68+
:status: valid
69+
:tags: manual_prio_1, attribute, mandatory
70+
:satisfies: wf__cr_mt_process_mgt_strategy, wf__def_app_process_description, wf__mon_imp_process_description
71+
:complies: std_req__iso26262__management_5421, std_req__iso26262__management_5422, std_req__aspice_40__gp-311
72+
73+
Each building block shall have defined attributes as defined here:
74+
:ref:`process_management_templates`.
75+
76+
Some have further constraints as defined here:
77+
78+
* The UID attribute must be unique.
79+
* The STATUS attribute shall have a status: <draft|valid>
80+
* The SAFETY attribute shall have level: <QM | ASIL_B>
81+
* The SECURITY attribute shall have level: <YES|NO>
82+
* Each building block shall have a description
83+
84+
85+
Process Building Blocks Linkage
86+
-------------------------------
87+
88+
.. gd_req:: Building blocks linkage
89+
:id: gd_req__process_management_build_blocks_link
90+
:status: valid
91+
:tags: manual_prio_1, attribute, mandatory
92+
:satisfies: wf__cr_mt_process_mgt_strategy, wf__def_app_process_description, wf__mon_imp_process_description
93+
:complies: std_req__iso26262__management_5421, std_req__iso26262__management_5422, std_req__aspice_40__gp-311
94+
95+
Each building block shall have defined links as defined here:
96+
:ref:`process_management_templates`.
97+
98+
99+
Process Building Blocks Checks
100+
------------------------------
101+
102+
.. gd_req:: Building blocks check
103+
:id: gd_req__process_management_build_blocks_check
104+
:status: valid
105+
:tags: done_automation
106+
:satisfies: wf__cr_mt_process_mgt_strategy, wf__def_app_process_description, wf__mon_imp_process_description
107+
:complies: std_req__iso26262__management_5421, std_req__iso26262__management_5422, std_req__aspice_40__gp-311
108+
109+
It shall be checked, that all attributes defined here
110+
:ref:`process_management_templates` are provided and correctly linked by the user.
111+
112+
113+
.. needextend:: docname is not None and "process_areas/process_management" in docname
114+
:+tags: process_management

0 commit comments

Comments
 (0)