Skip to content

02-learning-goals.adoc

Latest commit

 

History

History
146 lines (93 loc) · 6.67 KB

02-learning-goals.adoc

File metadata and controls

146 lines (93 loc) · 6.67 KB
Raw

{learning-goals}

LZ 2-1: Architekturdokumentation erstellen

Softwarearchitekt:innen können angemessene Architekturdokumentation für mittlere bis große IT-Systeme in beispielsweise folgenden Situationen erstellen:

  • Erstellung neuer Systeme

  • Weiterentwicklung bestehender Systeme mit vorhandener Dokumentation

  • Nachdokumentation bestehender Systeme ohne vorhandene Dokumentation

  • Dokumentation in Ausnahmesituationen (wenig Budget, wenig Zeit, wenig verfügbare Informationsquellen etc.)

Sie können Zielgruppen und Ziele der Dokumentation ermitteln (siehe LZ 2-2).

Details zu den notwendigen methodischen Mitteln finden sich in den Lernzielen LZ 3-1 bis LZ 3-5.

LZ 2-2: Zielgruppen und Ziele der Architekturdokumentation ermitteln

Softwarearchitekt:innen können die Zielgruppen („Stakeholder“) für Architekturdokumentation ermitteln (beispielsweise Management, Entwicklungsteam, fachliche Stakeholder, betriebliche Stakeholder, Test/QS).

Sie können zusammen mit diesen Stakeholdern konkrete Ziele der Dokumentation ermitteln.

LZ 2-3: Passende Struktur für Architekturdokumentation entwerfen

Softwarearchitekt:innen können für gegebene Situationen und Systeme eine passende Struktur für die Architekturdokumentation auswählen oder erarbeiten.

Als Basis dafür dienen Zielgruppen und Ziele (siehe LZ 2-2) sowie Templates (siehe LZ 2-6).

LZ 2-4: Passendes Vorgehen für die Architekturdokumentation definieren

Softwarearchitekt:innen finden für gegebene Situationen ein passendes Vorgehen zur Dokumentation. Sie können Stakeholdern und dem Entwicklungsteam die Vor- und Nachteile verschiedener Ansätze erläutern, etwa:

  • Dokumentation entsteht begleitend zur Entwicklungsarbeit

  • Dokumentation entsteht vor der Entwicklung/Implementierung

  • Dokumentation entsteht nach der Entwicklung („Dokumentations-Sprint“)

  • Dokumentation wird durch Personen aus dem Entwicklungsteam erstellt und gepflegt

  • Dokumentation wird durch Personen außerhalb des Entwicklungsteams erstellt und gepflegt

Sie wissen, dass agile Entwicklung und Architekturdokumentation nicht im Widerspruch zueinander stehen, und können dies Stakeholdern gegenüber begründen.

LZ 2-5: Anwendungsszenarien für GenAI in der Dokumentation identifizieren

Softwarearchitekt:innen wissen, wo und wie der Einsatz von GenAI-Werkzeugen bei Erstellung, Pflege und Nutzung technischer Dokumentation Mehrwert bieten kann. Dies umfasst beispielsweise:

  • Generieren von Dokumentation aus Code-Artefakten

  • Identifizieren und sichern architekturrelevanter Anforderungen

  • Abgleichen bestehender Dokumentation mit Quellcode

  • KI-Modelle als Ersatz für statische Dokumentation einsetzen

  • Informationen aus unstrukturierten oder schwach strukturierten Quellen (z. B. E-Mails, Chatverläufe, Tickets) extrahieren und mit bestehenden Inhalten verknüpfen

  • Einen Chatbot Fragen zu bestehender Dokumentation beantworten lassen (z.B. via RAG)

LZ 2-6: Passende Dokumentations-Templates kennen und kontextgerecht auswählen

Softwarearchitekt:innen kennen Beispiele von Architekturtemplates, etwa:

LG 2-1: Create architecture documentation

Software architects can create appropriate architecture documentation for medium to large IT systems in situations such as the following:

  • Building new systems

  • Ongoing development of existing systems with existing documentation

  • Post-documentation of already existing systems without available documentation

  • Documentation in extraordinary situations (little budget, little time, few available sources of information, etc.)

They can identify target groups and goals of the documentation (see LG 2-2).

Details on the necessary methods can be found in the learning goals LG 3-1 to LG 3-5.

LG 2-2: Identify target audiences and goals of architectural documentation

Software architects can identify the target audiences ("stakeholders") for architecture documentation (e.g. management, development team, business stakeholders, operations stakeholders, test/QA).

They can work together with these stakeholders to identify specific goals for the documentation.

LG 2-3: Define a suitable structure for architecture documentation

Software architects are able to select or develop a suitable structure for architecture documentation for given situations and systems.

Target audiences and goals (see LG 2-2) and templates (see LG 2-6) serve as the basis for this.

LG 2-4: Define a suitable process for architecture documentation

Software architects find a suitable documentation procedures for given situations. They can explain the advantages and disadvantages of different approaches to stakeholders and the development team, such as:

  • Documentation is created alongside development work

  • Documentation is created before development/implementation

  • Documentation is created after development ("documentation sprint")

  • Documentation is created and maintained by people from the development team.

  • Documentation is created and maintained by people outside the development team.

They know that agile development and architecture documentation are not in conflict and can justify this to stakeholders.

LG 2-5: Identify application scenarios for GenAI in documentation

Software architects know where and how the use of GenAI tools can add value in the creation, maintenance, and use of technical documentation. This includes, for example:

  • Generating documentation from code artifacts

  • Identifying and securing architecture-relevant requirements

  • Comparing existing documentation with source code

  • Using AI models as a replacement for static documentation

  • Extracting information from unstructured or weakly structured sources (e.g., emails, chat histories, tickets) and linking it to existing content

  • Having a chatbot answer questions about existing documentation (e.g. via RAG)

LG 2-6: Know and select suitable documentation templates for a given context

Software architects know examples of architecture templates, such as: