Skip to content

Commit

Permalink
Merge pull request #55 from isaqb-org/54-structural-cleanup
Browse files Browse the repository at this point in the history
move sentences to one line and add/remove blank lines where needed
  • Loading branch information
programming-wolf authored Oct 17, 2024
2 parents 94c3119 + 6f004b8 commit b66afd5
Show file tree
Hide file tree
Showing 16 changed files with 37 additions and 84 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ Das Modul kann unabhängig von einer CPSA-F-Zertifizierung besucht werden.

// tag::EN[]
=== What is taught in an Advanced Level module?

The module can be attended independently of a CPSA-F certification.

- The iSAQB Advanced Level offers modular training in three areas of competence with flexibly designable training paths. It takes individual inclinations and priorities into account.
- The certification is done as an assignment. The assessment and oral exam is conducted by experts appointed by the iSAQB.
// end::EN[]
Expand Down
1 change: 0 additions & 1 deletion docs/00a-preamble/02-advanced-level-knowledge.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ CPSA-A-Absolventen können:
- in IT-Systemen mittlerer bis hoher Kritikalität technische und inhaltliche Verantwortung übernehmen
- Maßnahmen zur Erreichung von Qualitätsanforderungen konzeptionieren, entwerfen und dokumentieren sowie Entwicklungsteams bei der Umsetzung dieser Maßnahmen begleiten
- architekturrelevante Kommunikation in mittleren bis großen Entwicklungsteams steuern und durchführen

// end::DE[]

// tag::EN[]
Expand Down
1 change: 0 additions & 1 deletion docs/00a-preamble/03-prerequisites.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
** Ausnahmen sind auf Antrag zulässig (etwa: Mitarbeit in Open-Source-Projekten)
* Aus- und Weiterbildung im Rahmen von iSAQB-Advanced-Level-Schulungen im Umfang von mindestens 70 Credit Points aus mindestens drei unterschiedlichen Kompetenzbereichen
* erfolgreiche Bearbeitung der CPSA-A-Zertifizierungsprüfung

// end::DE[]

// tag::EN[]
Expand Down
4 changes: 2 additions & 2 deletions docs/00b-basics/03-timing-didactics-and-more.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
// tag::DE[]
=== Dauer, Didaktik und weitere Details

Die unten genannten Zeiten sind Empfehlungen. Die Dauer einer Schulung zum Modul {curriculum-short}
sollte mindestens {recommended-duration-in-days} Tage betragen, kann aber länger sein.
Die unten genannten Zeiten sind Empfehlungen.
Die Dauer einer Schulung zum Modul {curriculum-short} sollte mindestens {recommended-duration-in-days} Tage betragen, kann aber länger sein.
Anbieter können sich durch Dauer, Didaktik, Art und Aufbau der Übungen sowie der detaillierten Kursgliederung voneinander unterscheiden.
Insbesondere die Art der Beispiele und Übungen lässt der Lehrplan komplett offen.

Expand Down
37 changes: 12 additions & 25 deletions docs/00b-basics/04-prerequisites-for-this-training.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,37 +16,24 @@ Hilfreich für das Verständnis einiger Konzepte sind darüber hinaus:
** Grundkenntnisse und erste Erfahrung in der Aufwandsschätzung von Entwicklungsaufgaben
* Erste praktische Erfahrung in der Anforderungsanalyse sowie dem Umgang mit unterschiedlichen Stakeholdern von Entwicklungsprojekten.
* Erste praktische Erfahrung in der Analyse von Entwicklungsprozessen.

// end::DE[]

// tag::EN[]
=== Prerequisites

Participants *should* have the following knowledge and/or experience:

* Hands-on experience in design and development of small to medium size
software systems.
* Some hands-on experience in maintenance and evolution of a software
system.
* Some hands-on experience with the handling of source code of medium to
large scale systems, in particular: analysis, assessment, quality check,
refactoring, and applying of metrics.

Furthermore, the following will be useful for understanding certain
concepts:

* Knowledge and hands-on experience with refactoring (see e.g.,
<<fowler>>)
* Knowledge or some hands-on experience with review and evaluation of
software:
** Basic knowledge about software metrics, such as metrics to measure
coupling, cohesion, dependency, and complexity.
** Basic knowledge of software run time analysis such as profiling,
tracing, log analysis, and analysis of application data.
** Basic knowledge and some experience with the estimation of
development efforts.
* Some hands-on experience with requirements engineering as well as
contact with various stakeholders in development projects.
* Some hands-on experience with analysis of development processes.
* Hands-on experience in design and development of small to medium size software systems.
* Some hands-on experience in maintenance and evolution of a software system.
* Some hands-on experience with the handling of source code of medium to large scale systems, in particular: analysis, assessment, quality heck, refactoring, and applying of metrics.

Furthermore, the following will be useful for understanding certain concepts:

* Knowledge and hands-on experience with refactoring (see e.g., <<fowler>>)
* Knowledge or some hands-on experience with review and evaluation of software:
** Basic knowledge about software metrics, such as metrics to measure coupling, cohesion, dependency, and complexity.
** Basic knowledge of software run time analysis such as profiling, tracing, log analysis, and analysis of application data.
** Basic knowledge and some experience with the estimation of development efforts.
* Some hands-on experience with requirements engineering as well as contact with various stakeholders in development projects.
* Some hands-on experience with analysis of development processes.
// end::EN[]
5 changes: 3 additions & 2 deletions docs/00b-basics/06-complementary-information.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@

Soweit für das Verständnis des Lehrplans erforderlich, haben wir Fachbegriffe ins https://github.com/isaqb-org/glossary[iSAQB-Glossar] aufgenommen, definiert und bei Bedarf durch die Übersetzungen der Originalliteratur ergänzt.

[discrete]
=== Helfen Sie uns, diesen Lehrplan zu verbessern

Sie finden die neueste Version dieses Dokuments online (https://isaqb-org.github.io/curriculum-improve/), wo Sie gerne Feedback und Verbesserungsvorschläge geben können.
Sie finden die neueste Version dieses Dokuments online (https://public.isaqb.org/curriculum-improve/), wo Sie gerne Feedback und Verbesserungsvorschläge geben können.
// end::DE[]

// tag::EN[]
Expand All @@ -17,7 +18,7 @@ To the extent necessary for understanding the curriculum, we have added definiti
[discrete]
=== Help us improve this curriculum

You find the most recent version of this document online (https://isaqb-org.github.io/curriculum-improve/), where you are encouraged to provide feedback.
You find the most recent version of this document online (https://public.isaqb.org/curriculum-improve/), where you are encouraged to provide feedback.
// end::EN[]


2 changes: 0 additions & 2 deletions docs/01-principles/01-duration-terms.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@
Softwarearchitektur: Struktur, Bausteine/Komponenten, Schnittstellen, übergreifende (querschnittliche) Konzepte;
Veränderung, Evolution, Wartung und Verbesserung von Software; Kategorien von Problemen und Risiken von Software (Technische Schulden),
Kernbegriffe rund um Verbesserung und Änderung von Software, technische Pflege


// end::DE[]

// tag::EN[]
Expand Down
5 changes: 1 addition & 4 deletions docs/01-principles/02-learning-goals.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
// tag::DE[]
[[LZ-1-1]]
==== LZ 1-1: Gründe für Veränderungen an Software

* Funktionale Erweiterung oder Änderung
* Änderung von Qualitätsanforderungen oder -zielen
* Änderungen in technischem oder fachlichen Kontext (z. B. Änderung an externen Schnittstellen)
Expand Down Expand Up @@ -55,8 +56,6 @@ Beispielsweise:
* Verbesserung durch Neuentwicklung (Rewrite) eines Systems oder Teilen davon
* Rein strukturelle Verbesserungen (Refactoring)
* Konzeptionelle/strukturelle Verbesserung (Re-Architecting, Reengineering)


// end::DE[]

// tag::EN[]
Expand Down Expand Up @@ -115,8 +114,6 @@ For example:
* Improvement by newly developed system or system parts (rewrite)
* Purely structural improvements (refactoring)
* Conceptual/structural improvements (re-architecting, reengineering)


// end::EN[]


5 changes: 2 additions & 3 deletions docs/02-analyze/01-duration-terms.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
=== Begriffe und Konzepte

Ist-Analyse, Stärken/Schwächen-Analyse, Stakeholder, Problem, Ursache versus Symptom, Lösungsansatz

// end::DE[]

// tag::EN[]
Expand All @@ -17,6 +16,6 @@ Ist-Analyse, Stärken/Schwächen-Analyse, Stakeholder, Problem, Ursache versus S
|===

=== Terms and concepts
current state analysis, strength/weaknesses analysis, stakeholder, problem, cause versus symptom,
solution approach.

current state analysis, strength/weaknesses analysis, stakeholder, problem, cause versus symptom, solution approach.
// end::EN[]
15 changes: 6 additions & 9 deletions docs/02-analyze/02-learning-goals.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
* Problem und Lösungsansatz in m:n Verhältnis einander zuordnen
* Komplexe Probleme in Teilprobleme zerlegen


[[LZ-2-2]]
==== LZ 2-2: Typische Praktiken und Methoden zur Ist-Analyse

Expand Down Expand Up @@ -46,19 +45,21 @@ Typische Praktiken der Ist-Analyse kennen und für die jeweilige Situation, das

[[LZ-2-5]]
==== LZ 2-5: Kontextanalyse

* Kontextabgrenzung durchführen und dokumentieren: Systeme bezüglich ihrer fachlichen und technischen Nachbarn abgrenzen und dabei externe Schnittstellen identifizieren.
* Zusammenhänge zwischen externen Schnittstellen und möglichen Stakeholdern erkennen und für Problemanalyse ausnutzen können.
* Probleme und Risiken externer Schnittstellen erarbeiten (u. a. über Interviews, Analyse bekannter Fehler, Laufzeitanalyse, Protokoll- oder Loganalyse, Analyse der organisatorischen Beziehungen, Analyse der Qualitätsmerkmale und/oder Service-Levels).

[[LZ-2-6]]
==== LZ 2-6: Code- und Strukturanalyse

(Statische) Analyse von bestehendem Quellcode und dessen Strukturen durchführen und dokumentieren.
(Hierzu können in der Schulung entsprechende Werkzeuge eingesetzt werden, sind jedoch nicht Voraussetzung).

[[LZ-2-7]]
==== LZ 2-7: Grundlegende Laufzeitanalysen
(Dynamische) Analyse von bestehenden Systemen planen und durchführen können, beispielsweise hinsichtlich Laufzeiten, Ressourcen-Bedarf, Lastverhalten. (Hierzu können in der Schulung Werkzeuge eingesetzt werden, sind jedoch nicht Voraussetzung).

(Dynamische) Analyse von bestehenden Systemen planen und durchführen können, beispielsweise hinsichtlich Laufzeiten, Ressourcen-Bedarf, Lastverhalten. (Hierzu können in der Schulung Werkzeuge eingesetzt werden, sind jedoch nicht Voraussetzung).
// end::DE[]

// tag::EN[]
Expand All @@ -72,9 +73,7 @@ Typische Praktiken der Ist-Analyse kennen und für die jeweilige Situation, das
[[LG-2-2]]
==== LG 2-2: Typical practices and methods for current state analysis

Know typical practices for current state analysis and being able to
choose the appropriate method in each situation according to budget,
time or the involved stakeholders. This includes approaches such as:
Know typical practices for current state analysis and being able to choose the appropriate method in each situation according to budget, time or the involved stakeholders. This includes approaches such as:

* Stakeholder analysis and interview
* Contextual analysis
Expand Down Expand Up @@ -120,11 +119,9 @@ time or the involved stakeholders. This includes approaches such as:
(For this purpose, tools may be used in the training. However, these are not a prerequisite).

[[LG-2-7]]
==== LG 2-7: Runtime analysis

Plan and perform (dynamic) analysis of existing systems, e.g., with respect to runtime behavior, resource utilization, load response.
(For this purpose, tools may be used in the training. However, these are not a prerequisite).
==== LG 2-7: Fundamental runtime analysis

Plan and perform (dynamic) analysis of existing systems, e.g., with respect to runtime behavior, resource utilization, load response. (For this purpose, tools may be used in the training. However, these are not a prerequisite).
// end::EN[]


11 changes: 2 additions & 9 deletions docs/03-evaluate/01-duration-terms.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,7 @@

=== Begriffe und Konzepte

Aufwand, Kosten, Schätzung, Beobachtung/Messung, Annahmen,
betriebswirtschaftliche Größen: Investition, Ertrag, Kosten, Wert, Return-on-Invest (ROI), Break-Even, Run-the-Shop (RTC) und Develop-the-Shop (DTC) Kosten, Capital Expense (CapEx), Operational Expense (OpEx);
Intervallschätzung, Gesetz-der-großen-Zahl.
Geschäftsziele, strategische Initiativen.

Aufwand, Kosten, Schätzung, Beobachtung/Messung, Annahmen, betriebswirtschaftliche Größen: Investition, Ertrag, Kosten, Wert, Return-on-Invest (ROI), Break-Even, Run-the-Shop (RTC) und Develop-the-Shop (DTC) Kosten, Capital Expense (CapEx), Operational Expense (OpEx); Intervallschätzung, Gesetz-der-großen-Zahlen; Geschäftsziele, strategische Initiativen.
// end::DE[]

// tag::EN[]
Expand All @@ -20,9 +16,6 @@ Geschäftsziele, strategische Initiativen.
|===

=== Terms and concepts
Effort, cost, estimate, observation/measurement, assumptions, economic dimensions: Investment, yield, cost, value, Return-on-Invest (ROI), Break-Even,
Run-the-Shop (RTC) und Develop-the-Shop (DTC) cost, Capital Expense (CapEx), Operational Expense (OpEx);
interval estimation, law of large numbers.
Business goals, strategic initiatives.

Effort, cost, estimate, observation/measurement, assumptions, economic dimensions: Investment, yield, cost, value, Return-on-Invest (ROI), Break-Even, Run-the-Shop (RTC) und Develop-the-Shop (DTC) cost, Capital Expense (CapEx), Operational Expense (OpEx); interval estimation, law of large numbers; Business goals, strategic initiatives.
// end::EN[]
3 changes: 0 additions & 3 deletions docs/03-evaluate/02-learning-goals.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
** Geeignete Wege zur Zuordnung von Problem- und Verbesserungskosten auf der Basis von Kostentreibern (intern und extern) finden.
** Potenzielle Kosten im Zusammenhang mit Risiken und technische Schulden identifizieren, einschließlich Auswirkungen auf Projektlaufzeiten und möglicher Schäden am Unternehmensruf.


[[LZ-3-2]]
==== LZ 3-2: Grundbegriffe für Evaluierung/Schätzung

Expand All @@ -32,7 +31,6 @@
==== LZ 3-3: Probleme und Lösungsansätze schätzen

Schätzverfahren auf Probleme und Lösungsansätze innerhalb von IT-Systemen und zugehörigen Prozessen anwenden können

// end::DE[]

// tag::EN[]
Expand Down Expand Up @@ -66,7 +64,6 @@ Schätzverfahren auf Probleme und Lösungsansätze innerhalb von IT-Systemen und
==== LG 3-3: Estimate for problems and solution approaches

Apply estimation techniques to problems and solution approaches of IT systems and related processes.

// end::EN[]


13 changes: 2 additions & 11 deletions docs/04-planning/01-duration-terms.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,7 @@

=== Begriffe und Konzepte

Explizite Darstellung (Dokumentation) von bewerteten Problemen und
Lösungsoptionen, Gruppierung/Clusterung von Lösungen, Abhängigkeiten von Problemen und Lösungen,
Mögliche m:n Relation von Problemen und Lösungsansätzen, Synergieeffekte, Iterativ-inkrementelles Vorgehen,
Entwicklung und Kommunikation langfristiger Lösungsstrategien


Explizite Darstellung (Dokumentation) von bewerteten Problemen und Lösungsoptionen, Gruppierung/Clusterung von Lösungen, Abhängigkeiten von Problemen und Lösungen, mögliche m:n Relation von Problemen und Lösungsansätzen, Synergieeffekte, Iterativ-inkrementelles Vorgehen, Entwicklung und Kommunikation langfristiger Lösungsstrategien
// end::DE[]

// tag::EN[]
Expand All @@ -22,9 +17,5 @@ Entwicklung und Kommunikation langfristiger Lösungsstrategien

=== Terms and concepts

Explicit representation (documentation) of evaluated problems and options for solutions,
grouping/clustering of solutions, dependencies between problems and solutions,
potential m:n relation between problems and solution approaches, synergies,
iterative-incremental approach, development, and communication of long-term solution strategies.

Explicit representation (documentation) of evaluated problems and options for solutions, grouping/clustering of solutions, dependencies between problems and solutions, potential m:n relation between problems and solution approaches, synergies, iterative-incremental approach, development, and communication of long-term solution strategies.
// end::EN[]
7 changes: 2 additions & 5 deletions docs/04-planning/02-learning-goals.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@
[[LZ-4-1]]
==== LZ 4-1: Bewertete Probleme und Lösungsansätze explizit darstellen

Technische oder manuelle Ansätze zur expliziten Darstellung von bewerteten Problemen und Lösungsansätzen kennen
und situationsangemessen auswählen – beispielsweise:
Technische oder manuelle Ansätze zur expliziten Darstellung von bewerteten Problemen und Lösungsansätzen kennen und situationsangemessen auswählen – beispielsweise:

* Issue-Tracker
* Tabellen oder
Expand All @@ -15,6 +14,7 @@ und situationsangemessen auswählen – beispielsweise:
==== LZ 4-2: Typische methodische Ansätze für Verbesserung

* Typische Ansätze für Verbesserung kennen, beispielsweise:

** Langfristige kontinuierliche Verbesserung
** Verbesserungs-Releases
** Application-Strangulation
Expand All @@ -32,7 +32,6 @@ und situationsangemessen auswählen – beispielsweise:

* In einer gegebenen Situation die Effekte (Risiken, Vorteile) der Ansätze „komplette Neuentwicklung (Rewrite)“ gegenüber einer „kontinuierlichen Verbesserung“ einschätzen und argumentieren können.
* Verstehen, dass mangelnde Kenntnis von Details (wie etwa Anforderungen, Details von Algorithmen und Prozessen, Qualitätsszenarien, Implementierungsdetails, technische Abhängigkeiten, betriebliche Prozesse) häufig die Option „Rewrite“ einfacher erscheinen lässt, als sie bei Berücksichtigung dieser Details wäre.

// end::DE[]

// tag::EN[]
Expand Down Expand Up @@ -66,9 +65,7 @@ Know technical or manual approaches to explicitly represent evaluated problems a
==== LG 4-3: Impact of “rewrite” versus “continuous improvement”

* Being able to assess and argue the impact (risks, benefits) of a “complete rewrite” approach in contrast to a “continuous improvement” approach in each situation.

* Understand that lack of details knowledge (e.g., requirements, details of algorithms and processes, quality scenarios, implementation details, technical dependencies, operational processes) often leads to the “rewrite” approach looking simpler as it would be when considering all the details.

// end::EN[]


6 changes: 1 addition & 5 deletions docs/05-approaches/01-duration-terms.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ Strukturelle versus konzeptionelle Verbesserung, Prozess- und Produktverbesserun
Verbesserung in Code, Daten, querschnittlichen Konzepten, Prozessen, Infrastruktur, Analysierbarkeit/Monitoring;
Abbau technischer Schulden, Verbesserungsmaßnahmen für Quellcode: Refactoring, Reduktion von Komplexität und Kopplung,
Erhöhung der Lesbarkeit und Verständlichkeit;Automatisierung von Prozessen zur Senkung von Änderungsrisiken, insbesondere automatisierte Tests.


// end::DE[]

// tag::EN[]
Expand All @@ -21,7 +19,5 @@ Erhöhung der Lesbarkeit und Verständlichkeit;Automatisierung von Prozessen zur

=== Terms and concepts
Structural vs. conceptual improvement, process and product improvement, improvement of code, data, cross-cutting concepts, processes, infrastructure, analyzability/monitoring;
Reduction of technical debts, ways to improve source code: refactoring, reduction of complexity and coupling,
improve readability and comprehensibility; process automation to lower risk of changes, in particular, automated tests.

Reduction of technical debts, ways to improve source code: refactoring, reduction of complexity and coupling, improve readability and comprehensibility; process automation to lower risk of changes, in particular, automated tests.
// end::EN[]
3 changes: 1 addition & 2 deletions docs/06-examples/02-learning-goals.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
// tag::DE[]
[[LZ-6-1]]
==== LZ 6-1: Beispiele für Probleme/Risiken in IT-Systemen

Anhand konkreter Beispiele Probleme und Risiken eines mittleren/großen IT-Systems erkennen und nachvollziehen können.

Dazu sollten in Schulungen mindestens dessen fachliche/funktionale Anforderungen, wesentliche Qualitätsziele, Anwendungs- und Änderungsszenarien, wesentliche Implementierungsstrukturen sowie wesentliche übergreifende Konzepte beschrieben werden.
Expand All @@ -21,7 +22,6 @@ Anhand konkreter Beispiele die (kurz-, mittel- und/oder langfristige) Planung ei
==== LZ 6-4: Verbesserungsmaßnahmen eines realen Systems

Anhand konkreter Beispiele die möglichen oder durchgeführten Verbesserungsmaßnahmen kennenlernen und nachvollziehen können.

// end::DE[]

// tag::EN[]
Expand All @@ -46,7 +46,6 @@ Get to know and understand the (short-, medium- and/or long-term) planning of an
==== LG 6-4: Improvement measures of a real-life system

Get to know and understand the possible or implemented improvement measures based on concrete examples.

// end::EN[]


0 comments on commit b66afd5

Please sign in to comment.