Vorlesung Software-Engineering I

Transkript

1 Vorlesung Software-Engineering I im 3. und 4. Semester 09. SW-Architektur - Dokumentation Architektur-Review Wir treten einen Schritt zurück und betrachten nochmal das Ganze. Sind wir noch auf dem richtigen Weg? 2

2 Architektur-Review: Sind wir noch auf dem richtigen Weg? Ja? Nein Haben wir verstanden was der Kunde will? [ ] [ ] [ ] Wurde alle wesentlichen Anwendungsfälle berücksichtigt? [ ] [ ] [ ] Erfüllt unsere Architektur diese Anwendungsfälle? [ ] [ ] [ ] Haben wir alle nicht funktionalen Anforderungen erkannt? [ ] [ ] [ ] Haben wir unser System klar von der Umgebung abgegrenzt? [ ] [ ] [ ] Haben wir eine eindeutige Modularisierung mit klaren Schnittstellen? [ ] [ ] [ ] Ist unsere Architektur ausreichend dokumentiert? [ ] [ ] [ ] Haben wir eine Strategie in unserer Architektur? [ ] [ ] [ ] Haben wir noch offene Punkte, sind diese dokumentiert? [ ] [ ] [ ] Sehen wir Risiken bei der Umsetzung? [ ] [ ] [ ] Können wir unsere Architektur übersichtlich und einfach erklären? [ ] [ ] [ ] Haben wir unsere Architektur anhand von konkreten Szenarien ausprobiert? [ ] [ ] [ ] 3 Artefakte - Zusammenhänge Produkt-Idee (Produkt-Karton): Produkt-Idee Zielgruppe Leistungsmerkmale 2 1 Anforderungen (Produkt-Backlog): Epics User Story s funktionale Anforderungen nicht funktionale Anforderungen 4 Abläufe (BPMN): Bausteinsicht (ConceptMap): 3 5 Datenmodell (ERM): Benutzeroberfläche (Mock-up): 5 Zustände (UML): 6 Die Zahlen in den Pfeilen geben an in welcher Reihenfolge die Artefakte entstanden sind. 4

3 Architektur-Dokumentation Dokumentation (Print) PDF PDF/PPT Generelles Vorgehen: Übersicht -> Detaillierung Übersichtspräsentation (View) 5 Struktur der Anwendung Anwendungsfälle User-Interface <<include>> <<extends>> Applikation Modul 1 Abläufe Datenmodell Team 1 Struktur Anwendungsfälle User-Interface <<extends>> <<include>> Datenmodell Modul 2 Abläufe Datenmodell Team 2 6

4 Architektur-Dokumentation [Hoyer] 1. Projektziele Produktidee, Anforderungen, Strategie t 2. Applikationsbeschreibung Gesamtsicht, Module, Beschreibung globaler Teile (z.b. Daten, Menü). 3. Modulbeschreibungen Beschreibung der einzelnen Module Modulübersicht, Daten, Abläufe, Benutzeroberfläche. 4. Abgrenzung Releaseplan, generelle Abgrenzung, vorhandene Teile, Schnittstellen von/nach außen. PDF Dokumentation (Print) 5. Testplan Beschreibung der Hauptszenarien. 6. Risiken Dokumentation von offene Punkte, Hindernisse. 7 Architektur-Präsentation [Hoyer] ca. 15 Min. 1. Projektziele Produktidee, Beschreibung der Hauptszenarien, Strategie t des Entwurfs. 2. Applikationsbeschreibung Gesamtsicht, Module, Beschreibung globaler Teile (z.b. Daten, Menü). 3. Modulbeschreibungen Kurz-Beschreibung der einzelnen Module Modulübersicht, Daten, Haupt-Abläufe, Benutzeroberfläche. 4. Abgrenzung Releaseplan, generelle Abgrenzung, vorhandene Teile, Schnittstellen von/nach außen. PDF/PPT Übersichtspräsentation (View) 5. Risiken Benennung offene Punkte, Hindernisse und Lösungsvorschläge 6. Projektarbeit Was lief gut, was kann man verbessern? 8

5 Best Practices: Architekt(o)urdokumentation [Dr. Michael Stal] 1. Dokumentation versionieren 2. Dokumentation immer aus der Sicht des Lesers schreiben 3. Wiederholungen vermeiden (Referenzen möglichst als Links) 4. Mehrdeutigkeiten vermeiden (z.b. Glossar mit Begriffserklärung schreiben) 5. Standard-Template für Dokumentation verwenden 6. Begründung für Entscheidungen mit dokumentieren 7. Dokumentation möglichst aktuelle halten 8. Verantwortlichen pro Dokument, Blog etc. benennen 9. Einzelnes Dokument im Umfang beschränken (lieber mehr Dokumente) 10. Review der Dokumente durchführen (Inhalt prüfen) siehe höre auch: 9 Templates: arc42 Stukturvorlage für Architektur-Dokumentation [Starke] 1. Einführung und Ziele 2. Einflussfaktoren und Randbedingungen 3. Kontextsicht 4. Bausteinsichten 5. Laufzeitsichten 6. Verteilungs- und Infrastruktursicht 7. Entwurfsentscheidungen 8. Szenarien zur Architekturbewertung 9. Querschnittliche Architekturaspekte 10. Projektaspekte 11. Glossar 10

6 Pflichtenheft [Balzert neu] 1. Visionen (V) und Ziele (Z) 2. Rahmenbedingungen (R) 3. Kontext und Überblick (K) 4. Funktionale Anforderungen (F) 5. Qualitätsanforderungen (QF) 6. Abnahmekriterien (A) 7. Subsystemstruktur (K) LH Übersicht PH Detaillierung Bezüge zum Lastenheft werden mit den entsprechenden Kennungen angeben. 12 Pflichtenheft [Balzert, alt] 1. Zielsetzung 2. Anforderungen (Musskriterien, Wunschkriterien) 3. Abgrenzungskriterien 4. Programmeinsatz (Anwendungsbereich, Zielgruppe, Betriebsbedingungen) 5. Programmumgebung (Software, Hardware) 6. Programmfunktionen 7. Programmdaten 8. Programmleistungen 9. Benutzerschnittstelle 10. Abläufe 11. Qualitätsbestimmung 12. Testfälle 13

7 Was fehlt noch: von Anforderungen zu Aufgaben (Umsetzung) Anforderungen (Produkt-Backlog): Epics User Story s funktionale Anforderungen nicht funktionale Anforderungen Aufgaben (Sprint-Backlog): Aufgaben Entwürfe Umsetzungen Tests Dokumentation 1 Beispiel Shät Schätzverfahren fh Planungspoker Anwendungsfall 1 Aufgabe 1 <Aufwand> Aufgabe 2 <Aufwand> Aufgabe n <Aufwand> Ausleihvorgang Umsetzungsentwurf Ausleihvorgang 0,5 PT Maske Ausleihvorgang umsetzen 1,0 PT Aufruf aus Ausleihliste umsetzen 0,5 PT Test des Ausleihvorgang 0,5 PT Dokumentation der Umsetzung 0,5 PT 14 Fragen: 15