add document lifecylce model

Extend documentation guideline
Add new process requirements
Add document lifecycle tags

Resolves: #435

Author: masc2023

process/process_areas/architecture_design/architecture_workproducts.rst

@@ -20,7 +20,8 @@ Architecture Work Products
 .. workproduct:: Feature Architecture
    :id: wp__feature_arch
    :status: valid
-   :complies: std_wp__iso26262__software_751, std_wp__isosae21434__development_1051
+   :complies: std_wp__iso26262__software_751
+   :tags: doc_lifecycle_model_3
 
    Feature Architecture linked to Feature Requirements, i.e. interaction of components
 
@@ -33,7 +34,8 @@ Architecture Work Products
 .. workproduct:: Component Architecture
    :id: wp__component_arch
    :status: valid
-   :complies: std_wp__iso26262__software_751, std_wp__isopas8926__4523, std_wp__isosae21434__development_1051
+   :complies: std_wp__iso26262__software_751, std_wp__isopas8926__4523
+   :tags: doc_lifecycle_model_3
 
    Component Architecture linked to Component Requirements
 
@@ -47,6 +49,7 @@ Architecture Work Products
    :id: wp__sw_arch_verification
    :status: valid
    :complies: std_wp__iso26262__software_754
+   :tags: doc_lifecycle_model_2
 
    Depends on architecture guideline and tooling.
    May include several methods like inspection, modelling ... Which are selected in SW Verification Plan.

process/process_areas/change_management/change_management_workproducts.rst

@@ -18,17 +18,16 @@ Change Management Work Products
 .. workproduct:: Platform Change Management Plan
    :id: wp__chm_plan
    :status: valid
-   :tags: change_management
+   :tags: doc_lifecycle_model_2
    :complies: std_wp__iso26262__support_851
 
    Change Management Plan (Part of the Platform Management Plan)
 
 .. workproduct:: Issue tracking system
    :id: wp__issue_track_system
    :status: valid
-   :tags: change_management
-   :complies: std_wp__iso26262__management_554, std_wp__iso26262__management_652, std_wp__iso26262__support_852, std_wp__iso26262__support_853, std_wp__iso26262__support_854, std_wp__isopas8926__4527, std_req__aspice_40__iic-13-16, std_req__aspice_40__iic-13-07, std_req__aspice_40__iic-15-55, std_req__aspice_40__iic-15-12,
-              std_wp__isosae21434__continual_8333, std_wp__isosae21434__continual_8431, std_wp__isosae21434__continual_8531, std_wp__isosae21434__continual_8631
+   :tags: doc_lifecycle_model_1
+   :complies: std_wp__iso26262__management_554, std_wp__iso26262__management_652, std_wp__iso26262__support_852, std_wp__iso26262__support_853, std_wp__iso26262__support_854, std_wp__isopas8926__4527, std_req__aspice_40__iic-13-16, std_req__aspice_40__iic-13-07, std_req__aspice_40__iic-15-55, std_req__aspice_40__iic-15-12
 
    | - Change request
    | - Change request plan
@@ -44,7 +43,7 @@ Change Management Work Products
 .. workproduct:: Feature Request
    :id: wp__feat_request
    :status: valid
-   :tags: change_management
+   :tags: doc_lifecycle_model_2
    :complies: std_wp__iso26262__support_852, std_wp__iso26262__support_853, std_req__aspice_40__iic-13-16
 
    | - Feature request for a new feature or a feature modification
@@ -55,14 +54,11 @@ Change Management Work Products
 .. workproduct:: Component Request
    :id: wp__cmpt_request
    :status: valid
-   :tags: change_management
+   :tags: doc_lifecycle_model_2
    :complies: std_wp__iso26262__support_852, std_wp__iso26262__support_853, std_req__aspice_40__iic-13-16
 
    | - Component request for a new component or a component modification
    |
    | Change Request for a new component or a modification of an existing component,
    | which changes the scope of the component.
    | Software Modules are also components (top-level component).
-
-.. needextend:: docname is not None and "process_areas/change_management" in docname
-   :+tags: change_management

process/process_areas/change_management/index.rst

@@ -27,3 +27,6 @@ Change Management
    change_management_roles
    change_management_workflow
    change_management_workproducts
+
+.. needextend:: docname is not None and "process_areas/change_management" in docname
+   :+tags: change_management

process/process_areas/configuration_management/configuration_workproducts.rst

@@ -18,7 +18,7 @@ Configuration Management Work Products
 .. workproduct:: Platform Configuration Management Plan
    :id: wp__config_mgt_plan
    :status: valid
-   :tags: config_management
+   :tags: doc_lifecycle_model_2
    :complies: std_wp__iso26262__support_751
 
    Config Management Plan (Part of the Platform Management Plan, :need:`wp__platform_mgmt`)

process/process_areas/configuration_management/index.rst

@@ -26,3 +26,6 @@ Configuration Management
    configuration_roles
    configuration_workflow
    configuration_workproducts
+
+.. needextend:: docname is not None and "process_areas/configuration_management" in docname
+   :+tags: configuration_management

process/process_areas/documentation_management/documentation_workproducts.rst

@@ -18,6 +18,7 @@ Documentation Management Work Products
 .. workproduct:: Documentation Management Plan
    :id: wp__document_mgt_plan
    :status: valid
+   :tags: doc_lifecycle_model_2
    :complies: std_wp__iso26262__support_1051, std_wp__iso26262__support_1052, std_req__aspice_40__iic-01-52
 
    Document Management Plan (Part of the Platform Management Plan)

process/process_areas/documentation_management/guidance/_assets/review_workflow.drawio.svg

@@ -30,3 +30,77 @@ For manual review of the formal elements the
 
 The review of each document is done as defined for this type of work product in the respective
 process description.
+
+
+Document lifecycle models
+-------------------------
+
+Each released document shall have the status: “VALID”.
+
+Depending on the document assigned lifecycle Model, as defined here
+:ref:`work_products_overview_list`, the document can either reach this state directly,
+or some prior states are required.
+
+Thus different document lifecycle models exists (as defined in
+:need:`gd_req__doc_attr_status`):
+
+* Model1: "VALID"
+* Model2: "DRAFT" -> "VALID"
+* Model3: "DRAFT" -> "VALID" -> "VALID(INSPECTED)"
+
+
+**Guidance for lifecycle model 1:**
+
+Example: :need:`wp__issue_track_system`
+
+The document has the state “VALID” after creation.
+
+Recommendation: Author should do a self verification for the correctness and completeness
+of the content and th fulfillment of required formal aspects.
+
+
+**Guidance for lifecycle model 2:**
+
+Example: :need:`wp__feat_request`
+
+The document has the state “VALID” after creation and a reviewer as confirmed
+the correctness and completeness of the content and th fulfillment of required formal
+aspects.
+
+The figure below shows an overview of the review workflow for lifecycle model 2 (Simple
+Workflow) based on Pull Requests.
+
+Nevertheless, it is still recommended for author to do a self verification for the
+correctness and completeness of the content and the fulfillment of required formal
+aspects before asking for a review.
+
+In case of any discussions are needed between author and reviewer, or still some ambiguities
+exists, the document can also be published first with the status "DRAFT".
+
+This indicates, that the document is created, may have no mature structure yet, content
+is not complete and correct or formal aspects are not considered.
+
+The figure below shows an overview of the review workflow for lifecycle model 2
+(Extended Workflow) based on Pull Requests.
+
+After some iterations between author and reviewer, the document can be set to status
+"VALID", when all issues are resolved.
+
+Due to updates, findings, other issues or change request, the document status may set
+back from "VALID" to "DRAFT". This triggers a new review cycle.
+
+
+.. figure:: _assets/review_workflow.drawio.svg
+  :width: 100%
+  :align: center
+  :alt: Overview review lifecycle model 2
+
+  Overview review lifecycle model 2 for PRs
+
+
+**Guidance for lifecycle model 3:**
+
+In principle same as lifecycle model 2, but an additional inspection step is required,
+as described here: :ref:`review_concept`.
+
+Example: :need:`wp__requirements_stkh`

process/process_areas/documentation_management/guidance/documentation_guideline.rst

@@ -68,6 +68,21 @@ Document Management Process Requirements
 
    Compare also  :need:`gd_temp__documentation`
 
+.. gd_req:: Document attribute: status
+   :id: gd_req__doc_attr_status
+   :status: valid
+   :tags: manual_prio_1, attribute, mandatory
+   :satisfies: wf__platform_cr_mt_platform_mgmt_plan
+   :complies: std_req__iso26262__support_1044
+
+   Each document, shall have a status depending on the document lifecycle models below:
+
+     * Model 1: VALID (e.g. for simple reports)
+     * Model 2: DRAFT -> VALID (e.g. for plans)
+     * Model 3: DRAFT-> VALID -> VALID(inspected) (e.g. for stakeholder requirements)
+
+   Compare :need:`gd_guidl__documentation`
+
 .. gd_req:: Document Author
    :id: gd_req__doc_reviewer
    :status: valid

process/process_areas/documentation_management/guidance/documentation_process_reqs.rst

@@ -28,4 +28,4 @@ Documentation Management
    documentation_workproducts
 
 .. needextend:: docname is not None and "process_areas/documentation_management" in docname
-   :+tags: doc_mgt
+   :+tags: documentation_management