arc42 in Aktion - Praktische Tipps zur Architekturdokumentation

Gernot Starke, Peter Hruschka

arc42 in Aktion

Praktische Tipps zur Architekturdokumentation

2016

210 Seiten

Format: PDF, Online Lesen

E-Book: €  15,99

E-Book kaufen

E-Book kaufen

ISBN: 9783446449381

 

Inhalt

6

I Überblick

10

I.1? Grundprinzipien von arc42

11

I.2? Warum dieses Buch?

13

I.3? Was dieses Buch nicht ist

14

I.4? Unsere Annahmen über Sie …

15

I.5? Navigationshilfe für Eilige

15

I.6? Konventionen

16

I.7? Danke

17

II arc42 am Beispiel

18

1? Einführung und Ziele

18

1.1? Aufgabenstellung

18

1.2? Qualitätsanforderungen

21

1.3? Stakeholder

21

2? Randbedingungen

22

3? Kontext

22

3.1? Fachlicher Kontext

23

3.2? Technischer Kontext/Verteilungskontext

24

4? Lösungsstrategie

25

5? Bausteinsicht

26

5.1 Whitebox Gesamtsystem (Level?1)

26

5.1.1? Blackbox „HSC Core“

27

5.1.2? Blackbox „HSC Gradle Plugin“

27

5.2? Bausteinsicht Level?2

28

5.2.1? Whitebox HSC Core

28

5.3? Bausteinsicht Level?3

29

5.3.1? Whitebox Results Collector

29

5.3.2? Suggester

30

6? Laufzeitsicht

31

6.1? Ausführen aller Prüfalgorithmen („perform all checks“)

31

6.2? Reporting von Prüfergebnissen

32

7? Verteilungssicht

33

8? Querschnittliche Konzepte

35

8.1? Fachliches Modell

35

8.2? Aufbau von UR (HTML-Verweise)

36

8.3? Entwicklung des Gradle-Plug-ins

37

8.4? Erweiterbarkeit um neue Prüf- oder Reporting-Verfahren

38

9? Entwurfsentscheidungen

39

9.1? Prüfung externer Links verschoben

39

9.2? JSOUP als HTML-Parser

39

9.2.1? Entscheidungskriterien

39

9.2.2? Alternativen

39

10? Qualitätsszenarien

40

10.1? Qualitätsbaum

40

10.2? Qualitätsszenarien

40

11? Risiken & technische Schulden

41

11.1? Betriebs-/Deployment-Risiken

41

11.2? Fachliche Risiken

41

12? Glossar

42

III Grundregeln effektiver Dokumentation

44

III.1? Anforderungen an die Dokumentation

44

III.2? Zentrale Tipps für eine effektive Dokumentation

46

IV arc42 effektiv einsetzen

52

1? Einführung und Ziele

53

1.1? Aufgabenstellung

53

1.2? Qualitätsziele

57

1.3? Stakeholder

61

2? Randbedingungen

64

3? Kontextabgrenzung

65

3.1? Fachlicher Kontext

72

3.2? Technischer Kontext

74

4? Lösungsstrategie

76

5? Bausteinsicht

79

6? Laufzeitsicht

94

7? Verteilungssicht

101

8? Querschnittliche Konzepte

107

9? Entwurfsentscheidungen

113

10? Qualitätsszenarien

116

11? Risiken und technische Schulden

120

12? Glossar

121

V arc42 im Alltag

124

V.1? Guter Start mit arc42

125

V.2? arc42 für bestehende Systeme

129

V.3? Mit arc42 auf der grünen Wiese

133

V.4? arc42 für agile Projekte

135

V.5? arc42 für sehr große Systeme

136

VI Werkzeuge für arc42

140

VI.1? Anforderungen an Werkzeuge

140

VI.2? Modellierungswerkzeuge

143

VI.2.1? Grafische Modellierungswerkzeuge

145

VI.2.2? Enterprise-Architect™ (Sparx Systems)

146

VI.2.3? Visual Paradigm™

150

VI.2.4? PlantUML

151

VI.2.5? Weitere Modellierungswerkzeuge

152

VI.3? Zeichenwerkzeuge

153

VI.3.1? Online-/Browser-Werkzeuge

153

VI.4? Wikis

155

VI.4.1? Confluence™

156

VI.4.2? Sonstige Wikis

157

VI.5? Markup- oder Makrosprachen

157

VI.5.1? AsciiDoc/AsciiDoctor

158

VI.5.2? Andere Markup-Sprachen

163

VI.5.3? DITA

163

VI.6? Textverarbeitung

164

VI.7? Mindmapping-Werkzeuge

165

VI.8? Empfehlungen

167

VII FAQ: Häufige Fragen zu arc42

168

VII.1? Allgemeines zu arc42

169

VII.2? Fragen zu arc42-Methodik

171

VII.3? Fragen zu arc42-Abschnitten

173

VII.3.1? Ad?1: Aufgabenstellung, Qualitätsziele, Stakeholder

173

VII.3.2? Ad?2: Randbedingungen

175

VII.3.3? Ad?3: Kontextabgrenzung

175

VII.3.4? Ad?4: Lösungsstrategie

176

VII.3.5? Ad?5: Bausteinsicht

177

VII.3.6? Ad?6: Laufzeitsicht

180

VII.3.7? Ad?7: Verteilungssicht

181

VII.3.8? Ad?8: Konzepte

182

VII.3.9? Ad?9: Entscheidungen

182

VII.4? Fragen zur Modellierung

183

VII.4.1? Nutzung von UML

183

VII.4.2? Alternativen zu UML

185

VII.4.3? Hardwaremodellierung

186

VII.4.4? Verständliche und konsistente Modelle

186

VII.5? arc42 und agiles Vorgehen

187

VII.6? Fragen zu Werkzeugen

188

VII.7? Fragen zu Versionen & Varianten

190

VII.8? Fragen zu Traceability

191

VII.9? Fragen zu Projekten und Projektmanagement

192

VII.10? Fragen zu spezifischen Anpassungen (Customizing) von arc42

194

Literatur und Quellen

196

Stichwortverzeichnis

198

 

© 2009-2024 ciando GmbH