Skip to content

Commit 7b17df9

Browse files
masc2023masc2023
authored
Merge pull request #206 from eclipse-score/resolve_issue_204
Improve Change Decision Record
2 parents 37a59d0 + a7e0f35 commit 7b17df9

File tree

2 files changed

+53
-13
lines changed

2 files changed

+53
-13
lines changed

‎process/process_areas/change_management/change_management_workflow.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Workflow Change Management
2626
:supported_by: rl__technical_lead, rl__module_lead, rl__safety_manager, rl__security_manager, rl__quality_manager
2727
:input: wp__policies, wp__issue_track_system, wp__feat_request, wp__cmpt_request
2828
:output: wp__issue_track_system, wp__feat_request, wp__cmpt_request
29-
: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
29+
: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
3030
:has: doc_concept__change_process, doc_getstrt__change_process
3131

3232
The Change Request is created.
@@ -45,7 +45,7 @@ Workflow Change Management
4545
:supported_by: rl__committer, rl__safety_manager, rl__security_manager, rl__quality_manager
4646
:input: wp__policies, wp__issue_track_system, wp__feat_request, wp__cmpt_request
4747
:output: wp__issue_track_system, wp__feat_request, wp__cmpt_request
48-
: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
48+
: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
4949
:has: doc_concept__change_process, doc_getstrt__change_process
5050

5151
The Change Request is analyzed.
@@ -67,7 +67,7 @@ Workflow Change Management
6767
:supported_by: rl__technical_lead, rl__module_lead, rl__safety_manager, rl__security_manager, rl__quality_manager
6868
:input: wp__issue_track_system, wp__feat_request, wp__cmpt_request
6969
:output: wp__issue_track_system, wp__feat_request, wp__cmpt_request
70-
: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
70+
: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
7171
:has: doc_concept__change_process, doc_getstrt__change_process
7272

7373
The Change Request is implemented and monitored.
@@ -93,7 +93,7 @@ Workflow Change Management
9393
:supported_by: rl__safety_manager, rl__security_manager, rl__quality_manager
9494
:input: wp__issue_track_system, wp__feat_request, wp__cmpt_request
9595
:output: wp__issue_track_system, wp__feat_request, wp__cmpt_request
96-
: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
96+
: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
9797
:has: doc_concept__change_process, doc_getstrt__change_process
9898

9999
The Change Request is closed.

‎process/process_areas/change_management/guidance/change_management_decision_record_template.rst‎

Lines changed: 49 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,57 @@ In each DR file, include the following sections:
3434
:id: dec_rec__<Platform|Feature|Component>__<Title>
3535
:status: <proposed|accepted|deprecated|rejected|superseded>
3636
:affects: <link>
37-
:context: <Your text>
38-
:decision: <Your text>
39-
:consequences: <Your text>
37+
38+
<Description>
39+
Descriptions shall contain at least the following sections:
40+
Context: <Your text>
41+
Decision: <Your text>
42+
Consequences: <Your text>
43+
44+
or use the the provided template below (if not marked as optional, it is mandatory content):
45+
46+
<Decision>
47+
48+
Context
49+
-------
50+
<your text, diagrams, etc>
51+
52+
Consequences
53+
------------
54+
<your text, diagrams, etc>
55+
56+
(optional)
57+
[
58+
Alternatives Considered
59+
-----------------------
60+
61+
<Alternative A>
62+
^^^^^^^^^^^^^^^
63+
<description of the alternative>
64+
65+
Advantages
66+
""""""""""
67+
* **<Advantage 1>:** <Explanation>
68+
* **<Advantage 2>:** <Explanation>
69+
70+
Disadvantages
71+
"""""""""""""
72+
* **<Disadvantage 1>:** <Explanation>
73+
* **<Disadvantage 2>:** <Explanation>
74+
]
75+
76+
Justification for the Decision
77+
------------------------------
78+
<your text>
4079
4180
.. attention::
4281
The above directive must be updated according to your decision record.
4382

44-
- Modify ``dec_rec`` to provide a descriptive and concise title. Summarizing the decision. (manadatory)
45-
- 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)
46-
- Adjust ``status`` according to your needs (manadatory)
83+
- Modify ``dec_rec`` to provide a descriptive and concise title. Summarizing the decision. (mandatory)
84+
- 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)
85+
- Adjust ``status`` according to your needs (mandatory)
4786
- Modify ``affects`` to point to the work product it affects, mostly this will be architecture or design (recommended)
48-
- Modify ``context`` to describe the issue or motivation behind this decision or change (manadatory)
49-
- Modify ``decision`` to detail the proposed change or decision (manadatory)
50-
- Modify ``consequences`` to explain the impact of this change, including what becomes easier or more difficult (recommended)
87+
- Provide ``Description`` (mandatory)
88+
- Add ``Context`` to describe the issue or motivation behind this decision or change (mandatory)
89+
- Add ``decision`` to detail the proposed change or decision (mandatory)
90+
- Add ``consequences`` to explain the impact of this change, including what becomes easier or more difficult (recommended)

0 commit comments

Comments
 (0)