Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#404 LG 04-05 architectural views #467

Merged
merged 3 commits into from
Jul 22, 2024
Merged

#404 LG 04-05 architectural views #467

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6c050ff
#404, LG-04-05: merge content of LG-04-06 into this one, remove old L…
gernotstarke Jul 22, 2024
d1bc05a
#404: squeeze numbering of LGs in this group
gernotstarke Jul 22, 2024
a6a6449
#404: added references for LG-04-05
gernotstarke Jul 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions docs/04-documentation/00-documentation.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,4 @@ include::./LZ-04-08.adoc[{include_configuration}]

include::./LZ-04-09.adoc[{include_configuration}]

include::./LZ-04-10.adoc[{include_configuration}]

include::./99-documentation-references.adoc[tags={bibrefs}]
2 changes: 1 addition & 1 deletion docs/04-documentation/99-documentation-references.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
// tag::BIB_REFS[]
=== {references}

<<arc42>>, <<archimate>>, <<bass>>, <<brownc4>>, <<clementsdoc>>, <<fmc>>, <<gharbietal>>, <<starkelorz>>, <<nygard>>, <<starke>>, <<uml>>, <<zoerner>>
<<arc42>>, <<archimate>>, <<bass>>, <<brownc4>>, <<clementsdoc>>, <<fmc>>, <<gharbietal>>, <<kruchten95>>, <<starkelorz>>, <<nygard>>, <<starke>>, <<uml>>, <<zoerner>>

// end::BIB_REFS[]
12 changes: 10 additions & 2 deletions docs/04-documentation/LZ-04-05.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
// tag::DE[]
[[LZ-04-05]]
==== LZ 04-05 [ehemaliges LZ 3-04]: Architektursichten erläutern und anwenden (R1)
Softwarearchitekt:innen können folgende Architektursichten anwenden:
Softwarearchitekt:innen können folgende Architektursichten anwenden (siehe <<kruchten95>>, <<rozanskiwoods>>, <<starkelorz>>, <<arc42>>, <<brownc4>>):

* Kontextsicht (auch genannt Kontextabgrenzung)
** z.{nbsp}B. in Form von Kontextdiagrammen mit Erläuterungen darstellen
** externe Schnittstellen von Systemen in der Kontextabgrenzung darstellen
** fachlichen und technischen Kontext differenzieren

* Baustein- oder Komponentensicht (Aufbau des Systems aus Softwarebausteinen)
* Laufzeitsicht (dynamische Sicht, Zusammenwirken der Softwarebausteine zur Laufzeit, Zustandsmodelle)
* Verteilungs-/Deploymentsicht (Hardware und technische Infrastruktur sowie Abbildung von Softwarebausteinen auf diese Infrastruktur)
Expand All @@ -13,11 +17,15 @@ Softwarearchitekt:innen können folgende Architektursichten anwenden:
// tag::EN[]
[[LG-04-05]]
==== LG 04-05 [previously LG 3-04]: Explain and Use Architectural Views (R1)
Software architects are able to use the following architectural views:
Software architects are able to use the following architectural views (see <<kruchten95>>, <<rozanskiwoods>>, <<starkelorz>>, <<arc42>>, <<brownc4>>):

* context view
** depict the context of systems, e.g. in the form of context diagrams with explanations
** represent external interfaces of systems in the context view
** differentiate business and technical context
* building block or component view (composition of software building blocks)
* runtime view (dynamic view, interaction between software building blocks at runtime, state machines)
* deployment view (hardware and technical infrastructure as well as the mapping of software building blocks onto the infrastructure)

// end::EN[]

14 changes: 4 additions & 10 deletions docs/04-documentation/LZ-04-06.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,16 @@

// tag::DE[]
[[LZ-04-06]]
==== LZ 04-06 [ehemaliges LZ 3-05]: Kontextabgrenzung von Systemen erläutern und anwenden (R1)
Softwarearchitekt:innen können:
==== LZ 04-06 [ehemaliges LZ 3-07]: Schnittstellen dokumentieren (R1)

* Kontext von Systemen z.{nbsp}B. in Form von Kontextdiagrammen mit Erläuterungen darstellen
* externe Schnittstellen von Systemen in der Kontextabgrenzung darstellen
* fachlichen und technischen Kontext differenzieren.
Softwarearchitekt:innen können sowohl interne als auch externe Schnittstellen dokumentieren und spezifizieren.

// end::DE[]

// tag::EN[]
[[LG-04-06]]
==== LG 04-06 [previously LG 3-05]: Explain and Apply Context View of Systems (R1)
Software architects are able to:
==== LG 04-06 [previously LG 3-07]: Document Interfaces (R1)

* depict the context of systems, e.g. in the form of context diagrams with explanations
* represent external interfaces of systems in the context view
* differentiate business and technical context.
Software architects are able to document and specify both internal and external interfaces.

// end::EN[]
13 changes: 9 additions & 4 deletions docs/04-documentation/LZ-04-07.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,21 @@


// tag::DE[]
[[LZ-04-07]]
==== LZ 04-07 [ehemaliges LZ 3-07]: Schnittstellen dokumentieren (R1)
==== LZ 04-07 [ehemaliges LZ 3-06]: Querschnittsthemen dokumentieren und kommunizieren (R2)

Softwarearchitekt:innen können sowohl interne als auch externe Schnittstellen dokumentieren und spezifizieren.
Softwarearchitekt:innen können typische Querschnittsthemen (synonym
_Querschnittskonzepte_, _Aspekte_) adäquat dokumentieren und kommunizieren,
z.{nbsp}B. Persistenz, Ablaufsteuerung, UI, Verteilung/Integration, Protokollierung.

// end::DE[]

// tag::EN[]
[[LG-04-07]]
==== LG 04-07 [previously LG 3-07]: Document Interfaces (R1)
==== LG 04-07 [previously LG 3-06]: Document and Communicate Cross-Cutting Concerns (R2)

Software architects are able to document and specify both internal and external interfaces.
Software architects are able to adequately document and communicate
typical cross-cutting concerns (synonym: _cross-cutting concepts_, _aspects_),
e. g., persistence, workflow management, UI, deployment/integration, logging.

// end::EN[]
22 changes: 13 additions & 9 deletions docs/04-documentation/LZ-04-08.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,25 @@


// tag::DE[]
[[LZ-04-08]]
==== LZ 04-08 [ehemaliges LZ 3-06]: Querschnittsthemen dokumentieren und kommunizieren (R2)
==== LZ 04-08 [ehemaliges LZ 3-08]: Architekturentscheidungen erläutern und dokumentieren (R1-R2)

Softwarearchitekt:innen können:

Softwarearchitekt:innen können typische Querschnittsthemen (synonym
_Querschnittskonzepte_, _Aspekte_) adäquat dokumentieren und kommunizieren,
z.{nbsp}B. Persistenz, Ablaufsteuerung, UI, Verteilung/Integration, Protokollierung.
* Architekturentscheidungen systematisch herbeiführen, begründen, kommunizieren und dokumentieren
* gegenseitige Abhängigkeiten solcher Entscheidungen erkennen, kommunizieren und dokumentieren

Softwarearchitekt:innen kennen Architecture-Decision-Records (ADR, siehe <<nygard>>) und können diese zur Dokumentation von Entscheidungen einsetzen (R2).
// end::DE[]

// tag::EN[]
[[LG-04-08]]
==== LG 04-08 [previously LG 3-06]: Document and Communicate Cross-Cutting Concerns (R2)
==== LG 04-08 [previously LG 3-08]: Explain and Document Architectural Decisions (R1-R2)

Software architects are able to:

* systematically take, justify, communicate, and document architectural decisions
* identify, communicate, and document interdependencies between design decisions

Software architects are able to adequately document and communicate
typical cross-cutting concerns (synonym: _cross-cutting concepts_, _aspects_),
e. g., persistence, workflow management, UI, deployment/integration, logging.
Software architects know about Architecture-Decision-Records (ADR, see <<nygard>>) and can apply these to document decisions (R2).

// end::EN[]
29 changes: 18 additions & 11 deletions docs/04-documentation/LZ-04-09.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,32 @@

// tag::DE[]
[[LZ-04-09]]
==== LZ 04-09 [ehemaliges LZ 3-08]: Architekturentscheidungen erläutern und dokumentieren (R1-R2)
==== LZ 04-09 [ehemaliges LZ 3-09]: Weitere Hilfsmittel und Werkzeuge zur Dokumentation kennen (R3)

Softwarearchitekt:innen können:
Softwarearchitekt:innen kennen:

* Architekturentscheidungen systematisch herbeiführen, begründen, kommunizieren und dokumentieren
* gegenseitige Abhängigkeiten solcher Entscheidungen erkennen, kommunizieren und dokumentieren
* Grundlagen mehrerer publizierter Frameworks zur Beschreibung von Softwarearchitekturen, beispielsweise:
** ISO/IEC/IEEE 42010, siehe <<iso42010>>
** arc42, siehe <<arc42>>
** C4, siehe <<brownc4>>
** FMC, siehe <<fmc>>
* Ideen und Beispiele von Checklisten für die Erstellung, Dokumentation und Prüfung von Softwarearchitekturen
* mögliche Werkzeuge zur Erstellung und Pflege von Architekturdokumentation

Softwarearchitekt:innen kennen Architecture-Decision-Records (ADR, siehe <<nygard>>) und können diese zur Dokumentation von Entscheidungen einsetzen (R2).
// end::DE[]

// tag::EN[]
[[LG-04-09]]
==== LG 04-09 [previously LG 3-08]: Explain and Document Architectural Decisions (R1-R2)
==== LG 04-09 [previously LG 3-09]: Know Additional Resources and Tools for Documentation (R3)

Software architects are able to:
Software architects know:

* systematically take, justify, communicate, and document architectural decisions
* identify, communicate, and document interdependencies between design decisions

Software architects know about Architecture-Decision-Records (ADR, see <<nygard>>) and can apply these to document decisions (R2).
* basics of several published frameworks for the description of software architectures, for example:
** ISO/IEC/IEEE 42010, see <<iso42010>>
** arc42, see <<arc42>>
** C4, see <<brownc4>>
** FMC, see <<fmc>>
* ideas and examples of checklists for the creation, documentation, and testing of software architectures
* possible tools for creating and maintaining architectural documentation

// end::EN[]
32 changes: 0 additions & 32 deletions docs/04-documentation/LZ-04-10.adoc
View file
Open in desktop

This file was deleted.

Loading