Remove REMARKS stuff

isaqb-org · Sep 6, 2024 · 4960c4a · 4960c4a
1 parent 886b921
commit 4960c4a
Show file tree

Hide file tree

Showing 30 changed files with 55 additions and 269 deletions.
diff --git a/docs/00a-preamble/01-what-to-expect-of-an-advanced-level-module.adoc b/docs/00a-preamble/01-what-to-expect-of-an-advanced-level-module.adoc
@@ -4,7 +4,7 @@
 Das Modul kann unabhängig von einer CPSA-F-Zertifizierung besucht werden.
 
 - Der iSAQB Advanced Level bietet eine modulare Ausbildung in drei Kompetenzbereichen mit flexibel gestaltbaren Ausbildungswegen. Er berücksichtigt individuelle Neigungen und Schwerpunkte.
-- Die Zertifizierung erfolgt als Hausarbeit. Die Bewertung und mündliche Prüfung wird durch vom iSAQB benannte Experten vorgenommen.
+- Die Zertifizierung erfolgt als Hausarbeit. Die Bewertung und mündliche Prüfung wird durch vom iSAQB benannte Expert:innen vorgenommen.
 // end::DE[]
 
 // tag::EN[]
@@ -13,5 +13,3 @@ Das Modul kann unabhängig von einer CPSA-F-Zertifizierung besucht werden.
 - The certification is done as an assignment. The assessment and oral exam is conducted by experts appointed by the iSAQB.
 // end::EN[]
 
-// tag::REMARK[]
-// end::REMARK[]
diff --git a/docs/00a-preamble/02-advanced-level-knowledge.adoc b/docs/00a-preamble/02-advanced-level-knowledge.adoc
@@ -19,5 +19,4 @@ CPSA-A graduates can:
 - Control and execute architecture-relevant communication in medium to large development teams
 // end::EN[]
 
-// tag::REMARK[]
-// end::REMARK[]
+
diff --git a/docs/00a-preamble/03-prerequisites.adoc b/docs/00a-preamble/03-prerequisites.adoc
@@ -24,5 +24,4 @@
 image:00-preamble/cpsa-a-logo.png[pdfwidth=50%,align=center,alt="Certified Professional for Software Architecture^(R)^ Advanced Level (CPSA-A)"]
 
 
-// tag::REMARK[]
-// end::REMARK[]
+
diff --git a/docs/00b-basics/01-what-to-expect-of-this-module.adoc b/docs/00b-basics/01-what-to-expect-of-this-module.adoc
@@ -1,16 +1,19 @@
 // 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 …
 // end::DE[]
 
 // tag::EN[]
+=== What does the module “{curriculum-short}” convey?
 
+The module presents {curriculum-short} to the participants …
+At the end of the module, the participants know … and are able to …
 // end::EN[]
 
-// tag::REMARK[]
 [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.
 ====
-// end::REMARK[]
diff --git a/docs/00b-basics/02-curriculum-structure-and-chronological-breakdown.adoc b/docs/00b-basics/02-curriculum-structure-and-chronological-breakdown.adoc
@@ -36,6 +36,4 @@
 
 // end::EN[]
 
-// tag::REMARK[]
 
-// end::REMARK[]
diff --git a/docs/00b-basics/03-timing-didactics-and-more.adoc b/docs/00b-basics/03-timing-didactics-and-more.adoc
@@ -1,9 +1,3 @@
-// tag::REMARK[]
-[NOTE]
-====
-Bitte die **?** durch die Anzahl der Tage sowie die erreichbaren Punkte ersetzen.
-====
-// end::REMARK[]
 :recommended-duration-in-days: 2
 :methodical-credits: 20
 :technical-credits: 0

diff --git a/docs/00b-basics/04-prerequisites-for-this-training.adoc b/docs/00b-basics/04-prerequisites-for-this-training.adoc
@@ -31,10 +31,3 @@ Knowledge in the following areas may be **helpful** for understanding some conce
   * Alignment of software architecture with requirements and constraints
   * Measuring and evaluating the quality of designs and decisions
 // end::EN[]
-
-// tag::REMARK[]
-[NOTE]
-====
-Kenntnisgruppen sowie Voraussetzungen bitte entsprechend ausformulieren!
-====
-// end::REMARK[]
diff --git a/docs/00b-basics/05-curriculum-outline.adoc b/docs/00b-basics/05-curriculum-outline.adoc
@@ -23,5 +23,4 @@ The individual sections of the curriculum are described according to the followi
 This section therefore also outlines the skills to be acquired in corresponding training courses.
 // end::EN[]
 
-// tag::REMARK[]
-// end::REMARK[]
+
diff --git a/docs/00b-basics/06-complementary-information.adoc b/docs/00b-basics/06-complementary-information.adoc
@@ -11,5 +11,4 @@ Soweit für das Verständnis des Lehrplans erforderlich, haben wir Fachbegriffe
 To the extent necessary for understanding the curriculum, we have added definitions of technical terms to the https://github.com/isaqb-org/glossary[iSAQB glossary] and complemented them by references to (translated) literature.
 // end::EN[]
 
-// tag::REMARK[]
-// end::REMARK[]
+
diff --git a/docs/01-basic-concepts/01-duration-terms.adoc b/docs/01-basic-concepts/01-duration-terms.adoc
@@ -17,18 +17,3 @@ Softwareachitektur, Architekturbewertung, übergreifende Konzepte/Aspekte, Archi
 Software architecture, architecture evaluation, crosscutting concepts/concerns, architecture goals, non-functional and functional requirements for systems, influences, evaluation methods.
 
 // end::EN[]
-
-
-// tag::REMARK[]
-[NOTE]
-====
-Überschrift in 00-structure.adoc ersetzen
-====
-// end::REMARK[]
-
-// tag::REMARK[]
-[NOTE]
-====
-Sinnvolle Zeiten für Dauer und Übungszeit eintragen, vernünftige Begriffe aufzählen.
-====
-// end::REMARK[]
diff --git a/docs/01-basic-concepts/02-learning-goals.adoc b/docs/01-basic-concepts/02-learning-goals.adoc
@@ -32,7 +32,7 @@
 [[LZ-1-4]]
 ==== LZ 1-4: Voraussetzungen für Architekturbewertung erläutern
 
-* Notwendige Artefakte der Softwarearchitektur und deren angemessenen Detaillierungsgrad in konkreten Projektsituationen 
+* Notwendige Artefakte der Softwarearchitektur und deren angemessenen Detaillierungsgrad in konkreten Projektsituationen
 * Rahmenbedingungen
 * Konkrete Qualitätsanforderungen
 * Dokumentierte Architekturentscheidungen
@@ -86,7 +86,7 @@
 [[LG-1-4]]
 ==== LG 1-4: Explain prerequisites for architecture evaluation
 
-* Necessary artifacts of software architecture and their appropriate level of detail in concrete project situations. 
+* Necessary artifacts of software architecture and their appropriate level of detail in concrete project situations.
 * Constraints
 * Concrete quality requirements
 * Documented architecture decisions
@@ -107,9 +107,4 @@
 ==== LG 1-6: Understand that different methods complement each other and can be combined
 // end::EN[]
 
-// tag::REMARK[]
-[NOTE]
-====
-Die einzelnen Lernziele müssen nicht als einfache Aufzählungen mit Unterpunkten aufgeführt werden, sondern können auch gerne in ganzen Sätzen formuliert werden, welche die einzelnen Punkte (sofern möglich) integrieren.
-====
-// end::REMARK[]
+
diff --git a/docs/01-basic-concepts/references.adoc b/docs/01-basic-concepts/references.adoc
@@ -2,13 +2,4 @@
 
 <<clements2002>>, <<kazman>>, <<bachmann>>, <<bass>>, <<clements>>, <<kruchten>>, <<starke>>
 
-// tag::REMARK[]
-[NOTE]
-====
-Eine Quelle wird über `<<label>>` referenziert. Dieses muss in `99-references/00-references.adoc` definiert sein.
 
-= = =
-
-A reference source is referenced via `<<label>>`. The label has to be defined in `99-references/00-references.adoc`.
-====
-// end::REMARK[]
diff --git a/docs/02-requirements-in-architecture-evaluation/01-duration-terms.adoc b/docs/02-requirements-in-architecture-evaluation/01-duration-terms.adoc
@@ -19,16 +19,6 @@ Quality, quality attributes, ISO 9126, ISO 25010, scenarios, utility tree, trade
 
 // end::EN[]
 
-// tag::REMARK[]
-[NOTE]
-====
-Überschrift in 00-structure.adoc ersetzen
-====
-// end::REMARK[]
-
-// tag::REMARK[]
-[NOTE]
-====
-Sinnvolle Zeiten für Dauer und Übungszeit eintragen, vernünftige Begriffe aufzählen.
-====
-// end::REMARK[]
+
+
+
diff --git a/docs/02-requirements-in-architecture-evaluation/02-learning-goals.adoc b/docs/02-requirements-in-architecture-evaluation/02-learning-goals.adoc
@@ -4,7 +4,7 @@
 [[LZ-2-1]]
 ==== LZ 2-1: Den Zusammenhang von Softwarequalität und Softwarearchitektur verstehen
 
-* Die Bedeutung von qualitativen Anforderungen für die Architektur erklären. 
+* Die Bedeutung von qualitativen Anforderungen für die Architektur erklären.
 * Die Begriffe "Qualität" und "Qualitätsmerkmal" präzisieren.
 * Verschiedene Qualitätsmodelle (z.B. DIN/ISO 25010) interpretieren.
 * Eigenschaften wichtiger Qualitätsmerkmale erklären:
@@ -77,7 +77,7 @@
 [[LG-2-1]]
 ==== LG 2-1: Understand the relationship between software quality and software architecture
 
-* Explain the importance of quality requirements for architecture. 
+* Explain the importance of quality requirements for architecture.
 * Clarify the terms "quality" and "quality attribute".
 * Interpret different quality models (e.g. DIN/ISO 25010).
 * Explain characteristics of important quality attributes:
@@ -145,9 +145,4 @@
 ** Quality requirements can be partially fulfilled or even overfulfilled
 // end::EN[]
 
-// tag::REMARK[]
-[NOTE]
-====
-Die einzelnen Lernziele müssen nicht als einfache Aufzählungen mit Unterpunkten aufgeführt werden, sondern können auch gerne in ganzen Sätzen formuliert werden, welche die einzelnen Punkte (sofern möglich) integrieren.
-====
-// end::REMARK[]
+
diff --git a/docs/02-requirements-in-architecture-evaluation/references.adoc b/docs/02-requirements-in-architecture-evaluation/references.adoc
@@ -2,13 +2,4 @@
 
 <<bass>>, <<clements2002>>, <<kazman2005>>, <<barbacci>>, <<starke>>
 
-// tag::REMARK[]
-[NOTE]
-====
-Eine Quelle wird über `<<label>>` referenziert. Dieses muss in `99-references/00-references.adoc` definiert sein.
 
-= = =
-
-A reference source is referenced via `<<label>>`. The label has to be defined in `99-references/00-references.adoc`.
-====
-// end::REMARK[]
diff --git a/docs/03-scenario-based-workshops/01-duration-terms.adoc b/docs/03-scenario-based-workshops/01-duration-terms.adoc
@@ -18,16 +18,6 @@ ATAM, trade-offs, risks, non-risks, sensitive points, decisions, framework, phas
 
 // end::EN[]
 
-// tag::REMARK[]
-[NOTE]
-====
-Überschrift in 00-structure.adoc ersetzen
-====
-// end::REMARK[]
-
-// tag::REMARK[]
-[NOTE]
-====
-Sinnvolle Zeiten für Dauer und Übungszeit eintragen, vernünftige Begriffe aufzählen.
-====
-// end::REMARK[]
+
+
+
diff --git a/docs/03-scenario-based-workshops/02-learning-goals.adoc b/docs/03-scenario-based-workshops/02-learning-goals.adoc
@@ -15,7 +15,7 @@ In diesem Teil lernen die Teilnehmer den Kern des methodischen Vorgehens zur qua
 
 [[LZ-3-2]]
 ==== LZ 3-2: Qualitative Bewertung von Softwarearchitekturen nach ATAM durchführen
-  
+
 * Vorgehen bei qualitativer Bewertung erklären und durchführen
 * Erstellung von Szenarien und Qualitätsbäumen erklären und durchführen
 * Ansätze hinsichtlich Szenarien analysieren
@@ -28,7 +28,7 @@ In diesem Teil lernen die Teilnehmer den Kern des methodischen Vorgehens zur qua
 
 * Risiko-Cluster und Risiko-Gruppen
 * Stärken und Schwächen einer Architektur
-* Lücken zu den zentralen Qualitätszielen 
+* Lücken zu den zentralen Qualitätszielen
 
 [[LZ-3-4]]
 ==== LZ 3-4: Kommunikationsmittel für die Vermittlung von Ergebnissen beschreiben
@@ -39,7 +39,7 @@ In diesem Teil lernen die Teilnehmer den Kern des methodischen Vorgehens zur qua
 
 [[LZ-3-5]]
 ==== LZ 3-5: Einflüsse der Bewertungsergebnisse auf iterative Prozesse verstehen
-  
+
 * Risiken aktiv angehen
 * offene Entscheidungen planen
 * Unsicherheiten ausräumen
@@ -102,9 +102,4 @@ In this part, participants get to know the core of the methodological approach f
 * Know methods to streamline the process (e.g. light weight ATAM).
 // end::EN[]
 
-// tag::REMARK[]
-[NOTE]
-====
-Die einzelnen Lernziele müssen nicht als einfache Aufzählungen mit Unterpunkten aufgeführt werden, sondern können auch gerne in ganzen Sätzen formuliert werden, welche die einzelnen Punkte (sofern möglich) integrieren.
-====
-// end::REMARK[]
+
diff --git a/docs/03-scenario-based-workshops/references.adoc b/docs/03-scenario-based-workshops/references.adoc
@@ -3,13 +3,4 @@
 <<clements2002>>, <<bass>>, <<bass2006>>, <<kazman>>, <<nord>>, <<kazman2005>>, <<starke>>
 
 
-// tag::REMARK[]
-[NOTE]
-====
-Eine Quelle wird über `<<label>>` referenziert. Dieses muss in `99-references/00-references.adoc` definiert sein.
 
-= = =
-
-A reference source is referenced via `<<label>>`. The label has to be defined in `99-references/00-references.adoc`.
-====
-// end::REMARK[]
diff --git a/docs/04-evaluation-of-existing-parts/01-duration-terms.adoc b/docs/04-evaluation-of-existing-parts/01-duration-terms.adoc
@@ -20,16 +20,6 @@ pain points, tools.
 
 // end::EN[]
 
-// tag::REMARK[]
-[NOTE]
-====
-Überschrift in 00-structure.adoc ersetzen
-====
-// end::REMARK[]
-
-// tag::REMARK[]
-[NOTE]
-====
-Sinnvolle Zeiten für Dauer und Übungszeit eintragen, vernünftige Begriffe aufzählen.
-====
-// end::REMARK[]
+
+
+
diff --git a/docs/04-evaluation-of-existing-parts/02-learning-goals.adoc b/docs/04-evaluation-of-existing-parts/02-learning-goals.adoc
@@ -16,17 +16,17 @@
 * Eignung der Tools, um Ist-Architekuren Bottom-Up zu erheben und Abgleiche mit Soll-Architekturen durchzuführen, verstehen
 
 [[LZ-4-3]]
-==== LZ 4-3: Metriken zur Bewertung einsetzen 
+==== LZ 4-3: Metriken zur Bewertung einsetzen
 
 * Konkrete Metriken für die Überprüfung von Design Best-Practices erklären. (z.B. Distanz, Fan-In/Fan-Out, zyklomatische Komplexität)
 * Einsatz von Metriken planen (aus Zielsicht, nicht aus Toolsicht)
-* Messungen interpretieren (Default-Einstellungen hinterfragen, auf Trends achten) 
+* Messungen interpretieren (Default-Einstellungen hinterfragen, auf Trends achten)
 * Verstehen, dass Messungen geeignete Ausgangspunkte für tiefere Analysen sind
 
 [[LZ-4-4]]
 ==== LZ 4-4: Den Einsatz dynamischer Prüfverfahren planen
 
-* Möglichkeiten der dynamischen Software-Prüfung benennen 
+* Möglichkeiten der dynamischen Software-Prüfung benennen
 * Für dynamische Prüfung geeignete Qualitätsmerkmale kennen.
 * Ansätze der statischen Analyse in stark verteilten Umfeldern (Microservices) mit dynamischen Mitteln nachstellen.
 * Einflechtung dieser Techniken in größere Bewertungsvorhaben erklären.
@@ -53,22 +53,17 @@
 
 * Explain metrics for reviewing design best practices. (e.g., distance, fan-in/fan-out, cyclomatic complexity).
 * Plan use of metrics (to fulfill requirements, not for the sake of using a tool).
-* Interpret measurements (question default settings, look for trends). 
+* Interpret measurements (question default settings, look for trends).
 * Understand that measurements are appropriate starting points for deeper analysis.
 
 [[LG-4-4]]
 ==== LG 4-4: Plan the use of dynamic analysis methods
 
-* Name the potentials of dynamic software analysis. 
+* Name the potentials of dynamic software analysis.
 * Know quality attributes suitable for dynamic analysis.
 * Recreate approaches to static analysis in highly distributed environments (microservices) using dynamic means.
 * Explain incorporation of these techniques into larger evaluation projects.
 
 // end::EN[]
 
-// tag::REMARK[]
-[NOTE]
-====
-Die einzelnen Lernziele müssen nicht als einfache Aufzählungen mit Unterpunkten aufgeführt werden, sondern können auch gerne in ganzen Sätzen formuliert werden, welche die einzelnen Punkte (sofern möglich) integrieren.
-====
-// end::REMARK[]
+
diff --git a/docs/04-evaluation-of-existing-parts/references.adoc b/docs/04-evaluation-of-existing-parts/references.adoc
@@ -2,13 +2,4 @@
 
 <<deMarco>>, <<martin>>, <<sonarqube>>, <<hello2morrow>>
 
-// tag::REMARK[]
-[NOTE]
-====
-Eine Quelle wird über `<<label>>` referenziert. Dieses muss in `99-references/00-references.adoc` definiert sein.
 
-= = =
-
-A reference source is referenced via `<<label>>`. The label has to be defined in `99-references/00-references.adoc`.
-====
-// end::REMARK[]
diff --git a/docs/05-alternative-evaluation-methods/01-duration-terms.adoc b/docs/05-alternative-evaluation-methods/01-duration-terms.adoc
@@ -18,16 +18,6 @@ Cost-benefit assessments (CBAM), decision-based methods (DCAR), expert-based met
 
 // end::EN[]
 
-// tag::REMARK[]
-[NOTE]
-====
-Überschrift in 00-structure.adoc ersetzen
-====
-// end::REMARK[]
-
-// tag::REMARK[]
-[NOTE]
-====
-Sinnvolle Zeiten für Dauer und Übungszeit eintragen, vernünftige Begriffe aufzählen.
-====
-// end::REMARK[]
+
+
+
Original file line number	Diff line number	Diff line change
Expand Up		@@ -24,5 +24,4 @@
		image:00-preamble/cpsa-a-logo.png[pdfwidth=50%,align=center,alt="Certified Professional for Software Architecture^(R)^ Advanced Level (CPSA-A)"]


		// tag::REMARK[]
		// end::REMARK[]
Original file line number	Diff line number	Diff line change
Expand Up		@@ -36,6 +36,4 @@

		// end::EN[]

		// tag::REMARK[]

		// end::REMARK[]