Documentation Management Plan		status: draft security: NO 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 following table lists all documents of the S-CORE project:

Title	ID	Status	Tags
[Your Component Name]	PROCESS_doc__component_name	draft	template; component_name
[Your Component Name] Architecture	PROCESS_doc__component_name_architecture	draft	template; component_name
[Your Component Name] Component Classification	PROCESS_doc__component_name_comp_class	draft	template; component_name
[Your Component Name] Component Classification	doc__component_name_comp_class	draft	commponent_feo
[Your Component Name] Detailed Design	PROCESS_doc__component_name_detailed_design	draft	template; component_name
[Your Component Name] DFA	PROCESS_doc__component_name_dfa	draft	template; component_name
[Your Component Name] FMEA	PROCESS_doc__component_name_fmea	draft	template; component_name
[Your Component Name] Requirements	PROCESS_doc__component_name_requirements	draft	template; component_name
[Your Feature Name]	PROCESS_doc__feature_name	draft	template; feature_name
[Your Feature Name] Architecture	PROCESS_doc__feature_name_architecture	draft	template; feature_name
[Your Feature Name] DFA	PROCESS_doc__feature_name_dfa	draft	template; feature_name
[Your Feature Name] FMEA	PROCESS_doc__feature_name_fmea	draft	template; feature_name
[Your Feature Name] Requirements	PROCESS_doc__feature_name_requirements	draft	template; feature_name
[Your Feature Name] Safety WPs	PROCESS_doc__feature_name_safety_wp	draft	template; feature_name
[Your Module Name] Release Note	PROCESS_doc__module_name_release_note	draft	template
[Your Module Name] Safety Manual	PROCESS_doc__module_name_safety_manual	draft	template
[Your Module Name] Safety Package Formal Review	PROCESS_doc__module_name_safety_package_fdr	draft	template
[Your Module Name] Safety Plan	PROCESS_doc__module_name_safety_plan	draft	template
[Your Module Name] Safety Plan Formal Review	PROCESS_doc__module_name_safety_plan_fdr	draft	template
[Your Module Name] Verification Report	PROCESS_doc__module_name_verification_report	draft	template
ABI Compatible Datatypes	doc__abi_compatible_data_types	valid	feature_request; change_management; communication; abi_compatible_data_types
AI-Platform	doc__ai_platform	draft	feature_request
API Guidelines	doc__api_guidelines	draft
Base Libraries	doc__baselibs	valid	feature_request
Change Management Plan	doc__platform_change_management_plan	draft	platform_management
Coding Guidelines C++	doc__cpp_coding_guidelines	valid
Coding Guidelines Python	doc__python_coding_guidelines	valid
Coding Guidelines Rust	doc__rust_coding_guidelines	valid
Communication	doc__com	valid	feature_request
Configuration Management	doc__config_mgmt	draft	contribution_request; feature_request
Configuration Management Plan	doc__config_mgt_plan	draft	platform_management
Contribution	doc__contribution_guideline	valid
Contribution Guideline	doc__contr_guideline	valid
Development Environment	doc__develop_environment	valid
DFA	doc__persistency_dfa	draft	feature_persistency
Diagnostics	doc__diagnostics	draft	feature_request
doc__logging	doc__logging	draft	feature_request
Documentation Management Plan	doc__documentation_mgt_plan	draft	platform_management
Feature Request Guideline	doc__feature_request_guideline	valid
FEO Assumptions of Use Requirements	doc__frameworks_feo_aou_reqs	valid	frameworks_feo
FEO Component	doc__component_name	draft	component_feo
FEO Component Architecture	doc__component_feo_architecture	draft	component_feo
FEO Component Architecture Inspection Checklist	doc__arch_inspection_component_feo	draft	component_feo
FEO Component Assumptions of Use Requirements	doc__component_feo_aou_reqs	valid	component_feo
FEO Component Detailed Design	doc__component_feo_detailed_design	draft	component_feo
FEO Component DFA	doc__component_feo_dfa	draft	coponent_feo
FEO Component Requirements	doc__component_feo_requirements	draft	component_feo
FEO Component Requirements Inspection Checklist	doc__req_inspection_component_feo	draft	component_feo
FEO Feature Architecture	doc__frameworks_feo_feat_arch	valid	frameworks_feo
FEO Feature Architecture Inspection Checklist	doc__arch_inspection_frameworks_feo	draft	frameworks_feo
FEO Feature DFA	doc__frameworks_feo_dfa	draft	frameworks_feo
FEO Feature Requirements	doc__frameworks_feo_feat_reqs	valid	frameworks_feo
FEO Feature Requirements Inspection Checklist	doc__req_inspection_frameworks_feo	draft	frameworks_feo
FEO Feature Safety Analysis Inspection Checklist	doc__saf_ana_inspec_frameworks_feo	draft	component_feo
FEO FMEA	doc__component_feo_fmea	draft	component_feo
FEO Implementation Inspection Checklist	doc__impl_inspection_component_feo	draft	component_feo
FEO Module Release Note	doc__feo_release_note	draft	module_feo
FEO Module Safety Manual	doc__feo_safety_manual	draft	module_feo
FEO Module Safety Package Formal Review	doc__module_name_safety_package_fdr	draft	module_feo
FEO Module Safety Plan	doc__feo_safety_plan	valid	module_feo
FEO Module Safety Plan Formal Review	doc__feo_safety_plan_fdr	draft	module_feo
FEO Module Verification Report	doc__feo_verification_report	draft	module_template
FEO Safety Analysis Inspection Checklist	doc__safety_analysis_inspection_component_feo	draft	component_feo
FEO Safety Work Products	doc__feo_safety_wp	valid	framework_feo
Fixed execution order framework	doc__frameworks_feo	valid	feature_request; frameworks_feo
FMEA	doc__frameworks_feo_fmea	draft	frameworks_feo
FMEA	doc__persistency_fmea	draft	feature_persistency
Gen-AI	doc__gen_ai	draft	feature_request
Git Guidelines	doc__git_coding_guidelines	valid
Inter-process Communication	doc__com_ipc	valid	contribution_request; feature_request
Issue Guideline	doc__issue_guideline	valid
JSON-Library	doc__json	valid	component_request
KVS DFA	doc__kvs_dfa	valid	Persistency KVS
KVS FMEA	doc__kvs_fmea	valid	Persistency KVS
Lifecycle	doc__lifecycle	draft	feature_request
MISRA C++:2023 Rule Mapping	doc__cpp_misra2023_rule_mapping	draft
Naming Conventions	doc__naming_conventions	valid
Orchestration	doc__orchestration	valid	feature_request; change_management; orchestration
Persistency Component Classification	doc__persistency_component_classification	valid	feature_persistency
Persistency JSON	doc__persistencyjson	draft	template
Persistency Key-Value-Storage	doc__persistency_kvs	valid	feature_request; persistency_kvs
Persistency KVS	doc__persistencykvs	draft	Persistency KVS
Persistency KVS Feature Architecture	doc__persistency_kvs_feat_arch	valid
Persistency KVS Feature Requirements	doc__persistency_kvs_feat_reqs	valid	persistencykvs; persistency
Persistency KVS Module Architecture	doc__persistency_kvs_mod_arch	draft
Persistency KVS Module Requirements	doc__persistency_kvs_mod_req	valid
Persistency Release Note	doc__persistency_release_note	draft	persistency
Persistency Safety Manual	doc__persistency_safety_manual	draft	feature_persistency
Persistency Safety Package Formal Review	doc__persistency_safety_package_fdr	valid	persistency
Persistency Safety Plan	doc__persistency_safety_plan	valid	persistency
Persistency Safety Plan Formal Review	doc__persistency_safety_plan_fdr	valid	persistency
Persistency Verification Report	doc__persistency_verification_report	draft	persistency
Platform DFA	PROCESS_doc__platform_dfa	draft	template
Platform Management Plan	doc__platform_mgt_plan	draft	platform_management
Platform Quality Management Plan	doc__platform_quality_plan	valid	platform_management
Platform Release Note	doc__platform_release_note	draft
Platform Safety Plan	doc__platform_safety_plan	draft	platform_management
Platform Security Plan	doc__platform_security_plan	draft	platform_management
Problem Resolution Plan	doc__platform_problem_resolution_plan	draft	platform_management
Project Management Plan	doc__project_mgt_plan	draft	platform_management
Pull Request Guideline	doc__pull_request_guideline	valid
Release Management Plan	doc__platform_release_management_plan	draft	platform_management
Requirements Inspection Checklist Persistency KVS	doc__req_inspection_persistency	valid	persistency; persistencykvs
Result Library Requirements	doc__result_lib_requirements	draft	requirements; result_library
Rust API design guidelines	doc__rust_api_design	draft
Software Development Plan	doc__software_development_plan	draft	platform_management
Software Verification Plan	doc__verification_plan	draft	platform_management
SOME_IP-Gateway	doc__some_ip_gateway	valid	contribution_request; feature_request
Static Code Analysis C++	doc__cpp_code_analysis	valid
Time	doc__time	valid	time; feature_request; change_management
Tool Management Plan	doc__platform_tool_management_plan	valid	platform_management