Documentation Management Plan		status: valid security: YES safety: ASIL_B
tags: platform_management version: 4 realizes: wp__document_mgt_plan
doc__documentation_mgt_plan		Generic Document

Documentation Management Plan

Purpose

The documentation management plan describes how documents are handled in the S-CORE project.

Objectives and scope

Goal of this plan is to describe

• which documents exist

• which attributes and lifecycle they have

• how they are reviewed

Approach

Some of the work products of the S-CORE project are modelled specifically (e.g. the requirements and architecture have a specific set of attributes) Others are modelled as general documents (e.g. the plans which are part of the program management plan or the verification reports).

This plan deals with these documents, which have the following manually set attributes:

• Title: The name of the document (mandatory)

• Unique Id: Id following the naming pattern of the document Title (mandatory)

• Safety: Which ASIL the document supports (mandatory)

• Author: Who is the main committer to the document (mandatory, but set automatically by the github information)

• Status: Describing where in the lifecycle of the document it currently is (mandatory)

• Tags: Can be used to group documents for subsequent filtering (optional)

Also the “Documentation Management” is a document, so an example for a correct document definition can be seen in the header section above, see Documentation Management Plan (doc__documentation_mgt_plan).

The following additional attributes of the document are generated automatically during the documentation build:

• Approver: from the github information on who was the last CODEOWNER performing the github review

• Reviewer: any additional reviewer performing the github review without CODEOWNER rights

The lifecycle of S-CORE documents has two states:

• Draft: The document is filled with content but not completed, the existing content is reviewed and already applicable

• Valid: The document is completed and approved

If a document is invalidated it is removed from the project entirely. A document can also transition from valid to draft, for example if a release was done with a valid verification report and then the development for the next release is started.

Invalidated documents are still observable as part of the git history in the unlikely case of later referral (e.g. for design decisions or audit). In this way, there is even an option to recover the content.

The review of each document is done as defined for this type of work product in the respective process description. This means that for some of the work products dedicated checklists are defined, but for others there are not. In any case the reviews are done in a github review at least by one CODEOWNER who is not the author of the document.

Generally all work products (specific and general documents) are subject to a documentation build, which always contains the latest version of the documents for each pull-request. Versioning of documents is done as for every work product with github means and is defined in the configuration management plan.

The time schedule is not part of the documentation management plan. As described in the project management plan GitHub issues is used to plan and track the work.

The following tables list all documents. The documentation is structured in several folders Platform Folder Structure, each representing a specific aspect of the project. First the documents of the platform folders are listed. Afterwards the documents are listed per feature: for each feature the feature documents are followed by the documents of the implementing modules and their components. Finally all further documents, which do not belong to one of these sections, are listed.

Note

The tables of this plan are generated during the documentation build from the documents which are part of that build. Therefore this plan looks different depending on where it is built:

• S-CORE platform repository: only the documents of the platform repository are listed. The module repositories are not part of this build, so the module and component tables are empty. Only the module documentation still located in the folder docs/modules of the platform repository is listed there. This documentation is not yet transferred into the module repositories, see Module Folder Structure. Also the section “Further documents” is empty.

• Reference integration: the module repositories and further dependencies (e.g. the process description and docs-as-code) are part of the build. Therefore the tables additionally contain the module and component documents of these repositories and the section “Further documents” lists the documents of the other dependencies.

The structure of the plan is the same in both cases.

Platform documentation

docs

Title	ID	Safety	Security	Status
Handbook	doc__platform_handbook	ASIL_B	YES	valid

docs/architecture

Title	ID	Safety	Security	Status
Platform Architecture	doc__platform_architecture	ASIL_B	YES	valid

docs/contribute

Title	ID	Safety	Security	Status
Feature Request Guideline	doc__feature_request_guideline	QM	NO	valid
Contribution Guideline	doc__contr_guideline	QM	NO	valid
Pull Request Guideline	doc__pull_request_guideline	QM	NO	valid
Issue Guideline	doc__issue_guideline	QM	NO	valid
API Guidelines	doc__api_guidelines	QM	NO	draft
Static Code Analysis C++	doc__cpp_code_analysis	ASIL_B	YES	valid
Coding Guidelines C++	doc__cpp_coding_guidelines	ASIL_B	YES	valid
MISRA C++:2023 Rule Mapping	doc__cpp_misra2023_rule_mapping	ASIL_B	YES	draft
Development Environment	doc__develop_environment	ASIL_B	YES	valid
Coding Guidelines Python	doc__python_coding_guidelines	QM	NO	valid
Coding Guidelines Rust	doc__rust_coding_guidelines	ASIL_B	YES	valid
Rust API design guidelines	doc__rust_api_design	QM	NO	draft
Traceability Tooling	doc__traceability_tooling	QM	NO	valid
Git Guidelines	doc__git_coding_guidelines	ASIL_B	NO	valid
Naming Conventions	doc__naming_conventions	ASIL_B	YES	valid
Contribution	doc__contribution_guideline	ASIL_B	YES	valid

docs/platform_management_plan

Title	ID	Safety	Security	Status
Change Management Plan	doc__platform_change_management_plan	ASIL_B	YES	valid
Configuration Management Plan	doc__config_mgt_plan	ASIL_B	YES	draft
Documentation Management Plan	doc__documentation_mgt_plan	ASIL_B	YES	valid
Platform Management Glossary	doc__platform_management_glossary	ASIL_B	YES	draft
Platform Management Plan	doc__platform_mgt_plan	ASIL_B	YES	draft
Problem Resolution Plan	doc__platform_problem_resolution_plan	ASIL_B	YES	draft
Project Management Plan	doc__project_mgt_plan	ASIL_B	YES	valid
Platform Quality Management Plan	doc__platform_quality_plan	ASIL_B	YES	valid
Release Management Plan	doc__platform_release_management_plan	ASIL_B	NO	draft
Platform Quality Manager	doc__platform_quality_manager	ASIL_B	YES	valid
Platform Safety Engineer	doc__platform_safety_engineer	ASIL_B	YES	valid
Platform Safety Manager	doc__platform_safety_manager	ASIL_B	YES	valid
Platform Security Manager	doc__platform_security_manager	ASIL_B	YES	valid
Platform Safety Plan	doc__score_platform_safety_plan	ASIL_B	NO	draft
Platform Security Plan	doc__score_platform_security_plan	ASIL_B	YES	draft
Software Development Plan	doc__software_development_plan	ASIL_B	YES	valid
Software Verification Plan	doc__verification_plan	ASIL_B	YES	valid
Tool Management Plan	doc__platform_tool_management_plan	ASIL_B	YES	valid
Platform Vulnerability Management Plan	doc__platform_vulnerability_mgt_plan	ASIL_B	YES	draft

docs/quality

Title	ID	Safety	Security	Status
Quality Report	doc__score_qms_report	ASIL_B	YES	draft

docs/requirements

Title	ID	Safety	Security	Status
SW-platform Assumptions	doc__platform_assumptions	ASIL_B	YES	draft
SW-platform stakeholder requirements	doc__stakeholder_requirements	ASIL_B	YES	draft

docs/safety

Title	ID	Safety	Security	Status
Safety Analysis Formal Review Report	doc__score_platform_safety_analysis_fdr	ASIL_B	NO	draft
Platform Safety Package Formal Review	doc__score_platform_safety_package_fdr	ASIL_B	NO	draft
S-CORE Platform Safety Plan Formal Review	doc__score_platform_safety_plan_fdr	ASIL_B	NO	draft
Platform DFA	doc__score_platform_dfa	ASIL_B	NO	draft
Platform Safety Manual	doc__score_platform_safety_manual	ASIL_B	NO	draft

docs/score_tools

Title	ID	Safety	Security	Status
Tool Evaluation List	doc__tool_evaluation_list	ASIL_B	YES	draft
Tools Requirements	doc__tools_requirements	ASIL_B	YES	valid

Title	ID	Safety Affected	Security Affected	Status
Bazel	doc_tool__bazel	YES	YES	draft
gcc	doc_tool__gcc	NO	NO	draft
qcc	doc_tool__qcc	YES	YES	draft
Doc-as-Code	doc_tool__doc_as_code	YES	YES	evaluated
clang-format	doc_tool__clang_format	YES	YES	evaluated
clang-tidy	doc_tool__clang_tidy	YES	YES	evaluated
clippy	doc_tool__clippy	YES	YES	evaluated
rustfmt	doc_tool__rustfmt	YES	YES	evaluated
gtest	doc_tool__gtest	YES	YES	draft
ITF	doc_tool__itf	YES	YES	draft
pytest	doc_tool__pytest	YES	YES	evaluated
github	doc_tool__github	YES	YES	draft

Feature, module and component documentation

In the following sections the documents of the features, that are planned for release v1.0, are listed. The features of the platform repository (docs/features) are used as structure. For each feature the documents are listed in the following order:

• Feature documents: the feature documents of the platform repository (see Platform Folder Structure) and the feature documents of the implementing module(s) (docs/features, see Module Folder Structure)

• Module documents: the documents on module level of the implementing module(s), e.g. module safety plan, safety manual, release note and verification report (docs/module, docs/verification_report)

• Component documents: the documents of the components of the implementing module(s), e.g. requirements, architecture, detailed design, safety analyses and their inspection checklists (score/<component_name>/docs)

The modules implementing a feature are listed with their Bazel module name, which is also used as folder name for the module documentation in the reference integration. If no module is assigned to a feature or a table is empty, the corresponding documentation is missing in the build.

AI platform

Modules: none

Note

The incubation repositories inc_ai_platform and inc_gen_ai were archived on 2026-03-10.

Feature documents

Title	ID	Safety	Security	Status
AI-Platform Architecture	doc__ai_platform_architecture	ASIL_B	NO	draft
Gen-AI Architecture	doc__gen_ai_architecture	QM	NO	draft
Gen-AI	doc__gen_ai	QM	NO	draft
AI-Platform	doc__ai_platform	ASIL_B	NO	draft

Module documents

No module is assigned to this feature yet.

Component documents

No module is assigned to this feature yet.

Baselibs

Modules: score_baselibs

Feature documents

Title	ID	Safety	Security	Status
Baselibs Architecture	doc__baselibs_architecture	ASIL_B	YES	valid
Base Libraries	doc__baselibs	ASIL_B	YES	valid
Baselibs Requirements Inspection Checklist	doc__baselibs_req_inspection	ASIL_B	YES	valid
Baselibs Requirements	doc__baselibs_requirements	ASIL_B	YES	valid

Module documents

No needs passed the filters

Component documents

No needs passed the filters

Code generation

Modules: none

Note

The incubation repository inc_score_codegen was archived on 2026-03-10.

Feature documents

Title	ID	Safety	Security	Status
Code-Generation Architecture	doc__code_generation_architecture	ASIL_B	NO	draft
Code-Generation	doc__code_generation	ASIL_B	NO	draft

Module documents

No module is assigned to this feature yet.

Component documents

No module is assigned to this feature yet.

Communication

Modules: score_communication, score_someip_gateway, communication

Feature documents

Title	ID	Safety	Security	Status
Communication	doc__com	ASIL_B	YES	valid
IPC Architecture	doc__ipc_architecture	ASIL_B	YES	valid
Inter-process Communication	doc__com_ipc	ASIL_B	YES	valid
IPC Requirements	doc__ipc_requirements	ASIL_B	YES	valid
IPC DFA	doc__ipc_dfa	ASIL_B	NO	draft
IPC FMEA	doc__ipc_fmea	ASIL_B	NO	draft
Communication IPC Safety WPs	doc__com_ipc_safety_wp	ASIL_B	YES	draft
Communication Requirements	doc__communication_requirements	ASIL_B	YES	valid
SOME_IP-Gateway	doc__some_ip_gateway	ASIL_B	YES	valid

Module documents

Title	ID	Safety	Security	Status
Communication Safety Manual	doc__communication_safety_manual	ASIL_B	NO	draft
Communication Release Note	doc__communication_release_note	ASIL_B	YES	valid
Communication Assumptions of Use	doc__communication_aou	ASIL_B	NO	valid
Communication Codeowners	doc__communication_codeowners	ASIL_B	YES	valid
Communication Safety Package Formal Review	doc__communication_safety_package_fdr	ASIL_B	NO	draft
Communication Safety Plan	doc__communication_safety_plan	ASIL_B	NO	draft
Communication Safety Plan Formal Review	doc__communication_safety_plan_fdr	ASIL_B	NO	draft
Communication Verification Report	doc__communication_verification_report	ASIL_B	YES	draft

Component documents

Title	ID	Safety	Security	Status
LoLa Architecture	doc__lola_architecture	ASIL_B	YES	draft
lola Component Classification	doc__lola_comp_class	ASIL_B	NO	draft
LoLa Detailed Design	doc__lola_detailed_design	ASIL_B	YES	draft
LoLa	doc__lola	ASIL_B	YES	draft
LoLa Requirements	doc__lola_requirements	ASIL_B	YES	draft
lola DFA	doc__lola_dfa	ASIL_B	NO	draft
lola FMEA	doc__lola_fmea	ASIL_B	NO	draft

Configuration

Modules: score_config_management

Note

The incubation repository inc_config_management was archived on 2026-03-10, the module is continued in the repository config_management (score_config_management).

Feature documents

Title	ID	Safety	Security	Status
Configuration Management Architecture	doc__config_mgmt_architecture	ASIL_B	YES	draft
Configuration Management	doc__config_mgmt	ASIL_B	YES	draft
Configuration Model	doc__configuration_model	QM	NO	draft

Module documents

No needs passed the filters

Component documents

No needs passed the filters

Diagnostics

Modules: score_diagnostics

Feature documents

Title	ID	Safety	Security	Status
Diagnostics Architecture	doc__diagnostics_architecture	QM	YES	draft
Diagnostics	doc__diagnostics	QM	YES	draft

Module documents

No needs passed the filters

Component documents

No needs passed the filters

Frameworks (DAAL, FEO)

Modules: score_feo, score_inc_daal, feo

Note

The incubation repository inc_feo was archived on 2026-03-10, the module is continued in the repository feo (score_feo).

Feature documents

Title	ID	Safety	Security	Status
Deterministic App Abstraction Layer Architecture	doc__daal_architecture	QM	NO	draft
Deterministic App Abstraction Layer	doc__daal	QM	NO	valid
FEO Feature Architecture Inspection Checklist	doc__arch_inspection_frameworks_feo	ASIL_B	NO	draft
FEO Feature Architecture	doc__frameworks_feo_feat_arch	ASIL_B	NO	valid
Fixed execution order framework	doc__frameworks_feo	ASIL_B	NO	valid
FEO Assumptions of Use Requirements	doc__frameworks_feo_aou_reqs	ASIL_B	NO	draft
FEO Feature Requirements Inspection Checklist	doc__req_inspection_frameworks_feo	ASIL_B	NO	draft
FEO Feature Requirements	doc__frameworks_feo_feat_reqs	ASIL_B	NO	valid
FEO Feature Safety Analysis Inspection Checklist	doc__saf_ana_inspec_frameworks_feo	ASIL_B	NO	draft
FEO Feature DFA	doc__frameworks_feo_dfa	ASIL_B	NO	draft
FEO Feature FMEA	doc__frameworks_feo_fmea	ASIL_B	NO	draft
FEO Safety Work Products	doc__feo_safety_wp	ASIL_B	NO	valid

Module documents

Title	ID	Safety	Security	Status
FEO Module Safety Manual	doc__feo_safety_manual	ASIL_B	NO	draft
FEO Module Release Note	doc__feo_release_note	ASIL_B	NO	valid
FEO Module Safety Package Formal Review	doc__feo_safety_package_fdr	ASIL_B	NO	draft
FEO Module Safety Plan	doc__feo_safety_plan	ASIL_B	NO	valid
FEO Module Safety Plan Formal Review	doc__feo_safety_plan_fdr	ASIL_B	NO	draft
FEO Module Verification Report	doc__feo_verification_report	ASIL_B	NO	draft

Component documents

Title	ID	Safety	Security	Status
FEO Component Architecture Inspection Checklist	doc__arch_inspection_component_feo	ASIL_B	NO	draft
FEO Component Architecture	doc__component_feo_architecture	ASIL_B	NO	draft
FEO Component Classification	doc__feo_comp_class	ASIL_B	NO	draft
FEO Implementation Inspection Checklist	doc__impl_inspection_component_feo	ASIL_B	NO	draft
FEO Component Detailed Design	doc__component_feo_detailed_design	ASIL_B	NO	draft
FEO Component	doc__feo	ASIL_B	YES	draft
FEO Component Assumptions of Use Requirements	doc__component_feo_aou_reqs	ASIL_B	NO	draft
FEO Component Requirements Inspection Checklist	doc__req_inspection_component_feo	ASIL_B	YES	draft
FEO Component Requirements	doc__component_feo_requirements	ASIL_B	NO	draft
FEO Safety Analysis Inspection Checklist	doc__safety_analysis_inspection_component_feo	ASIL_B	NO	draft
FEO Component DFA	doc__component_feo_dfa	ASIL_B	NO	draft
FEO FMEA	doc__component_feo_fmea	ASIL_B	NO	draft

Lifecycle

Modules: score_lifecycle

Feature documents

Title	ID	Safety	Security	Status
Lifecycle Architecture	doc__lifecycle_architecture	ASIL_B	YES	valid
Lifecycle	doc__lifecycle	ASIL_B	YES	valid
Lifecycle Requirements	doc__lifecycle_requirements	ASIL_B	YES	valid

Module documents

No needs passed the filters

Component documents

No needs passed the filters

Log and trace

Modules: score_logging

Feature documents

Title	ID	Safety	Security	Status
Logging Architecture	doc__logging_architecture	ASIL_B	YES	valid
doc__logging	doc__logging	ASIL_B	YES	draft
Logging Requirements Inspection Checklist	doc__logging_req_inspection	ASIL_B	YES	draft
Logging Requirements	doc__logging_requirements	ASIL_B	YES	valid

Module documents

No needs passed the filters

Component documents

No needs passed the filters

Orchestration

Modules: score_kyron, orchestrator

Note

The repository orchestrator was archived on 2026-09-21. The module documentation still available in the platform repository (docs/modules/orchestrator) is kept.

Feature documents

Title	ID	Safety	Security	Status
Orchestration Architecture	doc__orchestration_architecture	ASIL_B	YES	draft
Orchestration	doc__orchestration	ASIL_B	YES	valid
Orchestration Requirements	doc__orchestration_requirements	ASIL_B	YES	valid
Orchestration DFA	doc__orchestration_dfa	ASIL_B	YES	draft
Orchestration FMEA	doc__orchestration_fmea	ASIL_B	YES	draft
Orchestration Safety WPs	doc__orchestration_safety_wp	ASIL_B	YES	draft

Module documents

Title	ID	Safety	Security	Status
Orchestrator Safety Manual	doc__orchestrator_safety_manual	ASIL_B	YES	draft
Orchestrator Release Note	doc__orchestrator_release_note	ASIL_B	YES	draft
Orchestrator Codeowners	doc__orchestrator_codeowners	ASIL_B	YES	valid
Orchestrator Safety Package Formal Review	doc__orchestrator_safety_package_fdr	ASIL_B	YES	draft
Orchestrator Safety Plan	doc__orchestrator_safety_plan	ASIL_B	YES	draft
Orchestrator Safety Plan Formal Review	doc__orchestrator_safety_plan_fdr	ASIL_B	YES	draft
Orchestrator Verification Report	doc__orchestrator_verification_report	ASIL_B	YES	draft
Orchestrator	doc__orchestrator	ASIL_B	YES	draft

Component documents

Title	ID	Safety	Security	Status
Executor Architecture Inspection Checklist	doc__executor_arc_inspection	ASIL_B	YES	draft
Executor Architecture	doc__executor_architecture	ASIL_B	YES	valid
Executor Detailed Design	doc__executor_detailed_design	ASIL_B	YES	draft
Executor	doc__executor	ASIL_B	YES	draft
Executor Requirements Inspection Checklist	doc__executor_req_inspection	ASIL_B	YES	draft
Executor Requirements	doc__executor_requirements	ASIL_B	YES	draft
Executor DFA	doc__executor_dfa	ASIL_B	YES	draft
Executor FMEA	doc__executor_fmea	ASIL_B	YES	draft
Orchestrator Architecture Inspection Checklist	doc__orchestrator_arc_inspection	ASIL_B	YES	draft
Orchestrator Architecture	doc__orchestrator_architecture	ASIL_B	YES	valid
Orchestrator Detailed Design	doc__orchestrator_detailed_design	ASIL_B	YES	draft
Orchestrator	doc__orchestrator_component	ASIL_B	YES	draft
Orchestrator Requirements Inspection Checklist	doc__orchestrator_req_inspection	ASIL_B	YES	draft
Orchestrator Requirements	doc__orchestrator_requirements	ASIL_B	YES	draft
Orchestrator DFA	doc__orchestrator_dfa	ASIL_B	YES	draft
Orchestrator FMEA	doc__orchestrator_fmea	ASIL_B	YES	draft

Operating system

Modules: os

Note

The repository operating_system was archived on 2026-03-10. The module documentation still available in the platform repository (docs/modules/os) is kept.

Feature documents

There is no dedicated feature for the operating system.

Module documents

Title	ID	Safety	Security	Status
Operating System Assumptions of Use	doc__os_aou	ASIL_B	YES	draft
QNX Assumptions of Use	doc__os_aou_qnx	ASIL_B	YES	draft
Operating System Requirements	doc__os_requirements	ASIL_B	YES	draft

Component documents

Title	ID	Safety	Security	Status
[OS Name]	doc__os_onboarding	QM	YES	draft

Persistency

Modules: score_persistency

Feature documents

Title	ID	Safety	Security	Status
Persistency KVS Feature Architecture	doc__persistency_architecture	ASIL_B	NO	valid
Persistency	doc__persistency	ASIL_B	NO	valid
Persistency Requirements Inspection Checklist	doc__feature_persistency_requirements_chklst	ASIL_B	NO	valid
Persistency Requirements	doc__feature_persistency_requirements	ASIL_B	YES	valid

Module documents

No needs passed the filters

Component documents

No needs passed the filters

Security and crypto

Modules: score_security_crypto

Feature documents

Title	ID	Safety	Security	Status
Security & Crypto Architecture	doc__security_crypto_architecture	QM	YES	draft
Security & Crpyto Feature Requirements	doc__security_crypto_feat_reqs	QM	YES	valid

Module documents

No needs passed the filters

Component documents

No needs passed the filters

Time

Modules: score_time

Feature documents

Title	ID	Safety	Security	Status
Time Architecture	doc__time_architecture	ASIL_B	YES	draft
Time	doc__time	ASIL_B	YES	valid
Time Assumption of Use Requirements	doc__feature_time_aou_reqs	ASIL_B	NO	draft

Module documents

No needs passed the filters

Component documents

No needs passed the filters

Further documents

This section lists all documents which are part of the documentation build but are not assigned to one of the sections above, e.g. documents of included dependencies or of modules which are not yet assigned to a feature.

No needs passed the filters

No needs passed the filters