Skip to content

Commit d30f4a6

Browse files
committed
Add integration dependencies req to release handbook
Signed-off-by: Philipp Ahmann <[email protected]>
1 parent 9b60a4e commit d30f4a6

File tree

4 files changed

+30
-5
lines changed

4 files changed

+30
-5
lines changed

process/process_areas/release_management/guidance/release_guideline.rst

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ Platform Release
8585
* Prepare platform release notes summarizing the updates from all integrated software modules.
8686
* Check if all planned configuration items are in correct state (i.e. work products are valid, external libraries/tools are used in the correct released version).
8787
* Ensure the relevant safety packages are available and complete.
88+
* Create/Maintain Platform Handbook for the release.
8889
* Tag the platform release in the repository.
8990

9091
5. **Release Execution**:
@@ -110,10 +111,34 @@ Tracking and Communication
110111
* meeting definition and schedule is defined in the projects's platform management plan, as defined in :need:`gd_guidl__platform_mgmt_plan`.
111112

112113

114+
.. gd_guidl:: Release Handbook
115+
:id: gd_guidl__rel_handbook
116+
:status: valid
117+
:complies: std_req__iso26262__software_1041
118+
119+
Release Handbook
120+
----------------
121+
122+
The release handbook incorporates an overview including a tutorial to explain the usage of the released software.
123+
It extends as a decent documentation for users and contributors beyond the pure release notes created according to the template :need:`gd_temp__rel_plat_rel_note`.
124+
125+
It is intended to contain:
126+
127+
* Overview of the technologies used within the project
128+
* Software architecture overview
129+
* Module structure overview
130+
* Integration process
131+
* Getting started guide
132+
* Contribution guide
133+
134+
By this the software integration approach becomes clear and reflects the dependencies and functional unit integration of the various modules.
135+
It also describes how to build and run the software for the various target systems such as simulation, hardware architectures, and operating system(s).
136+
137+
113138
Templates
114139
=========
115140

116-
For the release note a template has been created for module level and for platform level
141+
For the release note a template has been created for module level and for platform level.
117142

118143
.. list-table:: Overview
119144
:header-rows: 1

process/process_areas/release_management/guidance/release_templates.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Templates
1818
.. gd_temp:: Platform Release Note Template
1919
:id: gd_temp__rel_plat_rel_note
2020
:status: valid
21-
:complies: std_req__iso26262__software_1041, std_req__iso26262__management_64134, std_req__iso26262__management_64135, std_req__aspice_40__SUP-8-BP7
21+
:complies: std_req__iso26262__management_64134, std_req__iso26262__management_64135, std_req__aspice_40__SUP-8-BP7
2222

2323
| Platform Release Notes
2424
| ======================
@@ -97,7 +97,7 @@ Templates
9797
.. gd_temp:: Module Release Note Template
9898
:id: gd_temp__rel_mod_rel_note
9999
:status: valid
100-
:complies: std_req__iso26262__software_1041, std_req__iso26262__management_64134, std_req__iso26262__management_64135
100+
:complies: std_req__iso26262__management_64134, std_req__iso26262__management_64135
101101

102102
For the content see here: :need:`doc__module_name_release_note`
103103

process/process_areas/release_management/release_workflow.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ For a detailed explanation of workflows and their role within the process model,
7777
:approved_by: rl__project_lead
7878
:input: wp__platform_safety_package, wp__platform_sw_release_plan, wp__verification_platform_ver_report
7979
:output: wp__platform_handbook
80-
:contains:
80+
:contains: gd_guidl__rel_handbook
8181
:has: doc_concept__rel_process, doc_getstrt__release_process
8282

8383
The platform handbook is prepared and approved by the project lead circle.

process/process_areas/verification/verification_workproducts.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ Module
8888
.. workproduct:: Module Verification Report
8989
:id: wp__verification_module_ver_report
9090
:status: valid
91-
:complies: std_wp__iso26262__software_952, std_req__iso26262__software_1041, std_wp__iso26262__software_1053, std_wp__iso26262__support_953, std_wp__iso26262__support_1253, std_wp__iso26262__analysis_752, std_wp__iso26262__analysis_852, std_wp__iso26262__support_1252, std_wp__isopas8926__4526, std_wp__iso26262__software_app_c_56
91+
:complies: std_wp__iso26262__software_952, std_wp__iso26262__software_1053, std_wp__iso26262__support_953, std_wp__iso26262__support_1253, std_wp__iso26262__analysis_752, std_wp__iso26262__analysis_852, std_wp__iso26262__support_1252, std_wp__isopas8926__4526, std_wp__iso26262__software_app_c_56
9292

9393
Verification Report contains:
9494

0 commit comments

Comments
 (0)