update due to Audit Findings

Resolves: #86

Author: masc2023

process/process_areas/platform_management/platform_management_workflow.rst

@@ -25,7 +25,7 @@ Workflow Platform Management
    :approved_by: rl__process_community
    :supported_by: rl__safety_manager, rl__security_manager, rl__quality_manager
    :input: wp__policies, wp__issue_track_system
-   :output: wp__platform_mgmt, wp__project_mgt, wp__document_mgt_plan, wp__config_mgt_plan
+   :output: wp__platform_mgmt, wp__project_mgt, wp__document_mgt_plan, wp__config_mgt_plan, wp__prm_plan
    :contains: gd_temp__platform__mgmt_plan, gd_guidl__platform__mgmt_plan, gd_guidl__documentation, gd_chklst__documentation__review, gd_temp__documentation
    :has: doc_concept__platform__process, doc_getstrt__platform__process
 

process/process_areas/problem_resolution/guidance/problem_resolution_guideline.rst

@@ -25,12 +25,14 @@ This document describes the general guidances for Problem Resolution based on th
 General Hints
 =============
 
-The detailed implementation of the Problem Resolution for **S-CORE** is described in the `[[title]]<REPLACE_doc__platform_problem_resolution_plan>`.
+The detailed implementation of the Problem Resolution for the project shall be described in the :ref:`Workflow Platform Management <workflow_platform_management>`.
 
 Templates
 ---------
 
-To create problem reports, **S-CORE** provides the following template: :need:`[[title]]<gd_temp__problem__template>`.
+To create problem reports, the project shall provide the following template: :need:`[[title]]<gd_temp__problem__template>`.
+An example template for the issue trackings system GitHub can be found here:
+`https://github.com/eclipse-score/communication/blob/main/.github/ISSUE_TEMPLATE/1-bugfix.yml`_.
 
 Attributes
 ----------
@@ -52,31 +54,32 @@ A more detailed description can be found here: :ref:`prm_process_requirements`
 Activities for Problem Resolution
 =================================
 
-This section describes in detail which steps need to be performed for a Problem resolution.
-
-Refer to the `Problem Resolution Plan <REPLACE_doc__platform_problem_resolution_plan>` for examples
-how to create problem reports.
+This section describes in detail which steps need to be performed for a Problem Resolution.
 
 .. list-table:: Activities for Problem Resolution
    :header-rows: 1
-   :widths: 10,60,30
+   :widths: 10,60,30,30
 
    * - Step
      - Description
      - Responsible
+     - Approver
    * - :ref:`1. <prm_create_problem_report>`
      - Create Problem Report
      - :need:`[[title]] <rl__contributor>`
+     - :need:`[[title]] <rl__committer>`
    * - :ref:`2. <prm_analyze_problem_report>`
-     - Analyse Problem Report
+     - Analyze Problem Report
      - :need:`[[title]] <rl__contributor>`
+     - :need:`[[title]] <rl__committer>`
    * - :ref:`3. <prm_initiate_problem_resolution>`
      - Initiate and Monitor Problem Resolution
      - :need:`[[title]] <rl__contributor>`
+     - :need:`[[title]] <rl__committer>`
    * - :ref:`4. <prm_monitor_problem_resolution>`
      - Close Problem Resolution
      - :need:`[[title]] <rl__committer>`
-
+     - :need:`[[title]] <rl__technical_lead>`, :need:`[[title]] <rl__module_lead>`
 
 .. _prm_create_problem_report:
 
@@ -94,18 +97,18 @@ The description should reflect the problem root cause and impact in detail.
 Copy therefore the :need:`Problem Template <gd_temp__problem__template>` into the created Problem
 Report (Issue Tracking System).
 
-Set the status of the Problem to "open", when ready to review and analyse set to "in review".
+Set the status of the Problem to "open", when ready to review and analyze set to "in review".
 
 .. _prm_analyze_problem_report:
 
-Analyse Problem Report
+Analyze Problem Report
 ----------------------
 
-The **S-CORE** :need:`[[title]] <rl__committer>` analyzes the problem together with the
+The projects :need:`[[title]] <rl__committer>` analyzes the problem together with the
 :need:`[[title]] <rl__contributor>` and takes a decision for accepting or rejecting it.
 
 If accepted, the status is set to "in implementation" and :need:`[[title]] <rl__contributor>`
-can start with the iniation of the Problem Resolution, otherwise the status is set to "rejected".
+can start with the initiation of the Problem Resolution, otherwise the status is set to "rejected".
 
 The author has the freedom to cancel it at any time by setting the status to "rejected".
 
@@ -119,7 +122,7 @@ Initiate and Monitor Problem Resolution
 Therefore further activities needs to be planned and linked to the Problem Report.
 
 During the resolution the responsible lead :need:`[[title]] <rl__technical_lead>` or
-:need:`[[title]] <rl__module_lead>` reports regularly the status to the affected **S-CORE** teams.
+:need:`[[title]] <rl__module_lead>` reports regularly the status to the affected projects teams.
 
 The author has the freedom to cancel it at any time by setting the status to "rejected".
 

process/process_areas/problem_resolution/guidance/problem_resolution_reqs.rst

@@ -26,7 +26,7 @@ Problem Attributes
    :id: gd_req__problem__attr_uid
    :status: valid
    :tags: done_automation, problem_resolution, attribute, mandatory
-   :satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
+   :satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
    :complies: std_req__aspice_40__SUP-9-BP1
 
    Each Problem shall have a unique ID. It shall be in an integer number.
@@ -35,7 +35,7 @@ Problem Attributes
    :id: gd_req__problem__attr_status
    :status: valid
    :tags: manual, problem_resolution, attribute, mandatory
-   :satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
+   :satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
    :complies: std_req__aspice_40__SUP-9-BP1
 
    Each Problem shall have a status:
@@ -50,7 +50,7 @@ Problem Attributes
    :id: gd_req__problem__attr_title
    :status: valid
    :tags: manual, problem_resolution, attribute, mandatory
-   :satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
+   :satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
    :complies: std_req__aspice_40__SUP-9-BP1
 
    Reason for Problem Report
@@ -59,21 +59,21 @@ Problem Attributes
    :id: gd_req__problem__attr_impact_description
    :status: valid
    :tags: manual, problem_resolution, attribute, mandatory
-   :satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
+   :satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
    :complies: std_req__aspice_40__SUP-9-BP1, std_req__aspice_40__SUP-9-BP2
 
    Exact description of the Problem, including potential cause and impact of the problem.
 
    Record especially, if functional safety or cybersecurity may affected here.
 
-   Record potential affected parties, and if it may requried to notify them about the potential
+   Record potential affected parties, and if it may required to notify them about the potential
    problem.
 
 .. gd_req:: Problem attribute: analysis results
    :id: gd_req__problem__attr_anaylsis_results
    :status: valid
    :tags: manual, problem_resolution, attribute, mandatory
-   :satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
+   :satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
    :complies: std_req__aspice_40__SUP-9-BP2
 
    Record analysis results (e.g. reason for rejection, safety, security, quality impact) as comments.
@@ -82,17 +82,17 @@ Problem Attributes
    :id: gd_req__problem__attr_stakeholder
    :status: valid
    :tags: prio_1_automation, problem_resolution, attribute, mandatory
-   :satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
+   :satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
    :complies: std_req__aspice_40__SUP-9-BP2, std_req__aspice_40__SUP-9-BP5
 
-   Assign responsible stakeholder for analysing the problem
+   Assign responsible stakeholder for analyzing the problem
    Assign responsible stakeholder to resolve the problem
 
 .. gd_req:: Problem attribute: classification
    :id: gd_req__problem__attr_classification
    :status: valid
    :tags: prio_1_automation, problem_resolution, attribute, mandatory
-   :satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
+   :satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
    :complies: std_req__aspice_40__SUP-9-BP1, std_req__aspice_40__SUP-9-BP2
 
    Each Problem shall have a classification identifier:
@@ -106,7 +106,7 @@ Problem Attributes
    :id: gd_req__problem__attr_category
    :status: valid
    :tags: prio_3_automation, problem_resolution, attribute, mandatory
-   :satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
+   :satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
    :complies: std_req__aspice_40__SUP-9-BP1
 
    Each Problem shall have a category identifier:
@@ -118,7 +118,7 @@ Problem Attributes
    :id: gd_req__problem__attr_safety_affected
    :status: valid
    :tags: prio_1_automation, problem_resolution, attribute, mandatory
-   :satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
+   :satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
    :complies: std_req__aspice_40__SUP-9-BP1
 
    Each Problem shall have a safety relevance identifier:
@@ -132,7 +132,7 @@ Problem Attributes
    :id: gd_req__problem__attr_security_affected
    :status: valid
    :tags: prio_1_automation, problem_resolution, attribute, mandatory
-   :satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
+   :satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
    :complies: std_req__aspice_40__SUP-9-BP1
 
    Each Problem shall have a security relevance identifier:
@@ -146,7 +146,7 @@ Problem Attributes
    :id: gd_req__problem__attr_milestone
    :status: valid
    :tags: manual, problem_resolution, attribute, mandatory
-   :satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
+   :satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
    :complies: std_req__aspice_40__SUP-9-BP1, std_req__aspice_40__SUP-9-BP6
 
    Milestone until the Problem must be implemented (used for prioritization)
@@ -159,7 +159,7 @@ Problem Resolution Checks
    :id: gd_req__problem__check_mandatory
    :status: valid
    :tags: prio_2_automation, problem_resolution, attribute, check
-   :satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
+   :satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
    :complies: std_req__aspice_40__SUP-9-BP1
 
    It shall be checked if all mandatory attributes for each Problem
@@ -175,7 +175,7 @@ Problem Resolution Checks
    :id: gd_req__problem__check_closing
    :status: valid
    :tags: prio_1_automation, problem_resolution, attribute, check
-   :satisfies: wf__problem__create_pr, wf__problem__analyse_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
+   :satisfies: wf__problem__create_pr, wf__problem__analyze_pr, wf__problem__initiate_monitor_pr, wf__problem__close_pr
    :complies: std_req__aspice_40__SUP-9-BP1
 
    ISSUEs related to Problem Reports shall not automatically closed, if linked ISSUEs or PRs are closed or merged and

process/process_areas/problem_resolution/problem_resolution_concept.rst

@@ -26,10 +26,10 @@ including the requirements of the different stakeholders for the Problem Resolut
 
 Key concept
 ***********
-A Problem Report is the **ONLY** way to report (compare `REPLACE_doc__contr_guideline`)
-deviations of an expected result for existing features in the **S-CORE** project.
-Deviations include problems found by user, bugs found during verification activites by tester,
-quality issues found by quality checks, safety anomalies, vulnerabilites or any other malfunction.
+A Problem Report is the **ONLY** way to report deviations of an expected result for
+existing features in the **S-CORE** project. Deviations include problems found by user,
+bugs found during verification activities by tester, quality issues found by quality
+checks, safety anomalies, vulnerabilities or any other malfunction.
 
 Inputs
 ******
@@ -63,7 +63,7 @@ Also requirements of standards need to be taken into consideration:
 Problem Report Categories
 *************************
 
-User: Problems relating to requirements, design, or code found by user of the platform.
+User: Problems relating to requirements, architecture, implementation, or code found by user of the platform.
 
 Bug: Problems found by contributor based on component, feature or platform integration tests including verification and quality assurance activities.
 

process/process_areas/problem_resolution/problem_resolution_getstrt.rst

@@ -20,9 +20,24 @@ Getting Started
    :status: valid
    :tags: problem_resolution
 
-In case you want to report a Problem to **S-CORE** consider to:
+This document describes the steps to create a problem report, and further to analyze,
+resolve, and to control the problem until closure. Where a problem is defined as a
+deviation of an expected result.
 
-* Create your Problem Report according to :need:`wf__problem__create_pr`
-* Make familiar with the development and supporting process descriptions in :ref:`process_description`
-* Make familiar with the relevant sections of the `Platform Management Plan <REPLACE_doc__platform_mgt_plan>`, here especially with `Problem Resolution Plan <REPLACE_doc__platform_problem_resolution_plan>`
-* In case of any questions, contact the :need:`Technical Lead <rl__technical_lead>` for your problem to establish reporting and planning
+Therefore guidelines :need:`gd_temp__problem__template`,
+:need:`gd_guidl__problem__problem` and a :need:`doc_concept__problem__process`
+are available.
+
+General Workflow
+****************
+
+The workflows are defined in the :ref:`problem_workflows` section.
+
+For every problem identified, the following workflows are executed:
+
+* Create your problem report according to :need:`wf__problem__create_pr`
+* Analyze your problem report according to :need:`wf__problem__analyse_pr`
+* Initiate problem resolution and monitor it until closure according to :need:`wf__problem__initiate_monitor_pr`
+* Close the problem resolution according to :need:`wf__problem__close_pr`
+
+In addition create a problem resolution plan as part of the platform management plan according to :need:`wf__platform__cr_mt_platform_mgmt_plan`.

process/process_areas/problem_resolution/problem_resolution_workflow.rst

@@ -12,6 +12,7 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
+.. _problem_workflows:
 
 Workflow Problem Resolution
 ###########################
@@ -33,8 +34,8 @@ Workflow Problem Resolution
 
    To start the review and the analysis the Problem status is changed to "in review"
 
-.. workflow:: Analyse Problem Report
-   :id: wf__problem__analyse_pr
+.. workflow:: Analyze Problem Report
+   :id: wf__problem__analyze_pr
    :status: valid
    :responsible: rl__contributor
    :approved_by: rl__committer
@@ -44,7 +45,7 @@ Workflow Problem Resolution
    :contains: gd_temp__problem__template, gd_chklst__problem__cr_review, gd_guidl__problem__problem
    :has: doc_concept__problem__process, doc_getstrt__problem__process
 
-   The Problem Report is analysed.
+   The Problem Report is analyzed.
 
    Until the template is not filled out properly, the Problem may be set back to “open” from the
    :need:`Committer <rl__committer>`.