You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Prepare platform release notes summarizing the updates from all integrated software modules.
86
86
* 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).
87
87
* Ensure the relevant safety packages are available and complete.
88
+
* Create/Maintain Platform Handbook for the release.
88
89
* Tag the platform release in the repository.
89
90
90
91
5. **Release Execution**:
@@ -109,11 +110,34 @@ Tracking and Communication
109
110
* Hold periodic meetings to discuss progress, issues, and dependencies within the project lead circle.
110
111
* meeting definition and schedule is defined in the projects's platform management plan, as defined in :need:`gd_guidl__platform_mgmt_plan`.
111
112
113
+
Release Handbook
114
+
----------------
115
+
116
+
.. gd_guidl:: Release Handbook
117
+
:id: gd_guidl__rel_handbook
118
+
:status: valid
119
+
:complies: std_req__iso26262__software_1041
120
+
121
+
The release handbook incorporates an overview including a tutorial to explain the usage of the released software.
122
+
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`.
123
+
124
+
It is intended to contain:
125
+
126
+
* Overview of the technologies used within the project
127
+
* Software architecture overview
128
+
* Module structure overview
129
+
* Integration process
130
+
* Getting started guide
131
+
* Contribution guide
132
+
133
+
By this the software integration approach becomes clear and reflects the dependencies and functional unit integration of the various modules.
134
+
It also describes how to build and run the software for the various target systems such as simulation, hardware architectures, and operating system(s).
135
+
112
136
113
137
Templates
114
138
=========
115
139
116
-
For the release note a template has been created for module level and for platform level
140
+
For the release note a template has been created for module level and for platform level.
0 commit comments