Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Wirkungsvolle Architekturdokumentionen

Wirkungsvolle Architekturdokumentionen

Armin Weißer

March 02, 2018
Tweet

More Decks by Armin Weißer

Other Decks in Programming

Transcript

  1. www.iTernity.com 1 Architekturdokumentation - Einführung  Die DSGVO gilt für

    die Datenverarbeitung im Rahmen von Tätigkeiten einer Niederlassung eines Data Controllers oder Data Processors auf dem Gebiet der Europäischen Union  Entscheidend ist der Ort der Niederlassung, nicht der Ort der Datenverarbeitung  Die DSGVO gilt auch für den „Marktort“ EU: für Datenverarbeitungen, die dazu dienen, Waren und Dienstleistungen innerhalb der EU anzubieten Grundprinzipien der DSGVO Wirkungsvolle Architektur- Dokumentationen Überblick und Einführung [email protected]
  2. www.iTernity.com 3 Architekturdokumentation - Einführung Was wollen wir heute machen?

    1. Aufbau der Dokumentation 2. Dokumentationsmittel 3. Hands on! 4. Ausblick
  3. www.iTernity.com 4 Architekturdokumentation - Einführung Architektur-Überblick Aufbau der Dokumentation Rolling

    updates High automation SLA’s Highly available • Produkt-Karton • Systemkontext • Qualitätsziele • Randbedingungen Problemstellung • Architekturansätze • Architekturprinzipien • Überblicksbild Lösungs-Strategie • Architektur-Entscheidung • Technologie-Entscheidungen • Struktur • Verhalten • Verteilung Lösungs-Details
  4. www.iTernity.com 5 Architekturdokumentation - Einführung  Die DSGVO gilt für

    die Datenverarbeitung im Rahmen von Tätigkeiten einer Niederlassung eines Data Controllers oder Data Processors auf dem Gebiet der Europäischen Union  Entscheidend ist der Ort der Niederlassung, nicht der Ort der Datenverarbeitung  Die DSGVO gilt auch für den „Marktort“ EU: für Datenverarbeitungen, die dazu dienen, Waren und Dienstleistungen innerhalb der EU anzubieten 2. Dokumentationsmittel
  5. www.iTernity.com 6 Architekturdokumentation - Einführung Problemstellung - Produkt-Karton Hilfsfragen: •

    Wozu ist das Produkt da? • Warum bieten wir dieses Produkt an? • Warum sollte man dieses Produkt kaufen? Inhalt: • Plakative Darstellung der wesentlichen Funktionen • Ziele und Merkmale des Systems • Beschränkt auf die 5-7 wichtigsten Aspekte Quelle: https://www.perfektegesundheit.de/vitamix-pro-750
  6. www.iTernity.com 7 Architekturdokumentation - Einführung Problemstellung – Systemkontext Hilfsfragen: •

    Wo fängt mein System an? • Wo endet mein System? • Mit wem interagiert das System? Inhalt: • User • System als Blackbox • Fremdkomponenten • Schnittstellen • Ggfs. Protokolle Quelle: http://update.hanser-fachbuch.de/2013/10/arc42-starschnitt-gradle-schnipsel-nr-2-systemkontext/
  7. www.iTernity.com 8 Architekturdokumentation - Einführung Problemstellung - Qualitätsziele Hilfsfragen: •

    Was sind die wichtigsten Qualitätsziele (*ilities)? • Sind die Ziele konsistent zum Produktkarton? • Haben alle Beteiligten die gleiche Ansicht? Inhalt: • IS0 9126 kann erste Orientierung geben • Fokus auf Top 3-5 Qualitätsziele • Sortierung nach Wichtigkeit Quelle: https://www.johner-institut.de/blog/iec-62304-medizinische-software/iso-9126-und-iso-25010/
  8. www.iTernity.com 9 Architekturdokumentation - Einführung Problemstellung - Randbedingungen Hilfsfragen: •

    Gibt es technischen Vorgaben? • Gibt es organisatorische Vorgaben? • Sind die Vorgaben erläutert und nachvollziehbar? Inhalt: • Achtung: Hinter Vorgaben können sich auch schnell Entscheidungen oder persönliche Vorlieben verstecken. • Nur die Vorgaben auflisten, welche die Architektur beeinflussen.
  9. www.iTernity.com 10 Architekturdokumentation - Einführung Lösungsstrategie – Architekturansätze Hilfsfragen: •

    Mit welchen Lösungsansätzen schlage ich eine Brücke zwischen Qualitätszielen und Architekturentscheidungen? Inhalt: • Gegenüberstellung der wichtigsten Ziele und Lösungsansätzen • Am besten zweispaltige Tabelle • Bezug auf Qualitätsziele aus der Problemstellung muss gegeben sein • Ggfs. auch alternative Ansätze erwähnen
  10. www.iTernity.com 11 Architekturdokumentation - Einführung Lösungsstrategie - Übersichtsbild Hilfsfragen: •

    Was sind die Hauptkomponenten des Systems? • Wie interagieren diese? • Was sind die Schnittstellen nach außen? Inhalt: • Eine Detailebene tiefer als der Systemkontext. • Muss mit dem Systemkontext korrespondieren. • Informell reicht. Kein UML! Quelle: http://slideplayer.org/slide/638162/
  11. www.iTernity.com 12 Architekturdokumentation - Einführung Lösungsstrategie – Architekturprinzipien Hilfsfragen: •

    Was sind die Grundsätze, an die sich alle halten sollen, damit wir eine konsequente und konsistente Architektur bekommen? Inhalt: • Darstellung als Liste • Präferenzen („Bevorzuge XY vor Z“)
  12. www.iTernity.com 13 Architekturdokumentation - Einführung Lösungsdetails - Architekturentscheidungen Hilfsfragen: •

    Was sind die zentralen, weittragenden Entscheidungen? • Was sind die Alternativen? • Warum entscheiden wir uns für XYZ? Inhalt: • Architektur-Patterns • Technologie-Entscheidungen • Eingesetzte Protokolle
  13. www.iTernity.com 14 Architekturdokumentation - Einführung Lösungsdetails - Sichten Hilfsfragen: •

    Was sind die wichtigsten Details? • Sind die Konzepte stabil genug? Inhalt: • Struktur / Komponenten-Modell • Verhalten / Sequenz-Diagramm • Verteilung / Deployment-Diagramm • Gerne UML. Quelle: https://en.wikipedia.org/wiki/Unified_Modeling_Language
  14. www.iTernity.com 15 Architekturdokumentation - Einführung  Die DSGVO gilt für

    die Datenverarbeitung im Rahmen von Tätigkeiten einer Niederlassung eines Data Controllers oder Data Processors auf dem Gebiet der Europäischen Union  Entscheidend ist der Ort der Niederlassung, nicht der Ort der Datenverarbeitung  Die DSGVO gilt auch für den „Marktort“ EU: für Datenverarbeitungen, die dazu dienen, Waren und Dienstleistungen innerhalb der EU anzubieten Hands on!
  15. www.iTernity.com 16 Architekturdokumentation - Einführung  Die DSGVO gilt für

    die Datenverarbeitung im Rahmen von Tätigkeiten einer Niederlassung eines Data Controllers oder Data Processors auf dem Gebiet der Europäischen Union  Entscheidend ist der Ort der Niederlassung, nicht der Ort der Datenverarbeitung  Die DSGVO gilt auch für den „Marktort“ EU: für Datenverarbeitungen, die dazu dienen, Waren und Dienstleistungen innerhalb der EU anzubieten War das alles?
  16. www.iTernity.com 17 Architekturdokumentation - Einführung War das alles? Nein. Das

    war nur der Einstieg. Es gibt noch mehr. • Tailoring - Man kann auch mit weniger starten • z.B. nur Produktkarton, Qualitätsziele, Systemkontext, Lösungsansätze und Architekturentscheidung. • Erweiterung - Es gibt noch mehr Dokumentationsmittel. • Man kann es Schritt für Schritt ausbauen. Bei Bedarf sogar in Richtung arc42. • Review der Dokumentation - Qualität an Zielgruppe testen und iterativ ausbauen • Komposition - Unterschiedliche Varianten und Formate für unterschiedliche Zielgruppen • PPT, Flyer, Poster, Architektur-Wand, Handbuch für Entwickler, ... • Entwickler, Professional Service, Solution-Architects, Stakeholder, Kunden, Partner, ... • Architektur-Reviews - regelmäßig Umsetzung gegen Architekturübersicht gegen Produktstrategie halten und Missmatch identifizieren (in alle Richtungen)
  17. www.iTernity.com 19 Architekturdokumentation - Einführung  Die DSGVO gilt für

    die Datenverarbeitung im Rahmen von Tätigkeiten einer Niederlassung eines Data Controllers oder Data Processors auf dem Gebiet der Europäischen Union  Entscheidend ist der Ort der Niederlassung, nicht der Ort der Datenverarbeitung  Die DSGVO gilt auch für den „Marktort“ EU: für Datenverarbeitungen, die dazu dienen, Waren und Dienstleistungen innerhalb der EU anzubieten Herzlichen Dank!