Skip to content

Commit aff03f2

Browse files
committed
Fixed images
1 parent 9e5659c commit aff03f2

File tree

2 files changed

+69
-71
lines changed

2 files changed

+69
-71
lines changed

docs/user-guide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The Ng2React Tree View can be used to identify and convert components: ![Tree Vi
1111

1212
## Context Menu: Analyse and Convert Components
1313

14-
The Ng2React Context Menu can be used to analyse and convert components: ![Context Actions](./images/v—scode_guide-context-menu.png)
14+
The Ng2React Context Menu can be used to analyse and convert components: ![Context Actions](./images/vscode_guide_context-menu.png)
1515

1616
## Review Output
1717

structurizr/arc42/arc42.md

+68-70
Original file line numberDiff line numberDiff line change
@@ -56,15 +56,15 @@ A table with quality goals and concrete scenarios, ordered by priorities
5656
Explicit overview of stakeholders of the system, i.e. all person, roles
5757
or organizations that
5858

59-
- should know the architecture
59+
- should know the architecture
6060

61-
- have to be convinced of the architecture
61+
- have to be convinced of the architecture
6262

63-
- have to work with the architecture or with code
63+
- have to work with the architecture or with code
6464

65-
- need the documentation of the architecture for their work
65+
- need the documentation of the architecture for their work
6666

67-
- have to come up with decisions about the system or its development
67+
- have to come up with decisions about the system or its development
6868

6969
**Motivation.**
7070

@@ -127,9 +127,9 @@ completely understand them.
127127

128128
Various options:
129129

130-
- Context diagrams
130+
- Context diagrams
131131

132-
- Lists of communication partners and their interfaces.
132+
- Lists of communication partners and their interfaces.
133133

134134
## Business Context
135135

@@ -192,14 +192,14 @@ and input/output.
192192
A short summary and explanation of the fundamental decisions and
193193
solution strategies, that shape the system’s architecture. These include
194194

195-
- technology decisions
195+
- technology decisions
196196

197-
- decisions about the top-level decomposition of the system, e.g.
197+
- decisions about the top-level decomposition of the system, e.g.
198198
usage of an architectural pattern or design pattern
199199

200-
- decisions on how to achieve key quality goals
200+
- decisions on how to achieve key quality goals
201201

202-
- relevant organizational decisions, e.g. selecting a development
202+
- relevant organizational decisions, e.g. selecting a development
203203
process or delegating certain tasks to third parties.
204204

205205
**Motivation.**
@@ -257,23 +257,23 @@ together with black box descriptions of their internal building blocks.
257257
Here you describe the decomposition of the overall system using the
258258
following white box template. It contains
259259

260-
- an overview diagram
260+
- an overview diagram
261261

262-
- a motivation for the decomposition
262+
- a motivation for the decomposition
263263

264-
- black box descriptions of the contained building blocks. For these
264+
- black box descriptions of the contained building blocks. For these
265265
we offer you alternatives:
266266

267-
- use _one_ table for a short and pragmatic overview of all
267+
- use _one_ table for a short and pragmatic overview of all
268268
contained building blocks and their interfaces
269269

270-
- use a list of black box descriptions of the building blocks
270+
- use a list of black box descriptions of the building blocks
271271
according to the black box template (see below). Depending on
272272
your choice of tool this list could be sub-chapters (in text
273273
files), sub-pages (in a Wiki) or nested elements (in a modeling
274274
tool).
275275

276-
- (optional:) important interfaces, that are not explained in the
276+
- (optional:) important interfaces, that are not explained in the
277277
black box templates of a building block, but are very important for
278278
understanding the white box. Since there are so many ways to specify
279279
interfaces why do not provide a specific template for them. In the
@@ -348,21 +348,21 @@ the name of the black box.
348348
Here you describe <black box 1> according the the following black
349349
box template:
350350

351-
- Purpose/Responsibility
351+
- Purpose/Responsibility
352352

353-
- Interface(s), when they are not extracted as separate paragraphs.
353+
- Interface(s), when they are not extracted as separate paragraphs.
354354
This interfaces may include qualities and performance
355355
characteristics.
356356

357-
- (Optional) Quality-/Performance characteristics of the black box,
357+
- (Optional) Quality-/Performance characteristics of the black box,
358358
e.g.availability, run time behavior, ….
359359

360-
- (Optional) directory/file location
360+
- (Optional) directory/file location
361361

362-
- (Optional) Fulfilled requirements (if you need traceability to
362+
- (Optional) Fulfilled requirements (if you need traceability to
363363
requirements).
364364

365-
- (Optional) Open issues/problems/risks
365+
- (Optional) Open issues/problems/risks
366366

367367
_<Purpose/Responsibility>_
368368

@@ -446,15 +446,15 @@ _<white box template>_
446446
The runtime view describes concrete behavior and interactions of the
447447
system’s building blocks in form of scenarios from the following areas:
448448

449-
- important use cases or features: how do building blocks execute
449+
- important use cases or features: how do building blocks execute
450450
them?
451451

452-
- interactions at critical external interfaces: how do building blocks
452+
- interactions at critical external interfaces: how do building blocks
453453
cooperate with users and neighboring systems?
454454

455-
- operation and administration: launch, start-up, stop
455+
- operation and administration: launch, start-up, stop
456456

457-
- error and exception scenarios
457+
- error and exception scenarios
458458

459459
Remark: The main criterion for the choice of possible scenarios
460460
(sequences, workflows) is their **architectural relevance**. It is
@@ -473,24 +473,24 @@ static models (building block view, deployment view).
473473

474474
There are many notations for describing scenarios, e.g.
475475

476-
- numbered list of steps (in natural language)
476+
- numbered list of steps (in natural language)
477477

478-
- activity diagrams or flow charts
478+
- activity diagrams or flow charts
479479

480-
- sequence diagrams
480+
- sequence diagrams
481481

482-
- BPMN or EPCs (event process chains)
482+
- BPMN or EPCs (event process chains)
483483

484-
- state machines
484+
- state machines
485485

486-
-
486+
-
487487

488488
## <Runtime Scenario 1>
489489

490-
- _<insert runtime diagram or textual description of the
490+
- _<insert runtime diagram or textual description of the
491491
scenario>_
492492

493-
- _<insert description of the notable aspects of the interactions
493+
- _<insert description of the notable aspects of the interactions
494494
between the building block instances depicted in this diagram.>_
495495

496496
## <Runtime Scenario 2>
@@ -505,12 +505,12 @@ There are many notations for describing scenarios, e.g.
505505

506506
The deployment view describes:
507507

508-
1. the technical infrastructure used to execute your system, with
508+
1. the technical infrastructure used to execute your system, with
509509
infrastructure elements like geographical locations, environments,
510510
computers, processors, channels and net topologies as well as other
511511
infrastructure elements and
512512

513-
2. the mapping of (software) building blocks to that infrastructure
513+
2. the mapping of (software) building blocks to that infrastructure
514514
elements.
515515

516516
Often systems are executed in different environments, e.g. development
@@ -538,27 +538,27 @@ section 3.2. as technical context with your own infrastructure as ONE
538538
black box. In this section you will zoom into this black box using
539539
additional deployment diagrams:
540540

541-
- UML offers deployment diagrams to express that view. Use it,
541+
- UML offers deployment diagrams to express that view. Use it,
542542
probably with nested diagrams, when your infrastructure is more
543543
complex.
544544

545-
- When your (hardware) stakeholders prefer other kinds of diagrams
545+
- When your (hardware) stakeholders prefer other kinds of diagrams
546546
rather than the deployment diagram, let them use any kind that is
547547
able to show nodes and channels of the infrastructure.
548548

549549
## Infrastructure Level 1
550550

551551
Describe (usually in a combination of diagrams, tables, and text):
552552

553-
- the distribution of your system to multiple locations, environments,
553+
- the distribution of your system to multiple locations, environments,
554554
computers, processors, .. as well as the physical connections
555555
between them
556556

557-
- important justification or motivation for this deployment structure
557+
- important justification or motivation for this deployment structure
558558

559-
- Quality and/or performance features of the infrastructure
559+
- Quality and/or performance features of the infrastructure
560560

561-
- the mapping of software artifacts to elements of the infrastructure
561+
- the mapping of software artifacts to elements of the infrastructure
562562

563563
For multiple environments or alternative deployments please copy that
564564
section of arc42 for all relevant environments.
@@ -607,15 +607,15 @@ that are relevant in multiple parts (= cross-cutting) of your system.
607607
Such concepts are often related to multiple building blocks. They can
608608
include many different topics, such as
609609

610-
- domain models
610+
- domain models
611611

612-
- architecture patterns or design patterns
612+
- architecture patterns or design patterns
613613

614-
- rules for using specific technology
614+
- rules for using specific technology
615615

616-
- principal, often technical decisions of overall decisions
616+
- principal, often technical decisions of overall decisions
617617

618-
- implementation rules
618+
- implementation rules
619619

620620
**Motivation.**
621621

@@ -631,33 +631,33 @@ provided for a cohesive specification of such concepts.
631631

632632
The form can be varied:
633633

634-
- concept papers with any kind of structure
634+
- concept papers with any kind of structure
635635

636-
- cross-cutting model excerpts or scenarios using notations of the
636+
- cross-cutting model excerpts or scenarios using notations of the
637637
architecture views
638638

639-
- sample implementations, especially for technical concepts
639+
- sample implementations, especially for technical concepts
640640

641-
- reference to typical usage of standard frameworks (e.g. using
641+
- reference to typical usage of standard frameworks (e.g. using
642642
Hibernate for object/relational mapping)
643643

644644
**Structure.**
645645

646646
A potential (but not mandatory) structure for this section could be:
647647

648-
- Domain concepts
648+
- Domain concepts
649649

650-
- User Experience concepts (UX)
650+
- User Experience concepts (UX)
651651

652-
- Safety and security concepts
652+
- Safety and security concepts
653653

654-
- Architecture and design patterns
654+
- Architecture and design patterns
655655

656-
- "Under-the-hood"
656+
- "Under-the-hood"
657657

658-
- development concepts
658+
- development concepts
659659

660-
- operational concepts
660+
- operational concepts
661661

662662
Note: it might be difficult to assign individual concepts to one
663663
specific topic on this list.
@@ -703,11 +703,11 @@ your decisions.
703703

704704
Various options:
705705

706-
- List or table, ordered by importance and consequences or:
706+
- List or table, ordered by importance and consequences or:
707707

708-
- more detailed in form of separate sections per decision
708+
- more detailed in form of separate sections per decision
709709

710-
- ADR (architecture decision record) for every important decision
710+
- ADR (architecture decision record) for every important decision
711711

712712
# Quality Requirements
713713

@@ -743,10 +743,10 @@ large number of quality requirements.
743743
The quality tree is a high-level overview of the quality goals and
744744
requirements:
745745

746-
- tree-like refinement of the term "quality". Use "quality" or
746+
- tree-like refinement of the term "quality". Use "quality" or
747747
"usefulness" as a root
748748

749-
- a mind map with quality categories as main branches
749+
- a mind map with quality categories as main branches
750750

751751
In any case the tree should include links to the scenarios of the
752752
following section.
@@ -763,13 +763,13 @@ the system.
763763

764764
For architects, two kinds of scenarios are important:
765765

766-
- Usage scenarios (also called application scenarios or use case
766+
- Usage scenarios (also called application scenarios or use case
767767
scenarios) describe the system’s runtime reaction to a certain
768768
stimulus. This also includes scenarios that describe the system’s
769769
efficiency or performance. Example: The system reacts to a user’s
770770
request within one second.
771771

772-
- Change scenarios describe a modification of the system or of its
772+
- Change scenarios describe a modification of the system or of its
773773
immediate environment. Example: Additional functionality is
774774
implemented or requirements for a quality attribute change.
775775

@@ -823,9 +823,9 @@ multi-language teams.
823823

824824
You should clearly define your terms, so that all stakeholders
825825

826-
- have an identical understanding of these terms
826+
- have an identical understanding of these terms
827827

828-
- do not use synonyms and homonyms
828+
- do not use synonyms and homonyms
829829

830830
**Form.**
831831

@@ -837,5 +837,3 @@ Potentially more columns in case you need translations.
837837
| ------ | -------------------- |
838838
| Term 1 | <definition-1> |
839839
| Term 2 | <definition-2> |
840-
841-

0 commit comments

Comments
 (0)