Detailed Design#

[Your Component Name] Detailed Design
status: draft
security: NO
safety: ASIL_B
tags: template, component_name
realizes: wp__sw_implementation
doc__component_name_detailed_design
Generic Document

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 - For the documentation of the decision the Decision Record Template (gd_temp__change_decision_record) can be used.
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#

.. dd_sta:: <Title>
   :id: dd_sta__<Feature>__<Title>
   :security: <YES|NO>
   :safety: <QM|ASIL_B>
   :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#

.. dd_dyn:: <Title>
   :id: dd_dyn__<Feature>__<Title>
   :security: <YES|NO>
   :safety: <QM|ASIL_B>
   :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>