From 36ded44703be15c5e0b30bd599a88b9d17d349fb Mon Sep 17 00:00:00 2001 From: Mathis Kral Date: Tue, 17 Oct 2023 20:18:08 +0200 Subject: [PATCH] Initial commit for scope statement Co-authored-by: Simon Bruder --- .../models/analysis/systemContextDiagram.svg | 3 ++ .../models/analysis/topLevelArchitecture.svg | 3 ++ src/main/asciidoc/pflichtenheft.adoc | 54 +++++++++++++++++-- 3 files changed, 56 insertions(+), 4 deletions(-) create mode 100644 src/main/asciidoc/models/analysis/systemContextDiagram.svg create mode 100644 src/main/asciidoc/models/analysis/topLevelArchitecture.svg diff --git a/src/main/asciidoc/models/analysis/systemContextDiagram.svg b/src/main/asciidoc/models/analysis/systemContextDiagram.svg new file mode 100644 index 0000000..6fb4d0e --- /dev/null +++ b/src/main/asciidoc/models/analysis/systemContextDiagram.svg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f46d6a1af9d02bbb88b5f671f7ff671acc72f4aee7ddd5e63d6114f2ff0b9cf8 +size 3213 diff --git a/src/main/asciidoc/models/analysis/topLevelArchitecture.svg b/src/main/asciidoc/models/analysis/topLevelArchitecture.svg new file mode 100644 index 0000000..027456f --- /dev/null +++ b/src/main/asciidoc/models/analysis/topLevelArchitecture.svg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:baf7d0d338f19ce8e2447aa6756e2d5ecc4b432266a4a5ddf163492d8cbde6f1 +size 7018 diff --git a/src/main/asciidoc/pflichtenheft.adoc b/src/main/asciidoc/pflichtenheft.adoc index c872791..d577c31 100644 --- a/src/main/asciidoc/pflichtenheft.adoc +++ b/src/main/asciidoc/pflichtenheft.adoc @@ -13,7 +13,24 @@ Dieses Dokument benötigt ein Inhaltsverzeichnis. Es existieren mehrere Einbindungsmöglichkeiten. == Zusammenfassung -Eine kurze Beschreibung des Dokuments. Wenige Absätze. + +Ziel des Projekts „Cateringservice“ ist es, eine web-basierte Java-Applikation für den Catering-Service „Mampf“ zu entwickeln, welche folgende Hauptfunktionen beinhalten soll: + +- Kundenverwaltung +- Personalverwaltung +- Personalzuteilung +- Termin- und Eventplanung inkl. Zubehör, Lebensmittelbedarf +- Abrechnungs- und Rechnungserstellung + +Zudem soll die Software diverse nicht-funktionale Kriterien, wie folgt, erfüllen: + +- einfache Bedienbarkeit +- Absturzsicherheit +- einfache Erweiterbarkeit +- nachvollziehbare Strukturierung +- hohe Codequalität + +Die Software gilt als fertig entwickelt und auslieferungsbereit, wenn die folgend in diesem Dokument aufgelisteten Akzeptanztest bestanden sind, auf welche sich mit dem Kunden geeinigt wurde. == Aufgabenstellung und Zielsetzung Text aus Aufgabenstellung kopieren und ggfs. präzisieren. @@ -29,10 +46,12 @@ Welche realen und juristischen Personen(-gruppen) haben Einfluss auf die Anforde == Systemgrenze und Top-Level-Architektur === Kontextdiagramm -Das Kontextdiagramm zeigt das geplante Software-System in seiner Umgebung. Zur Umgebung gehören alle Nutzergruppen des Systems und Nachbarsysteme. Die Grafik kann auch informell gehalten sein. Überlegen Sie sich dann geeignete Symbole. Die Grafik kann beispielsweise mit Visio erstellt werden. Wenn nötig, erläutern Sie diese Grafik. + +image::models/analysis/systemContextDiagram.svg[] === Top-Level-Architektur -Dokumentieren Sie ihre Top-Level-Architektur mit Hilfe eines Komponentendiagramm. + +image::models/analysis/topLevelArchitecture.svg[] == Anwendungsfälle @@ -70,13 +89,40 @@ Anforderungen die das Programm leisten können soll, aber für den korrekten Bet === Qualitätsziele -Dokumentieren Sie in einer Tabelle die Qualitätsziele, welche das System erreichen soll, sowie deren Priorität. + +[options="header"] +[cols="4,1"] +|=== +| Qualitätsziel | Priorität (hoch - mittel - gering) +| einfache Bedienbarkeit (für Nicht-Informatiker) | hoch +| Absturzsicherheit | hoch +| einfache Erweiterbarkeit | mittel +| nachvollziehbare Strukturierung | mittel +| hohe Codequalität | mittel +|=== === Konkrete Nicht-Funktionale Anforderungen Beschreiben Sie Nicht-Funktionale Anforderungen, welche dazu dienen, die zuvor definierten Qualitätsziele zu erreichen. Achten Sie darauf, dass deren Erfüllung (mindestens theoretisch) messbar sein muss. +==== Einfache Bedienbarkeit +- Interaktion vollständig über Knöpfe und Textfelder +- fehlerhafte Nutzereingaben werden dem Nutzer direkt mitgeteilt +- intuitives Design z. B. des Menüs + +==== Absturzsicherheit +- fehlerhafte Eingaben der Nutzer dürfen nicht zu Abstürzen führen + +==== Einfache Erweiterbarkeit +- Software muss so entworfen sein, dass einfach neue Produkte oder Dienstleistungen ergänzt werden können + +==== Nachvollziehbare Strukturierung +- das Design der Software muss sich an bekannten und geeigneten Entwurfsmustern orientieren + +==== Hohe Codequalität +- verständliche Dokumentation von Objekten und dessen Methoden + == GUI Prototyp In diesem Kapitel soll ein Entwurf der Navigationsmöglichkeiten und Dialoge des Systems erstellt werden.