Skip to content

Commit

Permalink
update examples for nutshell
Browse files Browse the repository at this point in the history
  • Loading branch information
@Per-Starke
Per-Starke committed Jun 8, 2024
1 parent 81ad685 commit 479ebf1
Show file tree
Hide file tree
Showing 16 changed files with 34 additions and 24 deletions.
3 changes: 2 additions & 1 deletion _examples/01-overview-example-3.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ category: overview
permalink: /examples/overview-example-3/
---

<div class="arc42-example" markdown="1">
<div class="arc42-example">
<br>
After a short introductory text explaining the system under design a table of key project goals is given and an overview of the functionality is shown as use case diagram with accompaning table
</div>

Expand Down
5 changes: 3 additions & 2 deletions _examples/01-overview-example-htmlsc-1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ category: overview
permalink: /examples/overview-example-htmlsc-1/
---

<div class="arc42-example" markdown="1">
The _HTML Sanity Checker_ is an extremely simple and small system.
<div class="arc42-example">
<br>
The <i>HTML Sanity Checker</i> is an extremely simple and small system.
The overview is given as informal diagram with a brief textual explanation.
</div>

Expand Down
3 changes: 2 additions & 1 deletion _examples/01-quality-reqs-example-1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ category: quality-goals
permalink: /examples/quality-requirements-1/
---

<div class="arc42-example" markdown="1">
<div class="arc42-example">
<br>
This example has been created with Enterprise Architect(TM) as a data flow diagram.
</div>

Expand Down
5 changes: 3 additions & 2 deletions _examples/01-quality-reqs-example-3.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ category: quality-goals
permalink: /examples/quality-requirements-3/
---

<div class="arc42-example" markdown="1">
We have used a table with categories and detailed decriptions for the top-3 quality goals. More quality requirements can be found in section 10.
<div class="arc42-example">
<br>
We have used a table with categories and detailed descriptions for the top-3 quality goals. More quality requirements can be found in section 10.
</div>


Expand Down
3 changes: 2 additions & 1 deletion _examples/02-constraint-example-1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ category: constraints
permalink: /examples/constraints-1/
---

<div class="arc42-example" markdown="1">
<div class="arc42-example">
<br>
Key constraints can often be explained as simple enumeration in plain text.
</div>

Expand Down
5 changes: 3 additions & 2 deletions _examples/04-solutionStrategy-example-htmlsc-1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@ permalink: /examples/solution-strategy-htmlsc-1/
---


<div class="arc42-example" markdown="1">
<div class="arc42-example">
<br>
You need a brief summary and explanation of the fundamental solution ideas and strategies.
These key ideas should be familiar to everyone involved in development and architecture.

<br>
Briefly explain how you achieve the most important quality requirements.
</div>

Expand Down
5 changes: 3 additions & 2 deletions _examples/04-solutionStrategy-example-mama-2.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@ category: solutionstrategy
permalink: /examples/solution-strategy-mama-2/
---

<div class="arc42-example" markdown="1">
<div class="arc42-example">
<br>
You need a brief summary and explanation of the fundamental solution ideas and strategies.
These key ideas should be familiar to everyone involved in development and architecture.

<br>
Briefly explain how you achieve the most important quality requirements.
</div>

Expand Down
3 changes: 2 additions & 1 deletion _examples/05-buildingblock-example-hsc.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ permalink: /examples/buildingblock-hsc/
---


<div class="arc42-example" markdown="1">
<div class="arc42-example">
<br>
This example contains several levels of the building block view - ranging from the overview level-1 down to very specific and low-level-3.
</div>

Expand Down
3 changes: 2 additions & 1 deletion _examples/05-buildingblock-example-tpu-lev-1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ permalink: /examples/buildingblock-tpu-1/
---


<div class="arc42-example" markdown="1">
<div class="arc42-example">
<br>
This Level 1 diagram has been created with Enterprise Architect(TM) as a component diagram. It is augmented by a list of black box descriptions for each building block.
</div>

Expand Down
3 changes: 2 additions & 1 deletion _examples/05-buildingblock-example-tpu-lev-2.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ permalink: /examples/buildingblock-tpu-2/
---


<div class="arc42-example" markdown="1">
<div class="arc42-example">
<br>
This diagram (created with Enterprise Architect(TM) as a component model) shows the refinement of the measuring box including the level 2 black box descriptions.
</div>

Expand Down
3 changes: 2 additions & 1 deletion _examples/06-runtime-example-htmlsc-1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ permalink: /examples/runtime-1/
---


<div class="arc42-example" markdown="1">
<div class="arc42-example">
<br>
A simple diagram with a brief textual explanation.
</div>

Expand Down
5 changes: 0 additions & 5 deletions _examples/06-runtime-example-mama-2.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,6 @@ category: runtime
permalink: /examples/runtime-mama-2/
---


<div class="arc42-example" markdown="1">

</div>

## 6. Runtime View

### 6.1 Import File
Expand Down
3 changes: 2 additions & 1 deletion _examples/06-runtime-example-tpu-1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ permalink: /examples/runtime-tpu-1/
---


<div class="arc42-example" markdown="1">
<div class="arc42-example">
<br>
A simple diagram with a brief textual explanation.
</div>

Expand Down
3 changes: 2 additions & 1 deletion _examples/07-deployment-example-tpu-1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ permalink: /examples/deployment-1/
---


<div class="arc42-example" markdown="1">
<div class="arc42-example">
<br>
The example shows an Enterprise Architect (TM) deployment diagram to show the processors used to implement the complete functionality of the Traffic Pursuit Unit. Note the design decisions (i.e. the technology) for the channels connecting the processors.
</div>

Expand Down
3 changes: 2 additions & 1 deletion _examples/07-deployment-sample-tpu-2.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ permalink: /examples/deployment-2/
---


<div class="arc42-example" markdown="1">
<div class="arc42-example">
<br>
The example shows an Enterprise Architect (TM) deployment diagram to show the refinement of one processors.
</div>

Expand Down
3 changes: 2 additions & 1 deletion _examples/12-glossary-example-htmlsc-1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ tags: glossary example
category: glossary
permalink: /examples/glossary-1/
---
<div class="arc42-example" markdown="1">
<div class="arc42-example">
<br>
Here you find an example of a glossary.
</div>

Expand Down

0 comments on commit 479ebf1

Please sign in to comment.