Skip to content

Commit 77b0be0

Browse files
committed
add diagram, fix minor adoc syntax issues, briefly update formulation
1 parent 6645caf commit 77b0be0

4 files changed

Lines changed: 12 additions & 8 deletions

docs/00b-basics/01-what-to-expect-of-this-module.adoc

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@
1010
Teilnehmende lernen, die wesentlichen Aspekte von Softwarearchitekturen (u. a. Entscheidungen, Strukturen, Konzepte, Qualitätsanforderungen und Sichten) systematisch zu beschreiben.
1111
Dazu stellt {curriculum-short} grundlegende Beschreibungs- und Notationsmittel sowie mögliche Werkzeuge zur praktischen Umsetzung vor.
1212

13-
Hier finden Sie eine übersichtliche „Navigationskarte" des Lehrplans, in der jeder Abschnitt zusammengefasst ist.
13+
Nachfolgend finden Sie eine übersichtliche „Navigationskarte" des Lehrplans, die jeden Abschnitt des Lehrplans kurz beschreibt.
14+
15+
image::curriculum-structure-DE.drawio.png[Struktur des Lehrplans, pdfwidth=60%, width=600,align=center]
1416

1517
==== 01 – Grundbegriffe von Architekturdokumentation
1618

@@ -29,13 +31,14 @@ Dazu gehören Einflussfaktoren und Randbedingungen, Architekturentscheidungen, v
2931

3032
==== 04 – Werkzeuge
3133

32-
Behandelt die Auswahl und den Einsatz von Werkzeugen für die Dokumentationsarbeit.
33-
Sie lernen Anforderungen an Dokumentationswerkzeuge zu definieren, den Docs-As-Code Ansatz kennen und GenAI-Werkzeuge als Unterstützung für die Architekturdokumentation anzuwenden.
34+
Hier geht es um Auswahl und Einsatz von Werkzeugen für die Dokumentation.
35+
Sie lernen Anforderungen an Dokumentationswerkzeuge zu definieren und bekommen einen Überblick über den Docs-As-Code Ansatz.
36+
Dazu erhalten Sie einen Ausblick auf den Einsatz von GenAI-Werkzeugen als Unterstützung für die Architekturdokumentation.
3437

3538
==== 05 – Dokumentation bewerten
3639

37-
Beschreibt, wie Architekturdokumentation auf Gebrauchstauglichkeit überprüft werden kann.
38-
Sie lernen zwischen inhaltlicher und formaler Begutachtung zu differenzieren, Ziele von Reviews zu ermitteln, Checklisten zu erstellen und verschiedene Rollen bei Reviews auszuüben.
40+
Beschreibt, wie Sie Architekturdokumentation auf Gebrauchstauglichkeit überprüfen können.
41+
Sie lernen, zwischen inhaltlicher und formaler Begutachtung zu differenzieren, Ziele von Reviews zu ermitteln, Checklisten zu erstellen und verschiedene Rollen bei Reviews auszuüben.
3942

4043
==== 06 – Beispiele
4144

@@ -58,6 +61,8 @@ For this purpose, {curriculum-short} introduces basic description and notation m
5861

5962
Here's a concise "navigational map" of the curriculum, summarizing each section.
6063

64+
image::curriculum-structure-EN.drawio.png[Struktur des Lehrplans, pdfwidth=60%, width=600,align=center]
65+
6166
==== 01 – Fundamental terms of architecture documentation
6267

6368
This section introduces the core concepts of architecture documentation.
@@ -76,7 +81,8 @@ This includes influencing factors and constraints, architecture decisions, diffe
7681
==== 04 – Tools
7782

7883
Covers the selection and use of tools for documentation work.
79-
You learn to define requirements for documentation tools, get to know the Docs-As-Code approach, and apply GenAI tools to support architecture documentation.
84+
You learn to define requirements for documentation tools and get to know the Docs-As-Code approach.
85+
In addition, you get an overview of applying GenAI tools to support architecture documentation.
8086

8187
==== 05 – Evaluating documentation
8288

docs/00b-basics/02-curriculum-structure-and-chronological-breakdown.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
| 4. Werkzeuge | 90 | 30
1212
| 5. Dokumentation bewerten | 75 | 45
1313
| 6. Beispiele für Dokumentation | 60 | 0
14-
| | |
1514
| Summe | 475 | 245
1615

1716
|===
@@ -32,7 +31,6 @@ Gesamtdauer: 720 min (12h)
3231
| 4. Tools | 90 | 30
3332
| 5. Evaluating documentation | 75 | 45
3433
| 6. Examples of software architecture documentation | 60 | 0
35-
| | |
3634
| Total | 475 | 245
3735
|===
3836

96.9 KB
Loading
92.3 KB
Loading

0 commit comments

Comments
 (0)