Skip to content

Improvement: update architecture diagrams according to specification #486

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
masc2023 merged 3 commits into from
Jan 8, 2026
Merged

Improvement: update architecture diagrams according to specification #486

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8b9f9bc
update architecture diagrams according to specification
RolandJentschETAS Jan 8, 2026
643a322
fix need ref
RolandJentschETAS Jan 8, 2026
38c3ee5
fix feature view in concept
RolandJentschETAS Jan 8, 2026
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
2 changes: 1 addition & 1 deletion MODULE.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ bazel_dep(name = "buildifier_prebuilt", version = "8.2.0.2")
###############################################################################
bazel_dep(name = "aspect_rules_lint", version = "1.5.3")
bazel_dep(name = "score_tooling", version = "1.0.2")
bazel_dep(name = "score_docs_as_code", version = "2.2.0")
bazel_dep(name = "score_docs_as_code", version = "2.3.0")
10 changes: 5 additions & 5 deletions process/process_areas/architecture_design/architecture_concept.rst
View file
Open in desktop
Copy link
Contributor

@masc2023 masc2023 Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feature 1 Architecture, is that as intended?

Original file line number Diff line number Diff line change
Expand Up @@ -179,9 +179,9 @@ A SW Module represents a outcome of an component or a set of components realizin

On this level also a view shall be defined which is called *Module View*. It represents the allocation of components into modules and displays the dependencies between the single modules. In this view also cyclic dependencies between modules can be identified.

.. mod_view_sta:: Module 3
.. mod_view_sta:: Module 1 Static View
:id: mod_view_sta__example_feature__archdes_3
:includes: comp_arc_sta__example_feature__archdes_component_1
:includes: comp__component_example_1
Copy link
Contributor

@masc2023 masc2023 Jan 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Provided you image of documentation, is that what is intended?


.. needarch::
:scale: 50
Expand All @@ -198,12 +198,12 @@ Static View

The second viewpoint is named as *component architecture* and describes the implementation of the functionalities in a white-box view of the platform. It describes the structural decomposition of the *SW components* into *lower level* SW components. In the projects this viewpoint provides more detailed information concerning the respective interfaces of a component. If a SW component interacts with a different component it is also included via a *use* relationship in the diagram. An example of the *component architecture* is displayed here:

.. comp_arc_sta:: Component 2
:id: comp_arc_sta__example_feature__archdes_component_2
.. comp_arc_sta:: Component 1 Static View
:id: comp_arc_sta__example_feature__archdes_component_concept_1
:status: valid
:safety: ASIL_B
:security: NO
:includes: comp_arc_sta__example_feature__archdes_sub_component_1, comp_arc_sta__example_feature__archdes_sub_component_2, comp_arc_sta__example_feature__archdes_sub_component_3
:includes: comp__archdes_sub_component_1, comp__archdes_sub_component_2, comp__archdes_sub_component_3
:fulfils: comp_req__example_feature__archdes_example_req

.. needarch::
Expand Down
9 changes: 7 additions & 2 deletions process/process_areas/architecture_design/architecture_getstrt.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,14 +165,19 @@ Component Architecture

The following section is an example, how an component looks like and how the detail design of an component is described. Please note that components with an "ASIL_B" safety rating are highlighted with red borders in the diagram (e.g., "Component 1").

.. comp:: Component 1
:id: comp__component_getstrt
:security: NO
:safety: ASIL_B
:status: invalid
:implements: logic_arc_int__example_feature__archdes_logical_interface_1

.. comp_arc_sta:: Component 1
.. comp_arc_sta:: Component 1 Static View
:id: comp_arc_sta__example_feature__component_getstrt
:status: valid
:safety: ASIL_B
:security: NO
:uses: logic_arc_int__example_feature__archdes_logical_interface_3
:implements: logic_arc_int__example_feature__archdes_logical_interface_1
:fulfils: comp_req__example_feature__archdes_example_req

.. needarch::
Expand Down
2 changes: 1 addition & 1 deletion process/process_areas/architecture_design/guidance/architecture_guideline.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ UML diagram selection

Static architecture
-------------------
As can be seen from the examples presented in :need:`feat_arc_sta__example_feature__feature_1` and :need:`comp_arc_sta__example_feature__archdes_component_2`
As can be seen from the examples presented in :need:`feat_arc_sta__example_feature__feature_1` and :need:`comp_arc_sta__example_feature__archdes_component_concept_1`
for the static architecture a UML component diagram is expected (and supported by the tooling).

Dynamic architecture
Expand Down
17 changes: 7 additions & 10 deletions ...ss/process_areas/architecture_design/guidance/architecture_modeling_example.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@ Component Architecure File(s)
:status: invalid
:implements: logic_arc_int__example_feature__archdes_logical_interface_1, logic_arc_int__example_feature__archdes_logical_interface_2
:uses: logic_arc_int__example_feature__archdes_logical_interface_3
:consists_of: comp__archdes_sub_component_1, comp__archdes_sub_component_2, comp__archdes_sub_component_3

Example Component 1 description.

Expand All @@ -182,7 +183,6 @@ Component Architecure File(s)
:uses: logic_arc_int__example_feature__archdes_logical_interface_3
:implements: logic_arc_int__example_feature__archdes_logical_interface_1, logic_arc_int__example_feature__archdes_logical_interface_2
:fulfils: comp_req__example_feature__archdes_example_req
:includes: comp_arc_sta__example_feature__archdes_sub_component_1, comp_arc_sta__example_feature__archdes_sub_component_2, comp_arc_sta__example_feature__archdes_sub_component_3

.. needarch::
:scale: 50
Expand All @@ -206,31 +206,28 @@ Component Architecure File(s)

.. Subcomponents

.. comp_arc_sta:: Lower Level Component 1
:id: comp_arc_sta__example_feature__archdes_sub_component_1
.. comp:: Lower Level Component 1
:id: comp__archdes_sub_component_1
:status: valid
:safety: ASIL_B
:security: NO
:uses: logic_arc_int__example_feature__archdes_logical_interface_3
:implements: logic_arc_int__example_feature__archdes_logical_interface_2
:fulfils: comp_req__example_feature__archdes_example_req

.. comp_arc_sta:: Lower Level Component 2
:id: comp_arc_sta__example_feature__archdes_sub_component_2
.. comp:: Lower Level Component 2
:id: comp__archdes_sub_component_2
:status: valid
:safety: ASIL_B
:security: NO
:uses: logic_arc_int__example_feature__archdes_logical_interface_3
:implements: logic_arc_int__example_feature__archdes_logical_interface_2
:fulfils: comp_req__example_feature__archdes_example_req

.. comp_arc_sta:: Lower Level Component 3
:id: comp_arc_sta__example_feature__archdes_sub_component_3
.. comp:: Lower Level Component 3
:id: comp__archdes_sub_component_3
:status: valid
:safety: QM
:security: NO
:implements: logic_arc_int__example_feature__archdes_logical_interface_3
:fulfils: comp_req__example_feature__archdes_example_req

..
Requirements
Expand Down
4 changes: 2 additions & 2 deletions process/process_areas/implementation/_assets/detailed_design_example.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Static Diagrams for Unit Interactions
:safety: ASIL_B
:status: valid
:implements: comp_req__example_feature__archdes_example_req
:satisfies: comp_arc_sta__example_feature__archdes_sub_component_1
:satisfies: comp_arc_sta__example_feature__archdes_component_1
:includes: sw_unit__example_feature__unit1, sw_unit__example_feature__unit2

.. uml:: dd_example_ex_sta.puml
Expand All @@ -45,7 +45,7 @@ Dynamic Diagrams for Unit Interactions
:safety: ASIL_B
:status: valid
:implements: comp_req__example_feature__archdes_example_req
:satisfies: comp_arc_sta__example_feature__archdes_sub_component_1
:satisfies: comp_arc_sta__example_feature__archdes_component_1

.. uml:: dd_example_ex_dyn.puml

Expand Down
Loading