Skip to content

Commit

Permalink
Merge pull request #4 from isaqb-org/translate_to_english
Browse files Browse the repository at this point in the history
add english translation
  • Loading branch information
ebbing authored Oct 25, 2023
2 parents 4b42c5d + 246e415 commit 0e768b4
Show file tree
Hide file tree
Showing 32 changed files with 553 additions and 292 deletions.
12 changes: 11 additions & 1 deletion README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,23 @@ This is <<copyrighted,copyrighted work>>.
== Content
This repository contains the examination regulations and criteria for the iSAQB^®^ CPSA^®^ Expert Level in AsciiDoc.

== How to clone the project
The project uses Git Modules. So, don't forget to clone the repository with the option --recursive.

If you forgot the option --recursive, you can load the Git Modules with this command
[source,console]
$ git submodule update --init

== How to contribute or participate
Create an issue, a merge- or pull-request

== How to build the documents
Prerequisite: You need a Java Runtime(tm) installed.

You build the output documents with gradle.
You build the output documents with gradle:
[source,console]
$ ./gradlew buildDocs

That will produce both pdf and html output in German (DE) _and_ English (EN), unless you modify the configuration.

In case you want to change that, adjust the following part of `build.gradle`:
Expand Down
75 changes: 64 additions & 11 deletions docs/01-definitions/01-involved-parties.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,12 @@
| Advanced-Level-Architekt:in, der/die das Expert-Level-Zertifikat CPSA-E anstrebt

| iSAQB
| Der iSAQB e. V. stellt folgende Artefakte zur Verfügung:
- Liste (offener) Themen, auf Website
- Jahresbuch (sammelt, bindet, publiziert, übersetzt Papers, die in den Themenarbeitsgruppen final bearbeitet wurden)
- abgeschlossene Themen zum Download
- Webseite zur Anmeldung für EL-Bewerber:innen
a| Der iSAQB e. V. stellt folgende Artefakte zur Verfügung:

* Liste (offener) Themen, auf Website
* Jahresbuch (sammelt, bindet, publiziert, übersetzt Papers, die in den Themenarbeitsgruppen final bearbeitet wurden)
* Abgeschlossene Themen zum Download
* Webseite zur Anmeldung für EL-Bewerber:innen

| iSAQB AG Expert Level
| Arbeitsgruppe zum Expert Level im iSAQB. +
Expand All @@ -22,14 +23,15 @@ Die Arbeitsgruppe organisiert und überwacht die Durchführung der Prozesse.
| Prüfer:in
| Prüfer:innen arbeiten für die Zertifizierer und prüfen die Ergebnisse einer Themenarbeitsgruppe.
Die AG Expert Level stellt den Zertifizierern Prüfer:innen aus der eigenen Arbeitsgruppe zur Verfügung.
Auch andere iSAQB-Mitglieder kön- nen sich als Prüfer:innen melden und werden zu diesem Zweck in die AG Expert Level aufgenommen.
Auch andere iSAQB-Mitglieder können sich als Prüfer:innen melden und werden zu diesem Zweck in die AG Expert Level aufgenommen.

Prüfer:innen müssen folgende Eigenschaften haben:
- Sie sind Mitglieder der AG Expert Level.
- Sie sind anerkannte Expert:innen in der Softwarearchitektur.
- Sie haben breites und tiefes Wissen im Bereich der Softwarearchitektur.
- Sie arbeiten auf Honorarbasis als Prüfer:innen.
- Sie verfügen über ausreichend Zeit, um ihrer Arbeit als Prüfer:innen nachzugehen.

* Sie sind Mitglieder der AG Expert Level.
* Sie sind anerkannte Expert:innen in der Softwarearchitektur.
* Sie haben breites und tiefes Wissen im Bereich der Softwarearchitektur.
* Sie arbeiten auf Honorarbasis als Prüfer:innen.
* Sie verfügen über ausreichend Zeit, um ihrer Arbeit als Prüfer:innen nachzugehen.

| Themenarbeitsgruppe
| Arbeitsgruppe, die gebildet wird, um ein EL-Thema auszuarbeiten.
Expand Down Expand Up @@ -59,5 +61,56 @@ Er/sie ist aktives Mitglied des iSAQB.

// tag::EN[]
=== Involved Parties
People involved in the examination process

[cols="<3,<7a"]
|===
|Name of the role | Description, position, task

| Expert Level Candidate
|Advanced-Level architect aiming for the Expert Level certificate CPSA-E

| iSAQB
| iSAQB e. V. makes the following artifacts available:

- List of (open) topics, on the website
- Yearbook (collects, binds, publishes, and translates papers that were finally worked on in the topic working groups)
- Completed topics for download
- Website for registration for EL candidates

| iSAQB Expert Level WG
| Working group for the Expert Level at iSAQB

The working group organizes and oversees the implementation of the processes.

| Examiner
| Examiners work for the certifying body and assess the results of a topic working group. The Expert Level WG provides the certifying body with examiners from its own working group. Other iSAQB members can also register as examiners and are included in the Expert Level WG for this purpose.
Examiners must have the following characteristics:

- They are members of the Expert Level WG.
- They are recognized experts in software architecture.
- They have extensive and in-depth knowledge in the field of software architecture.
- They work as examiners on a fee basis.
- They have sufficient time to perform their work as examiners.

| Topic working group
| Working group formed to work on an EL topic. The topic working group is composed of accepted candidates for a topic.

| Person submitting a topic
| Submits a (possible) topic, which should be worked on within the scope of an Expert Level certification.

| Topic moderator
| Each topic working group is guided by a topic moderator. They guide the topic working group, take delivery of the roadmap, answer questions, and assess the results based on formal criteria. They may organize rooms and presentation materials for in-person meetings.

| Topic administrator
| The topic administrator checks new topics and manages topics in the list of topics. They are an active member of iSAQB.

| Training provider
| Training providers are “training facilitators” accredited by iSAQB who appoint the topic moderator.

| Certifying body
| Certifying bodies are institutes accredited by iSAQB that organize the examination of a topic working group’s results and issue the CPSA Expert Level certificate.

|===

// end::EN[]
11 changes: 11 additions & 0 deletions docs/02-examination-information/01-purpose-intent.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,17 @@ berufliche Zukunft auf.

// tag::EN[]
=== Purpose and Intent
During the CPSA-E, you and other candidates bring together experience-based knowledge from your project work. Together, you supplement this with additional expert knowledge, research, and a discussion between yourselves. You then present this knowledge via publications within the scope of the CPSA-E. You thus actively help to disseminate expert knowledge and improve software quality through your contribution, even in other projects.

The topics were submitted in advance via the iSAQB website. Following approval by the topic admin-
istrator, the topics are available to be worked on.

=== Objectives
- You show that you are an expert in a specialist field of software architecture.
- You develop new knowledge with other experts.
- You show the ability to work in a team.
- You interact with other experts, thereby building a network for your professional future.
- You present the results at conferences or publish them in trade magazines.

// end::EN[]

4 changes: 4 additions & 0 deletions docs/02-examination-information/02-preconditions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ Die Praxiserfahrung muss nicht nachgewiesen werden, da sie schon Voraussetzung f

// tag::EN[]
=== Preconditions
As a qualification requirement, an Expert Level candidate must have successfully acquired the iSAQB Advanced-Level certification. There are no other qualification requirements. However, you should have extensive project experience and in-depth knowledge in the field of your chosen software architecture
topic, which you would like to work on with the topic working group.

The practical experience does not need to be proven as it is already a requirement for the iSAQB Foundation and Advanced-Level certifications. There is also no minimum amount of time that must have passed between the Advanced and the Expert Level certification.

// end::EN[]

Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ Die Begründung muss dem/der Themenmoderator:in vorliegen und diese:r muss sie a

// tag::EN[]
=== Examination Duration

The topic working group has 12 months from the first meeting with the topic moderator to submit the results to the certifying body for the first time. A period of 3 to 9 months is recommended. With valid justification, the topic working group can extend the period by individual months. The justification must be submitted to and accepted by the topic moderator.

// end::EN[]
6 changes: 6 additions & 0 deletions docs/02-examination-information/04-examination-costs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ oder Extrakosten durch Nachbesserungen, sind nicht inkludiert und selbstorganisa

// tag::EN[]
=== Examination Costs
The costs of certification at the Expert Level comprise the costs for the selected topic moderator and the certification body. The prices can vary depending on the size of the group. Rough cost estimate for the whole topic working group:

- Costs for certification body: € 2600
- Costs for the topic moderator: approx. € 8000 (quotations for the training providers accredited for the EL can vary)
- Possible additional costs, e.g., for travel within the scope of the collaboration or extra costs due to corrections are not included and are to be borne by the topic working group itself.



// end::EN[]
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Der/Die Themenmoderator:in nimmt die Ergebnisse formell ab und leitet sie an den
// end::DE[]

// tag::EN[]
=== Examination Registration

=== Registration for the Examination
The topic working group seeks and engages the certifying body and informs the topic moderator about the chosen certifying body. You can find available certifying bodies under “Certification bodies” on the iSAQB website. The topic moderator formally accepts the results and passes them on to the certifying body.

// end::EN[]
3 changes: 1 addition & 2 deletions docs/03-examination-procedure/00-structure.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,4 @@ include::02-select-topic.adoc[{include_configuration}]
include::03-assemble-working-group.adoc[{include_configuration}]
include::04-book-trainings-provider.adoc[{include_configuration}]
include::05-create-roadmap.adoc[{include_configuration}]
include::06-symposia.adoc[{include_configuration}]
include::07-papers.adoc[{include_configuration}]
include::06-develop-topic.adoc[{include_configuration}]
10 changes: 8 additions & 2 deletions docs/03-examination-procedure/01-submit-topic.adoc
Original file line number Diff line number Diff line change
@@ -1,15 +1,21 @@
// tag::DE[]
=== Thema einreichen
=== Thema einreichen (optional)
Die Einreichung eines Themas erfolgt auf der Website des iSAQB mittels eines Formulars.
Der/die Themenverwalter:in prüft das eingereichte Thema inhaltlich und formell innerhalb eines Monats.
Bei Akzeptanz gibt er/sie das Thema frei.
Das Thema steht dann auf der Website des iSAQB für die Bewerbung zur Verfügung.
Sollte ein Thema abgelehnt werden, kann es nachgebessert und dem/der Themenverwalter:in erneut vorgelegt werden.

include::../05-criteria/02-criteria-new-topic.adoc[{include_configuration}]

// end::DE[]

// tag::EN[]
=== Submit Topic
=== Submit Topic (optional)
The submission of a topic takes place on the iSAQB website via a form. The topic administrator assesses the submitted topic formally and in terms of content within one month. On acceptance, they approve the topic. The topic is then available for application on the iSAQB website. If a topic is rejected, it can be improved and submitted to the topic administrator again.

include::../05-criteria/02-criteria-new-topic.adoc[{include_configuration}]

// end::EN[]


6 changes: 3 additions & 3 deletions docs/03-examination-procedure/02-select-topic.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
// tag::DE[]
=== Thema auswählen
=== Schritt 1: Thema auswählen
Bewerber:innen können sich auf freigegebene Themen bewerben. Die Bewerbung erfolgt über die Website des iSAQB und erfordert die Mindestvoraussetzungen für die Teilnahme am CPSA-E. Wenn die Themenarbeitsgruppe ihre Ziel-Gruppengröße erreicht hat, kann sie ihre Arbeit aufnehmen.
// end::DE[]

// tag::EN[]
=== Select Topic

=== Step 1: Select Topic
Candidates can apply for approved topics. The application takes place via the iSAQB website and must fulfill the minimum requirements for participation in the CPSA-E. Once the topic working group has reached its target group size, it can begin its work.

// end::EN[]
9 changes: 5 additions & 4 deletions docs/03-examination-procedure/03-assemble-working-group.adoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
// tag::DE[]
=== Themenarbeitsgruppe zusammenstellen
Der/Die Themenverwalter:in sorgt dafür, dass entsprechend der Themeneinreichung ausreichend Bewerber:innen in der Themenarbeitsgruppe sind. Diese Aufgabe muss er/sie nicht allein durch- führen, sondern kann sich die Hilfe der sich bereits in der Themenarbeitsgruppe befindlichen Be- werber:innen zunutze machen. Die Themenarbeitsgruppe darf gern für das Thema im Kolleg:in- nen- und Bekanntenkreis werben. Auch das iSAQB wird regelmäßig auf offene Themen aufmerksam machen und für eine Teilnahme werben. (_Dieser Punkt wird noch in der AG weiter diskutiert. Eventuell ändert sich Formulierung nochmal._)
=== Schritt 2: Themenarbeitsgruppe zusammenstellen
Der/Die Themenverwalter:in sorgt dafür, dass entsprechend der Themeneinreichung ausreichend Bewerber:innen in der Themenarbeitsgruppe sind. Diese Aufgabe muss er/sie nicht allein durchführen, sondern kann sich die Hilfe der sich bereits in der Themenarbeitsgruppe befindlichen Bewerber:innen zunutze machen. Die Themenarbeitsgruppe darf gern für das Thema im Kolleg:innen- und Bekanntenkreis werben. Auch das iSAQB wird regelmäßig auf offene Themen aufmerksam machen und für eine Teilnahme werben.

Sobald genug Bewerber:innen für die Themenarbeitsgruppe vorhanden sind, informiert der/die Themenverwalter:in über den Start der Themenarbeitsgruppe und schickt die Kontaktdaten aller Mitglieder an die Themenarbeitsgruppe.

// end::DE[]

// tag::EN[]
=== Assemble Working Group

=== Step 2: Assemble Topic Working Group
The topic administrator ensures that there are sufficient candidates in the topic working group according to the topic submission. They do not need to perform this task alone, but can take advantage of assistance from the candidates already in the topic working group. The topic working group is welcome to promote the topic among colleagues and acquaintances. iSAQB will also regularly draw attention to open topics and encourage participation.

As soon as enough candidates for the topic working group are available, the topic administrator informs about the start of the topic working group and sends all the members` contact details to the topic working group.
// end::EN[]
6 changes: 3 additions & 3 deletions docs/03-examination-procedure/04-book-trainings-provider.adoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
// tag::DE[]
=== Trainingsprovider mit Themenmoderator:in bestellen
=== Schritt 3: Trainingsprovider mit Themenmoderator:in bestellen
Die Themenarbeitsgruppe holt Angebote von Trainingsprovidern ein und wählt einen für sie passenden aus.
Der Trainingsprovider stellt eine:n Themenmoderator:in bereit.
Diese:r begleitet die Themenarbeitsgruppe durch den gesamten Arbeitsprozess und gibt Arbeitsschritte frei.

// end::DE[]

// tag::EN[]
=== Book Trainings Provider

=== Step 3: Appoint Trainings Provider with Topic Moderator
The topic working group obtains offers from training providers and selects an appropriate one for them. The training provider makes a topic moderator available. This topic moderator guides the topic working group through the entire working process and approves working steps.

// end::EN[]
48 changes: 8 additions & 40 deletions docs/03-examination-procedure/05-create-roadmap.adoc
Original file line number Diff line number Diff line change
@@ -1,55 +1,23 @@
// tag::DE[]
=== Roadmap erstellen
=== Schritt 4: Roadmap erstellen
Die Themenarbeitsgruppe erstellt eine Roadmap, in der sie inhaltlich und zeitlich ihren Plan für ihr Vorgehen verschriftlicht.
Der/die Themenmoderator:in kann hierbei unterstützen.
Schließlich wird die Roadmap bei dem/der Themenmoderator:in eingereicht, welche:r diese anhand festgelegter Kriterien überprüft.

==== Kriterien für die Abnahme der Roadmap
[cols="<3,<1,<7a"]
|===
| Kriterium | Pflicht | Beschreibung

| Ziel, Mission
| Muss
| - Sind Ziel und Mission der Themenarbeitsgruppe verständlich beschrieben?

| Themenarbeitsgruppe
| Muss
| - Sind die Kontaktdaten aller Mitglieder der Themenarbeitsgruppe angeführt?

| Vorgehensweise
| Muss
|- Werden die Rollen und Aufgaben der Mitglieder der Themenarbeitsgruppe beschrieben?
- Ist ein Zeitplan mit Meilensteinen vorhanden?
- Sind die Zeiten und Orte für die optionalen persönlichen Treffen angeführt?
- Sind die Zeiten und Mittel für die virtuellen Treffen angeführt?
- Werden die Werkzeuge für die elektronische Kommunikation aufgelistet?
- Sind Arbeitspakete und Zuständigkeiten definiert?
- Ist der Review-Prozess bestimmt?

| Literatur
| Muss
| - Gibt es eine Literaturliste?
- Umfasst die Literaturliste mindestens 7 Quellen?
- Sind die Quellen von wissenschaftlichem Wert?

| Ergebnisse
| Muss
| - Wird der verpflichtende Artikel diskutiert?
- Wird zumindest ein weiteres Ergebnis angeführt (z.{nbsp}B. Anleitung, Beispiel, ...)?
- Wird für jedes Ergebnis die Form und Struktur behandelt?
- Versucht die Themenarbeitsgruppe, die Ergebnisse bei mindestens einer Konferenz zu präsentieren?
- Versucht die Themenarbeitsgruppe, die Ergebnisse in zumindest einer Fachzeitschrift zu publizieren?

|===
include::../05-criteria/05-criteria-roadmap.adoc[{include_configuration}]

Gibt der/die Themenmoderator:in die Roadmap frei, kann die Themenarbeitsgruppe mit der Umsetzung beginnen.
Bei Ablehnung der Roadmap hat die Themenarbeitsgruppe einen weiteren Versuch, die Roadmap zu verbessern und erneut abzugeben.

// end::DE[]

// tag::EN[]
=== Create Roadmap
=== Step 4: Create Roadmap
The topic working group creates a roadmap, in which they put down in writing their plan for their procedure in terms of content and timescale. The topic moderator can provide assistance here. The roadmap is ultimately submitted to the topic moderator, who assesses this based on specified criteria.

include::../05-criteria/05-criteria-roadmap.adoc[{include_configuration}]

If the topic moderator approves the roadmap, the topic working group can begin with implementation. If the roadmap is rejected, the topic working group has one further attempt to improve and re-submit the roadmap.


// end::EN[]
19 changes: 19 additions & 0 deletions docs/03-examination-procedure/06-develop-topic.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
// tag::DE[]
=== Schritt 5: Thema ausarbeiten
Die Themenarbeitsgruppe kommt zu Symposien zusammen, wo sie sich gemeinsam abstimmt und Aufgaben aus der Roadmap erarbeitet.
Dabei wird sie von dem/der Themenmoderator:in unterstützt. Symposien können auch online durchgeführt werden.

Die Themenarbeitsgruppe trägt ihre Erfahrung zu dem gewählten Thema zusammen, konsolidiert dieses und leitet daraus neue Erkenntnisse ab.
Zu den nötigen Ausarbeitungen gehören Erhebungen von Daten, Literaturrecherchen oder Verschriftlichungen.
Themenarbeitsgruppen wird empfohlen, ihre Ergebnisse auf Konferenzen oder Fachzeitschriften zu veröffentlichen.
Das iSAQB wird die Veröffentlichungen unterstützen und fördern.

// end::DE[]

// tag::EN[]
=== Step 5: Develop Topic
The topic working group comes together for meetings, where they coordinate with each other and work on tasks from the roadmap. They are supported in this by the topic moderator. Meetings can also be held online.

The topic working group brings together its experience on the selected topic, consolidates it, and derives new insights from it. The necessary work includes collection of data, literature research or writing. It is recommended that topic working groups publish their results at conferences or in professional journals. iSAQB will support and promote the publications.

// end::EN[]
12 changes: 0 additions & 12 deletions docs/03-examination-procedure/06-symposia.adoc

This file was deleted.

14 changes: 0 additions & 14 deletions docs/03-examination-procedure/07-papers.adoc

This file was deleted.

Loading

0 comments on commit 0e768b4

Please sign in to comment.