Skip to content

Commit fc7b1a1

Browse files
add feat and comp into archtecture description
1 parent 3f4ee14 commit fc7b1a1

File tree

2 files changed

+37
-8
lines changed

2 files changed

+37
-8
lines changed

process/process_areas/architecture_design/architecture_concept.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ Static View
123123

124124
The first viewpoint is named as *feature architecture*. It displays the SW modules (= top level SW components) which are required to realize the feature including their interactions. Also the *logical interfaces* and the interaction between the feature and the user are included in this view. On this architectural level the feature requirements shall be allocated. An example for the static architecture is shown here:
125125

126-
.. feat_arc_sta:: Feature 1
126+
.. feat_arc_sta:: Feature 1 Architecture
127127
:id: feat_arc_sta__example_feature__feature_1
128128
:security: YES
129129
:safety: QM

process/process_areas/architecture_design/architecture_getstrt.rst

Lines changed: 36 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,12 @@ Tooling support
4343
Templates
4444
=========
4545

46-
For creating the architectural design, snippets in vs code are available:
46+
For creating the architectural design, snippets in RestructuredText (rst) are available:
4747

48-
* feat_arc_<sta|dyn|int|int_op>_t
49-
* comp_arc_<sta|dyn|int|int_op>_t
48+
* feat
49+
* feat_arc_<sta|dyn>
50+
* comp
51+
* comp_arc_<sta|dyn>
5052

5153
The needs itself which are the basis for the template are defined in the :ref:`Architectural Design <architectural_design>`.
5254

@@ -112,7 +114,15 @@ Feature Architecture
112114

113115
The following section is an example, how an `Feature <https://eclipse-score.github.io/score/main/features/index.html>`_ looks like and how the architecture of an Feature is described. Please note that components with an "ASIL_B" safety rating are highlighted with red borders in the diagram (e.g., "Component 1").
114116

115-
.. feat_arc_sta:: Feature Getting Started
117+
.. feat:: Feature Name
118+
:id: feat__feature_name_example
119+
:security: YES
120+
:safety: ASIL_B
121+
:status: invalid
122+
:includes: logic_arc_int__feature_name__interface_name
123+
:consists_of: comp__component_name
124+
125+
.. feat_arc_sta:: Feature Static Architecture - Getting Started Example
116126
:id: feat_arc_sta__example_feature__archdes_getstrt
117127
:security: YES
118128
:safety: QM
@@ -128,7 +138,15 @@ The following section is an example, how an `Feature <https://eclipse-score.gith
128138

129139
.. code-block:: rst
130140
131-
.. feat_arc_sta:: Feature Getting Started
141+
.. feat:: Feature Name
142+
:id: feat__feature_name
143+
:security: YES
144+
:safety: ASIL_B
145+
:status: invalid
146+
:includes: logic_arc_int__feature_name__interface_name
147+
:consists_of: comp__component_name
148+
149+
.. feat_arc_sta:: Feature Static Architecture View Getting Started
132150
:id: feat_arc_sta__example_feature__archdes_getstrt
133151
:security: YES
134152
:safety: QM
@@ -144,6 +162,10 @@ The following section is an example, how an `Feature <https://eclipse-score.gith
144162
145163
Component Architecture
146164
^^^^^^^^^^^^^^^^^^^^^^
165+
166+
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").
167+
168+
147169
.. comp_arc_sta:: Component 1
148170
:id: comp_arc_sta__example_feature__component_getstrt
149171
:status: valid
@@ -161,7 +183,14 @@ Component Architecture
161183

162184
.. code-block:: rst
163185
164-
.. comp_arc_sta:: Component 1
186+
.. comp:: Component 1
187+
:id: comp__component_name
188+
:security: YES
189+
:safety: ASIL_B
190+
:status: invalid
191+
:implements: logic_arc_int__feature_name__interface_name
192+
193+
.. comp_arc_sta:: Static View - Component 1
165194
:id: comp_arc_sta__example_feature__component_getstrt
166195
:status: valid
167196
:safety: ASIL_B
@@ -225,7 +254,7 @@ To make *needuml* work we have to replace the *need()* call with a different fun
225254
}
226255
CM -> LI1: EXTRA_LINKAGE_MANUALLY_ADDED
227256
228-
.. comp_arc_sta:: Component Get Started Manually Edited
257+
.. comp_arc_sta:: Component Static View - Get Started Manually Edited
229258
:id: comp_arc_sta__example_feature__component_manual_getstrt
230259
:status: valid
231260
:safety: ASIL_B

0 commit comments

Comments
 (0)