Skip to content

Improvement: fix architecture drawings and increase docs as code version #504

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 14, 2026
Merged

Improvement: fix architecture drawings and increase docs as code version #504

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
e698736
fix arcitecture drawings and increase docs as code version
RolandJentschETAS Jan 14, 2026
fcd96be
increase module version
RolandJentschETAS Jan 14, 2026
66de05d
add logical inetrface 1 in drawing
RolandJentschETAS Jan 14, 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
4 changes: 2 additions & 2 deletions MODULE.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

module(
name = "score_process",
version = "1.4.1",
version = "1.4.2",
compatibility_level = 1,
)

Expand Down 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.3.0")
bazel_dep(name = "score_docs_as_code", version = "2.3.1")
13 changes: 7 additions & 6 deletions process/process_areas/architecture_design/architecture_concept.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -597,12 +597,12 @@ To make *needuml* work we have to replace the *need()* call with a different fun
:status: valid
:safety: ASIL_B
:security: NO
:uses: real_arc_int__archdes_component_interface_3
:uses: logic_arc_int__example_feature__archex_logical_interface_1
:fulfils: comp_req__example_feature__archex_example_req

.. needuml::

{{ draw_component( needs.__getitem__('comp_arc_sta__example_feature__component_getstrt'), needs ) }}
{{ draw_component( needs.__getitem__('comp__component_example_1'), needs ) }}
component "Component Manual" as CM {
}
CM -> LI1: EXTRA_LINKAGE_MANUALLY_ADDED
Expand All @@ -612,15 +612,16 @@ To make *needuml* work we have to replace the *need()* call with a different fun
:status: valid
:safety: ASIL_B
:security: NO
:uses: logic_arc_int__example_feature__archex_logical_interface_3
:uses: logic_arc_int__example_feature__archex_logical_interface_1
:fulfils: comp_req__example_feature__archex_example_req

.. needuml::
.. needarch::

{{ draw_component( needs.__getitem__('comp__component_example_1'), needs ) }}

{{ draw_component( needs.__getitem__('comp_arc_sta__example_feature__component_getstrt'), needs ) }}
component "Component Manual" as CM {
}
CM -> LI1: EXTRA_LINKAGE_MANUALLY_ADDED
CM -> logic_arc_int__example_feature__archex_logical_interface_1: EXTRA_LINKAGE_MANUALLY_ADDED

You can add any layout or additional configuration you want before you call the *draw_xyz*.

Expand Down
4 changes: 3 additions & 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 @@ -101,7 +101,9 @@ Create feature architecture (Concept)

The feature architecture (= high-level architecture) shall be created in the feature tree of the platform repository.

For this step, the following guidance is available: :need:`Feature Architecture Template <gd_temp__arch_feature>`. Based on this template, the feature architecture shall describe the concept of the feature, including supporting figures and drawings. Additionally, you should consult your project's specific guidelines, e.g., for using the version management tooling or architecture element naming conventions, which should be defined (or linked) in the :need:`Project SW development Plan <wp__sw_development_plan>`.
For this step, the following guidance is available: :need:`Feature Architecture Template <gd_temp__arch_feature>`. Based on this template, the feature architecture shall describe the concept of the feature, including supporting figures and drawings. If multiple solutions are possible, these should be documented here with the rationale for the final decision. A design decision template is provided in :need:`Decision Record Template <gd_temp__change_decision_record>`.

Additionally, you should consult your project's specific guidelines, e.g., for using the version management tooling or architecture element naming conventions, which should be defined (or linked) in the :need:`Project SW development Plan <wp__sw_development_plan>`.

.. _model_feature_architecture:

Expand Down
4 changes: 2 additions & 2 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 @@ -207,7 +207,7 @@ Component Architecure File(s)
:status: valid
:safety: QM
:security: NO
:uses: logic_arc_int__example_feature__archex_logical_interface_2, logic_arc_int__example_feature__archex_logical_interface_3
:uses: logic_arc_int__example_feature__archex_logical_interface_1, logic_arc_int__example_feature__archex_logical_interface_2, logic_arc_int__example_feature__archex_logical_interface_3
:fulfils: comp_req__example_feature__archex_example_req

.. needarch::
Expand All @@ -232,7 +232,7 @@ Component Architecure File(s)
:safety: ASIL_B
:security: NO
:uses: logic_arc_int__example_feature__archex_logical_interface_3
:implements: logic_arc_int__example_feature__archex_logical_interface_2
:implements: logic_arc_int__example_feature__archex_logical_interface_1

.. comp:: Lower Level Component 3
:id: comp__archex_sub_component_3
Expand Down
Loading