Release Management Work Products#

Platform Release Notes
status: valid

The platform release note provides clarity what is included in the current version of the platform release. The platform release note mentions all individual software modules used in the platform release and their used released versions. It shall indicate also the distinct changes to previous platform versions and provide information regarding the time of the release. It includes known bugs from own testing and field reporting, with clear statement, that these bugs do not lead to violation of any safety requirements or which workaround measures need to be applied. It contains also the build configuration capable to create the SEooC Library for the reference HW, platform level.

Note: Embedded software in the sense of the Iso (i.e. deployed on the production HW) is not part of our delivery.

Module Release Notes
status: valid

The module release note provides clarity what is included in the current version of the software module release. It shall indicate also the distinct changes to previous versions and provide information regarding the time of the release. It includes known bugs from own testing and field reporting, with clear statement, that these bugs do not lead to violation of any safety requirements or which workaround measures need to be applied. It contains also the build configuration capable to create the SEooC Library for the reference HW, module level.

Note: Embedded software in the sense of the Iso (i.e. deployed on the production HW) is not part of our delivery.

Platform Release Plan
status: valid
tags: doc_lifecycle_model_2, release_management
version: 1

The platform release plan is a high-level document that outlines which software modules will be included in the overall platform and what features can be expected within the platform. It provides a strategic overview of the platform’s development, ensuring that all stakeholders are aligned on the platform’s future direction and the integration of various software modules.

Module Release Plan
status: valid
tags: doc_lifecycle_model_2, release_management
version: 1

The module release plan is a strategic document that outlines the features planned for upcoming module releases along with their estimated release dates. It provides a roadmap for the development and release of new features, ensuring that all stakeholders are aligned on the module’s future direction.

Module User Manual
status: valid
tags: doc_lifecycle_model_2, release_management
version: 1

The module user manual describes for the users of the module how to integrate, configure and use the released software module. It is the customer documentation of the module release package and is referenced by the module safety manual and the module security manual.

It contains:

  • the needed environment (languages, toolchains, build system, target platforms) and the dependencies;

  • the description of the configuration of the module and its effects;

  • the instructions for a correct integration, including the configuration parameters of the development tools required to integrate and use the module;

  • the usage of the module (application manual), including examples;

  • a reference to the interface documentation of the module.

Platform Handbook
status: valid
tags: doc_lifecycle_model_2, release_management
version: 1

The platform handbook is a tutorial to explain how the project works from a technical perspective. It explains the background of the project, but also what the project is not about.

Further it contains:

  • Overview of the technologies used within the project

  • Software architecture overview

  • Module structure overview

  • Integration process

  • Getting started guide

  • Contribution guide