Skip to content

Add overview section with curriculum navigation map (DE/EN)#72

Merged
gernotstarke merged 3 commits into
mainfrom
copilot/add-overview-section
Dec 1, 2025
Merged

Add overview section with curriculum navigation map (DE/EN)#72
gernotstarke merged 3 commits into
mainfrom
copilot/add-overview-section

Conversation

Copilot AI commented Nov 30, 2025

Copy link
Copy Markdown
Contributor

Adds an "elevator pitch" overview section describing each curriculum chapter in 1-2 sentences, serving as a navigational map for readers.

Changes

  • Added navigational map to docs/00b-basics/01-what-to-expect-of-this-module.adoc
  • Both German (DE) and English (EN) versions included
  • Each of the 6 chapters summarized with key learning focus
  • Diagram placeholder intentionally omitted per instructions (human will add later)

Example (DE excerpt)

Hier finden Sie eine übersichtliche „Navigationskarte" des Lehrplans, in der jeder Abschnitt zusammengefasst ist.

==== 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.

Terminology ("fitness for purpose", "content and formal assessment") kept consistent with existing learning goals in section 05.

Original prompt

This section details on the original issue you should resolve

<issue_title>add overview section at beginning</issue_title>
<issue_description>describing the chapters in one, two sentences.
As a whole, this section shall serve as an Elevator Pitch. </issue_description>

<agent_instructions>please provide a DE and EN version. Add it to the file "docs/00b-basics/01-what-to-expect-of-this-module.adoc". Leave out the diagram for now, a human will take care of that later.</agent_instructions>

Comments on the Issue (you are @copilot in this section)

@gernotstarke This is the elevator-pitch from IMPROVE: Create something similar for us here. Use a new branch. // tag::DE[] === Was vermittelt das Modul „{curriculum-short}“?

Teilnehmende lernen hier, Softwaresysteme und -architekturen anhand ökonomischer und technischer Ziele systematisch und methodisch zu verbessern.
Dazu vermitteln entsprechende Schulungen die systematische Trennung von Problemen und Lösungsansätzen, das Erarbeiten von kurz-/mittel- und langfristigen Lösungsstrategien sowie deren Abgleich mit betriebswirtschaftlichen Zielen und Größen.
Zusätzlich zeigt der IMPROVE-Lehrplan typische Ansätze für Verbesserungen auf, beispielsweise Restrukturierungen und Refactoring, Verbesserungen der Analysierbarkeit, Prozessverbesserung, Verbesserung an technischer Infrastruktur, Verbesserung von Qualitätseigenschaften, etc.

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

Hier finden Sie eine übersichtliche „Navigationskarte” des Lehrplans, in der jeder Abschnitt zusammengefasst ist.

==== 01 – Grundlagen und Terminologie

Dieser Abschnitt stellt die Kernkonzepte der Softwareevolution und -wartung sowie den Begriff der technischen (und anderer) Schulden vor.
Er hilft dabei, Triebkräfte für Veränderungen zu identifizieren, technische und organisatorische Defizite zu klassifizieren, zwischen Ursachen und Symptomen zu unterscheiden und Verbesserungsstrategien zu erkennen.
Diese Grundlagen schaffen eine gemeinsame Sprache für kontinuierliche Verbesserungen.

==== 02 – Analyse des aktuellen Zustands

Der Schwerpunkt liegt auf der Analyse (Diagnose) bestehender Systeme, bevor Maßnahmen ergriffen werden.
Sie unterscheiden zwischen Problemanalyse und Lösungsfindung.
Sie erlernen verschiedene Analysemethoden anzuwenden, um Probleme und Risiken verschiedener Kategorien zu identifizieren, und dokumentieren Sie diese Ergebnisse angemessen.
Das Ziel ist es, ein umfassendes, evidenzbasiertes Verständnis dafür zu entwickeln, wo und warum Verbesserungen erforderlich sind.

==== 03 – Bewertung von Problemen und Lösungen

Dieser Abschnitt verbindet die Ergebnisse der Analyse mit wirtschaftlichen/geschäftlichen Überlegungen.
Er stellt einige wirtschaftliche Kennzahlen (ROI, CAPEX/OPEX, Break-even) und Schätzverfahren vor, um die Schwere von Problemen und Risiken zu bewerten.
Das Ziel besteht darin, Verbesserungsentscheidungen durch quantifizierbare, kontextbezogene Bewertungen zu unterstützen.

==== 04 – Ansätze und Praktiken zur Verbesserung

Beschreibt spezifische und konkrete Ansätze (Muster, Strategien, Taktiken) zur Verbesserungen.
Dazu gehören die Optimierung von Prozessen, die Verbesserung von Code und Datenbanken, die Reduzierung von Kopplungs- und Änderungsrisiken durch Automatisierung, die Verbesserung des Laufzeitverhaltens und die Verfeinerung der Dokumentation.
Das Ziel ist ein methodischer Werkzeugkasten von Verbesserungsmaßnahmen.

==== 05 – Planung von Verbesserungen

Behandelt die Planung und Kommunikation nachhaltiger Verbesserungsstrategien.
Langfristige Initiativen werden auf die Geschäftsziele abgestimmt, Abhängigkeiten visualisiert und unterschiedliche Ansätze gegeneinander abgewogen.
Der Schwerpunkt liegt auf iterativer Planung, Einbindung von Stakeholdern und strategischer Kommunikation.

==== 06 – Beispiele

Rundet das Thema durch Vorstellung realer oder repräsentativer Fallstudien ab.

// end::DE[]

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

Participants learn to methodically improve software systems and architectures, guided by economic and technical goals.
The training imparts the systematic separation of problem and solution, the elaboration of short-, mid- and long-term solution strategies as well as their alignment with business goals and measures.
In addition, the IMPROVE curriculum teaches typical approaches of improvement, e.g., restructuring and refactoring, improving analyzability, process improvement, improvement of technical infrastructure, improvement of quality attributes, etc.

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

Here’s a concise “navigational map” of the curriculum, summarizing each section.

==== 01 – Foundations and Terminology

This section introduces the core concepts of software evolution, maintena...


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

… + EN)

Co-authored-by: gernotstarke <1233990+gernotstarke@users.noreply.github.com>
Copilot AI changed the title [WIP] Add overview section at beginning of document Add overview section with curriculum navigation map (DE/EN) Nov 30, 2025
Copilot AI requested a review from gernotstarke November 30, 2025 09:55
@github-actions

github-actions Bot commented Dec 1, 2025

Copy link
Copy Markdown
Contributor

Build Successful! You can find a link to the downloadable artifacts below.

Name Link
Commit 77b0be0
Logs https://github.com/isaqb-org/curriculum-adoc/actions/runs/19820755700
Download https://github.com/isaqb-org/curriculum-adoc/suites/51137768539/artifacts/4723498362

@gernotstarke gernotstarke merged commit 77b0be0 into main Dec 1, 2025
1 check passed
@gernotstarke gernotstarke deleted the copilot/add-overview-section branch December 1, 2025 11:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

add overview section at beginning

2 participants