Detailed Design Template#
Detailed Design Templates
|
status: valid
|
||||
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#
.. 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#
.. 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>