Merge pull request #121 from eclipse-score/aschemmel-tech-process-reqs-fixes

Fix issues in process requirements

Author: aschemmel-tech

process/process_areas/configuration_management/configuration_concept.rst

@@ -28,7 +28,7 @@ Key concept
 The Configuration Management Plan should define the strategy to manage the configuration items
 in an effective and repeatable way for the project life cycle.
 
-Note: configuration items are all defined work products in the project plus additional arefacts not developed by the project
+Note: configuration items are all realizations of defined work products in the project plus additional arefacts not developed by the project
 needed for the building of the binaries, documentation and verification reports (e.g. tools, external SW libraries).
 
 Inputs

process/process_areas/configuration_management/guidance/configuration_process_req.rst

@@ -21,7 +21,9 @@ Configuration Management Process Requirements
    :tags: done_automation, config_mgt
    :complies: std_req__iso26262__support_745, std_req__aspice_40__SUP-8-BP8
 
-   The structured text tool shall check that the Id's of the configuration items are unique.
+   The doc-as-code tool shall check that the Id's of the configuration items (documented in doc-as-code) are unique.
+
+   Note: For definition of configuration items see :need:`doc_concept__configuration__process`
 
 .. gd_req:: Permanent Storage
    :id: gd_req__config__workproducts_storage

process/process_areas/documentation_management/guidance/documentation_process_reqs.rst

@@ -23,16 +23,19 @@ Document Management Process Requirements
    :tags: manual
    :complies: std_req__iso26262__support_1043
 
-   There is only one generic document type:
+   There are the following document types:
+
    * document
+   * doc_tool
 
     .. note::
-      This type is the ONLY type, which can be used for realizing concrete work products,
-      e.g. Safety Plan
+      The type "document" is the GENERIC type, which can be used for realizing concrete work products,
+      with the exception of the tool verification report (which uses the "doc_tool" type).
+      The "doc_tool" type is described in :ref:`tlm_process_requirements`.
 
    .. note::
-      Process documents are not generic documents and types for that shall only used for
-      process definition, as defined
+      Process documents are not documents realizing work products,
+      types for that shall only used for process definition, as defined
 
       * gd_chklst
       * gd_guidl
@@ -51,7 +54,7 @@ Document Management Process Requirements
    :tags: manual
    :complies: std_req__iso26262__support_1043
 
-   Documents shall have the following mandatory manual attributes:
+   Generic documents shall have the following mandatory manual attributes:
 
    * id
    * status
@@ -64,45 +67,32 @@ Document Management Process Requirements
 
    Compare also  :need:`gd_temp__documentation`
 
-.. gd_req:: Document attributes automated
-   :id: gd_req__doc__attributes_automated
-   :status: valid
-   :tags: prio_2_automation
-   :complies: std_req__iso26262__support_1043
-
-   Documents shall have automatic added attributes:
-
-   * author
-   * approver
-   * reviewer
-
 .. gd_req:: Document Author
    :id: gd_req__doc__author
    :status: valid
-   :tags: prio_2_automation
+   :tags: prio_1_automation
    :complies: std_req__iso26262__support_1045
 
-   Documents headers shall contain an "author" attribute. Every committer who adds more than 50%
-   of the content shall put his name.
-
-   Note: In the future this may also be automated based on an analysis of content during the
-   documentation build for every commit of the file containing the document.
+   The version management tool shall document and report (be able to show) the authorship of a document.
+   I.e. for each change of a document the author of the changes is stored.
 
 .. gd_req:: Document Reviewer
    :id: gd_req__doc__reviewer
    :status: valid
-   :tags: prio_2_automation
+   :tags: prio_1_automation
    :complies: std_req__iso26262__support_1043
 
-   Documents headers shall contain "reviewer" attribute, which is added during documentation build
-   and contains only the names of the last PR reviewers, which actually reviewed the file
-   containing the document, which were not covered by :need:`gd_req__doc__approver`.
+   The version management tool shall document and report (be able to show) the reviewers of a document.
+   I.e. for each change of a document the reviewers of the change are stored.
 
 .. gd_req:: Document Approver
    :id: gd_req__doc__approver
    :status: valid
-   :tags: prio_2_automation
+   :tags: prio_1_automation
    :complies: std_req__iso26262__support_1045
 
-   Documents headers shall contain an "approver" attribute, which is added during documentation build
-   and contains only the names of the last approval reviewers, which actually approved the file containing the document.
+   The version management tool shall document and report (be able to show) the approver of a document.
+   I.e. for each change of a document the approver of the change is stored,
+   which is usually the person with "write-rights" on the document approving
+   the merge of a Pull Request (this may also be more than one person).
+   Note that every approver is also reviewer.

process/process_areas/problem_resolution/guidance/problem_resolution_reqs.rst

@@ -151,14 +151,16 @@ Problem Resolution Checks
    :complies: std_req__aspice_40__SUP-9-BP1
 
    It shall be checked if all mandatory attributes for each Problem
-   is provided by the user. For all requirements following attributes shall be mandatory:
+   is provided by the user. Following attributes shall be mandatory:
 
    .. needtable:: Overview mandatory problem attributes
       :filter: "mandatory" in tags and "attribute" and "problem_resolution" in tags and is_external == False
       :style: table
       :columns: title
       :colwidths: 30
 
+   Note: See also template for problem report: :need:`gd_temp__problem__template`
+
 .. gd_req:: Problem Report issues closing constraints
    :id: gd_req__problem__check_closing
    :status: valid

process/process_areas/requirements_engineering/guidance/requirements_process_reqs.rst

@@ -162,7 +162,7 @@ Process Requirement Linkage
 .. gd_req:: Requirement Traceability
    :id: gd_req__req__traceability
    :status: valid
-   :tags: prio_1_automation
+   :tags: prio_1_automation, attribute
    :complies: std_req__iso26262__support_6432
    :satisfies: wf__req__stkh_req, wf__req__feat_req, wf__req__comp_req
 
@@ -216,17 +216,17 @@ Process Requirement Linkage
    :satisfies: wf__req__stkh_req, wf__req__feat_req, wf__req__comp_req
    :complies: std_req__iso26262__support_6425, std_req__iso26262__support_6434
 
-   A versioning for requirements shall be provided. For this all mandatory attributes shall be taken into account: :need:`gd_req__req__attr_mandatory`
+   A versioning for requirements shall be provided. For this all mandatory attributes shall be taken into account: see :need:`gd_req__req__check_mandatory`
 
 .. _process_requirement_checks:
 
 Process Requirements Checks
 '''''''''''''''''''''''''''
 
 .. gd_req:: Requirement check: suspicious
-   :id: gd_req__req__attr_suspicious
+   :id: gd_req__req__suspicious
    :status: valid
-   :tags: prio_2_automation, attribute
+   :tags: prio_2_automation, check
    :satisfies: wf__req__stkh_req, wf__req__feat_req, wf__req__comp_req
    :complies: std_req__iso26262__support_6425, std_req__iso26262__support_6434
 
@@ -236,9 +236,9 @@ Process Requirements Checks
    Note: This refers to :need:`gd_req__req__attr_req_cov` and :need:`gd_req__req__attr_test_covered`
 
 .. gd_req:: Requirements mandatory attributes provided
-   :id: gd_req__req__attr_mandatory
+   :id: gd_req__req__check_mandatory
    :status: valid
-   :tags: prio_1_automation, attribute, check
+   :tags: prio_1_automation, check
    :satisfies: wf__req__stkh_req, wf__req__feat_req, wf__req__comp_req
 
    It shall be checked if all mandatory attributes for each requirement is provided by the user. For all requirements following attributes shall be mandatory:
@@ -250,9 +250,9 @@ Process Requirements Checks
       :colwidths: 30
 
 .. gd_req:: Requirements no weak words
-   :id: gd_req__req__attr_desc_weak
+   :id: gd_req__req__desc_weak
    :status: valid
-   :tags: done_automation, attribute, check
+   :tags: done_automation, check
    :satisfies: wf__req__stkh_req, wf__req__feat_req, wf__req__comp_req
 
    It shall be ensured that no *weak words* are contained in the requirement description for:
@@ -268,7 +268,7 @@ Process Requirements Checks
 .. gd_req:: Requirements linkage level
    :id: gd_req__req__linkage_fulfill
    :status: valid
-   :tags: done_automation, attribute, check
+   :tags: done_automation, check
    :complies: std_req__iso26262__support_6432
    :satisfies: wf__req__stkh_req, wf__req__feat_req, wf__req__comp_req
 
@@ -279,7 +279,7 @@ Process Requirements Checks
 .. gd_req:: Requirements linkage architecture
    :id: gd_req__req__linkage_architecture
    :status: valid
-   :tags: prio_2_automation, attribute, check
+   :tags: prio_2_automation, check
    :complies: std_req__iso26262__support_6423
    :satisfies: wf__req__feat_req, wf__req__comp_req
 
@@ -288,7 +288,7 @@ Process Requirements Checks
 .. gd_req:: Requirements linkage architecture switch
    :id: gd_req__req__linkage_architecture_switch
    :status: valid
-   :tags: prio_2_automation, attribute, check
+   :tags: prio_2_automation, check
    :complies: std_req__iso26262__support_6423
    :satisfies: wf__req__feat_req, wf__req__comp_req
 
@@ -297,7 +297,7 @@ Process Requirements Checks
 .. gd_req:: Requirements linkage safety
    :id: gd_req__req__linkage_safety
    :status: valid
-   :tags: prio_1_automation, attribute, check
+   :tags: prio_1_automation, check
    :satisfies: wf__req__stkh_req, wf__req__feat_req, wf__req__comp_req
    :complies: std_req__iso26262__support_6422
 

process/process_areas/requirements_engineering/requirements_concept.rst

@@ -183,6 +183,8 @@ Following attributes need to be filled manually for each requirement:
    * - Requirements Type
      - The requirement type defines which category the requirement relates to. Following categories are defined: [Functional, Interface, Process, Legal, Non-Functional]
 
+Following attributes are automatically generated:
+
 .. list-table:: Automated Attributes
    :header-rows: 1
    :widths: 15,70,15

process/process_areas/verification/guidance/verification_process_toolreqs.rst

@@ -124,7 +124,7 @@ Test Linking to Requirements
             ...
         }
 
-.. gd_req:: Test Independence
+.. gd_req:: Independence
     :id: gd_req__verification__independence
     :status: valid
     :tags: done_automation, verification