216 lines
4.8 KiB
Markdown
216 lines
4.8 KiB
Markdown
---
|
||
date: July 2025
|
||
title: " Template"
|
||
---
|
||
|
||
#
|
||
|
||
**About arc42**
|
||
|
||
arc42, the template for documentation of software and system
|
||
architecture.
|
||
|
||
Template Version 9.0-EN. (based upon AsciiDoc version), July 2025
|
||
|
||
Created, maintained and © by Dr. Peter Hruschka, Dr. Gernot Starke and
|
||
contributors. See <https://arc42.org>.
|
||
|
||
# Introduction and Goals {#section-introduction-and-goals}
|
||
|
||
## Requirements Overview {#_requirements_overview}
|
||
|
||
## Quality Goals {#_quality_goals}
|
||
|
||
## Stakeholders {#_stakeholders}
|
||
|
||
+-------------+---------------------------+---------------------------+
|
||
| Role/Name | Contact | Expectations |
|
||
+=============+===========================+===========================+
|
||
| * | _\<Contact-1\>_ | _\<Expectation-1\>_ |
|
||
| \<Role-1\>* | | |
|
||
+-------------+---------------------------+---------------------------+
|
||
| * | _\<Contact-2\>_ | _\<Expectation-2\>_ |
|
||
| \<Role-2\>* | | |
|
||
+-------------+---------------------------+---------------------------+
|
||
|
||
# Architecture Constraints {#section-architecture-constraints}
|
||
|
||
# Context and Scope {#section-context-and-scope}
|
||
|
||
## Business Context {#_business_context}
|
||
|
||
**\<Diagram or Table\>**
|
||
|
||
**\<optionally: Explanation of external domain interfaces\>**
|
||
|
||
## Technical Context {#_technical_context}
|
||
|
||
**\<Diagram or Table\>**
|
||
|
||
**\<optionally: Explanation of technical interfaces\>**
|
||
|
||
**\<Mapping Input/Output to Channels\>**
|
||
|
||
# Solution Strategy {#section-solution-strategy}
|
||
|
||
# Building Block View {#section-building-block-view}
|
||
|
||
## Whitebox Overall System {#_whitebox_overall_system}
|
||
|
||
_**\<Overview Diagram\>**_
|
||
|
||
Motivation
|
||
|
||
: _\<text explanation\>_
|
||
|
||
Contained Building Blocks
|
||
|
||
: _\<Description of contained building block (black boxes)\>_
|
||
|
||
Important Interfaces
|
||
|
||
: _\<Description of important interfaces\>_
|
||
|
||
### \<Name black box 1\> {#_name_black_box_1}
|
||
|
||
_\<Purpose/Responsibility\>_
|
||
|
||
_\<Interface(s)\>_
|
||
|
||
_\<(Optional) Quality/Performance Characteristics\>_
|
||
|
||
_\<(Optional) Directory/File Location\>_
|
||
|
||
_\<(Optional) Fulfilled Requirements\>_
|
||
|
||
_\<(optional) Open Issues/Problems/Risks\>_
|
||
|
||
### \<Name black box 2\> {#_name_black_box_2}
|
||
|
||
_\<black box template\>_
|
||
|
||
### \<Name black box n\> {#_name_black_box_n}
|
||
|
||
_\<black box template\>_
|
||
|
||
### \<Name interface 1\> {#_name_interface_1}
|
||
|
||
...
|
||
|
||
### \<Name interface m\> {#_name_interface_m}
|
||
|
||
## Level 2 {#_level_2}
|
||
|
||
### White Box _\<building block 1\>_ {#_white_box_building_block_1}
|
||
|
||
_\<white box template\>_
|
||
|
||
### White Box _\<building block 2\>_ {#_white_box_building_block_2}
|
||
|
||
_\<white box template\>_
|
||
|
||
...
|
||
|
||
### White Box _\<building block m\>_ {#_white_box_building_block_m}
|
||
|
||
_\<white box template\>_
|
||
|
||
## Level 3 {#_level_3}
|
||
|
||
### White Box \<\_building block x.1\_\> {#_white_box_building_block_x_1}
|
||
|
||
_\<white box template\>_
|
||
|
||
### White Box \<\_building block x.2\_\> {#_white_box_building_block_x_2}
|
||
|
||
_\<white box template\>_
|
||
|
||
### White Box \<\_building block y.1\_\> {#_white_box_building_block_y_1}
|
||
|
||
_\<white box template\>_
|
||
|
||
# Runtime View {#section-runtime-view}
|
||
|
||
## \<Runtime Scenario 1\> {#_runtime_scenario_1}
|
||
|
||
- _\<insert runtime diagram or textual description of the scenario\>_
|
||
|
||
- _\<insert description of the notable aspects of the interactions
|
||
between the building block instances depicted in this diagram.\>_
|
||
|
||
## \<Runtime Scenario 2\> {#_runtime_scenario_2}
|
||
|
||
## ...
|
||
|
||
## \<Runtime Scenario n\> {#_runtime_scenario_n}
|
||
|
||
# Deployment View {#section-deployment-view}
|
||
|
||
## Infrastructure Level 1 {#_infrastructure_level_1}
|
||
|
||
_**\<Overview Diagram\>**_
|
||
|
||
Motivation
|
||
|
||
: _\<explanation in text form\>_
|
||
|
||
Quality and/or Performance Features
|
||
|
||
: _\<explanation in text form\>_
|
||
|
||
Mapping of Building Blocks to Infrastructure
|
||
|
||
: _\<description of the mapping\>_
|
||
|
||
## Infrastructure Level 2 {#_infrastructure_level_2}
|
||
|
||
### _\<Infrastructure Element 1\>_ {#_infrastructure_element_1}
|
||
|
||
_\<diagram + explanation\>_
|
||
|
||
### _\<Infrastructure Element 2\>_ {#_infrastructure_element_2}
|
||
|
||
_\<diagram + explanation\>_
|
||
|
||
...
|
||
|
||
### _\<Infrastructure Element n\>_ {#_infrastructure_element_n}
|
||
|
||
_\<diagram + explanation\>_
|
||
|
||
# Cross-cutting Concepts {#section-concepts}
|
||
|
||
## _\<Concept 1\>_ {#_concept_1}
|
||
|
||
_\<explanation\>_
|
||
|
||
## _\<Concept 2\>_ {#_concept_2}
|
||
|
||
_\<explanation\>_
|
||
|
||
...
|
||
|
||
## _\<Concept n\>_ {#_concept_n}
|
||
|
||
_\<explanation\>_
|
||
|
||
# Architecture Decisions {#section-design-decisions}
|
||
|
||
# Quality Requirements {#section-quality-scenarios}
|
||
|
||
## Quality Requirements Overview {#_quality_requirements_overview}
|
||
|
||
## Quality Scenarios {#_quality_scenarios}
|
||
|
||
# Risks and Technical Debts {#section-technical-risks}
|
||
|
||
# Glossary {#section-glossary}
|
||
|
||
+----------------------+-----------------------------------------------+
|
||
| Term | Definition |
|
||
+======================+===============================================+
|
||
| _\<Term-1\>_ | _\<definition-1\>_ |
|
||
+----------------------+-----------------------------------------------+
|
||
| _\<Term-2\>_ | _\<definition-2\>_ |
|
||
+----------------------+-----------------------------------------------+
|