From 0aeec544acd6a4b631effce1fe2dc24c248a6e6f Mon Sep 17 00:00:00 2001 From: aschemmel-git Date: Wed, 4 Jun 2025 09:23:41 +0200 Subject: [PATCH] doc: add detailed design also to folder templates Ref: closes #1106 --- .../docs/detailed_design/index.rst | 78 +++++++++++++++++++ .../module_name/component_name/docs/index.rst | 1 + .../guidance/detailed_design_template.rst | 45 +---------- 3 files changed, 80 insertions(+), 44 deletions(-) create mode 100644 process/folder_templates/modules/module_name/component_name/docs/detailed_design/index.rst diff --git a/process/folder_templates/modules/module_name/component_name/docs/detailed_design/index.rst b/process/folder_templates/modules/module_name/component_name/docs/detailed_design/index.rst new file mode 100644 index 0000000000..464eb22e94 --- /dev/null +++ b/process/folder_templates/modules/module_name/component_name/docs/detailed_design/index.rst @@ -0,0 +1,78 @@ +.. + # ******************************************************************************* + # Copyright (c) 2025 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 + # ******************************************************************************* + +.. _component_detailed_design_template: + +Detailed Design +############### + +.. document:: [Your Component Name] Detailed Design + :id: doc__component_name_detailed_design + :status: draft + :safety: ASIL_D + :realizes: wp__sw_implementation + :tags: template + +.. attention:: + The above directive must be updated according to your Component. + + - Modify ``Your Component Name`` to be your Component Name + - Modify ``id`` to be your Component Name in upper snake case preceded by ``doc__`` and followed by ``_detailed_design`` + - Adjust ``status`` to be ``valid`` + - Adjust ``safety`` and ``tags`` according to your needs + +Detailed Design for Component: +=============================================== + +Description +----------- + +| Design Decisions +| Design Constraints + +Rationale Behind Decomposition into Units +****************************************** +| mandatory: a motivation for the decomposition into one or more units. + +.. note:: Reason for split into multiple units could be- + - Based on design principles like SOLID,DRY etc + - Based on design pattern's etc. + +Static Diagrams for Unit Interactions +------------------------------------- +.. code-block:: rst + + .. dd_sta:: + :id: dd_sta__<Title> + :security: <YES|NO> + :safety: <QM|ASIL_B|ASIL_D> + :status: <valid|invalid> + :implements: <link to component requirement id> + :satisfies: <link to component architecture id> + + .. image:: <link to drawio image> or .. uml:: <link to plantuml> + +Dynamic Diagrams for Unit Interactions +-------------------------------------- +.. code-block:: rst + + .. dd_dyn:: <Title> + :id: dd_dyn__<Title> + :security: <YES|NO> + :safety: <QM|ASIL_B|ASIL_D> + :status: <valid|invalid> + :implements: <link to component requirement id> + :satisfies: <link to component architecture id> + + .. image:: <link to drawio image> or .. uml:: <link to plantuml> diff --git a/process/folder_templates/modules/module_name/component_name/docs/index.rst b/process/folder_templates/modules/module_name/component_name/docs/index.rst index 204a70e452..9740bde356 100644 --- a/process/folder_templates/modules/module_name/component_name/docs/index.rst +++ b/process/folder_templates/modules/module_name/component_name/docs/index.rst @@ -175,6 +175,7 @@ Footnotes requirements/index.rst architecture/index.rst + detailed_design/index.rst safety_analysis/fmea.rst safety_analysis/dfa.rst component_classification.rst diff --git a/process/process_areas/implementation/guidance/detailed_design_template.rst b/process/process_areas/implementation/guidance/detailed_design_template.rst index d07d929a68..9e05b4ffcd 100644 --- a/process/process_areas/implementation/guidance/detailed_design_template.rst +++ b/process/process_areas/implementation/guidance/detailed_design_template.rst @@ -21,47 +21,4 @@ Detailed Design Template :status: valid :complies: std_req__iso26262__software_542, std_req__iso26262__support_641, std_req__iso26262__support_6421, std_req__iso26262__support_6425 -Detailed Design for Component: <Component Name> -=============================================== - -Description ------------ - -| Design Decisions -| Design Constraints - -Rationale Behind Decomposition into Units -****************************************** -| mandatory: a motivation for the decomposition into one or more units. - -.. note:: Reason for split into multiple units could be- - - Based on design principles like SOLID,DRY etc - - Based on design pattern's etc. - -Static Diagrams for Unit Interactions -------------------------------------- -.. code-block:: rst - - .. dd_sta:: <Title> - :id: dd_sta__<Title> - :security: <YES|NO> - :safety: <QM|ASIL_B|ASIL_D> - :status: <valid|invalid> - :implements: <link to component requirement id> - :satisfies: <link to component architecture id> - - .. image:: <link to drawio image> or .. uml:: <link to plantuml> - -Dynamic Diagrams for Unit Interactions --------------------------------------- -.. code-block:: rst - - .. dd_dyn:: <Title> - :id: dd_dyn__<Title> - :security: <YES|NO> - :safety: <QM|ASIL_B|ASIL_D> - :status: <valid|invalid> - :implements: <link to component requirement id> - :satisfies: <link to component architecture id> - - .. image:: <link to drawio image> or .. uml:: <link to plantuml> + For the content see here: :ref:`component_detailed_design_template`