Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 73 additions & 3 deletions docs/00b-basics/01-what-to-expect-of-this-module.adoc
Original file line number Diff line number Diff line change
@@ -1,19 +1,54 @@
// tag::DE[]
=== Was vermittelt das Modul „{curriculum-short}?
=== Was vermittelt das Modul „{curriculum-short}"?

{curriculum-short} vermittelt die Fähigkeiten:

* die Dokumentation von Softwarearchitekturen selbständig zu konzipieren und zu erstellen
* bestehende Dokumentation bezüglich ihrer Eignung und Angemessenheit zu bewerten
* bestehende Dokumentation zu verbessern.

Teilnehmende lernen, die wesentlichen Aspekte von Softwarearchitekturen (u. a. Entscheidungen, Strukturen, Konzepte, Qualitätsanforderungen und Sichten) systematisch zu beschreiben.
Teilnehmende lernen, die wesentlichen Aspekte von Softwarearchitekturen (u. a. Entscheidungen, Strukturen, Konzepte, Qualitätsanforderungen und Sichten) systematisch zu beschreiben.
Dazu stellt {curriculum-short} grundlegende Beschreibungs- und Notationsmittel sowie mögliche Werkzeuge zur praktischen Umsetzung vor.

Nachfolgend finden Sie eine übersichtliche „Navigationskarte" des Lehrplans, die jeden Abschnitt des Lehrplans kurz beschreibt.

image::curriculum-structure-DE.drawio.png[Struktur des Lehrplans, pdfwidth=60%, width=600,align=center]

==== 01 – Grundbegriffe von Architekturdokumentation

Dieser Abschnitt führt in die Kernkonzepte der Architekturdokumentation ein.
Er erläutert Nutzen und Ziele, die Bedeutung für verschiedene Stakeholder, die Abgrenzung zu anderen Dokumentationsarten sowie passende Notationen und deren Anpassung an unterschiedliche Entwicklungsvorgehen.

==== 02 – Vorgehen bei Architekturdokumentation

Der Schwerpunkt liegt auf dem Erstellen von Architekturdokumentation für verschiedene Situationen.
Sie lernen, Zielgruppen und Ziele zu ermitteln, passende Strukturen zu entwerfen, geeignete Vorgehensweisen zu definieren, GenAI-Werkzeuge sinnvoll einzusetzen und bewährte Templates auszuwählen.

==== 03 – Bestandteile von Architekturdokumentationen

Beschreibt die konkreten Inhalte einer Architekturdokumentation.
Dazu gehören Einflussfaktoren und Randbedingungen, Architekturentscheidungen, verschiedene Sichten (Baustein-, Laufzeit-, Verteilungssicht), übergreifende Konzepte sowie die Sicherstellung der Konsistenz zwischen den Dokumentationsteilen.

==== 04 – Werkzeuge

Hier geht es um Auswahl und Einsatz von Werkzeugen für die Dokumentation.
Sie lernen Anforderungen an Dokumentationswerkzeuge zu definieren und bekommen einen Überblick über den Docs-As-Code Ansatz.
Dazu erhalten Sie einen Ausblick auf den Einsatz von GenAI-Werkzeugen als Unterstützung für die Architekturdokumentation.

==== 05 – Dokumentation bewerten

Beschreibt, wie Sie Architekturdokumentation auf Gebrauchstauglichkeit überprüfen können.
Sie lernen, zwischen inhaltlicher und formaler Begutachtung zu differenzieren, Ziele von Reviews zu ermitteln, Checklisten zu erstellen und verschiedene Rollen bei Reviews auszuüben.

==== 06 – Beispiele

Rundet das Thema durch Vorstellung realer oder repräsentativer Fallstudien ab.
Sie lernen anhand praktischer Beispiele Vor- und Nachteile von Architekturdokumentation zu erklären.

// end::DE[]

// tag::EN[]
=== What does the module {curriculum-short} convey?
=== What does the module "{curriculum-short}" convey?

{curriculum-short} teaches the skills to:

Expand All @@ -24,5 +59,40 @@ Dazu stellt {curriculum-short} grundlegende Beschreibungs- und Notationsmittel s
Participants learn to systematically describe the essential aspects of software architectures (including decisions, structures, concepts, quality requirements and views).
For this purpose, {curriculum-short} introduces basic description and notation methods as well as possible tools for practical implementation.

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

image::curriculum-structure-EN.drawio.png[Struktur des Lehrplans, pdfwidth=60%, width=600,align=center]

==== 01 – Fundamental terms of architecture documentation

This section introduces the core concepts of architecture documentation.
It explains the benefits and goals, the importance for different stakeholders, the differentiation from other types of documentation, as well as suitable notations and their adaptation to different development processes.

==== 02 – Process for architecture documentation

The focus is on creating architecture documentation for various situations.
You learn to identify target audiences and goals, design suitable structures, define appropriate processes, use GenAI tools effectively, and select proven templates.

==== 03 – Elements of architecture documentation

Describes the concrete contents of architecture documentation.
This includes influencing factors and constraints, architecture decisions, different views (building block, runtime, deployment view), cross-cutting concepts, and ensuring consistency between the documentation parts.

==== 04 – Tools

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

==== 05 – Evaluating documentation

Describes how architecture documentation can be checked for fitness for purpose.
You learn to differentiate between content and formal assessment, identify goals of reviews, create checklists, and perform different roles in reviews.

==== 06 – Examples

Concludes the topic by demonstrating real or representative case studies.
You learn to explain advantages and disadvantages of architecture documentation using practical examples.

// end::EN[]

Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
| 4. Werkzeuge | 90 | 30
| 5. Dokumentation bewerten | 75 | 45
| 6. Beispiele für Dokumentation | 60 | 0
| | |
| Summe | 475 | 245

|===
Expand All @@ -32,7 +31,6 @@ Gesamtdauer: 720 min (12h)
| 4. Tools | 90 | 30
| 5. Evaluating documentation | 75 | 45
| 6. Examples of software architecture documentation | 60 | 0
| | |
| Total | 475 | 245
|===

Expand Down
Binary file added docs/images/curriculum-structure-DE.drawio.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/curriculum-structure-EN.drawio.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.