1

added folder for documentation

This commit is contained in:
AndiBuls
2020-03-03 15:30:51 +01:00
parent 1bbb2f5de0
commit c73c84ec6d
13 changed files with 295 additions and 0 deletions

View File

@ -0,0 +1,56 @@
// numbering from here on
:numbered:
<<<
// 1. Anforderungen und Ziele
include::src/01_introduction_and_goals.adoc[]
<<<
// 2. Randbedingungen
include::src/02_architecture_constraints.adoc[]
<<<
// 3. Kontextabgrenzung
include::src/03_system_scope_and_context.adoc[]
<<<
// 4. Lösungsstrategie
include::src/04_solution_strategy.adoc[]
<<<
// 5. Bausteinsicht
include::src/05_building_block_view.adoc[]
<<<
// 6. Laufzeitsicht
include::src/06_runtime_view.adoc[]
<<<
// 7. Verteilungssicht
include::src/07_deployment_view.adoc[]
<<<
// 8. Querschnittliche Konzepte
include::src/08_concepts.adoc[]
<<<
// 9. Entscheidungen
include::src/09_design_decisions.adoc[]
<<<
// 10. Qualität...
include::src/10_quality_scenarios.adoc[]
<<<
// 11. Risiken
include::src/11_technical_risks.adoc[]
<<<
// 12. Glossar
include::src/12_glossary.adoc[]
'''
(C)
We acknowledge that this document uses material from the arc42 architecture template, http://www.arc42.de.
Created by Dr. Peter Hruschka & Dr. Gernot Starke.

View File

@ -0,0 +1,15 @@
[[section-introduction-and-goals]]
== Einführung und Ziele
=== Aufgabenstellung
=== Qualitätsziele
=== Stakeholder
[cols="1,1,2" options="header"]
|===
|Rolle |Kontakt |Erwartungshaltung
| _<Rolle-1>_ | _<Kontakt-1>_ | _<Erwartung-1>_
| _<Rolle-2>_ | _<Kontakt-2>_ | _<Erwartung-2>_
|===

View File

@ -0,0 +1,4 @@
[[section-architecture-constraints]]
== Randbedingungen

View File

@ -0,0 +1,22 @@
[[section-system-scope-and-context]]
== Kontextabgrenzung
=== Fachlicher Kontext
**<Diagramm und/oder Tabelle>**
**<optional: Erläuterung der externen fachlichen Schnittstellen>**
=== Technischer Kontext
**<Diagramm oder Tabelle>**
**<optional: Erläuterung der externen technischen Schnittstellen>**
**<Mapping fachliche auf technische Schnittstellen>**

View File

@ -0,0 +1,4 @@
[[section-solution-strategy]]
== Lösungsstrategie

View File

@ -0,0 +1,87 @@
[[section-building-block-view]]
== Bausteinsicht
=== Whitebox Gesamtsystem
_**<Übersichtsdiagramm>**_
Begründung:: _<Erläuternder Text>_
Enthaltene Bausteine:: _<Beschreibung der enthaltenen Bausteine (Blackboxen)>_
Wichtige Schnittstellen:: _<Beschreibung wichtiger Schnittstellen>_
==== <Name Blackbox 1>
_<Zweck/Verantwortung>_
_<Schnittstelle(n)>_
_<(Optional) Qualitäts-/Leistungsmerkmale>_
_<(Optional) Ablageort/Datei(en)>_
_<(Optional) Erfüllte Anforderungen>_
_<(optional) Offene Punkte/Probleme/Risiken>_
==== <Name Blackbox 2>
_<Blackbox-Template>_
==== <Name Blackbox n>
_<Blackbox-Template>_
==== <Name Schnittstelle 1>
...
==== <Name Schnittstelle m>
=== Ebene 2
==== Whitebox _<Baustein 1>_
_<Whitebox-Template>_
==== Whitebox _<Baustein 2>_
_<Whitebox-Template>_
...
==== Whitebox _<Baustein m>_
_<Whitebox-Template>_
=== Ebene 3
==== Whitebox <_Baustein x.1_>
_<Whitebox-Template>_
==== Whitebox <_Baustein x.2_>
_<Whitebox-Template>_
==== Whitebox <_Baustein y.1_>
_<Whitebox-Template>_

View File

@ -0,0 +1,17 @@
[[section-runtime-view]]
== Laufzeitsicht
=== _<Bezeichnung Laufzeitszenario 1>_
* <hier Laufzeitdiagramm oder Ablaufbeschreibung einfügen>
* <hier Besonderheiten bei dem Zusammenspiel der Bausteine in diesem Szenario erläutern>
=== _<Bezeichnung Laufzeitszenario 2>_
...
=== _<Bezeichnung Laufzeitszenario n>_
...

View File

@ -0,0 +1,34 @@
[[section-deployment-view]]
== Verteilungssicht
=== Infrastruktur Ebene 1
_**<Übersichtsdiagramm>**_
Begründung:: _<Erläuternder Text>_
Qualitäts- und/oder Leistungsmerkmale:: _<Erläuternder Text>_
Zuordnung von Bausteinen zu Infrastruktur:: _<Beschreibung der Zuordnung>_
=== Infrastruktur Ebene 2
==== _<Infrastrukturelement 1>_
_<Diagramm + Erläuterungen>_
==== _<Infrastrukturelement 2>_
_<Diagramm + Erläuterungen>_
...
==== _<Infrastrukturelement n>_
_<Diagramm + Erläuterungen>_

View File

@ -0,0 +1,18 @@
[[section-concepts]]
== Querschnittliche Konzepte
=== _<Konzept 1>_
_<Erklärung>_
=== _<Konzept 2>_
_<Erklärung>_
...
=== _<Konzept n>_
_<Erklärung>_

View File

@ -0,0 +1,4 @@
[[section-design-decisions]]
== Entwurfsentscheidungen

View File

@ -0,0 +1,12 @@
[[section-quality-scenarios]]
== Qualitätsanforderungen
=== Qualitätsbaum
=== Qualitätsszenarien

View File

@ -0,0 +1,5 @@
[[section-technical-risks]]
== Risiken und technische Schulden

View File

@ -0,0 +1,17 @@
[[section-glossary]]
== Glossar
[cols="1,2" options="header"]
|===
|Begriff
|Definition
|_<Begriff-1>_
|_<Definition-1>_
|_<Begriff-2_
|_<Definition-2>_
|===