Configuration Management Process Requirements#

Unique Id
status: valid

The Docs-as-Code tool shall check that the Id’s of the configuration items (documented in doc-as-code) are unique.

Note: For definition of configuration items see Configuration Management Co...

Permanent Storage
status: valid
tags: prio_3_automation, config_mgt, configuration_management

At least every platform release shall be stored permanently as a collection of text documents (docs and code) including the used OSS tooling on project owned servers.

Note: This is to ensure to have the development artefacts available during the complete lifetime of the products (cars) the SW platform is used in.

Storage of pull requests documentation
status: valid
tags: prio_2_automation, config_mgt, configuration_management

The content of pull requests (conversation, commits, files changed) shall be stored permanently for every release.

Note: This requirement exists because PRs may be modified after a release, which could corrupt the documented inspection results recorded during the review.

Baseline Differences
status: valid
tags: prio_2_automation, config_mgt, configuration_management

It shall be possible to show the differences between two baselines.

Note: This could be done by showing all the commits which happened between these baselines in one release branch.

Document attributes
status: valid
tags: prio_2_automation, configuration_management

It shall be prohibited to override any mandatory attribute value of an docs-as-code element.

Note: This requirement exists because docs-as-code attributes may be globally overridden, which leads to a mismatch of code and the representing generated documentation. Exception only exists for optional tags, which can be used for filtering and reporting purposes.

Global tags extension
status: valid
tags: prio_3_automation, configuration_management

It shall be possible to define global tags with the docs-as-code tool, which can be used for filtering and reporting.

Note: This requirement exists to enable the use of global tags for filtering and reporting purposes, while still prohibiting the overriding of mandatory attributes or elements globally.