Module Template Documentation

<Brief description of the module and the implemented feature(s).>

<Further documentation of the module and the implemented feature(s) should be added in the respective sections of the documentation (e.g., feature architecture, safety analysis, security analysis, manuals, etc.) following the provided templates and guidelines.>

Feature Documentation

The Feature documentation covers the feature-level definition of <module name>, including architecture and safety planning artifacts.

• [Feature Name]

Title	ID	Safety	Security	Status
[Feature Name] Architecture	doc__feature_example_architecture	ASIL_B	NO	draft
[Feature Name] Architecture Inspection	doc__feature_name_arc_inspection	ASIL_B	YES	draft
[Feature Name] DFA	doc__feature_name_dfa	ASIL_B	NO	draft
[Feature Name] Feature AoU	doc__feature_name_feat_aou	ASIL_B	NO	draft
[Feature Name] Feature Security AoU	doc__feature_name_sec_feat_aou	QM	YES	draft
[Feature Name] FMEA	doc__feature_name_fmea	ASIL_B	NO	draft
[Feature Name] Safety WPs	doc__feature_example_safety_wp	ASIL_B	NO	draft
[Feature Name] Security WPs	doc__feature_example_security_planning_wp	ASIL_B	YES	draft

Module Documentation

The Module documentation covers the module-level view, including architecture, safety management documents, and the user manual.

• Module
• Verification Report

Title	ID	Safety	Security	Status
[Module Name] Release Note	doc__mod_temp_module_name_release_note	ASIL_B	NO	draft
[Module Name] Safety Analysis Checklist	doc__mod_temp_module_name_safety_analysis_fdr	ASIL_B	YES	draft
[Module Name] Safety Manual	doc__mod_temp_module_name_safety_manual	ASIL_B	NO	draft
[Module Name] Safety Package Formal Review	doc__mod_temp_module_name_safety_package_fdr	ASIL_B	NO	draft
[Module Name] Safety Plan	doc__mod_temp_module_name_safety_plan	ASIL_B	NO	draft
[Module Name] Safety Plan Formal Review	doc__mod_temp_module_name_safety_plan_fdr	ASIL_B	NO	draft
[Module Name] Security Manual	doc__mod_temp_module_name_security_manual	ASIL_B	YES	draft
[Module Name] Security Package Formal Review	doc__mod_temp_module_name_sec_pkg_fdr	ASIL_B	YES	draft
[Module Name] Security Plan	doc__mod_temp_module_name_security_plan	ASIL_B	YES	draft
[Module Name] Security Plan Formal Review	doc__mod_temp_module_name_security_plan_fdr	ASIL_B	YES	draft
[Module Name] User Manual	doc__mod_temp_module_name_user_manual	QM	NO	draft
[Module Name] Verification Report	doc__mod_temp_verification_report	ASIL_B	NO	draft

Component Documentation

The Components documentation provides detailed documentation for each individual library component, including requirements, architecture, and design decisions:

• Components

Title	ID	Safety	Security	Status
[Component Name] Architecture	doc__mod_temp_component_name_architecture	ASIL_B	NO	draft
[Component Name] Architecture Inspection	doc__mod_temp_component_name_arc_inspection	ASIL_B	YES	draft
[Component Name] Component AoU	doc__mod_temp_component_name_comp_aou	ASIL_B	NO	draft
[Component Name] Component AoU	doc__mod_temp_component_name_comp_sec_aou	QM	YES	draft
[Component Name] Component Classification	doc__mod_temp_component_name_comp_class	ASIL_B	NO	draft
[Component Name] Detailed Design	doc__mod_temp_component_name_detailed_design	ASIL_B	NO	draft
[Component Name] DFA	doc__mod_temp_component_name_dfa	ASIL_B	NO	draft
[Component Name] FMEA	doc__mod_temp_component_name_fmea	ASIL_B	NO	draft
[Component Name] Implementation Inspection Checklist	doc__mod_temp_component_name_impl_inspection	ASIL_B	YES	draft
[Component Name] Requirements	doc__mod_temp_component_name_requirements	ASIL_B	YES	draft
[Component Name] Requirements Inspection Checklist	doc__mod_temp_component_name_req_inspection	ASIL_B	YES	draft
[Your Component Name]	doc__mod_temp_component_name	ASIL_B	NO	draft

Architecture Modeling Example

An example of modeling architecture in Sphinx Needs can be found in

• Examples

Please note, that is not a template for architecture documentation, but an example of how to use Sphinx Needs for architecture modeling. The architecture documentation of the components and features of the module should follow the provided templates and guidelines.

Quick Start - Building and Testing

Attention

This could also contain just a link to the repository’s README

To build the entire module:

bazel build //src/...

To run all tests:

bazel test //...

To run only unit tests:

bazel test //src/...

To run only component or feature integration tests:

bazel test //tests/...

Module Build Configuration

The project_config.bzl file at the root of the module defines metadata used by Bazel macros. This file controls build behavior and project-specific settings. It should follow the S-CORE definition. See S-CORE user guide for project_config.bzl for details.

The configuration enables conditional build behavior:

• Language-specific tools: For C++ code, tools like clang-tidy are used; for Rust code, clippy is used

• Safety level: The ASIL level affects safety-related build settings and validation

• Source code languages: The build system optimizes for the configured languages

Release Notes

The Module documentation covers the module-level view, including architecture, safety management documents, and the user manual.

• Release notes