Merge pull request #424 from etas-contrib/proper_general_workflow_description

masc2023 · web-flow · commit 51598bb32247 · 2025-12-01T13:40:48.000+01:00
process introduction explanation
diff --git a/process/index.rst b/process/index.rst
@@ -44,7 +44,7 @@ Workflow activities are supported by guidances.
 General Concepts
 ~~~~~~~~~~~~~~~~
 
-General concepts like traceability of work products, life cycle model, building blocks can be found here:
+The general concepts like traceability of work products, life cycle model, building blocks can be found here:
 
 .. toctree::
    :maxdepth: 1
@@ -64,7 +64,7 @@ The process description for the project (e.g. requirements, architecture, safety
 Process Role definition
 ~~~~~~~~~~~~~~~~~~~~~~~
 
-General roles not part of any process area.
+The general roles that are not part of any process area and the project roles list can be found here:
 
 .. toctree::
    :maxdepth: 1
@@ -74,7 +74,7 @@ General roles not part of any process area.
 Work Products
 ~~~~~~~~~~~~~
 
-General work products not part of any process area and work product overview list.
+The general work products that are not part of any process area and the work product overview list can be found here:
 
 .. toctree::
    :maxdepth: 1
@@ -84,7 +84,7 @@ General work products not part of any process area and work product overview lis
 Workflows
 ~~~~~~~~~
 
-General workflows not part of any process area and workflow overview list.
+The general workflows that are not part of any process area and workflow overview list can be found here:
 
 .. toctree::
    :maxdepth: 1
@@ -94,7 +94,7 @@ General workflows not part of any process area and workflow overview list.
 Standards
 ---------
 
-The the standard references the project's processes are derived from can be found here:
+The standard references the project's processes are derived from and the coverage of the requirements and the work products from the standards can be found here:
 
 .. toctree::
    :maxdepth: 1
diff --git a/process/introduction/_assets/score_process_model.drawio.svg b/process/introduction/_assets/score_process_model.drawio.svg
diff --git a/process/introduction/index.rst b/process/introduction/index.rst
@@ -28,16 +28,19 @@ Introduction
 
 Motivation
 ----------
-| The process model aims to establish organization rules for developing
-| open source software in the automotive industry, which can be used in safety and security context.
+
+The process model aims to establish organization rules for developing
+open source software in the automotive industry, which can be used in safety and security context.
 
 Objectives
 ----------
-| The process model shall provide processes, which conform to state-of the art standards
-| * ASPICE
-| * ISO 26262
-| * ISO 21434
-| * ISO PAS 8926
+
+The process model shall provide processes, which conform to state-of the art standards
+
+* :ref:`ASPICE<standard_aspice_pam4>`
+* :ref:`ISO 26262<standard_iso26262>`
+* :ref:`ISO 21434<standard_isosae21434>`
+* :ref:`ISO PAS 8926<standard_isopas8926>`
 
 Approach
 --------
@@ -47,7 +50,7 @@ Approach
 3. We aim to develop the process in conformance to the targeted standards (compare figure below).
 4. We aim to establish traceability from the begin (compare :ref:`general_concepts_traceability`).
 5. We aim to verify conformity and traceability by tool automation as much as possible (compare figure below).
-6. We aim for an iterative collaboration model initiated by change requests (compare :need:`gd_guidl__change_change_request`)
+6. We aim for an iterative collaboration model initiated by change requests (compare :need:`gd_guidl__change_change_request`).
 
 
 .. figure:: _assets/score_process_model.drawio.svg
@@ -56,3 +59,15 @@ Approach
   :alt: Overview process model
 
   Overview process model
+
+The process model is structured around the concept of :ref:`workflows<workflows>`, which form the core of each :ref:`process<process_areas>`. Each workflow defines the sequence of activities required to achieve specific objectives within the project. The activities linked from these workflows are directly linked to roles, ensuring that responsibilities and accountabilities are clearly assigned throughout the process.
+
+Workflows also establish connections to :ref:`work products<work_products>`, which are often inputs and the tangible outputs or artifacts generated during process execution. Each work product is associated with or requested by relevant :ref:`standards<external_standards>` and :ref:`requirements<process_req>` of these standards, ensuring compliance and traceability.
+
+To facilitate onboarding and understanding, the process model provides dedicated sections for a "Getting Started" and a detailed "Concept Description" for each process. These resources help Contributors, Committers and other Users quickly familiarize themselves with the process, understand key concepts, and apply best practices throughout process execution and should be read in this order. See :need:`Requirements process getting started<doc_getstrt__req_process>`, :need:`Requirement concept description<doc_concept__req_process>` as examples.
+
+The model further integrates an comprehensive guideline (within the "Guidance" section), :ref:`templates<folder_templates>`, checklists and methods for each workflow to support the consistent and efficient execution of processes. See the :need:`Requirement process guideline<gd_guidl__req_engineering>`, the :need:`requirement inspection checklist<doc__feature_name_req_inspection>` and :need:`verification methods<gd_meth__verification_methods>` as examples.
+
+Additionally, the process model incorporates traceability mechanisms, allowing for the verification of conformity to standards such as ASPICE, ISO 26262, and others. The relationships between workflows, roles, work products, and supporting materials are visualized in the process model diagram above, providing a clear overview of how all elements interact to support process development and continuous improvement within the organization.
+
+The process model follows a code-centric, iterative approach that establishes :ref:`traceability<general_concepts_traceability>` according to the :ref:`meta model of the building blocks<general_concepts_building_blocks>` from the beginning and leverages tool automation to verify conformity and traceability as much as possible. Tools are evaluated and :ref:`qualified<tools_template>` by Committers, used by Contributors to execute workflows, and must fulfill defined process requirements to support efficient and compliant process execution.
diff --git a/process/process_areas/architecture_design/architecture_workflow.rst b/process/process_areas/architecture_design/architecture_workflow.rst
@@ -14,8 +14,10 @@
 
 .. _arch_workflow:
 
-Architecture Workflow
-=====================
+Architecture Workflows
+######################
+
+For a detailed explanation of workflows and their role within the process model, please refer to the :ref:`processes_introduction`.
 
 .. workflow:: Create/Maintain Feature architecture
    :id: wf__cr_mt_featarch
diff --git a/process/process_areas/architecture_design/architecture_workproducts.rst b/process/process_areas/architecture_design/architecture_workproducts.rst
@@ -14,8 +14,8 @@
 
 .. _arch_workproducts:
 
-Architecture Workproducts
-=========================
+Architecture Work Products
+##########################
 
 .. workproduct:: Feature Architecture
    :id: wp__feature_arch
diff --git a/process/process_areas/change_management/change_management_workflow.rst b/process/process_areas/change_management/change_management_workflow.rst
@@ -14,8 +14,10 @@
 
 .. _chm_change_workflows:
 
-Workflow Change Management
-##########################
+Change Management Workflows
+###########################
+
+For a detailed explanation of workflows and their role within the process model, please refer to the :ref:`processes_introduction`.
 
 .. workflow:: Create Change Request
    :id: wf__change_create_cr
diff --git a/process/process_areas/change_management/change_management_workproducts.rst b/process/process_areas/change_management/change_management_workproducts.rst
@@ -12,7 +12,7 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-Work Products Change Management
+Change Management Work Products
 ###############################
 
 .. workproduct:: Platform Change Management Plan
diff --git a/process/process_areas/configuration_management/configuration_workflow.rst b/process/process_areas/configuration_management/configuration_workflow.rst
@@ -13,9 +13,11 @@
    # *******************************************************************************
 
 
-Workflows Configuration Management
+Configuration Management Workflows
 ##################################
 
+For a detailed explanation of workflows and their role within the process model, please refer to the :ref:`processes_introduction`.
+
 The main work product is the configuration management plan, which is a part of the platform management plan.
 Thus the work flow :need:`wf__platform_cr_mt_platform_mgmt_plan` applies.
 
diff --git a/process/process_areas/configuration_management/configuration_workproducts.rst b/process/process_areas/configuration_management/configuration_workproducts.rst
@@ -12,7 +12,7 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-Work Products Configuration Management
+Configuration Management Work Products
 ######################################
 
 .. workproduct:: Platform Configuration Management Plan
diff --git a/process/process_areas/documentation_management/documentation_workflow.rst b/process/process_areas/documentation_management/documentation_workflow.rst
@@ -12,10 +12,11 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-
-Workflow Documentation Management
+Documentation Management Workflow
 #################################
 
+For a detailed explanation of workflows and their role within the process model, please refer to the :ref:`processes_introduction`.
+
 The main work product is the documentation management plan, which is a part of the platform
 management plan. Thus the work flow :need:`wf__platform_cr_mt_platform_mgmt_plan` applies.
 
diff --git a/process/process_areas/documentation_management/documentation_workproducts.rst b/process/process_areas/documentation_management/documentation_workproducts.rst
@@ -12,7 +12,7 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-Work Products Documentation Management
+Documentation Management Work Products
 ######################################
 
 .. workproduct:: Documentation Management Plan
diff --git a/process/process_areas/implementation/implementation_workflow.rst b/process/process_areas/implementation/implementation_workflow.rst
@@ -14,9 +14,10 @@
 
 .. _workflow_implementation:
 
+Implementation Workflows
+########################
 
-Workflow Implementation
-#######################
+For a detailed explanation of workflows and their role within the process model, please refer to the :ref:`processes_introduction`.
 
 .. workflow:: Create/Maintain Software Development Plan
    :id: wf__sw_development_plan
diff --git a/process/process_areas/implementation/implementation_workproducts.rst b/process/process_areas/implementation/implementation_workproducts.rst
@@ -12,8 +12,8 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-Workproducts Implementation
-###########################
+Implementation Work Products
+############################
 
 .. workproduct:: Implementation
    :id: wp__sw_implementation
diff --git a/process/process_areas/platform_management/platform_management_workflow.rst b/process/process_areas/platform_management/platform_management_workflow.rst
@@ -14,8 +14,10 @@
 
 .. _workflow_platform_management:
 
-Workflow Platform Management
-############################
+Platform Management Workflows
+#############################
+
+For a detailed explanation of workflows and their role within the process model, please refer to the :ref:`processes_introduction`.
 
 .. workflow:: Create/Maintain Platform Management Plan
    :id: wf__platform_cr_mt_platform_mgmt_plan
diff --git a/process/process_areas/platform_management/platform_management_workproducts.rst b/process/process_areas/platform_management/platform_management_workproducts.rst
@@ -12,7 +12,7 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-Work Products Platform Management
+Platform Management Work Products
 #################################
 
 .. workproduct:: Platform Management Plan
diff --git a/process/process_areas/problem_resolution/problem_resolution_workflow.rst b/process/process_areas/problem_resolution/problem_resolution_workflow.rst
@@ -14,8 +14,10 @@
 
 .. _problem_workflows:
 
-Workflow Problem Resolution
-###########################
+Problem Resolution Workflows
+############################
+
+For a detailed explanation of workflows and their role within the process model, please refer to the :ref:`processes_introduction`.
 
 .. workflow:: Create Problem Report
    :id: wf__problem_create_pr
diff --git a/process/process_areas/problem_resolution/problem_resolution_workproducts.rst b/process/process_areas/problem_resolution/problem_resolution_workproducts.rst
@@ -12,7 +12,7 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-Work Products Problem Resolution
+Problem Resolution Work Products
 ################################
 
 .. workproduct:: Platform Problem Resolution Plan
diff --git a/process/process_areas/process_management/process_management_workflow.rst b/process/process_areas/process_management/process_management_workflow.rst
@@ -14,8 +14,10 @@
 
 .. _process_management_workflows:
 
-Workflow Process Management
-###########################
+Process Management Workflows
+############################
+
+For a detailed explanation of workflows and their role within the process model, please refer to the :ref:`processes_introduction`.
 
 .. workflow:: Create/Maintain Process Management Strategy
    :id: wf__cr_mt_process_mgt_strategy
diff --git a/process/process_areas/process_management/process_management_workproducts.rst b/process/process_areas/process_management/process_management_workproducts.rst
@@ -12,7 +12,7 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-Work Products Process Management
+Process Management Work Products
 ################################
 
 .. workproduct:: Process Management Strategy
diff --git a/process/process_areas/quality_management/quality_workflow.rst b/process/process_areas/quality_management/quality_workflow.rst
@@ -14,8 +14,11 @@
 
 .. _quality_workflows:
 
-Workflows
----------
+Quality Management Workflows
+############################
+
+For a detailed explanation of workflows and their role within the process model, please refer to the :ref:`processes_introduction`.
+
 
 .. workflow:: Create/Maintain Quality Management Plan
    :id: wf__cr_mt_qlm_plan
diff --git a/process/process_areas/quality_management/quality_workproducts.rst b/process/process_areas/quality_management/quality_workproducts.rst
@@ -12,8 +12,8 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-Workproducts
-############
+Quality Management Work Products
+################################
 
 .. workproduct:: Quality Management Plan
    :id: wp__qms_plan
diff --git a/process/process_areas/release_management/release_workflow.rst b/process/process_areas/release_management/release_workflow.rst
@@ -14,8 +14,10 @@
 
 .. _release_workflows:
 
-Workflow Release Management
-###########################
+Release Management Workflows
+############################
+
+For a detailed explanation of workflows and their role within the process model, please refer to the :ref:`processes_introduction`.
 
 .. workflow:: Create/Maintain Module Release Note
    :id: wf__rel_mod_rel_note
diff --git a/process/process_areas/release_management/release_workproducts.rst b/process/process_areas/release_management/release_workproducts.rst
@@ -12,7 +12,7 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-Work Products Release Management
+Release Management Work Products
 ################################
 
 .. workproduct:: Platform Release Notes
diff --git a/process/process_areas/requirements_engineering/requirements_workflow.rst b/process/process_areas/requirements_engineering/requirements_workflow.rst
@@ -13,8 +13,11 @@
    # *******************************************************************************
 
 
-Workflow Requirements Engineering
-#################################
+Requirements Engineering Workflows
+##################################
+
+For a detailed explanation of workflows and their role within the process model, please refer to the :ref:`processes_introduction`.
+
 
 .. workflow:: Create/Maintain Stakeholder requirements and SW-Platform AoU
    :id: wf__req_stkh_req
diff --git a/process/process_areas/requirements_engineering/requirements_workproducts.rst b/process/process_areas/requirements_engineering/requirements_workproducts.rst
@@ -12,8 +12,8 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-Workproducts Requirements Engineering
-#####################################
+Requirements Engineering Work Products
+######################################
 
 .. workproduct:: Stakeholder Requirements
    :id: wp__requirements_stkh
diff --git a/process/process_areas/safety_analysis/safety_analysis_workflow.rst b/process/process_areas/safety_analysis/safety_analysis_workflow.rst
@@ -15,8 +15,10 @@
 
 .. _workflow_safety_analysis:
 
-Workflow Safety Analysis
-########################
+Safety Analysis Workflows
+#########################
+
+For a detailed explanation of workflows and their role within the process model, please refer to the :ref:`processes_introduction`.
 
 Safety Analysis is used as a umbrella term for the methods FMEA (Failure Modes and Effects Analysis) and DFA (Dependent Failure Analysis).
 
diff --git a/process/process_areas/safety_analysis/safety_analysis_workproducts.rst b/process/process_areas/safety_analysis/safety_analysis_workproducts.rst
@@ -12,8 +12,8 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-Workproducts Safety Analysis
-############################
+Safety Analysis Work Products
+#############################
 
 .. workproduct:: Platform DFA
    :id: wp__platform_dfa
diff --git a/process/process_areas/safety_management/workproducts.rst b/process/process_areas/safety_management/workproducts.rst
@@ -12,8 +12,8 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
-Work products
--------------
+Safety Management Work Products
+###############################
 
 .. workproduct:: Platform Safety Plan
    :id: wp__platform_safety_plan
diff --git a/process/process_areas/security_analysis/security_analysis_workflow.rst b/process/process_areas/security_analysis/security_analysis_workflow.rst
@@ -16,8 +16,10 @@
 
 .. _workflow_security_analysis:
 
-Workflow Security Analysis
-##########################
+Security Analysis Workflows
+###########################
+
+For a detailed explanation of workflows and their role within the process model, please refer to the :ref:`processes_introduction`.
 
 Security analysis is used as an umbrella term.
 
diff --git a/process/process_areas/security_analysis/security_analysis_workproducts.rst b/process/process_areas/security_analysis/security_analysis_workproducts.rst
diff --git a/process/process_areas/security_management/security_management_workflow.rst b/process/process_areas/security_management/security_management_workflow.rst
diff --git a/process/process_areas/security_management/security_management_workproducts.rst b/process/process_areas/security_management/security_management_workproducts.rst
diff --git a/process/process_areas/tool_management/tool_management_workflow.rst b/process/process_areas/tool_management/tool_management_workflow.rst
diff --git a/process/process_areas/tool_management/tool_management_workproducts.rst b/process/process_areas/tool_management/tool_management_workproducts.rst
diff --git a/process/process_areas/verification/verification_workflows.rst b/process/process_areas/verification/verification_workflows.rst
diff --git a/process/process_areas/verification/verification_workproducts.rst b/process/process_areas/verification/verification_workproducts.rst
diff --git a/process/roles/index.rst b/process/roles/index.rst
diff --git a/process/workflows/index.rst b/process/workflows/index.rst
diff --git a/process/workproducts/index.rst b/process/workproducts/index.rst
