Getting Started#

Architecture Design Process		status: valid
status: valid tags: architecture_design relates to: wf__cr_mt_featarch, wf__cr_mt_comparch, wf__mr_vy_arch

doc_getstrt__arch__process		Getting Startet

As described in the Architecture Design Concept currently two views are defined. The getting started provides an overview which steps need to be done to create the feature architecture and the component architecture.

For the detailed description both an Architectural Design and an Architecture Process are available.

General Workflow#

../../../_images/architecture_workflow.drawio.svg — Fig. 16 Architecture Design Workflow#

Fig. 16 shows all steps which are required to create an architectural design. In this getting started only a short overview is given. A more detailed description of all the step is provided in the guideline (gd_guidl__arch__design)

Tooling support#

Templates#

For creating the architectural design, snippets in vs code are available:

feat_arc_<sta|dyn|int|int_op>_t
comp_arc_<sta|dyn|int|int_op>_t

The needs itself which are the basis for the template are defined in the Architectural Design.

Architecture Generation for Sphinx-Needs#

Overview#

The system provides utilities to generate UML diagrams from requirement specifications. It supports various architectural elements types including:

Features
Logical Interfaces
Components
Component Interfaces

as well as the linkage between them.

Usage#

To generate a UML diagram, use the needarch directive in your Sphinx-Needs documentation:

.. needarch::
   :scale: 50
   :align: center

   {{ draw_feature(need(), needs) }}

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

It’s also possible to manually extend the drawing. For an example, check out Manual Addition to the UML

Available Drawing Classes#

# Draw Feature
# Generates a UML representation of a feature and its included components/interfaces.

{{ draw_feature(need(), needs) }}

# Draw Logical Interface
# Renders a logical interface and its operations.

{{ draw_logical_interface(need(), needs) }}

# Draw Component
# Creates a complete component diagram including internal structure and linkages.

{{ draw_component(need(), needs) }}

# Draw Component Interface
# Generates a component interface diagram with its operations and implementations.

{{ draw_component_interface(need(), needs)}}

Note

Note: The above syntax is for the needarch directive. It is also possible to use the needuml directive. To achieve this the need() call needs to be replaced with the following, as needuml does not support need()

# need() => needs.__getitem__('ID OF THE REQUIREMENT YOU ARE IN')

# For example, drawing the requirement:
`COMP_ARC_STA__component_manual_1`

 would then look as such
{{ draw_component( needs.__getitem__('COMP_ARC_STA__component_manual_1'), needs ) }}

Rendered Examples#

Here are some excerpts of UML diagrams made from the requirements of that file.

Component

.. comp_arc_sta:: Component 1
   :id: comp_arc_sta__component_getstrt
   :status: valid
   :safety: ASIL_B
   :security: NO
   :uses: comp_arc_int__archdes_component_interface_3
   :implements: comp_arc_int__archdes_component_interface_1
   :fulfils: comp_req__archdes_example_req

   .. needarch::
      :scale: 50
      :align: center

      allowmixing
      {{ draw_component( need(), needs ) }}

Component 1		status: valid security: NO safety: ASIL_B
status: valid tags: architecture_design safety: ASIL_B security: NO fulfils: comp_req__archdes_example_req implements: comp_arc_int__archdes_component_interface_1 uses: comp_arc_int__archdes_component_interface_3

comp_arc_sta__component_getstrt		Component Architecture Static View

Manual Addition to the UML#

We use a similar rst as above, just this time we use needuml and add some extra manual UML at the end. To make needuml work we have to replace the need() call with a different function call.

.. comp_arc_sta:: Component Get Started Manually Edited
   :id: comp_arc_sta__component_manual_getstrt
   :status: valid
   :safety: ASIL_B
   :security: NO
   :uses: comp_arc_int__archdes_component_interface_3
   :implements: comp_arc_int__archdes_component_interface_1
   :fulfils: comp_req__archdes_example_req

   .. needuml::

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

Component Get Started Manually Edited		status: valid security: NO safety: ASIL_B
status: valid tags: architecture_design safety: ASIL_B security: NO fulfils: comp_req__archdes_example_req implements: comp_arc_int__archdes_component_interface_1 uses: comp_arc_int__archdes_component_interface_3

comp_arc_sta__component_manual_getstrt		Component Architecture Static View

Limitations#

Grouping functionality needs improvement
Manual extendability is limited to the same type as the underlying drawing, either class or association diagram types
Currently only uses the need attributes includes, uses, implements