diff --git a/index.html b/index.html index 767b7c55..ed3c36d1 100644 --- a/index.html +++ b/index.html @@ -461,6 +461,44 @@

arc42 T
  • 3.2. Technical 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
    • @@ -974,6 +1012,8 @@

    3.1. Business Context

    Figure 1. Business Context Diagram
    + + @@ -1037,8 +1077,6 @@

    3.1. Business Context

    - -

    3.2. Technical Context

    @@ -1049,6 +1087,8 @@

    3.2. Technical Context

    Figure 2. Technical Context Diagram
    + +
    Table 1. WIQ
    @@ -1095,9 +1135,12 @@

    3.2. Technical Context

    Table 2. WIQ
    -
    -

    == Solution Strategy

    + + +
    +

    4. Solution Strategy

    +
    @@ -1177,8 +1220,8 @@

    3.2. Technical Context

    - - +
    +
    Contents

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

    @@ -1216,14 +1259,16 @@

    3.2. Technical Context

    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, …​)

    @@ -1265,13 +1310,12 @@

    3.2. Technical Context

    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

    @@ -1306,8 +1350,8 @@

    3.2. Technical Context

    -
    -
    +
    +

    <Overview Diagram>

    @@ -1327,8 +1371,8 @@

    3.2. Technical Context

    -
    -
    +
    +

    Insert your explanations of black boxes from level 1:

    @@ -1362,13 +1406,12 @@

    3.2. Technical Context

    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:

    @@ -1395,8 +1438,8 @@

    3.2. Technical Context

    -
    -
    +
    +

    <Purpose/Responsibility>

    @@ -1415,32 +1458,34 @@

    3.2. Technical Context

    <(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.

    @@ -1449,41 +1494,41 @@

    3.2. Technical Context

    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.

    @@ -1491,39 +1536,42 @@

    3.2. Technical Context

    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:

    @@ -1582,11 +1630,10 @@

    3.2. Technical Context

    Further Information

    See Runtime View in the arc42 documentation.

    -
    -
    -
    -

    === <Runtime Scenario 1>

    +
    +
    +

    6.1. <Runtime Scenario 1>

    • @@ -1606,21 +1653,26 @@

      3.2. Technical Context

      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:

    @@ -1671,13 +1723,12 @@

    3.2. Technical Context

    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):

    @@ -1700,8 +1751,8 @@

    3.2. Technical Context

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

    -
    -
    +
    +

    <Overview Diagram>

    @@ -1721,46 +1772,49 @@

    3.2. Technical Context

    -
    -

    === 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. @@ -1856,35 +1910,37 @@

    3.2. Technical Context

    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. @@ -1925,14 +1981,16 @@

    3.2. Technical Context

    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)

    @@ -1951,13 +2009,12 @@

    3.2. Technical Context

    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.

    @@ -1983,13 +2040,13 @@

    3.2. Technical Context

    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.

    @@ -2024,14 +2081,17 @@

    3.2. Technical Context

    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

    @@ -2051,14 +2111,16 @@

    3.2. Technical Context

    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.

    @@ -2091,8 +2153,8 @@

    3.2. Technical Context

    Further Information

    See Glossary in the arc42 documentation.

    -
    -
    +
    +
    Table 3. Technology decisions
    @@ -2118,9 +2180,6 @@

    3.2. Technical Context

    - - -