Improve Change Decision Record

Address improvements proposal
Removed unnecessary links from workflows to be compliant with process model
add decision template to workflows, as it may required during feat/cmp requests or their modifications

Resolves: #204

Author: masc2023

process/process_areas/change_management/change_management_workflow.rst

@@ -26,7 +26,7 @@ Workflow Change Management
    :supported_by: rl__technical_lead, rl__module_lead, rl__safety_manager, rl__security_manager, rl__quality_manager
    :input: wp__policies, wp__issue_track_system, wp__feat_request, wp__cmpt_request
    :output: wp__issue_track_system, wp__feat_request, wp__cmpt_request
-   :contains: gd_guidl__change_change_request, gd_temp__change_feature_request, gd_temp__change_component_request, gd_temp__change_impact_analysis, gd_temp__component_classification, gd_req__change_attr_uid, gd_req__change_attr_status, gd_req__change_attr_title, gd_req__change_attr_impact_description, gd_req__change_attr_impact_safety, gd_req__change_attr_impact_security, gd_req__change_attr_types, gd_req__change_attr_affected_wp, gd_req__change_attr_milestone, gd_req__change_tool_impact_analysis
+   :contains: gd_guidl__change_change_request, gd_temp__change_feature_request, gd_temp__change_component_request, gd_temp__change_impact_analysis, gd_temp__component_classification, gd_temp__change_decision_record
    :has: doc_concept__change_process, doc_getstrt__change_process
 
    The Change Request is created.
@@ -45,7 +45,7 @@ Workflow Change Management
    :supported_by: rl__committer, rl__safety_manager, rl__security_manager, rl__quality_manager
    :input: wp__policies, wp__issue_track_system, wp__feat_request, wp__cmpt_request
    :output: wp__issue_track_system, wp__feat_request, wp__cmpt_request
-   :contains: gd_guidl__change_change_request, gd_temp__change_feature_request, gd_temp__change_component_request, gd_temp__change_impact_analysis, gd_temp__component_classification, gd_req__change_attr_uid, gd_req__change_attr_status, gd_req__change_attr_title, gd_req__change_attr_impact_description, gd_req__change_attr_impact_safety, gd_req__change_attr_impact_security, gd_req__change_attr_types, gd_req__change_attr_affected_wp, gd_req__change_attr_milestone, gd_req__change_tool_impact_analysis
+   :contains: gd_guidl__change_change_request, gd_temp__change_feature_request, gd_temp__change_component_request, gd_temp__change_impact_analysis, gd_temp__component_classification, gd_temp__change_decision_record
    :has: doc_concept__change_process, doc_getstrt__change_process
 
    The Change Request is analyzed.
@@ -67,7 +67,7 @@ Workflow Change Management
    :supported_by: rl__technical_lead, rl__module_lead, rl__safety_manager, rl__security_manager, rl__quality_manager
    :input: wp__issue_track_system, wp__feat_request, wp__cmpt_request
    :output: wp__issue_track_system, wp__feat_request, wp__cmpt_request
-   :contains: gd_guidl__change_change_request, gd_temp__change_feature_request, gd_temp__change_component_request, gd_temp__change_impact_analysis, gd_temp__component_classification, gd_req__change_attr_uid, gd_req__change_attr_status, gd_req__change_attr_title, gd_req__change_attr_impact_description, gd_req__change_attr_impact_safety, gd_req__change_attr_impact_security, gd_req__change_attr_types, gd_req__change_attr_affected_wp, gd_req__change_attr_milestone, gd_req__change_tool_impact_analysis
+   :contains: gd_guidl__change_change_request, gd_temp__change_feature_request, gd_temp__change_component_request, gd_temp__change_impact_analysis, gd_temp__component_classification, gd_temp__change_decision_record
    :has: doc_concept__change_process, doc_getstrt__change_process
 
    The Change Request is implemented and monitored.
@@ -93,7 +93,7 @@ Workflow Change Management
    :supported_by: rl__safety_manager, rl__security_manager, rl__quality_manager
    :input: wp__issue_track_system, wp__feat_request, wp__cmpt_request
    :output: wp__issue_track_system, wp__feat_request, wp__cmpt_request
-   :contains: gd_guidl__change_change_request, gd_temp__change_feature_request, gd_temp__change_component_request, gd_temp__change_impact_analysis, gd_temp__component_classification, gd_req__change_attr_uid, gd_req__change_attr_status, gd_req__change_attr_title, gd_req__change_attr_impact_description, gd_req__change_attr_impact_safety, gd_req__change_attr_impact_security, gd_req__change_attr_types, gd_req__change_attr_affected_wp, gd_req__change_attr_milestone, gd_req__change_tool_impact_analysis
+   :contains: gd_guidl__change_change_request, gd_temp__change_feature_request, gd_temp__change_component_request, gd_temp__change_impact_analysis, gd_temp__component_classification, gd_temp__change_decision_record
    :has: doc_concept__change_process, doc_getstrt__change_process
 
    The Change Request is closed.

process/process_areas/change_management/guidance/change_management_decision_record_template.rst

@@ -34,17 +34,57 @@ In each DR file, include the following sections:
       :id: dec_rec__<Platform|Feature|Component>__<Title>
       :status: <proposed|accepted|deprecated|rejected|superseded>
       :affects: <link>
-      :context: <Your text>
-      :decision: <Your text>
-      :consequences: <Your text>
+
+      <Description>
+      Descriptions shall contain at least the following sections:
+      Context: <Your text>
+      Decision: <Your text>
+      Consequences: <Your text>
+
+      or use the the provided template below (if not marked as optional, it is mandatory content):
+
+      <Decision>
+
+      Context
+      -------
+      <your text, diagrams, etc>
+
+      Consequences
+      ------------
+      <your text, diagrams, etc>
+
+      (optional)
+      [
+      Alternatives Considered
+      -----------------------
+
+      <Alternative A>
+      ^^^^^^^^^^^^^^^
+      <description of the alternative>
+
+      Advantages
+      """"""""""
+      *  **<Advantage 1>:** <Explanation>
+      *  **<Advantage 2>:** <Explanation>
+
+      Disadvantages
+      """""""""""""
+      *  **<Disadvantage 1>:** <Explanation>
+      *  **<Disadvantage 2>:** <Explanation>
+      ]
+
+      Justification for the Decision
+      ------------------------------
+      <your text>
 
 .. attention::
     The above directive must be updated according to your decision record.
 
-    - Modify ``dec_rec`` to provide a descriptive and concise title. Summarizing the decision. (manadatory)
-    - Modify ``id`` to contain the Platform/Feature/Component name the DR belongs to and the title, in upper snake case preceded by ``dec_rec__`` (manadatory)
-    - Adjust ``status`` according to your needs (manadatory)
+    - Modify ``dec_rec`` to provide a descriptive and concise title. Summarizing the decision. (mandatory)
+    - Modify ``id`` to contain the Platform/Feature/Component name the DR belongs to and the title, in upper snake case preceded by ``dec_rec__`` (mandatory)
+    - Adjust ``status`` according to your needs (mandatory)
     - Modify ``affects`` to point to the work product it affects, mostly this will be architecture or design (recommended)
-    - Modify ``context`` to describe the issue or motivation behind this decision or change (manadatory)
-    - Modify ``decision`` to detail the proposed change or decision (manadatory)
-    - Modify ``consequences`` to explain the impact of this change, including what becomes easier or more difficult (recommended)
+    - Provide ``Description`` (mandatory)
+    - Add ``Context`` to describe the issue or motivation behind this decision or change (mandatory)
+    - Add ``decision`` to detail the proposed change or decision (mandatory)
+    - Add ``consequences`` to explain the impact of this change, including what becomes easier or more difficult (recommended)