Skip to content

Commit

Permalink
Merge pull request #534 from isaqb-org/sw/glossary
Browse files Browse the repository at this point in the history
Add several links to glossary (LG-0{1,2,3}-*)
  • Loading branch information
gernotstarke authored Sep 28, 2024
2 parents 7b41238 + 3b690e6 commit 5dd9e93
Show file tree
Hide file tree
Showing 9 changed files with 27 additions and 27 deletions.
4 changes: 2 additions & 2 deletions docs/01-basics/01-basics-duration-terms.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Architekturdomänen;
{glossary_url}component[Komponenten];
{glossary_url}interface[Schnittstellen];
{glossary_url}relationship[Beziehungen];
Querschnittsthemen;
{glossary_url}cross-cutting-concern[Querschnittsthemen];
Nutzen von Softwarearchitektur;
Softwarearchitekt:innen und deren Verantwortlichkeiten;
Rolle;
Expand Down Expand Up @@ -55,7 +55,7 @@ architecture domains; {glossary_url}structure[structure];
{glossary_url}component[components];
{glossary_url}interface[interfaces];
{glossary_url}relationship[relationships];
{glossary_url}cross-cutting-concerns[cross-cutting-concerns];
{glossary_url}cross-cutting-concern[cross-cutting concerns];
software architects and their responsibilities;
tasks and required skills;
stakeholders and their concerns;
Expand Down
8 changes: 4 additions & 4 deletions docs/01-basics/LZ-01-01.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
Softwarearchitekt:innen kennen die Gemeinsamkeiten vieler Definitionen
von Softwarearchitektur <<iso42010>> <<bass>> <<kruchten>>:

* Komponenten/Bausteine mit Schnittstellen und Beziehungen
* {glossary_url}building-block[Komponenten/Bausteine] mit Schnittstellen und Beziehungen
* Bausteine als allgemeiner Begriff, Komponenten als eine spezielle Ausprägung davon
* Strukturen, Querschnittsthemen, Prinzipien
* Strukturen, {glossary_url}cross-cutting-concern[Querschnittsthemen], Prinzipien
* Architekturentscheidungen und ihre Auswirkungen auf das gesamte System und
seinen Lebenszyklus

Expand All @@ -20,9 +20,9 @@ von Softwarearchitektur <<iso42010>> <<bass>> <<kruchten>>:
Software architects know the commonalities of many definitions of
software architecture <<iso42010>> <<bass>> <<kruchten>>:

* components/building blocks with interfaces and relationships
* {glossary_url}building-block[components/building blocks] with interfaces and relationships
* building blocks as a general term, components as a special form thereof
* structures, cross-cutting concerns, principles
* structures, {glossary_url}cross-cutting-concern[cross-cutting concerns], principles
* architecture decisions and their consequences on the entire systems and its lifecycle

// end::EN[]
4 changes: 2 additions & 2 deletions docs/01-basics/LZ-01-02.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Softwarearchitekt:innen können die folgenden wesentlichen Ziele und Nutzen der
* Entwurf, Implementierung, Pflege und Betrieb von Systemen zu unterstützen
* funktionale Anforderungen zu erreichen bzw. deren Erfüllbarkeit sicherzustellen
* Anforderungen wie Zuverlässigkeit, Wartbarkeit, Änderbarkeit, Sicherheit, Energieeffizienz zu erreichen
* Verständnis für Strukturen und Konzepte des Systems zu vermitteln, bezogen auf sämtliche relevanten Stakeholder
* Verständnis für Strukturen und Konzepte des Systems zu vermitteln, bezogen auf sämtliche relevanten {glossary_url}stakeholder[Stakeholder];
* Komplexität systematisch zu reduzieren
* architekturrelevante Richtlinien für Implementierung und Betrieb zu spezifizieren

Expand All @@ -23,7 +23,7 @@ Software architects can justify the following essential goals and benefits of so
* support the design, implementation, maintenance, and operation of systems
* achieve functional requirements or ensure that they can be met
* achieve requirements such as reliability, maintainability, changeability, security, energy efficiency etc.
* ensure that the system's structures and concepts are understood by all relevant stakeholders
* ensure that the system's structures and concepts are understood by all relevant {glossary_url}stakeholder[stakeholders];
* systematically reduce complexity
* specify architecturally relevant guidelines for implementation and operation

Expand Down
4 changes: 2 additions & 2 deletions docs/01-basics/LZ-01-06.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ die Architektur. Sie

* können Datenmodelle identifizieren, die maßgeblichen Einfluss auf die Architektur haben.
* können solche Datenmodelle systematisch entwerfen.
* verstehen den Unterschied zwischen Produkten und Summen in der
* verstehen den Unterschied zwischen {glossary_url}product[Produkten] und {glossary_url}sum[Summen] in der
Datenmodellierung <<felleisenetal>> <<sperberklaeren>>.
* verstehen die Bedeutung der Entkopplung von Datenmodellen und ihrer Repräsentation in Datenbanken, Dateien und Übertragungsprotokollen.

Expand All @@ -24,7 +24,7 @@ the architecture. They
* can identify data models that have significant impact on the
architecture.
* can design such data models systematically.
* understand the difference between products and sums in data
* understand the difference between {glossary_url}product[products] and {glossary_url}sum[sums] in data
modelling <<felleisenetal>> <<sperberklaeren>>.
* understand the importance of decoupling data models from their representation in databases, files, and transmission protocols.

Expand Down
4 changes: 2 additions & 2 deletions docs/02-requirements/LZ-02-02.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Sie erkennen und berücksichtigen den Einfluss von:

* produktbezogenen Anforderungen wie (R1)
** funktionale Anforderungen
** Qualitätsanforderungen
** {glossary_url}quality-requirement[Qualitätsanforderungen]

* Technologische Randbedingungen wie
** bestehende oder geplante Hardware- und Software-Infrastruktur (R1)
Expand Down Expand Up @@ -55,7 +55,7 @@ They should recognize and account for the impact of:

* product-related requirements such as (R1)
** functional requirements
** quality requirements
** {glossary_url}quality-requirement[quality requirements]

* technological constraints such as
** existing or planned hardware and software infrastructure (R1)
Expand Down
2 changes: 1 addition & 1 deletion docs/03-design/01-design-duration-terms.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ In addition, this section addresses the management of cross-cutting concerns, th
Design; design approach; design decision; views;
{glossary_url}interface[interfaces];
technical and
{glossary_url}cross-cutting-concerns[cross-cutting concerns];
{glossary_url}cross-cutting-concern[cross-cutting concerns];
architectural patterns;
pattern languages;
design principles;
Expand Down
4 changes: 2 additions & 2 deletions docs/03-design/LZ-03-02.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Softwarearchitekt:innen können:
* Softwarearchitekturen auf Basis bekannter funktionaler und Qualitätsanforderungen für nicht sicherheits- oder unternehmenskritische Softwaresysteme entwerfen und angemessen kommunizieren und dokumentieren
* Strukturentscheidungen hinsichtlich Systemzerlegung und Bausteinstruktur treffen, dabei Abhängigkeiten zwischen Bausteinen festlegen (siehe <<LG-03-06>>)
* gegenseitige Abhängigkeiten und Abwägungen bezüglich Entwurfsentscheidungen erkennen und begründen
* Begriffe _Blackbox_ und _Whitebox_ erklären und zielgerichtet anwenden
* Begriffe {glossary_url}blockbox[Blackbox] und {glossary_url}whitebox[Whitebox] erklären und zielgerichtet anwenden
* schrittweise Verfeinerung und Spezifikation von Bausteinen durchführen
* Architektursichten entwerfen, insbesondere Baustein-, Laufzeit- und Verteilungssicht (siehe <<LG-04-05>>, <<kruchten95>>, <<rozanskiwoods>>, <<starkelorz>>, <<arc42>>, <<brownc4>>)
* die aus diesen Entscheidungen resultierenden Konsequenzen auf den Quellcode erklären
Expand All @@ -26,7 +26,7 @@ Software architects are able to:
* design and appropriately communicate and document software architectures based upon known functional and quality requirements for software systems that are neither safety- nor business-critical
* make structure-relevant decisions regarding system decomposition and building-block structure and deliberately design dependencies between building blocks (see <<LG-03-06>>)
* recognize and justify interdependencies and trade-offs of design decisions
* explain the terms _black box_ and _white box_ and apply them purposefully
* explain the terms {glossary_url}blockbox[black box] and {glossary_url}whitebox[white box] and apply them purposefully
* apply stepwise refinement and specify building blocks
* design architecture views, especially building-block view, runtime view and deployment view (see <<LG-04-05>>, <<kruchten95>>, <<rozanskiwoods>>, <<starkelorz>>, <<arc42>>, <<brownc4>>)
* explain the consequences of these decisions on the corresponding source code
Expand Down
20 changes: 10 additions & 10 deletions docs/03-design/LZ-03-04.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ Softwarearchitekt:innen sind in der Lage:

**Modularisierung** (R1)

* Geheimnisprinzip (Information Hiding) und Kapselung (R1)
* Trennung von Verantwortlichkeiten (Separation of Concerns - SoC) (R1)
* Geheimnisprinzip ({glossary_url}information-hiding[Information Hiding]) und {glossary_url}encapsulation[Kapselung] (R1)
* Trennung von Verantwortlichkeiten ({glossary_url}separation-of-concern[Separation of Concerns] - SoC) (R1)
* Lose, aber funktionell ausreichende Kopplung (R1) von Bausteinen, siehe <<LG-03-06>>
* Hohe Kohäsion (R1)
* Offen/geschlossen-Prinzip (R1)
* Dependency-Inversion-Prinzip (R1) - Umkehrung von Abhängigkeiten durch Schnittstellen oder ähnlichen Abstraktionen
* Hohe {glossary_url}cohesion[Kohäsion] (R1)
* {glossary_url}open-close-principle[Offen/geschlossen-Prinzip] (R1)
* {glossary_url}dependency-inversion[Dependency-Inversion-Prinzip] (R1) - Umkehrung von Abhängigkeiten durch Schnittstellen oder ähnlichen Abstraktionen

**Konzeptionelle Integrität** (R2)

Expand Down Expand Up @@ -70,12 +70,12 @@ Software architects are able to:

**Modularization** (R1-R3)

* information hiding and encapsulation (R1)
* separation of concerns - SoC (R1)
* {glossary_url}information-hiding[information hiding] and {glossary_url}encapsulation[encapsulation] (R1)
* {glossary_url}separation-of-concern[separation of concerns] - SoC (R1)
* loose, but functionally sufficient, coupling (R1) of building blocks, see <<LG-03-06>>
* high cohesion (R1)
* Open/closed principle (R1)
* Dependency inversion principle (R1) by means of interfaces or similar abstractions
* high {glossary_url}cohesion[cohesion] (R1)
* {glossary_url}open-close-principle[Open/closed principle] (R1)
* {glossary_url}dependency-inversion[Dependency inversion principle] (R1) by means of interfaces or similar abstractions

**Conceptual integrity** (R2)

Expand Down
4 changes: 2 additions & 2 deletions docs/03-design/LZ-03-10.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

Softwarearchitekt:innen können:

* die Bedeutung von Querschnittsthemen (synonym: Belange, Anliegen) erklären
* die Bedeutung von {glossary_url}cross-cutting-concern[Querschnittsthemen] (synonym: Belange, Anliegen) erklären
* solche Querschnittsthemen identifizieren
* Querschnittskonzepte entwerfen, unter anderem Persistenz, Kommunikation, GUI, Fehlerbehandlung, Nebenläufigkeit, Energieeffizienz
* mögliche wechselseitige Abhängigkeiten erkennen und beurteilen.
Expand All @@ -21,7 +21,7 @@ Siehe auch <<LG-04-07>>.

Software architects are able to:

* explain the significance of such cross-cutting concerns
* explain the significance of such {glossary_url}cross-cutting-concern[cross-cutting concerns]
* identify such cross-cutting concerns
* design cross-cutting concepts, for example persistence, communication, GUI, error handling, concurrency, energy efficiency
* identify and assess potential interdependencies.
Expand Down

0 comments on commit 5dd9e93

Please sign in to comment.