Documentation Management Plan		status: valid security: YES safety: ASIL_B
tags: platform_management realizes: PROCESS_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)

• 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 lists all documents. The documentation is structured in several folders Platform Folder Structure, each representing a specific aspect of the project. The following sections lists all documents that are available in each folder. Afterwards an additional section is provided with the collected documents for the features, modules and components. Missing documents are listed as well, so that it is easy to identify missing documents.

Platform documentation

docs/glossary

No needs passed the filters

docs/contribute

Title	ID	Safety	Security	Status
API Guidelines	doc__api_guidelines			draft
Contribution Guideline	doc__contr_guideline	QM		valid
Contribution	doc__contribution_guideline	ASIL_B		valid
Static Code Analysis C++	doc__cpp_code_analysis			valid
Coding Guidelines C++	doc__cpp_coding_guidelines			valid
MISRA C++:2023 Rule Mapping	doc__cpp_misra2023_rule_mapping			draft
Development Environment	doc__develop_environment	ASIL_B		valid
Feature Request Guideline	doc__feature_request_guideline			valid
Git Guidelines	doc__git_coding_guidelines	ASIL_B		valid
Issue Guideline	doc__issue_guideline	QM		valid
Naming Conventions	doc__naming_conventions	ASIL_B		valid
Pull Request Guideline	doc__pull_request_guideline	QM		valid
Coding Guidelines Python	doc__python_coding_guidelines			valid
Rust API design guidelines	doc__rust_api_design			draft
Coding Guidelines Rust	doc__rust_coding_guidelines			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 Plan	doc__platform_mgt_plan	ASIL_B		draft
Problem Resolution Plan	doc__platform_problem_resolution_plan	ASIL_B	YES	draft
Project Management Plan	doc__project_mgt_plan	ASIL_B	YES	draft
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 Safety Plan	doc__platform_safety_plan	ASIL_B	NO	draft
Platform Security Plan	doc__platform_security_plan	ASIL_B	YES	draft
Software Development Plan	doc__software_development_plan	ASIL_B	YES	draft
Software Verification Plan	doc__verification_plan	ASIL_B	YES	draft
Tool Management Plan	doc__platform_tool_management_plan	ASIL_B	YES	valid

docs/requirements

Title	ID	Safety	Security	Status
SW Platform Assumptions	doc__platform_assumptions	ASIL_B	YES	draft

docs/quality

No needs passed the filters

docs/safety

No needs passed the filters

docs/security

No needs passed the filters

docs/score_tools

Title	ID	Safety Affected	Security Affected	Status
Doc-as-Code	doc_tool__doc_as_code	YES	YES	evaluated

docs/verification_report

No needs passed the filters

platform_integration_tests

No needs passed the filters

docs/manuals

No needs passed the filters

docs/score_releases

Title	ID	Safety	Security	Status
Platform Release Note	doc__platform_release_note	ASIL_B		draft

Feature documentation

In the following sections all documents of the features and related modules (components), that are planned for release v0.5, are listed.

docs/features/baselibs

Title	ID	Safety	Security	Status
Base Libraries	doc__baselibs	ASIL_B		valid
[Your Feature Name] Architecture	PROCESS_doc__feature_name_architecture	ASIL_B		draft
[Your Feature Name] DFA	PROCESS_doc__feature_name_dfa	ASIL_B		draft
[Your Feature Name] FMEA	PROCESS_doc__feature_name_fmea	ASIL_B		draft
[Your Feature Name] Requirements	PROCESS_doc__feature_name_requirements	ASIL_B		draft
[Your Feature Name] Safety WPs	PROCESS_doc__feature_name_safety_wp	ASIL_B		draft

docs/features/communication

Title	ID	Safety	Security	Status
ABI Compatible Datatypes	doc__abi_compatible_data_types	ASIL_B		valid
Communication	doc__com			valid
Inter-process Communication	doc__com_ipc			valid
SOME_IP-Gateway	doc__some_ip_gateway	ASIL_B		valid
[Your Feature Name] Architecture	PROCESS_doc__feature_name_architecture	ASIL_B		draft
[Your Feature Name] DFA	PROCESS_doc__feature_name_dfa	ASIL_B		draft
[Your Feature Name] FMEA	PROCESS_doc__feature_name_fmea	ASIL_B		draft
[Your Feature Name] Requirements	PROCESS_doc__feature_name_requirements	ASIL_B		draft
[Your Feature Name] Safety WPs	PROCESS_doc__feature_name_safety_wp	ASIL_B		draft

docs/features/frameworks

Title	ID	Safety	Security	Status
FEO Feature Architecture Inspection Checklist	doc__arch_inspection_frameworks_feo	ASIL_B	NO	draft
FEO Safety Work Products	doc__feo_safety_wp	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	valid
FEO Feature DFA	doc__frameworks_feo_dfa	ASIL_B	NO	draft
FEO Feature Architecture	doc__frameworks_feo_feat_arch	ASIL_B	NO	valid
FEO Feature Requirements	doc__frameworks_feo_feat_reqs	ASIL_B	NO	valid
FMEA	doc__frameworks_feo_fmea	ASIL_B	NO	draft
FEO Feature Requirements Inspection Checklist	doc__req_inspection_frameworks_feo	ASIL_B	NO	draft
FEO Feature Safety Analysis Inspection Checklist	doc__saf_ana_inspec_frameworks_feo	ASIL_B	NO	draft
[Your Feature Name] Architecture	PROCESS_doc__feature_name_architecture	ASIL_B		draft
[Your Feature Name] Requirements	PROCESS_doc__feature_name_requirements	ASIL_B		draft

docs/features/orchestration

Title	ID	Safety	Security	Status
Orchestration	doc__orchestration	ASIL_B		valid
[Your Feature Name] Architecture	PROCESS_doc__feature_name_architecture	ASIL_B		draft
[Your Feature Name] DFA	PROCESS_doc__feature_name_dfa	ASIL_B		draft
[Your Feature Name] FMEA	PROCESS_doc__feature_name_fmea	ASIL_B		draft
[Your Feature Name] Requirements	PROCESS_doc__feature_name_requirements	ASIL_B		draft
[Your Feature Name] Safety WPs	PROCESS_doc__feature_name_safety_wp	ASIL_B		draft

docs/features/persistency

Title	ID	Safety	Security	Status
DFA	doc__persistency_dfa	ASIL_B		draft
FMEA	doc__persistency_fmea	ASIL_B		draft
Persistency Key-Value-Storage	doc__persistency_kvs	ASIL_B		valid
Persistency KVS Feature Architecture	doc__persistency_kvs_feat_arch	ASIL_B		valid
Persistency KVS Feature Requirements	doc__persistency_kvs_feat_reqs	ASIL_B		valid
Requirements Inspection Checklist Persistency KVS	doc__req_inspection_persistency			valid
[Your Feature Name] Architecture	PROCESS_doc__feature_name_architecture	ASIL_B		draft
[Your Feature Name] Requirements	PROCESS_doc__feature_name_requirements	ASIL_B		draft
[Your Feature Name] Safety WPs	PROCESS_doc__feature_name_safety_wp	ASIL_B		draft

Modules documentation

docs/modules/baselibs/docs

Title	ID	Safety	Security	Status
[Your Module Name] Release Note	PROCESS_doc__module_name_release_note	ASIL_B		draft
[Your Module Name] Safety Manual	PROCESS_doc__module_name_safety_manual	ASIL_B		draft
[Your Module Name] Safety Package Formal Review	PROCESS_doc__module_name_safety_package_fdr	ASIL_B		draft
[Your Module Name] Safety Plan	PROCESS_doc__module_name_safety_plan	ASIL_B		draft
[Your Module Name] Safety Plan Formal Review	PROCESS_doc__module_name_safety_plan_fdr	ASIL_B		draft
[Your Module Name] Verification Report	PROCESS_doc__module_name_verification_report	ASIL_B		draft

docs/modules/communication/docs

Title	ID	Safety	Security	Status
[Your Module Name] Release Note	PROCESS_doc__module_name_release_note	ASIL_B		draft
[Your Module Name] Safety Manual	PROCESS_doc__module_name_safety_manual	ASIL_B		draft
[Your Module Name] Safety Package Formal Review	PROCESS_doc__module_name_safety_package_fdr	ASIL_B		draft
[Your Module Name] Safety Plan	PROCESS_doc__module_name_safety_plan	ASIL_B		draft
[Your Module Name] Safety Plan Formal Review	PROCESS_doc__module_name_safety_plan_fdr	ASIL_B		draft
[Your Module Name] Verification Report	PROCESS_doc__module_name_verification_report	ASIL_B		draft

docs/modules/feo/docs

Title	ID	Safety	Security	Status
FEO Module Release Note	doc__feo_release_note	ASIL_B	NO	draft
FEO Module Safety Manual	doc__feo_safety_manual	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
FEO Module Safety Package Formal Review	doc__module_name_safety_package_fdr	ASIL_B	NO	draft

docs/modules/logging/docs

Title	ID	Safety	Security	Status
[Your Module Name] Release Note	PROCESS_doc__module_name_release_note	ASIL_B		draft
[Your Module Name] Safety Manual	PROCESS_doc__module_name_safety_manual	ASIL_B		draft
[Your Module Name] Safety Package Formal Review	PROCESS_doc__module_name_safety_package_fdr	ASIL_B		draft
[Your Module Name] Safety Plan	PROCESS_doc__module_name_safety_plan	ASIL_B		draft
[Your Module Name] Safety Plan Formal Review	PROCESS_doc__module_name_safety_plan_fdr	ASIL_B		draft
[Your Module Name] Verification Report	PROCESS_doc__module_name_verification_report	ASIL_B		draft

docs/modules/os/docs

Title	ID	Safety	Security	Status
[Your Module Name] Release Note	PROCESS_doc__module_name_release_note	ASIL_B		draft
[Your Module Name] Safety Manual	PROCESS_doc__module_name_safety_manual	ASIL_B		draft
[Your Module Name] Safety Package Formal Review	PROCESS_doc__module_name_safety_package_fdr	ASIL_B		draft
[Your Module Name] Safety Plan	PROCESS_doc__module_name_safety_plan	ASIL_B		draft
[Your Module Name] Safety Plan Formal Review	PROCESS_doc__module_name_safety_plan_fdr	ASIL_B		draft
[Your Module Name] Verification Report	PROCESS_doc__module_name_verification_report	ASIL_B		draft

docs/modules/persistency/docs

Title	ID	Safety	Security	Status
Persistency Release Note	doc__persistency_release_note	ASIL_B		draft
Persistency Safety Manual	doc__persistency_safety_manual	ASIL_B		draft
Persistency Safety Package Formal Review	doc__persistency_safety_package_fdr	ASIL_B		valid
Persistency Safety Plan	doc__persistency_safety_plan	ASIL_B		valid
Persistency Safety Plan Formal Review	doc__persistency_safety_plan_fdr	ASIL_B		valid
Persistency Verification Report	doc__persistency_verification_report	ASIL_B		draft

docs/modules/tracing/docs

Title	ID	Safety	Security	Status
[Your Module Name] Release Note	PROCESS_doc__module_name_release_note	ASIL_B		draft
[Your Module Name] Safety Manual	PROCESS_doc__module_name_safety_manual	ASIL_B		draft
[Your Module Name] Safety Package Formal Review	PROCESS_doc__module_name_safety_package_fdr	ASIL_B		draft
[Your Module Name] Safety Plan	PROCESS_doc__module_name_safety_plan	ASIL_B		draft
[Your Module Name] Safety Plan Formal Review	PROCESS_doc__module_name_safety_plan_fdr	ASIL_B		draft
[Your Module Name] Verification Report	PROCESS_doc__module_name_verification_report	ASIL_B		draft

Components documentation

docs/modules/baselibs/components

Title	ID	Safety	Security	Status
Bit Manipulation Requirements	doc__bitmanipulation_requirements	ASIL_B		draft
Containers Library Requirements	doc__containers_lib_requirements	ASIL_B		draft
JSON-Library	doc__json	ASIL_B		valid
JSON Architecture	doc__json_architecture	ASIL_B		draft
JSON Requirements	doc__json_requirements	ASIL_B		draft
JSON Wrapper Requirements	doc__json_wrapper_requirements	ASIL_B		valid
Result Library	doc__result	ASIL_B		draft
Result Library Requirements	doc__result_lib_requirements	ASIL_B		draft
Utils Library Requirements	doc__utils_lib_requirements	ASIL_B		draft
[Your Component Name] Architecture	PROCESS_doc__component_name_architecture	ASIL_B		draft
[Your Component Name] Component Classification	PROCESS_doc__component_name_comp_class	ASIL_B		draft
[Your Component Name] Detailed Design	PROCESS_doc__component_name_detailed_design	ASIL_B		draft
[Your Component Name] DFA	PROCESS_doc__component_name_dfa	ASIL_B		draft
[Your Component Name] FMEA	PROCESS_doc__component_name_fmea	ASIL_B		draft

docs/modules/communication/components

No needs passed the filters

docs/modules/feo/components

Title	ID	Safety	Security	Status
FEO Component Architecture Inspection Checklist	doc__arch_inspection_component_feo	ASIL_B	NO	draft
FEO Component Assumptions of Use Requirements	doc__component_feo_aou_reqs	ASIL_B	NO	valid
FEO Component Architecture	doc__component_feo_architecture	ASIL_B	NO	draft
FEO Component Detailed Design	doc__component_feo_detailed_design	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
FEO Component Requirements	doc__component_feo_requirements	ASIL_B	NO	draft
FEO Component	doc__component_name	ASIL_B		draft
[Your Component Name] Component Classification	doc__component_name_comp_class	ASIL_B	NO	draft
FEO Implementation Inspection Checklist	doc__impl_inspection_component_feo	ASIL_B	NO	draft
FEO Component Requirements Inspection Checklist	doc__req_inspection_component_feo	ASIL_B	NO	draft
FEO Safety Analysis Inspection Checklist	doc__safety_analysis_inspection_component_feo	ASIL_B	NO	draft
[Your Component Name] Component Classification	PROCESS_doc__component_name_comp_class	ASIL_B		draft

docs/modules/logging/components

No needs passed the filters

docs/modules/os/components

No needs passed the filters

docs/modules/persistency/components

Title	ID	Safety	Security	Status
KVS DFA	doc__kvs_dfa	ASIL_B		valid
KVS FMEA	doc__kvs_fmea	ASIL_B		valid
Persistency Component Classification	doc__persistency_component_classification	ASIL_B		valid
Persistency KVS Module Architecture	doc__persistency_kvs_mod_arch	ASIL_B		draft
Persistency KVS Module Requirements	doc__persistency_kvs_mod_req	ASIL_B		valid
Persistency JSON	doc__persistencyjson	ASIL_B		draft
Persistency KVS	doc__persistencykvs	ASIL_B		draft
[Your Component Name] Architecture	PROCESS_doc__component_name_architecture	ASIL_B		draft
[Your Component Name] Component Classification	PROCESS_doc__component_name_comp_class	ASIL_B		draft
[Your Component Name] Detailed Design	PROCESS_doc__component_name_detailed_design	ASIL_B		draft
[Your Component Name] DFA	PROCESS_doc__component_name_dfa	ASIL_B		draft
[Your Component Name] FMEA	PROCESS_doc__component_name_fmea	ASIL_B		draft
[Your Component Name] Requirements	PROCESS_doc__component_name_requirements	ASIL_B		draft

docs/modules/tracing/components

No needs passed the filters