From 66ef4839e4543a833e0c128320dcf32323dd062b Mon Sep 17 00:00:00 2001 From: Denis Natusch Date: Wed, 18 Oct 2023 19:12:56 +0200 Subject: [PATCH] Add use-case diagram and general use-cases Co-authored-by: Mathis Kral --- .../models/analysis/useCaseDiagram.svg | 3 + src/main/asciidoc/pflichtenheft.adoc | 724 +++++++++++++++++- 2 files changed, 712 insertions(+), 15 deletions(-) create mode 100644 src/main/asciidoc/models/analysis/useCaseDiagram.svg diff --git a/src/main/asciidoc/models/analysis/useCaseDiagram.svg b/src/main/asciidoc/models/analysis/useCaseDiagram.svg new file mode 100644 index 0000000..79a5bff --- /dev/null +++ b/src/main/asciidoc/models/analysis/useCaseDiagram.svg @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:be08edc562aa714946a3cb63c16fb6c02a93b3724116429110422e3ea24092dd +size 16192 diff --git a/src/main/asciidoc/pflichtenheft.adoc b/src/main/asciidoc/pflichtenheft.adoc index 8134956..9ce24dd 100644 --- a/src/main/asciidoc/pflichtenheft.adoc +++ b/src/main/asciidoc/pflichtenheft.adoc @@ -92,25 +92,719 @@ image::models/analysis/topLevelArchitecture.svg[] === Akteure -Akteure sind die Benutzer des Software-Systems oder Nachbarsysteme, welche darauf zugreifen. Dokumentieren Sie die Akteure in einer Tabelle. Diese Tabelle gibt einen Überblick über die Akteure und beschreibt sie kurz. Die Tabelle hat also mindestens zwei Spalten (Akteur Name und Kommentar). -Weitere relevante Spalten können bei Bedarf ergänzt werden. - -// See http://asciidoctor.org/docs/user-manual/#tables -[options="header"] -[cols="1,4"] +[cols="1h,3"] |=== -|Name |Beschreibung -|... |... +|Nutzer +|Ist jede Person, die mit dem System interagiert - unabhängig, ob Sie eine Zugriffsberechtigung hat oder nicht. + +|Registrieter Nutzer +|Ist jede Person, die eine Zugriffsberechtigung auf das System hat. Die Berechtigungen für diese Person sind begrenzt. + +|Boss / Admin +|Ein registrieter Nutzer mit uneingeschränkten Berechtigungen. |=== -=== Überblick Anwendungsfalldiagramm -Anwendungsfall-Diagramm, das alle Anwendungsfälle und alle Akteure darstellt +=== Anwendungsfalldiagramm / Use-Case Diagram -=== Anwendungsfallbeschreibungen -Dieser Unterabschnitt beschreibt die Anwendungsfälle. In dieser Beschreibung müssen noch nicht alle Sonderfälle und Varianten berücksichtigt werden. Schwerpunkt ist es, die wichtigsten Anwendungsfälle des Systems zu finden. Wichtig sind solche Anwendungsfälle, die für den Auftraggeber, den Nutzer den größten Nutzen bringen. -Für komplexere Anwendungsfälle ein UML-Sequenzdiagramm ergänzen. -Einfache Anwendungsfälle mit einem Absatz beschreiben. -Die typischen Anwendungsfälle (Anlegen, Ändern, Löschen) können zu einem einzigen zusammengefasst werden. +image::models/analysis/useCaseDiagram.svg[] + +=== Anwendungsfallbeschreibung + +===== Kundenverwaltung +[cols="1h,2"] +|=== +|ID +|[UC0101] + +|Name +|Kundendaten bearbeiten + +|Beschreibung +|Der Nutzer verfügt über die Berechtigung die Daten eines Kunden (z.B. Rechnungsadresse) zu bearbeiten. + +|Akteure +|Registrieter Nutzer + +|Trigger +| + +|Bedingungen +| + +|Essizielle Schritte +| + +|Erweiterungen +| + +|Funkionale Vorraussetzungen +| +|=== + +[cols="1h,2"] +|=== +|ID +|[UC0102] + +|Name +|Kundendaten einsehen + +|Beschreibung +|Der Nutzer verfügt über die Berechtigung die Daten eines Kunden einzusehen. + +|Akteure +|Registrieter Nutzer + +|Trigger +| + +|Bedingungen +| + +|Essizielle Schritte +| + +|Erweiterungen +| + +|Funkionale Vorraussetzungen +| +|=== + +[cols="1h,2"] +|=== +|ID +|[UC0103] + +|Name +|Kunden entfernen + +|Beschreibung +|Der Nutzer verfügt über die Berechtigung einen Kunden aus dem System zu entfernen. + +|Akteure +|Registrieter Nutzer + +|Trigger +| + +|Bedingungen +| + +|Essizielle Schritte +| + +|Erweiterungen +| + +|Funkionale Vorraussetzungen +| +|=== + +[cols="1h,2"] +|=== +|ID +|[UC0104] + +|Name +|Kunden hinzufügen + +|Beschreibung +|Der Nutzer verfügt über die Berechtigung einen neuen Kunden dem System hinzuzufügen. + +|Akteure +|Registrieter Nutzer + +|Trigger +| + +|Bedingungen +| + +|Essizielle Schritte +| + +|Erweiterungen +| + +|Funkionale Vorraussetzungen +| +|=== + +===== Personalverwaltung +[cols="1h,2"] +|=== +|ID +|[UC0201] + +|Name +|Personal hinzufügen + +|Beschreibung +|Der Nutzer verfügt über die Berechtigung einen Angestelten dem System hinzuzufügen. + +|Akteure +|Registrieter Nutzer + +|Trigger +| + +|Bedingungen +| + +|Essizielle Schritte +| + +|Erweiterungen +| + +|Funkionale Vorraussetzungen +| +|=== + +[cols="1h,2"] +|=== +|ID +|[UC0202] + +|Name +|Personaldaten bearbeiten + +|Beschreibung +|Der Nutzer verfügt über die Berechtigung die personbezogenen Daten eines Angestelten zu ändern (z.B. die Adresse). + +|Akteure +|Registrieter Nutzer + +|Trigger +| + +|Bedingungen +| + +|Essizielle Schritte +| + +|Erweiterungen +| + +|Funkionale Vorraussetzungen +| +|=== +[cols="1h,2"] +|=== +|ID +|[UC0203] + +|Name +|Personaldaten einsehen + +|Beschreibung +|Der Nutzer verfügt über die Berechtigung die personbezogenen Daten eines Angestelten einzusehen. + +|Akteure +|Registrieter Nutzer + +|Trigger +| + +|Bedingungen +| + +|Essizielle Schritte +| + +|Erweiterungen +| + +|Funkionale Vorraussetzungen +| +|=== + +[cols="1h,2"] +|=== +|ID +|[UC0204] + +|Name +|Personal entfernen + +|Beschreibung +|Der Nutzer verfügt über die Berechtigung einen Angestelten aus dem System zu entfernen. + +|Akteure +|Registrieter Nutzer + +|Trigger +| + +|Bedingungen +| + +|Essizielle Schritte +| + +|Erweiterungen +| + +|Funkionale Vorraussetzungen +| +|=== + +[cols="1h,2"] +|=== +|ID +|[UC0205] + +|Name +|Personal einem Auftrag zuordnen + +|Beschreibung +|Der Nutzer verfügt über die Berechtigung einen Angestelten für einen Auftrag einzuteilen. + +|Akteure +|Registrieter Nutzer + +|Trigger +| + +|Bedingungen +| + +|Essizielle Schritte +| + +|Erweiterungen +| + +|Funkionale Vorraussetzungen +| +|=== + +===== Rechnungswesen +[cols="1h,2"] +|=== +|ID +|[UC0301] + +|Name +|Rechnung hinzufügen + +|Beschreibung +|Der Nutzer verfügt über die Berechtigung eine Rechnung dem System hinzuzufügen. + +|Akteure +|Registrieter Nutzer + +|Trigger +| + +|Bedingungen +| + +|Essizielle Schritte +| + +|Erweiterungen +| + +|Funkionale Vorraussetzungen +| +|=== + +[cols="1h,2"] +|=== +|ID +|[UC0302] + +|Name +|Rechnungen bearbeiten + +|Beschreibung +|Der Nutzer verfügt über die Berechtigung eine bereits vorhandene Rechnung zu bearbeiten. + +|Akteure +|Registrieter Nutzer + +|Trigger +| + +|Bedingungen +| + +|Essizielle Schritte +| + +|Erweiterungen +| + +|Funkionale Vorraussetzungen +| +|=== + +[cols="1h,2"] +|=== +|ID +|[UC0303] + +|Name +|Rechnung bezahlen + +|Beschreibung +|Der Nutzer verfügt über die Berechtigung eine Rechnung als bezahlt einzustufen. + +|Akteure +|Registrieter Nutzer + +|Trigger +| + +|Bedingungen +| + +|Essizielle Schritte +| + +|Erweiterungen +| + +|Funkionale Vorraussetzungen +| +|=== + +[cols="1h,2"] +|=== +|ID +|[UC0304] + +|Name +|Rechnung einsehen + +|Beschreibung +|Der Nutzer verfügt über die Berechtigung den Inhalt einer Rechnung einzusehen. + +|Akteure +|Registrieter Nutzer + +|Trigger +| + +|Bedingungen +| + +|Essizielle Schritte +| + +|Erweiterungen +| + +|Funkionale Vorraussetzungen +| +|=== + +===== Auftragverwaltung +[cols="1h,2"] +|=== +|ID +|[U0401] + +|Name +|Auftragsdaten bearbeiten + +|Beschreibung +|Der Nutzer verfügt über die Berechtigung den Inhalt eines vorhandenen Auftrags zubearbeiten. + +|Akteure +|Registrieter Nutzer + +|Trigger +| + +|Bedingungen +| + +|Essizielle Schritte +| + +|Erweiterungen +| + +|Funkionale Vorraussetzungen +| +|=== + +[cols="1h,2"] +|=== +|ID +|[UC0402] + +|Name +|Auftragsdaten einsehen + +|Beschreibung +|Der Nutzer verfügt über die Berechtigung den Inhalt eines vorhandenen Auftrags einzusehen. + +|Akteure +|Registrieter Nutzer + +|Trigger +| + +|Bedingungen +| + +|Essizielle Schritte +| + +|Erweiterungen +| + +|Funkionale Vorraussetzungen +| +|=== + +[cols="1h,2"] +|=== +|ID +|[UC0403] + +|Name +|Auftrag entfernen + +|Beschreibung +|Der Nutzer verfügt über die Berechtigung einen vorhandenen Auftrag aus dem System zu entfernen. + +|Akteure +|Registrieter Nutzer + +|Trigger +| + +|Bedingungen +| + +|Essizielle Schritte +| + +|Erweiterungen +| + +|Funkionale Vorraussetzungen +| +|=== + +[cols="1h,2"] +|=== +|ID +|[UC0404] + +|Name +|Auftrag hinzufügen + +|Beschreibung +|Der Nutzer verfügt über die Berechtigung einen Auftrag dem System hinzuzufügen. + +|Akteure +|Registrieter Nutzer + +|Trigger +| + +|Bedingungen +| + +|Essizielle Schritte +| + +|Erweiterungen +| + +|Funkionale Vorraussetzungen +| +|=== + +===== Inventarverwaltung +[cols="1h,2"] +|=== +|ID +|[UC0501] + +|Name +|Inventar einsehen + +|Beschreibung +|Der Nutzer verfügt über die Berechtigung das Inventar einzusehen. + +|Akteure +|Registrieter Nutzer + +|Trigger +| + +|Bedingungen +| + +|Essizielle Schritte +| + +|Erweiterungen +| + +|Funkionale Vorraussetzungen +| +|=== + +[cols="1h,2"] +|=== +|ID +|[UC0502] + +|Name +|Inventar bearbeiten + +|Beschreibung +|Der Nutzer verfügt über die Berechtigung den Inhalt des Inventars zu bearbeiten. + +|Akteure +|Registrieter Nutzer + +|Trigger +| + +|Bedingungen +| + +|Essizielle Schritte +| + +|Erweiterungen +| + +|Funkionale Vorraussetzungen +| +|=== + +===== Administration +[cols="1h,2"] +|=== +|ID +|[UC0601] + +|Name +|Registrieten Nutzer hinzufügen + +|Beschreibung +|Der Admin verfügt über die Berechtigung einen registrieten Nutzer anzulegen. + +|Akteure +|Registrieter Nutzer + +|Trigger +| + +|Bedingungen +| + +|Essizielle Schritte +| + +|Erweiterungen +| + +|Funkionale Vorraussetzungen +| +|=== + +[cols="1h,2"] +|=== +|ID +|[UC0602] + +|Name +|Registrieten Nutzer entfernen + +|Beschreibung +|Der Admin verfügt über die Berechtigung einen registrieten Nutzer aus dem System zu entfernen. + +|Akteure +|Registrieter Nutzer + +|Trigger +| + +|Bedingungen +| + +|Essizielle Schritte +| + +|Erweiterungen +| + +|Funkionale Vorraussetzungen +| +|=== + +====== Oberfläche +[cols="1h,2"] +|=== +|ID +|[UC0701] + +|Name +|Login + +|Beschreibung +|Der Nutzer verfügt über die Berechtigung die Login-Page aufzurufen. + +|Akteure +|Registrieter Nutzer + +|Trigger +| + +|Bedingungen +| + +|Essizielle Schritte +| + +|Erweiterungen +| + +|Funkionale Vorraussetzungen +| +|=== +[cols="1h,2"] + +|=== +|ID +|[UC0702] + +|Name +|Logout + +|Beschreibung +|Der Nutzer verfügt über die Berechtigung sich abzumelden. + +|Akteure +|Registrieter Nutzer + +|Trigger +| + +|Bedingungen +| + +|Essizielle Schritte +| + +|Erweiterungen +| + +|Funkionale Vorraussetzungen +| +|=== == Funktionale Anforderungen