From fbe9ab6b3ec68f5846d395476b5e293e7a5fc6df Mon Sep 17 00:00:00 2001 From: Marina Date: Sun, 18 Feb 2024 17:35:30 +0100 Subject: [PATCH] Updates --- index.html | 363 +++++++++++++++++++++++++++++++---------------------- 1 file changed, 213 insertions(+), 150 deletions(-) diff --git a/index.html b/index.html index 0730509c..08a793bf 100644 --- a/index.html +++ b/index.html @@ -452,6 +452,50 @@

arc42 T
  • 2. Architecture Constraints
    • +
  • 3. System Scope and Context + +
    • +
  • 4. Solution Strategy
    • +
  • 5. Building Block View + +
    • +
  • 6. Runtime View + +
    • +
  • 7. Deployment View + +
    • +
  • 8. Cross-cutting Concepts + +
    • +
  • 9. Architecture Decisions
    • +
  • 10. Quality Requirements + +
    • +
  • 11. Risks and Technical Debts
    • +
  • 12. Glossary
    • @@ -643,9 +687,7 @@

    1.3. Stakeholders

    2. Architecture Constraints

    -
    -
    -
    +

    ===Restricciones técnicas

    @@ -712,11 +754,13 @@

    2. Architecture Constraints

    See Architecture Constraints in the arc42 documentation.

    -
    -

    == System Scope and Context

    -
    +
    +

    3. System Scope and Context

    +
    +
    +
    Contents

    System scope and context - as the name suggests - delimits your system (i.e. your scope) from all its communication partners @@ -747,13 +791,12 @@

    2. Architecture Constraints

    Further Information

    See Context and Scope in the arc42 documentation.

    -
    -
    -
    -

    === Business Context

    -
    +
    +

    3.1. Business Context

    +
    +
    Contents

    Specification of all communication partners (users, IT-systems, …​) with explanations of domain specific inputs and outputs or interfaces. @@ -771,19 +814,19 @@

    2. Architecture Constraints

    Alternatively (or additionally) you can use a table. The title of the table is the name of your system, the three columns contain the name of the communication partner, the inputs, and the outputs.

    -
    -
    +
    +

    <Diagram or Table>

    <optionally: Explanation of external domain interfaces>

    -
    -

    === Technical Context

    -
    -
    +
    +

    3.2. Technical Context

    +
    +
    Contents

    Technical interfaces (channels and transmission media) linking your system to its environment. In addition a mapping of domain specific input/output to the channels, i.e. an explanation which I/O uses which channel.

    @@ -797,8 +840,8 @@

    2. Architecture Constraints

    E.g. UML deployment diagram describing channels to neighboring systems, together with a mapping table showing the relationships between channels and input/output.

    -
    -
    +
    +

    <Diagram or Table>

    @@ -809,11 +852,14 @@

    2. Architecture Constraints

    <Mapping Input/Output to Channels>

    -
    -

    == Solution Strategy

    +
    +

    4. Solution Strategy

    +
    +
    +
    Contents

    A short summary and explanation of the fundamental decisions and solution strategies, that shape system architecture. It includes

    @@ -851,14 +897,16 @@

    2. Architecture Constraints

    Further Information

    See Solution Strategy in the arc42 documentation.

    -
    -
    -
    -
    -

    == Building Block View

    +
    +
    +
    +

    5. Building Block View

    +
    +
    +
    Content

    The building block view shows the static decomposition of the system into building blocks (modules, components, subsystems, classes, interfaces, packages, libraries, frameworks, layers, partitions, tiers, functions, macros, operations, data structures, …​) as well as their dependencies (relationships, associations, …​)

    @@ -900,13 +948,12 @@

    2. Architecture Constraints

    Further Information

    See Building Block View in the arc42 documentation.

    -
    -
    -
    -

    === Whitebox Overall System

    -
    +
    +

    5.1. Whitebox Overall System

    +
    +

    Here you describe the decomposition of the overall system using the following white box template. It contains

    @@ -941,8 +988,8 @@

    2. Architecture Constraints

    -
    -
    +
    +

    <Overview Diagram>

    @@ -962,8 +1009,8 @@

    2. Architecture Constraints

    -
    -
    +
    +

    Insert your explanations of black boxes from level 1:

    @@ -997,13 +1044,12 @@

    2. Architecture Constraints

    If you use a list of black box descriptions then you fill in a separate black box template for every important building block . Its headline is the name of the black box.

    -
    -
    -
    -

    ==== <Name black box 1>

    -
    +
    +

    5.1.1. <Name black box 1>

    +
    +

    Here you describe <black box 1> according the the following black box template:

    @@ -1030,8 +1076,8 @@

    2. Architecture Constraints

    -
    -
    +
    +

    <Purpose/Responsibility>

    @@ -1050,32 +1096,34 @@

    2. Architecture Constraints

    <(optional) Open Issues/Problems/Risks>

    -
    -

    ==== <Name black box 2>

    +
    +

    5.1.2. <Name black box 2>

    <black box template>

    -
    -

    ==== <Name black box n>

    +
    +

    5.1.3. <Name black box n>

    <black box template>

    -
    -

    ==== <Name interface 1>

    +
    +

    5.1.4. <Name interface 1>

    …​

    -
    -

    ==== <Name interface m>

    -
    -
    -

    === Level 2

    +
    +

    5.1.5. <Name interface m>

    +
    +
    +

    5.2. Level 2

    +
    +

    Here you can specify the inner structure of (some) building blocks from level 1 as white boxes.

    @@ -1084,41 +1132,41 @@

    2. Architecture Constraints

    Please prefer relevance over completeness. Specify important, surprising, risky, complex or volatile building blocks. Leave out normal, simple, boring or standardized parts of your system

    -
    -
    -
    -

    ==== White Box <building block 1>

    -
    +
    +

    5.2.1. White Box <building block 1>

    +
    +

    …​describes the internal structure of building block 1.

    -
    -
    +
    +

    <white box template>

    -
    -

    ==== White Box <building block 2>

    +
    +

    5.2.2. White Box <building block 2>

    <white box template>

    …​

    -
    -

    ==== White Box <building block m>

    +
    +

    5.2.3. White Box <building block m>

    <white box template>

    -
    -

    === Level 3

    -
    +
    +

    5.3. Level 3

    +
    +

    Here you can specify the inner structure of (some) building blocks from level 2 as white boxes.

    @@ -1126,39 +1174,42 @@

    2. Architecture Constraints

    When you need more detailed levels of your architecture please copy this part of arc42 for additional levels.

    -
    -
    -
    -

    ==== White Box <_building block x.1_>

    -
    +
    +

    5.3.1. White Box <_building block x.1_>

    +
    +

    Specifies the internal structure of building block x.1.

    -
    -
    +
    +

    <white box template>

    -
    -

    ==== White Box <_building block x.2_>

    +
    +

    5.3.2. White Box <_building block x.2_>

    <white box template>

    -
    -

    ==== White Box <_building block y.1_>

    +
    +

    5.3.3. White Box <_building block y.1_>

    <white box template>

    -
    -

    == Runtime View

    +
    +
    +

    6. Runtime View

    +
    +
    +
    Contents

    The runtime view describes concrete behavior and interactions of the system’s building blocks in form of scenarios from the following areas:

    @@ -1217,11 +1268,10 @@

    2. Architecture Constraints

    Further Information

    See Runtime View in the arc42 documentation.

    -
    -
    -
    -

    === <Runtime Scenario 1>

    +
    +
    +

    6.1. <Runtime Scenario 1>

    • @@ -1241,21 +1291,26 @@

      2. Architecture Constraints

      Sequence diagram
    -
    -

    === <Runtime Scenario 2>

    -
    -

    === …​

    +
    +

    6.2. <Runtime Scenario 2>

    +
    -
    -

    === <Runtime Scenario n>

    +
    +

    6.3. …​

    +
    +
    +

    6.4. <Runtime Scenario n>

    -
    -

    == Deployment View

    +
    +

    7. Deployment View

    +
    +
    +
    Content

    The deployment view describes:

    @@ -1306,13 +1361,12 @@

    2. Architecture Constraints

    Further Information

    See Deployment View in the arc42 documentation.

    -
    -
    -
    -

    === Infrastructure Level 1

    -
    +
    +

    7.1. Infrastructure Level 1

    +
    +

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

    @@ -1335,8 +1389,8 @@

    2. Architecture Constraints

    For multiple environments or alternative deployments please copy and adapt this section of arc42 for all relevant environments.

    -
    -
    +
    +

    <Overview Diagram>

    @@ -1356,46 +1410,49 @@

    2. Architecture Constraints

    -
    -

    === Infrastructure Level 2

    -
    -
    +
    +

    7.2. Infrastructure Level 2

    +
    +

    Here you can include the internal structure of (some) infrastructure elements from level 1.

    Please copy the structure from level 1 for each selected element.

    -
    -
    -
    -

    ==== <Infrastructure Element 1>

    +
    +
    +

    7.2.1. <Infrastructure Element 1>

    <diagram + explanation>

    -
    -

    ==== <Infrastructure Element 2>

    +
    +

    7.2.2. <Infrastructure Element 2>

    <diagram + explanation>

    …​

    -
    -

    ==== <Infrastructure Element n>

    +
    +

    7.2.3. <Infrastructure Element n>

    <diagram + explanation>

    -
    -

    == Cross-cutting Concepts

    +
    +
    +

    8. Cross-cutting Concepts

    +
    +
    +
    Content

    This section describes overall, principal regulations and solution ideas that are relevant in multiple parts (= cross-cutting) of your system. @@ -1491,35 +1548,37 @@

    2. Architecture Constraints

    Further Information

    See Concepts in the arc42 documentation.

    -
    -
    -
    -

    === <Concept 1>

    +
    +
    +

    8.1. <Concept 1>

    <explanation>

    -
    -

    === <Concept 2>

    +
    +

    8.2. <Concept 2>

    <explanation>

    …​

    -
    -

    === <Concept n>

    +
    +

    8.3. <Concept n>

    <explanation>

    -
    -

    == Architecture Decisions

    +
    +

    9. Architecture Decisions

    +
    +
    +
    Contents

    Important, expensive, large scale or risky architecture decisions including rationales. @@ -1560,14 +1619,16 @@

    2. Architecture Constraints

    See Architecture Decisions in the arc42 documentation. There you will find links and examples about ADR.

    -
    -
    -
    -
    -

    == Quality Requirements

    +
    +
    +
    +

    10. Quality Requirements

    +
    +
    +
    Content

    This section contains all quality requirements as quality tree with scenarios. The most important ones have already been described in section 1.2. (quality goals)

    @@ -1586,13 +1647,12 @@

    2. Architecture Constraints

    Further Information

    See Quality Requirements in the arc42 documentation.

    -
    -
    -
    -

    === Quality Tree

    -
    +
    +

    10.1. Quality Tree

    +
    +
    Content

    The quality tree (as defined in ATAM – Architecture Tradeoff Analysis Method) with quality/evaluation scenarios as leafs.

    @@ -1618,13 +1678,13 @@

    2. Architecture Constraints

    In any case the tree should include links to the scenarios of the following section.

    -
    -
    -
    -

    === Quality Scenarios

    +
    +

    10.2. Quality Scenarios

    +
    +
    Contents

    Concretization of (sometimes vague or implicit) quality requirements using (quality) scenarios.

    @@ -1659,14 +1719,17 @@

    2. Architecture Constraints

    Form

    Tabular or free form text.

    -
    -
    +
    +
    -
    -

    == Risks and Technical Debts

    +
    +

    11. Risks and Technical Debts

    +
    +
    +
    Contents

    A list of identified technical risks or technical debts, ordered by priority

    @@ -1686,14 +1749,16 @@

    2. Architecture Constraints

    Further Information

    See Risks and Technical Debt in the arc42 documentation.

    -
    -
    -
    -
    -

    == Glossary

    +
    +
    +
    +

    12. Glossary

    +
    +
    +
    Contents

    The most important domain and technical terms that your stakeholders use when discussing the system.

    @@ -1726,8 +1791,8 @@

    2. Architecture Constraints

    Further Information

    See Glossary in the arc42 documentation.

    -
    -
    +
    +
    @@ -1753,8 +1818,6 @@

    2. Architecture Constraints

    - -