1.2 Architekturziele

Werbung
Architekturdokumentation
<Ihr System>
erstellt von
<Ihr Name>
Template Revision: 4.0 DE
Juni 2009
We acknowledge that this document uses material from the arc 42 architecture
template, http://www.arc42.de. Created by Dr. Peter Hruschka & Dr. Gernot
Starke.
Seite 2 von 15
Änderungsübersicht
Version
Datum
Bearbeiter
Basisdokumente
Dokument
Beschreibung
Beschreibung
Seite 3 von 15
Inhaltsverzeichnis
1.
2.
3.
4.
5.
6.
7.
8.
Einführung und Ziele....................................................................................................... 5
1.1
Aufgabenstellung ...................................................................................................... 5
1.2
Architekturziele ......................................................................................................... 5
1.3
Stakeholder ............................................................................................................... 5
Randbedingungen .......................................................................................................... 5
2.1
Technische Randbedingungen .................................................................................. 5
2.2
Organisatorische Randbedingungen ......................................................................... 5
2.3
Konventionen ............................................................................................................ 6
Kontextabgrenzung ........................................................................................................ 6
3.1
Fachlicher Kontext .................................................................................................... 6
3.2
Technischer- oder Verteilungskontext ....................................................................... 6
Bausteinsicht .................................................................................................................. 6
4.1
Ebene 1 .................................................................................................................... 6
4.2
Ebene 2 .................................................................................................................... 7
4.3
Ebene 3 .................................................................................................................. 10
Laufzeitsicht ................................................................................................................. 10
5.1
Laufzeitszenario 1 ................................................................................................... 10
5.2
Laufzeitszenario 2 ................................................................................................... 10
5.3
................................................................................................................................ 11
5.4
Laufzeitszenario n ................................................................................................... 11
Verteilungssicht ............................................................................................................ 11
6.1
Infrastruktur Ebene 1 ............................................................................................... 11
6.2
Infrastruktur Ebene 2 ............................................................................................... 12
Typische Muster, Strukturen und Abläufe ..................................................................... 12
7.1
Typische Muster und Strukturen.............................................................................. 12
7.2
Typische Abläufe..................................................................................................... 12
Übergreifende Architekturaspekte und technische Konzepte ........................................ 12
8.1
Persistenz ............................................................................................................... 12
8.2
Benutzungsoberfläche ............................................................................................ 12
8.3
Ergonomie............................................................................................................... 12
8.4
Ablaufsteuerung ...................................................................................................... 12
8.5
Transaktionsbehandlung ......................................................................................... 12
8.6
Sessionbehandlung................................................................................................. 13
8.7
Sicherheit ................................................................................................................ 13
8.8
Kommunikation und Integration mit anderen IT-Systemen ...................................... 13
Seite 4 von 15
8.9
Verteilung ................................................................................................................ 13
8.10
Ausnahme-/Fehlerbehandlung .............................................................................. 13
8.11
Management des Systems & Administrierbarkeit .................................................. 13
8.12
Logging, Protokollierung, Tracing .......................................................................... 13
8.13
Geschäftsregeln .................................................................................................... 13
8.14
Konfigurierbarkeit .................................................................................................. 13
8.15
Parallelisierung und Threading .............................................................................. 13
8.16
Internationalisierung .............................................................................................. 13
8.17
Migration ............................................................................................................... 13
8.18
Testbarkeit ............................................................................................................ 13
8.19
Plausibilisierung und Validierung ........................................................................... 14
8.20
Codegenerierung .................................................................................................. 14
8.21
Build-Management ................................................................................................ 14
9.
Entwurfsentscheidungen .............................................................................................. 14
10.
Szenarien zur Architekturbewertung ........................................................................... 14
10.1
Bewertungsszenario 1 ........................................................................................... 14
10.2
Bewertungsszenario ... .......................................................................................... 14
11.
Projektaspekte ............................................................................................................ 14
11.1
Change Request ................................................................................................... 14
11.2
Technische Risiken ............................................................................................... 14
11.3
Offene Punkte ....................................................................................................... 14
11.4
Erwartete Änderungen .......................................................................................... 14
11.5
Migration ............................................................................................................... 14
11.6
Auswirkungen ....................................................................................................... 15
12.
Glossar ....................................................................................................................... 15
Anmerkung: In der Microsoft-Word-Variante enthält dieses Template Anleitungen und
Ausfüllhinweise als „ausgeblendeten Text“. Durch den Befehl „Formate ein-/ausblenden“
können Sie die Anzeige dieser Texte bestimmen.
Seite 5 von 15
1. Einführung und Ziele
1.1 Aufgabenstellung
1.2 Architekturziele
Wir haben oft genug Projekt ohne definierte Qualitätsziele durchlitten. Wir leiden
nicht gerne, daher sind wir inzwischen ziemlich überzeugt, dass sich diese paar
Stunden lohnen. Sollte es in Ihrem Projekt Wochen oder Monate dauern, dann
denken Sie besser rechtzeitig über berufliche Veränderungen nach :-)
PH & GS.
1.3 Stakeholder
2. Randbedingungen
2.1 Technische Randbedingungen
Hardware-Vorgaben
<hier Randbedingungen einfügen>
<hier Randbedingungen einfügen>
Software-Vorgaben
<hier Radbedingungen einfügen>
Vorgaben des Systembetriebs
<hier Randbedingungen einfügen>
Programmiervorgaben
<hier Randbedingungen einfügen>
2.2 Organisatorische Randbedingungen
Seite 6 von 15
Organisation und Struktur
<hier Randbedingungen einfügen>
Ressourcen (Budget, Zeit, Personal)
<hier Randbedingungen einfügen>
Organisatorische Standards
<hier Randbedingungen einfügen>
Juristische Faktoren
<hier Randbedingungen einfügen>
2.3 Konventionen
3. Kontextabgrenzung
Die folgenden Unterkapitel zeigen die Einbettung unseres Systems in seine Umgebung.
3.1 Fachlicher Kontext
3.2 Technischer- oder Verteilungskontext
4. Bausteinsicht
4.1 Ebene 1
Die folgende Abbildung zeigt die Hauptbausteine unseres Systems und deren Abhängigkeiten.
<hier Überblicksdiagramm einfügen>
Erläuterung zu Struktur und Abhängigkeiten der Ebene 1:
Zwar sind wir an vielen Stellen zu Pragmatismus bereit – hier jedoch bestehen wir auf der
vollständigen Auflistung aller (a-l-l-e-r) Nachbarsysteme. Zu viele Projekte sind daran gescheitert,
dass sie ihre Nachbarn nicht kannten 
1
Seite 7 von 15
4.1.1 Bausteinname 1 (BlackBox-Beschreibung)
<Black Box Template des Bausteins hier einfügen>
4.1.2 Bausteinname 2 (Black Box-Beschreibung)
<Black Box Template des Bausteins hier einfügen>
4.1.3 ...
<Black Box Template des Bausteins hier einfügen>
4.1.4 Bausteinname n (Black Box-Beschreibung)
<Black Box Template des Bausteins hier einfügen>
4.1.5 Offene Punkte
4.2 Ebene 2
4.2.1 Bausteinname 1 (Whitebox-Beschreibung)
< Hier Überblicksdiagramm für Innenleben von Baustein 1 einfügen>
Bausteinname 1.1 (BlackBox Beschreibung)
Struktur gemäß Black-Box- Template:

Zweck / Verantwortlichkeit:

Schnittstelle(n):

Erfüllte Anforderungen:

Variabilität:

Leistungsmerkmale:

Ablageort / Datei:

Sonstige Verwaltungsinformation:

Offene Punkte:
Bausteinname 1.2 (Black Box Beschreibung)
Struktur gemäß Black-Box- Template:

Zweck / Verantwortlichkeit:

Schnittstelle(n):

Erfüllte Anforderungen:

Variabilität:
Seite 8 von 15

Leistungsmerkmale:

Ablageort / Datei:

Sonstige Verwaltungsinformation:

Offene Punkte:
...
Bausteinname 1.n (Black Box Beschreibung)
Struktur gemäß Black-Box- Template:

Zweck / Verantwortlichkeit:

Schnittstelle(n):

Erfüllte Anforderungen:

Variabilität:

Leistungsmerkmale:

Ablageort / Datei:

Sonstige Verwaltungsinformation:

Offene Punkte:
Beschreibung der Beziehungen
Offene Punke
4.2.2 Bausteinname 2 (Whitebox-Beschreibung)
Überblicksdiagramm 2 Ebene 2

zeigt das Innenleben des Bausteines in Diagrammform mit den lokalen Bausteinen 1 - n, sowie
deren Zusammenhänge und Abhängigkeiten.

beschreibt wichtige Begründungen, die zu dieser Struktur führen

verweist evtl. auf verworfene Alternativen (mit der Begründung, warum es verworfen wurde
Bausteinname 2.1 (BlackBox Beschreibung)
Struktur gemäß Black-Box- Template:

Zweck / Verantwortlichkeit:

Schnittstelle(n):

Erfüllte Anforderungen:

Variabilität:

Leistungsmerkmale:

Ablageort / Datei:

Sonstige Verwaltungsinformation:

Offene Punkte:
Bausteinname 2.2 (Black Box Beschreibung)
Struktur gemäß Black-Box- Template:

Zweck / Verantwortlichkeit:
Seite 9 von 15

Schnittstelle(n):

Erfüllte Anforderungen:

Variabilität:

Leistungsmerkmale:

Ablageort / Datei:

Sonstige Verwaltungsinformation:

Offene Punkte:
...
Bausteinname 2.n (Black Box Beschreibung)
Struktur gemäß Black-Box- Template:

Zweck / Verantwortlichkeit:

Schnittstelle(n):

Erfüllte Anforderungen:

Variabilität:

Leistungsmerkmale:

Ablageort / Datei:

Sonstige Verwaltungsinformation:

Offene Punkte:
Beschreibung der Beziehungen
Offene Punkte
4.2.3 Bausteinename 3 (Whitebox-Beschreibung)
Überblicksdiagramm 3 Ebene 2

zeigt das Innenleben des Bausteines in Diagrammform mit den lokalen Bausteinen 1 - n, sowie
deren Zusammenhänge und Abhängigkeiten.

beschreibt wichtige Begründungen, die zu dieser Struktur führen

verweist evtl. auf verworfene Alternativen (mit der Begründung, warum es verworfen wurde
Bausteinname 3.1 (BlackBox Beschreibung)
Struktur gemäß Black-Box- Template:

Zweck / Verantwortlichkeit:

Schnittstelle(n):

Erfüllte Anforderungen:

Variabilität:

Leistungsmerkmale:

Ablageort / Datei:

Sonstige Verwaltungsinformation:

Offene Punkte:
Seite 10 von 15
Bausteinname 3.2 (Black Box Beschreibung)
Struktur gemäß Black-Box- Template:

Zweck / Verantwortlichkeit:

Schnittstelle(n):

Erfüllte Anforderungen:

Variabilität:

Leistungsmerkmale:

Ablageort / Datei:

Sonstige Verwaltungsinformation:

Offene Punkte:
...
Bausteinname 3.n (Black Box Beschreibung)
Struktur gemäß Black-Box- Template:

Zweck / Verantwortlichkeit:

Schnittstelle(n):

Erfüllte Anforderungen:

Variabilität:

Leistungsmerkmale:

Ablageort / Datei:

Sonstige Verwaltungsinformation:

Offene Punkte:
Beschreibung der Beziehungen
Offene Punkte
4.3 Ebene 3
5. Laufzeitsicht
5.1 Laufzeitszenario 1
5.2 Laufzeitszenario 2
Seite 11 von 15
5.3 ...
5.4 Laufzeitszenario n
6. Verteilungssicht
6.1 Infrastruktur Ebene 1
6.1.1 Verteilungsdiagramm Ebene 1
6.1.2 Prozessor 1

Beschreibung

Leistungsmerkmale

Zugeordnete Software- Bausteine

Sonstige Verwaltungsinformationen

Offene Punkte
6.1.3 Prozessor 2

Beschreibung

Leistungsmerkmale

Zugeordnete Software- Bausteine

Sonstige Verwaltungsinformationen

Offene Punkte
6.1.4 ...
6.1.5 Prozessor n

Beschreibung

Leistungsmerkmale

Zugeordnete Software- Bausteine

Sonstige Verwaltungsinformationen

Offene Punkte
Seite 12 von 15
6.1.6 Kanal 1
6.1.7 Kanal 2
6.1.8 ...
6.1.9 Kanal m
6.1.10 Offene Punkte
6.2 Infrastruktur Ebene 2
7. Typische Muster, Strukturen und Abläufe
7.1 Typische Muster und Strukturen
7.2 Typische Abläufe
8. Übergreifende Architekturaspekte und technische Konzepte
8.1 Persistenz
8.2 Benutzungsoberfläche
8.3 Ergonomie
8.4 Ablaufsteuerung
8.5 Transaktionsbehandlung
Seite 13 von 15
8.6 Sessionbehandlung
8.7 Sicherheit
8.8 Kommunikation und Integration mit anderen IT-Systemen
8.9 Verteilung
8.10 Ausnahme-/Fehlerbehandlung
8.11 Management des Systems & Administrierbarkeit
8.12 Logging, Protokollierung, Tracing
8.13 Geschäftsregeln
8.14 Konfigurierbarkeit
8.15 Parallelisierung und Threading
8.16 Internationalisierung
8.17 Migration
8.18 Testbarkeit
Seite 14 von 15
8.19 Plausibilisierung und Validierung
8.20 Codegenerierung
8.21 Build-Management
9. Entwurfsentscheidungen
10. Szenarien zur Architekturbewertung
10.1 Bewertungsszenario 1
10.2 Bewertungsszenario ...
11. Projektaspekte
11.1 Change Request
11.2 Technische Risiken
11.3 Offene Punkte
11.4 Erwartete Änderungen
11.5 Migration
Seite 15 von 15
11.6 Auswirkungen
12. Glossar
Herunterladen