Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -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: <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>
Original file line number Diff line number Diff line change
Expand Up @@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Loading