add document lifecylce model

masc2023 · masc2023 · commit 845dd144ffb5 · 2025-12-18T08:56:22.000+01:00
Extend documentation guideline Add new process requirements Resolves: #435
diff --git a/process/process_areas/architecture_design/architecture_workproducts.rst b/process/process_areas/architecture_design/architecture_workproducts.rst
@@ -21,6 +21,7 @@ Architecture Work Products
    :id: wp__feature_arch
    :status: valid
    :complies: std_wp__iso26262__software_751
+   :tags: doc_lifecycle_model_3
 
    Feature Architecture linked to Feature Requirements, i.e. interaction of components
 
@@ -34,6 +35,7 @@ Architecture Work Products
    :id: wp__component_arch
    :status: valid
    :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.
diff --git a/process/process_areas/change_management/change_management_workproducts.rst b/process/process_areas/change_management/change_management_workproducts.rst
@@ -18,15 +18,15 @@ Change Management Work Products
 .. workproduct:: Platform Change Management Plan
    :id: wp__chm_plan
    :status: valid
-   :tags: change_management
+   :tags: change_management, 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
+   :tags: change_management, 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
@@ -43,7 +43,7 @@ Change Management Work Products
 .. workproduct:: Feature Request
    :id: wp__feat_request
    :status: valid
-   :tags: change_management
+   :tags: change_management, 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
@@ -54,7 +54,7 @@ Change Management Work Products
 .. workproduct:: Component Request
    :id: wp__cmpt_request
    :status: valid
-   :tags: change_management
+   :tags: change_management, 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
diff --git a/process/process_areas/documentation_management/guidance/_assets/review_workflow.drawio.svg b/process/process_areas/documentation_management/guidance/_assets/review_workflow.drawio.svg
diff --git a/process/process_areas/documentation_management/guidance/documentation_guideline.rst b/process/process_areas/documentation_management/guidance/documentation_guideline.rst
@@ -30,3 +30,73 @@ 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 life cycle models
+--------------------------
+
+Each released document shall have the status: “VALID”.
+
+Depending on the document assigned life cycle 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 life cycle models exists (as defined in
+:need:`gd_req__doc_attr_status`):
+
+* Model1: "VALID"
+* Model2: "DRAFT" -> "VALID"
+* Model3: "DRAFT" -> "VALID" -> "VALID(INSPECTED)"
+
+
+
+**Guidance for life cycle 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.
+
+
+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 life cycle model 2 (Simple
+Workflow).
+
+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 life cycle model 2
+(Extended Workflow).
+
+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 life cycle model 2
+
+  Overview review life cycle model 2
+
+**Guidance for life cycle model 3:**
+
+In principle same as life cycle model 2, but an additional inspection step is required,
+as described here: :ref:`review_concept`.
diff --git a/process/process_areas/documentation_management/guidance/documentation_process_reqs.rst b/process/process_areas/documentation_management/guidance/documentation_process_reqs.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 life cycle 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
diff --git a/process/process_areas/requirements_engineering/requirements_workproducts.rst b/process/process_areas/requirements_engineering/requirements_workproducts.rst
@@ -19,47 +19,54 @@ Requirements Engineering Work Products
    :id: wp__requirements_stkh
    :status: valid
    :complies: std_wp__iso26262__system_651
+   :tags: doc_lifecycle_model_3
 
    Technical requirements from a stakeholder viewpoint on SW-platform level, contain "assumed Technical Safety Requirements" in SW-Platform SEooC development.
 
 .. workproduct:: Feature Requirements
    :id: wp__requirements_feat
    :status: valid
    :complies: std_wp__iso26262__software_651
+   :tags: doc_lifecycle_model_3
 
    Feature requirements describe in a more detailed way the functionality which will fulfill a set of stakeholder requirements. A "feature" itself represents a set of requirements. It describes the interaction of the components to form a feature. It shall also be the basis for integration testing on platform level.
 
 .. workproduct:: Component Requirements
    :id: wp__requirements_comp
    :status: valid
    :complies: std_wp__iso26262__software_651, std_wp__isopas8926__4521, std_wp__iso26262__analysis_651, std_wp__iso26262__software_app_c_51
+   :tags: doc_lifecycle_model_3
 
    SW Requirements for components, broken down from feature requirements to the realizing component. These include configuration specification.
 
 .. workproduct:: SW-Platform Assumptions of Use
    :id: wp__requirements_sw_platform_aou
    :status: valid
    :complies: std_wp__iso26262__software_651
+   :tags: doc_lifecycle_model_3
 
    SW Safety Requirements for the user of the platform, exportable requirements for the user to integrate in their requirements management system.
 
 .. workproduct:: Feature Assumptions of Use
    :id: wp__requirements_feat_aou
    :status: valid
    :complies: std_wp__iso26262__software_651
+   :tags: doc_lifecycle_model_3
 
    SW Safety Requirements for the user of the feature, exportable requirements for the user to integrate in their req mgt system.
 
 .. workproduct:: Component Assumptions of Use
    :id: wp__requirements_comp_aou
    :status: valid
    :complies: std_wp__iso26262__software_651, std_wp__isopas8926__4521
+   :tags: doc_lifecycle_model_3
 
    SW Safety Requirements for the user of the component, exportable requirements for the user to integrate in their req mgt system.
 
 .. workproduct:: Process/Tool Requirements
    :id: wp__requirements_proc_tool
    :status: valid
+   :tags: doc_lifecycle_model_2
 
    Process and Tool requirements describe activities needed to be executed in the development process either manually or automated (i.e. tool supported).
    Tool requirements (if derived from process requirements) are more detailed as those are also the basis for tool (qualification) testing.
@@ -68,6 +75,7 @@ Requirements Engineering Work Products
    :id: wp__requirements_inspect
    :status: draft
    :complies: std_wp__iso26262__software_653
+   :tags: doc_lifecycle_model_2
 
    Depends on requirements management tooling, expect text based requirements.
 
diff --git a/process/workproducts/index.rst b/process/workproducts/index.rst
@@ -62,6 +62,9 @@ Project Work product Linkage
    :colors: red, green, blue
    :filter-func: score_metamodel.checks.standards.my_pie_workproducts_contained_in_exactly_one_workflow
 
+
+.. _work_products_overview_list:
+
 Project Work product list
 -------------------------
 
