From 69d2d6bdd07a4953aaeea5aae2a63e1ff513356c Mon Sep 17 00:00:00 2001 From: aschemmel-git Date: Fri, 7 Aug 2026 16:51:54 +0200 Subject: [PATCH] Restructure starting page --- docs/index.rst | 191 ++---------------- docs/module/index.rst | 51 +++++ .../manuals/api_description/.gitkeep | 0 docs/{ => module}/manuals/config/.gitkeep | 0 docs/{ => module}/manuals/examples/.gitkeep | 0 docs/{ => module}/manuals/index.rst | 0 .../{ => module}/manuals/performance/.gitkeep | 0 docs/{ => module}/manuals/safety_manual.rst | 0 docs/{ => module}/manuals/security_manual.rst | 0 docs/{ => module}/manuals/user_manual.rst | 2 +- docs/{ => module}/release/release_note.rst | 0 docs/{ => module}/safety_mgt/index.rst | 0 .../safety_mgt/module_safety_analysis_fdr.rst | 0 .../safety_mgt/module_safety_package_fdr.rst | 0 .../safety_mgt/module_safety_plan.rst | 0 .../safety_mgt/module_safety_plan_fdr.rst | 0 docs/{ => module}/security_mgt/index.rst | 0 .../module_security_package_fdr.rst | 0 .../security_mgt/module_security_plan.rst | 0 .../security_mgt/module_security_plan_fdr.rst | 0 docs/template/index.rst | 164 +++++++++++++++ 21 files changed, 237 insertions(+), 171 deletions(-) create mode 100644 docs/module/index.rst rename docs/{ => module}/manuals/api_description/.gitkeep (100%) rename docs/{ => module}/manuals/config/.gitkeep (100%) rename docs/{ => module}/manuals/examples/.gitkeep (100%) rename docs/{ => module}/manuals/index.rst (100%) rename docs/{ => module}/manuals/performance/.gitkeep (100%) rename docs/{ => module}/manuals/safety_manual.rst (100%) rename docs/{ => module}/manuals/security_manual.rst (100%) rename docs/{ => module}/manuals/user_manual.rst (98%) rename docs/{ => module}/release/release_note.rst (100%) rename docs/{ => module}/safety_mgt/index.rst (100%) rename docs/{ => module}/safety_mgt/module_safety_analysis_fdr.rst (100%) rename docs/{ => module}/safety_mgt/module_safety_package_fdr.rst (100%) rename docs/{ => module}/safety_mgt/module_safety_plan.rst (100%) rename docs/{ => module}/safety_mgt/module_safety_plan_fdr.rst (100%) rename docs/{ => module}/security_mgt/index.rst (100%) rename docs/{ => module}/security_mgt/module_security_package_fdr.rst (100%) rename docs/{ => module}/security_mgt/module_security_plan.rst (100%) rename docs/{ => module}/security_mgt/module_security_plan_fdr.rst (100%) create mode 100644 docs/template/index.rst diff --git a/docs/index.rst b/docs/index.rst index 55d48f6b..d8be1f17 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -15,198 +15,46 @@ Module Template Documentation ============================= -This documentation describes the structure, usage and configuration of the Bazel-based C++/Rust module template according to the `SCORE module folder structure `_ and the `SCORE building blocks concept `_. - -.. contents:: Table of Contents - :depth: 2 - :local: - -Overview --------- - -This repository provides a standardized setup for projects using **C++** or **Rust** and **Bazel** as a build system. -It integrates best practices for build, test, CI/CD and documentation. -It also provides an example for the documentation of an module with all necessary artifacts for safety and security management, verification and release management. -It also provides an example of modeling architecture in Sphinx Needs in :ref:`definition_architectural_design`. -It also provides the component architecture template snippets in :ref:`component_architecture`. -It also provides an example of documenting detailed design in :ref:`detailed_design_example`. - -Module Layout -------------- - -The module template includes the following top-level structure: - -.. parsed-literal:: - - / # Root folder of the module, subfolder only if more than one module exists in the repository - ├── .github/ - │ └── workflows/ # CI/CD pipelines - ├── docs/ # Global documentation of the module - │ ├── features/ # Feature documentation and architecture - │ │ └── / # Feature folder parts for each feature which should be in module documentation - │ │ ├── architecture/ # Feature architecture [wp__feature_arch] and of architecture review [wp__sw_arch_verification] - │ │ ├── safety_analysis/ # Feature safety analysis artifacts ([wp__feature_fmea], [wp__feature_dfa], [wp__requirements_feat_aou]) - │ │ ├── safety_planning/ # Feature safety planning artifacts - │ │ ├── security_analysis/ # Feature security analysis artifacts [wp__feature_security_analysis] - │ │ └── security_planning/ # Feature security planning artifacts - │ ├── manuals/ # Module manual, integration manual, table of assumptions of use - │ │ | # safety manual [wp__module_safety_manual], - │ │ | # needs table of [wp__requirements_feat_aou] - │ │ | # security manual [wp__module_security_manual] - │ │ │ # Additional optional user centric documentation (e.g. configuration guide, - │ │ │ # examples user guide, APIs & usage, performance analysis) - │ │ ├── config/ # Configuration guide (optional) - │ │ ├── examples/ # Examples user guide (optional) - │ │ ├── api_description/ # API detail description (optional) - │ │ └── performance/ # Performance analysis (optional) - │ ├── release/ # Module release note [wp__module_sw_release_note] - │ ├── safety_mgt/ # Module safety plan [wp__module_safety_plan], - │ │ # module safety package [wp__module_safety_package], - │ │ # formal document and safety analysis reviews [wp__fdr_reports] - │ ├── security_mgt/ # Module security plan [wp__module_security_plan], - │ │ # module security package [wp__module_security_package], - │ │ # formal document reviews [wp__fdr_reports_security], - │ │ # module SW bill of material [wp__sw_module_sbom] - │ └── verification_report/ # Module verification report, - │ # module verifications [wp__verification_module_ver_report], - ├── examples/ # Usage examples for the module / features - ├── score/ # Components of the module - │ ├── tests/ # Module-level tests (e.g., feature integration tests, system tests) [wp__verification_feat_int_test] - │ └── / # Component folder for each component of the module - │ ├── docs/ # Documentation of the component - │ │ ├── architecture/ # Component architecture [wp__component_arch] - │ │ │ # (only if lower level components exist) - | | | # architecture review [wp__sw_arch_verification], - │ │ ├── detailed_design/ # Detailed design [wp__sw_implementation] - │ │ │ # code inspection [wp__sw_implementation_inspection] - │ │ ├── requirements/ # Component requirements [wp__requirements_comp],[wp__requirements_inspect] - │ │ ├── safety_analysis/ # Safety analysis [wp__sw_component_fmea], [wp__sw_component_dfa], [wp__requirements_comp_aou] - | | | # Component classification [wp__sw_component_class] for pre-existing software - │ │ │ # (only if component architecture exists) - │ │ ├── security_analysis/ # Security analysis [wp__sw_component_security_analysis] - │ │ │ # (only if component architecture exists) - │ │ └── manuals/ # User documentation (of a single component, e.g., user manual of a library component, optional) - │ ├── src/ # Source files, include files, unit tests [wp__verification_sw_unit_test], - │ │ └── / # Lower level component (follows structure) - │ └── tests/ # Component-level tests (e.g., integration or complex unit tests) [wp__verification_comp_int_test] - ├── MODULE.bazel # Bazel module definition - ├── BUILD # Root build rules - ├── project_config.bzl # Project metadata used by Bazel macros - └── README.md # Entry point of the repository - -.. note:: - - The feature-specific subfolder under ``docs/features//`` is only necessary - if more than one feature is implemented in the module. - -Module Folder Structure (Single-Feature Variant) ------------------------------------------------- - -The following variant keeps the same structure but removes the additional -feature-name nesting under ``docs/features/``. In this case, the ``features/`` -subfolder is optional and omitted. This variant is intended for modules that only implement a single feature, to avoid unnecessary nesting. -For identification of the single feature, the repository name or module name should be replicate the feature name. - -.. parsed-literal:: - - / # Root folder of the module, subfolder only if more than one module exists in the repository - ├── .github/ - │ └── workflows/ # CI/CD pipelines - ├── docs/ # Global documentation of the module and the single feature - │ ├── architecture/ # Feature architecture [wp__feature_arch] and of architecture review [wp__sw_arch_verification] - │ ├── safety_analysis/ # Feature safety analysis artifacts ([wp__feature_fmea], [wp__feature_dfa], [wp__requirements_feat_aou]) - │ ├── safety_planning/ # Feature safety planning artifacts - │ ├── security_analysis/ # Feature security analysis artifacts [wp__feature_security_analysis] - │ ├── security_planning/ # Feature security planning artifacts - │ ├── manuals/ # Module manual, integration manual, table of assumptions of use, - │ │ | # safety manual [wp__module_safety_manual], - │ │ | # needs table of [wp__requirements_feat_aou] - │ │ | # security manual [wp__module_security_manual] - │ │ | # Additional optional user centric documentation (e.g. configuration guide, - │ │ | # examples user guide, APIs & usage, performance analysis) - │ │ ├── config/ # Configuration guide (optional) - │ │ ├── examples/ # Examples user guide (optional) - │ │ ├── api_description/ # APIs detail description (optional) - │ │ └── performance/ # Performance analysis (optional) - │ ├── release/ # Module release note [wp__module_sw_release_note] - │ ├── safety_mgt/ # Module safety plan [wp__module_safety_plan], - │ │ # module safety package [wp__module_safety_package], - │ │ # formal document and safety analysis reviews [wp__fdr_reports] - │ ├── security_mgt/ # Module security plan [wp__module_security_plan], - │ │ # module security package [wp__module_security_package], - │ │ # formal document reviews [wp__fdr_reports_security], - │ │ # module SW bill of material [wp__sw_module_sbom] - │ └── verification_report/ # Module verification report, - │ # module verifications [wp__verification_module_ver_report], - ├── examples/ # Usage examples for the module / features - ├── score/ # Components of the module - │ ├── tests/ # Module-level tests (e.g., feature integration tests, system tests) [wp__verification_feat_int_test] - │ └── / # Component folder for each component of the module - │ ├── docs/ # Documentation of the component - │ │ ├── architecture/ # Component architecture [wp__component_arch] - │ │ │ # (only if lower level components exist) - | | | # architecture review [wp__sw_arch_verification], - │ │ ├── detailed_design/ # Detailed design [wp__sw_implementation] - │ │ │ # code inspection [wp__sw_implementation_inspection] - │ │ ├── requirements/ # Component requirements [wp__requirements_comp],[wp__requirements_inspect] - │ │ ├── safety_analysis/ # Safety analysis [wp__sw_component_fmea], [wp__sw_component_dfa], [wp__requirements_comp_aou] - | | | # Component classification [wp__sw_component_class] for pre-existing software - │ │ │ # (only if component architecture exists) - │ │ ├── security_analysis/ # Security analysis [wp__sw_component_security_analysis] - │ │ │ # (only if component architecture exists) - │ │ └── manuals/ # User documentation (of a single component, e.g., user manual of a library component, optional) - │ ├── src/ # Source files, include files, unit tests [wp__verification_sw_unit_test], - │ │ └── / # Lower level component (follows structure) - │ └── tests/ # Component-level tests (e.g., integration or complex unit tests) [wp__verification_comp_int_test] - ├── MODULE.bazel # Bazel module definition - ├── BUILD # Root build rules - ├── project_config.bzl # Project metadata used by Bazel macros - └── README.md # Entry point of the repository - -Module Documentation --------------------- - - -.. code-block:: rst +.. toctree:: + :titlesonly: + :hidden: + :glob: - .. mod:: Module Name - :id: mod__module_name - :includes: comp__component_name_template + template/index +Feature Documentation +--------------------- - .. mod_view_sta:: Module Name Static View - :id: mod_view_sta__feature_name__module_name - :includes: comp__component_name_template +The Feature documentation covers the feature-level definition of Base Libraries, including architecture and safety planning artifacts. - .. needarch:: - :scale: 50 - :align: center +.. toctree:: + :maxdepth: 1 - {{ draw_module(need(), needs) }} + features/index + +Module Documentation +-------------------- +The Module documentation covers the module-level view, including architecture, safety management documents, and the user manual. .. toctree:: :maxdepth: 1 - manuals/index - release/release_note - features/index - safety_mgt/index - security_mgt/index + module/index verification_report/module_verification_report Component Documentation ----------------------- -For documentation of individual components within this module see: +The Components documentation provides detailed documentation for each individual library component, including requirements, architecture, and design decisions: .. toctree:: :maxdepth: 1 @@ -231,6 +79,9 @@ Please note, that is not a template for architecture documentation, but an examp Quick Start - Building and Testing ================================== +.. attention:: + This could also contain just a link to the repository's README + To build the entire module: .. code-block:: bash diff --git a/docs/module/index.rst b/docs/module/index.rst new file mode 100644 index 00000000..7123feca --- /dev/null +++ b/docs/module/index.rst @@ -0,0 +1,51 @@ +.. + # ******************************************************************************* + # Copyright (c) 2026 Contributors to the Eclipse Foundation + # + # See the NOTICE file(s) distributed with this work for additional + # information regarding copyright ownership. + # + # This program and the accompanying materials are made available under the + # terms of the Apache License Version 2.0 which is available at + # https://www.apache.org/licenses/LICENSE-2.0 + # + # SPDX-License-Identifier: Apache-2.0 + # ******************************************************************************* + +Module +====== + + + +.. code-block:: rst + + .. mod:: Module Name + :id: mod__module_name + :includes: comp__component_name_template + +Module View +----------- + +.. code-block:: rst + + .. mod_view_sta:: Module Name Static View + :id: mod_view_sta__feature_name__module_name + :includes: comp__component_name_template + + .. needarch:: + :scale: 50 + :align: center + + {{ draw_module(need(), needs) }} + +Module Documents +---------------- + +.. toctree:: + :maxdepth: 1 + + manuals/index + release/release_note + safety_mgt/index + security_mgt/index diff --git a/docs/manuals/api_description/.gitkeep b/docs/module/manuals/api_description/.gitkeep similarity index 100% rename from docs/manuals/api_description/.gitkeep rename to docs/module/manuals/api_description/.gitkeep diff --git a/docs/manuals/config/.gitkeep b/docs/module/manuals/config/.gitkeep similarity index 100% rename from docs/manuals/config/.gitkeep rename to docs/module/manuals/config/.gitkeep diff --git a/docs/manuals/examples/.gitkeep b/docs/module/manuals/examples/.gitkeep similarity index 100% rename from docs/manuals/examples/.gitkeep rename to docs/module/manuals/examples/.gitkeep diff --git a/docs/manuals/index.rst b/docs/module/manuals/index.rst similarity index 100% rename from docs/manuals/index.rst rename to docs/module/manuals/index.rst diff --git a/docs/manuals/performance/.gitkeep b/docs/module/manuals/performance/.gitkeep similarity index 100% rename from docs/manuals/performance/.gitkeep rename to docs/module/manuals/performance/.gitkeep diff --git a/docs/manuals/safety_manual.rst b/docs/module/manuals/safety_manual.rst similarity index 100% rename from docs/manuals/safety_manual.rst rename to docs/module/manuals/safety_manual.rst diff --git a/docs/manuals/security_manual.rst b/docs/module/manuals/security_manual.rst similarity index 100% rename from docs/manuals/security_manual.rst rename to docs/module/manuals/security_manual.rst diff --git a/docs/manuals/user_manual.rst b/docs/module/manuals/user_manual.rst similarity index 98% rename from docs/manuals/user_manual.rst rename to docs/module/manuals/user_manual.rst index 958cf1fb..a2564fd9 100644 --- a/docs/manuals/user_manual.rst +++ b/docs/module/manuals/user_manual.rst @@ -118,7 +118,7 @@ Integrating with Your Project Version History, Compatibility, and Troubleshooting =================================================== -For comprehensive information on the following topics, refer to :doc:`/release/release_note`: +For comprehensive information on the following topics, refer to :need:`doc__mod_temp_module_name_release_note`: * Version history and changes * Compatibility notes and upgrade instructions diff --git a/docs/release/release_note.rst b/docs/module/release/release_note.rst similarity index 100% rename from docs/release/release_note.rst rename to docs/module/release/release_note.rst diff --git a/docs/safety_mgt/index.rst b/docs/module/safety_mgt/index.rst similarity index 100% rename from docs/safety_mgt/index.rst rename to docs/module/safety_mgt/index.rst diff --git a/docs/safety_mgt/module_safety_analysis_fdr.rst b/docs/module/safety_mgt/module_safety_analysis_fdr.rst similarity index 100% rename from docs/safety_mgt/module_safety_analysis_fdr.rst rename to docs/module/safety_mgt/module_safety_analysis_fdr.rst diff --git a/docs/safety_mgt/module_safety_package_fdr.rst b/docs/module/safety_mgt/module_safety_package_fdr.rst similarity index 100% rename from docs/safety_mgt/module_safety_package_fdr.rst rename to docs/module/safety_mgt/module_safety_package_fdr.rst diff --git a/docs/safety_mgt/module_safety_plan.rst b/docs/module/safety_mgt/module_safety_plan.rst similarity index 100% rename from docs/safety_mgt/module_safety_plan.rst rename to docs/module/safety_mgt/module_safety_plan.rst diff --git a/docs/safety_mgt/module_safety_plan_fdr.rst b/docs/module/safety_mgt/module_safety_plan_fdr.rst similarity index 100% rename from docs/safety_mgt/module_safety_plan_fdr.rst rename to docs/module/safety_mgt/module_safety_plan_fdr.rst diff --git a/docs/security_mgt/index.rst b/docs/module/security_mgt/index.rst similarity index 100% rename from docs/security_mgt/index.rst rename to docs/module/security_mgt/index.rst diff --git a/docs/security_mgt/module_security_package_fdr.rst b/docs/module/security_mgt/module_security_package_fdr.rst similarity index 100% rename from docs/security_mgt/module_security_package_fdr.rst rename to docs/module/security_mgt/module_security_package_fdr.rst diff --git a/docs/security_mgt/module_security_plan.rst b/docs/module/security_mgt/module_security_plan.rst similarity index 100% rename from docs/security_mgt/module_security_plan.rst rename to docs/module/security_mgt/module_security_plan.rst diff --git a/docs/security_mgt/module_security_plan_fdr.rst b/docs/module/security_mgt/module_security_plan_fdr.rst similarity index 100% rename from docs/security_mgt/module_security_plan_fdr.rst rename to docs/module/security_mgt/module_security_plan_fdr.rst diff --git a/docs/template/index.rst b/docs/template/index.rst new file mode 100644 index 00000000..ea870591 --- /dev/null +++ b/docs/template/index.rst @@ -0,0 +1,164 @@ +.. + # ******************************************************************************* + # Copyright (c) 2026 Contributors to the Eclipse Foundation + # + # See the NOTICE file(s) distributed with this work for additional + # information regarding copyright ownership. + # + # This program and the accompanying materials are made available under the + # terms of the Apache License Version 2.0 which is available at + # https://www.apache.org/licenses/LICENSE-2.0 + # + # SPDX-License-Identifier: Apache-2.0 + # ******************************************************************************* + +Template Information +==================== + +This information describes the structure, usage and configuration of the Bazel-based C++/Rust module template according to the `SCORE module folder structure `_ and the `SCORE building blocks concept `_. + + +Overview +-------- + +This repository provides a standardized setup for projects using **C++** or **Rust** and **Bazel** as a build system. +It integrates best practices for build, test, CI/CD and documentation. +It also provides an example for the documentation of an module with all necessary artifacts for safety and security management, verification and release management. +It also provides an example of modeling architecture in Sphinx Needs in :ref:`definition_architectural_design`. +It also provides the component architecture template snippets in :ref:`component_architecture`. +It also provides an example of documenting detailed design in :ref:`detailed_design_example`. + +Module Layout +------------- + +The module template includes the following top-level structure: + +.. parsed-literal:: + + / # Root folder of the module, subfolder only if more than one module exists in the repository + ├── .github/ + │ └── workflows/ # CI/CD pipelines + ├── docs/ # Global documentation of the module + │ ├── features/ # Feature documentation and architecture + │ │ └── / # Feature folder parts for each feature which should be in module documentation + │ │ ├── architecture/ # Feature architecture [wp__feature_arch] and of architecture review [wp__sw_arch_verification] + │ │ ├── safety_analysis/ # Feature safety analysis artifacts ([wp__feature_fmea], [wp__feature_dfa], [wp__requirements_feat_aou]) + │ │ ├── safety_planning/ # Feature safety planning artifacts + │ │ ├── security_analysis/ # Feature security analysis artifacts [wp__feature_security_analysis] + │ │ └── security_planning/ # Feature security planning artifacts + │ ├── manuals/ # Module manual, integration manual, table of assumptions of use + │ │ | # safety manual [wp__module_safety_manual], + │ │ | # needs table of [wp__requirements_feat_aou] + │ │ | # security manual [wp__module_security_manual] + │ │ │ # Additional optional user centric documentation (e.g. configuration guide, + │ │ │ # examples user guide, APIs & usage, performance analysis) + │ │ ├── config/ # Configuration guide (optional) + │ │ ├── examples/ # Examples user guide (optional) + │ │ ├── api_description/ # API detail description (optional) + │ │ └── performance/ # Performance analysis (optional) + │ ├── release/ # Module release note [wp__module_sw_release_note] + │ ├── safety_mgt/ # Module safety plan [wp__module_safety_plan], + │ │ # module safety package [wp__module_safety_package], + │ │ # formal document and safety analysis reviews [wp__fdr_reports] + │ ├── security_mgt/ # Module security plan [wp__module_security_plan], + │ │ # module security package [wp__module_security_package], + │ │ # formal document reviews [wp__fdr_reports_security], + │ │ # module SW bill of material [wp__sw_module_sbom] + │ └── verification_report/ # Module verification report, + │ # module verifications [wp__verification_module_ver_report], + ├── examples/ # Usage examples for the module / features + ├── score/ # Components of the module + │ ├── tests/ # Module-level tests (e.g., feature integration tests, system tests) [wp__verification_feat_int_test] + │ └── / # Component folder for each component of the module + │ ├── docs/ # Documentation of the component + │ │ ├── architecture/ # Component architecture [wp__component_arch] + │ │ │ # (only if lower level components exist) + | | | # architecture review [wp__sw_arch_verification], + │ │ ├── detailed_design/ # Detailed design [wp__sw_implementation] + │ │ │ # code inspection [wp__sw_implementation_inspection] + │ │ ├── requirements/ # Component requirements [wp__requirements_comp],[wp__requirements_inspect] + │ │ ├── safety_analysis/ # Safety analysis [wp__sw_component_fmea], [wp__sw_component_dfa], [wp__requirements_comp_aou] + | | | # Component classification [wp__sw_component_class] for pre-existing software + │ │ │ # (only if component architecture exists) + │ │ ├── security_analysis/ # Security analysis [wp__sw_component_security_analysis] + │ │ │ # (only if component architecture exists) + │ │ └── manuals/ # User documentation (of a single component, e.g., user manual of a library component, optional) + │ ├── src/ # Source files, include files, unit tests [wp__verification_sw_unit_test], + │ │ └── / # Lower level component (follows structure) + │ └── tests/ # Component-level tests (e.g., integration or complex unit tests) [wp__verification_comp_int_test] + ├── MODULE.bazel # Bazel module definition + ├── BUILD # Root build rules + ├── project_config.bzl # Project metadata used by Bazel macros + └── README.md # Entry point of the repository + +.. note:: + + The feature-specific subfolder under ``docs/features//`` is only necessary + if more than one feature is implemented in the module. + +Module Folder Structure (Single-Feature Variant) +------------------------------------------------ + +The following variant keeps the same structure but removes the additional +feature-name nesting under ``docs/features/``. In this case, the ``features/`` +subfolder is optional and omitted. This variant is intended for modules that only implement a single feature, to avoid unnecessary nesting. +For identification of the single feature, the repository name or module name should be replicate the feature name. + +.. parsed-literal:: + + / # Root folder of the module, subfolder only if more than one module exists in the repository + ├── .github/ + │ └── workflows/ # CI/CD pipelines + ├── docs/ # Global documentation of the module and the single feature + │ ├── architecture/ # Feature architecture [wp__feature_arch] and of architecture review [wp__sw_arch_verification] + │ ├── safety_analysis/ # Feature safety analysis artifacts ([wp__feature_fmea], [wp__feature_dfa], [wp__requirements_feat_aou]) + │ ├── safety_planning/ # Feature safety planning artifacts + │ ├── security_analysis/ # Feature security analysis artifacts [wp__feature_security_analysis] + │ ├── security_planning/ # Feature security planning artifacts + │ ├── manuals/ # Module manual, integration manual, table of assumptions of use, + │ │ | # safety manual [wp__module_safety_manual], + │ │ | # needs table of [wp__requirements_feat_aou] + │ │ | # security manual [wp__module_security_manual] + │ │ | # Additional optional user centric documentation (e.g. configuration guide, + │ │ | # examples user guide, APIs & usage, performance analysis) + │ │ ├── config/ # Configuration guide (optional) + │ │ ├── examples/ # Examples user guide (optional) + │ │ ├── api_description/ # APIs detail description (optional) + │ │ └── performance/ # Performance analysis (optional) + │ ├── release/ # Module release note [wp__module_sw_release_note] + │ ├── safety_mgt/ # Module safety plan [wp__module_safety_plan], + │ │ # module safety package [wp__module_safety_package], + │ │ # formal document and safety analysis reviews [wp__fdr_reports] + │ ├── security_mgt/ # Module security plan [wp__module_security_plan], + │ │ # module security package [wp__module_security_package], + │ │ # formal document reviews [wp__fdr_reports_security], + │ │ # module SW bill of material [wp__sw_module_sbom] + │ └── verification_report/ # Module verification report, + │ # module verifications [wp__verification_module_ver_report], + ├── examples/ # Usage examples for the module / features + ├── score/ # Components of the module + │ ├── tests/ # Module-level tests (e.g., feature integration tests, system tests) [wp__verification_feat_int_test] + │ └── / # Component folder for each component of the module + │ ├── docs/ # Documentation of the component + │ │ ├── architecture/ # Component architecture [wp__component_arch] + │ │ │ # (only if lower level components exist) + | | | # architecture review [wp__sw_arch_verification], + │ │ ├── detailed_design/ # Detailed design [wp__sw_implementation] + │ │ │ # code inspection [wp__sw_implementation_inspection] + │ │ ├── requirements/ # Component requirements [wp__requirements_comp],[wp__requirements_inspect] + │ │ ├── safety_analysis/ # Safety analysis [wp__sw_component_fmea], [wp__sw_component_dfa], [wp__requirements_comp_aou] + | | | # Component classification [wp__sw_component_class] for pre-existing software + │ │ │ # (only if component architecture exists) + │ │ ├── security_analysis/ # Security analysis [wp__sw_component_security_analysis] + │ │ │ # (only if component architecture exists) + │ │ └── manuals/ # User documentation (of a single component, e.g., user manual of a library component, optional) + │ ├── src/ # Source files, include files, unit tests [wp__verification_sw_unit_test], + │ │ └── / # Lower level component (follows structure) + │ └── tests/ # Component-level tests (e.g., integration or complex unit tests) [wp__verification_comp_int_test] + ├── MODULE.bazel # Bazel module definition + ├── BUILD # Root build rules + ├── project_config.bzl # Project metadata used by Bazel macros + └── README.md # Entry point of the repository + +.. attention:: + This page is describing the module template and shall be deleted in the module's documentation.