Skip to content

Commit

Permalink
#3 basic informations added
Browse files Browse the repository at this point in the history
  • Loading branch information
sippsack committed Dec 15, 2024
1 parent cfb13df commit 1a8302a
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 54 deletions.
16 changes: 7 additions & 9 deletions docs/00b-basics/01-what-to-expect-of-this-module.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
// tag::DE[]
=== Was vermittelt das Modul „{curriculum-short}“?

Das Modul präsentiert den Teilnehmerinnen und Teilnehmern {curriculum-name} als …
Am Ende des Moduls kennen die Teilnehmerinnen und Teilnehmer … und können …
Application Programming Interfaces, oder APIs, ermöglichen die Nutzung von digitalen Diensten über programmierbare Schnittstellen. Ihre Nutzung hat über die letzten 20 Jahre stark zugenommen. Aus Sicht der Softwarearchitektur sind APIs sowohl aus Produzenten- als auch aus Konsumentensicht relevant: Softwarekomponenten sollten idealerweise als wiederverwendbare Produkte verstanden werden; APIs helfen, eine Softwarekomponente einfach wiederverwendbar zu machen. Heute stehen mehr und mehr Dienste über APIs zur Verfügung; als Konsument dieser Dienste kann man sich besser auf Kernaufgaben konzentrieren und andere Aufgaben auslagern an externe Komponenten.

Das Modul betrachtet die verschiedenen Arten, wie APIs Wert erzeugen: Als technische Schnittstellen die es verschiedenen Komponenten ermöglichen miteinander zu kommunizieren; als organisatorische Schnittstellen die es verschiedenen Teams ermöglicht mit weniger gegenseitigen Abhängigkeiten ihre jeweiligen Komponenten zu entwickeln; und als geschäftsorientierte Bausteine die es der Organisation erlauben, neue Dienste schneller und effektiver zu entwickeln.

Im Rahmen dieses Moduls sprechen wir bei APIs immer von Netzwerk-basierten Schnittstellen, also nicht von lokalen Programmierschnittstellen.

Neben dem Schwerpunkt auf technischem Themen werden auch strategische Aspekte behandelt wie die Wertschöpfung und die Verwendungen von APIs als Team-Kollaboration im Unternehmen. Damit eignet sich das Modul gut, um sich dem Thema APIs mit einer weiteren Perspektive als dem rein technischen Blick zu nähern.
// end::DE[]

// tag::EN[]
Expand All @@ -11,10 +16,3 @@ Am Ende des Moduls kennen die Teilnehmerinnen und Teilnehmer … und können …
The module presents {curriculum-short} to the participants …
At the end of the module, the participants know … and are able to …
// end::EN[]


[NOTE]
====
Hier bitte das Modul bzw. dessen Lerninhalte zusammenfassend in 5-8 Sätzen beschreiben. Dabei `{curriculum-name}`
nicht entfernen, beim Zusammenbauen wird dieser Platzhalter mit dem Modulnamen ersetzt.
====
Original file line number Diff line number Diff line change
@@ -1,18 +1,51 @@
// tag::DE[]
=== Struktur des Lehrplans und empfohlene zeitliche Aufteilung

[cols="<,>", options="header"]
[cols="<,>,>", options="header"]
|===
| Inhalt | Empfohlene Mindestdauer (min)
| 1. Thema mit Einleitung | 180
| 2. Thema über xz | 150
| 3. Thema mit viel Theorie | 120
| 4. Thema mit xy und Beispiel | 180
| 5. Thema mit abc und d | 210
| 6. Thema mit Abschlussbeispiel | 120
| |
| Summe | 960 (16h)
| Inhalt
| Empfohlene Mindestdauer (min)
| Übungszeit (Minuten)

| 1. Warum APIs wichtig sind
| 60
| 0

| 2. Wie APIs Wert erzeugen
| 90
| 30

| 3. API Stile und Technologien
| 60
| 30

| 4. API Design
| 90
| 30

| 5. Beschreibung von APIs
| 90
| 30

| 6. API Lifecycle und API Tooling
| 90
| 60

| 7. API Security
| 60
| 30

| 8. APIs at Scale: Plattformen und Governance
| 60
| 30

|
|
|

| Summe
| 600 (10 h)
| 240 (4 h)
|===

// end::DE[]
Expand All @@ -36,12 +69,3 @@
|===

// end::EN[]

[NOTE]
====
Bitte die oben angegebene Tabelle entsprechend anpassen.
= = =
Please adjust the table above according to your curriculum.
====
15 changes: 4 additions & 11 deletions docs/00b-basics/03-timing-didactics-and-more.adoc
Original file line number Diff line number Diff line change
@@ -1,14 +1,7 @@

[NOTE]
====
Bitte in dieser Datei nur die "**?**"-Platzhalter durch die Anzahl der Tage sowie die erreichbaren Punkte ersetzen. Ansonsten keine Änderungen vornehmen!
====


:recommended-duration-in-days: **?**
:methodical-credits: **?**
:technical-credits: **?**
:communicative-credits: **?**
:recommended-duration-in-days: **2**
:methodical-credits: **10**
:technical-credits: **10**
:communicative-credits: **0**

// tag::DE[]
=== Dauer, Didaktik und weitere Details
Expand Down
18 changes: 3 additions & 15 deletions docs/00b-basics/04-prerequisites-for-this-training.adoc
Original file line number Diff line number Diff line change
@@ -1,22 +1,10 @@
// tag::DE[]
=== Voraussetzungen

Neben dem Schwerpunkt auf technischem Themen werden auch strategische Aspekte behandelt wie die Wertschöpfung und die Verwendungen von APIs als Team-Kollaboration im Unternehmen. Damit eignet sich das Modul gut, um sich dem Thema APIs mit einer weiteren Perspektive als dem rein technischen Blick zu nähern.

Teilnehmerinnen und Teilnehmer **sollten** folgende Kenntnisse und/oder Erfahrung mitbringen:

- Architekten, Entwickler und andere technisch orientierte Personen, die sich einen umfassenden Überblick über das Thema APIs verschaffen möchten.
- Voraussetzung 1
- Voraussetzung 2, etc.

**Hilfreich** für das Verständnis einiger Konzepte sind darüber hinaus:

- Kenntnisgruppe 1:
* Kenntnis 1
* Erfahrung 2
* Kenntnis 3
* Erfahrung 4
* Wissen 5
- Architekten
- Entwickler
- andere technisch orientierte Personen, die sich einen umfassenden Überblick über das Thema APIs verschaffen möchten.
// end::DE[]

// tag::EN[]
Expand Down

0 comments on commit 1a8302a

Please sign in to comment.