diff --git a/src/main/asciidoc/pflichtenheft.adoc b/src/main/asciidoc/pflichtenheft.adoc index bd6625a..57ecfb2 100644 --- a/src/main/asciidoc/pflichtenheft.adoc +++ b/src/main/asciidoc/pflichtenheft.adoc @@ -186,28 +186,29 @@ image::models/analysis/useCaseDiagram.svg[] |[UC0101] |Name -|Kundendaten bearbeiten +|Kundendaten einsehen |Beschreibung -|Der Nutzer verfügt über die Berechtigung die Daten eines Kunden (z.B. Rechnungsadresse) zu bearbeiten. +|Der Administrator verfügt über die Berechtigung die Daten eines Kunden einzusehen. |Akteure -|Registrieter Nutzer +|Administrator |Trigger -| +|Der Administrator wählt Nutzerdatenbank in der Navigation Bar aus. |Bedingungen -| +|Der Administrator hat sich angemeldet. -|Essizielle Schritte -| +|Essizielle Schritte a| +1. Der Administrator wählt Nutzerdatenbank in der Navigation Bar aus. +2. Eine Liste aller Kunden erscheint. |Erweiterungen -| +| - |Funkionale Vorraussetzungen -| +| <> |=== [cols="1h,2"] @@ -215,89 +216,33 @@ image::models/analysis/useCaseDiagram.svg[] |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. +|Der Administrator verfügt über die Berechtigung einen Kunden aus dem System zu entfernen. |Akteure -|Registrieter Nutzer +|Administrator |Trigger -| +|Der Administrator wählt den Nutzer aus der Nutzerdatenbank und drückt auf „Konto löschen“. |Bedingungen -| +|Der Administrator hat sich angemeldet. -|Essizielle Schritte -| +|Essizielle Schritte a| +1. Der Administrator wählt Nutzerdatenbank in der Navigation Bar aus. +2. Eine Liste aller Kunden erscheint. +3. Der Administrator wählt den gewünschten Nutzer. +4. Eine Liste von möglichen Änderungen erscheint. +5. Der Administrator wählt „Konto löschen“ |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 @@ -310,25 +255,27 @@ image::models/analysis/useCaseDiagram.svg[] |Personal hinzufügen |Beschreibung -|Der Nutzer verfügt über die Berechtigung einen Angestelten dem System hinzuzufügen. +|Der Administrator verfügt über die Berechtigung einen Angestelten dem System hinzuzufügen. |Akteure -|Registrieter Nutzer +|Administrator |Trigger -| +|Der Administrator wählt hinzufügen im Bereich Personal. |Bedingungen -| +|Der Administrator hat sich angemeldet. -|Essizielle Schritte -| +|Essizielle Schritte a| +1. Der Administrator wählt Personal in der Navigation Bar aus. +2. Eine Liste aller Mitarbeiter erscheint. +3. Der Administrator wählt hinzufügen. |Erweiterungen -| +| - |Funkionale Vorraussetzungen -| +| <> |=== [cols="1h,2"] @@ -340,26 +287,30 @@ image::models/analysis/useCaseDiagram.svg[] |Personaldaten bearbeiten |Beschreibung -|Der Nutzer verfügt über die Berechtigung die personbezogenen Daten eines Angestelten zu ändern (z.B. die Adresse). +|Der Administrator verfügt über die Berechtigung die personbezogenen Daten eines Angestelten zu ändern (z.B. die Adresse). |Akteure -|Registrieter Nutzer +|Administrator |Trigger -| +|Der Administrator wählt einen Mitarbeiter im Bereich Personal aus. |Bedingungen -| +|Der Administrator ist angemeldet. -|Essizielle Schritte -| +|Essizielle Schritte a| +1. Der Administrator wählt Personal in der Navigation Bar aus. +2. Eine Liste aller Mitarbeiter erscheint. +3. Der Administrator wählt den gewünschten Mitarbeiter. +4. Eine Liste von möglichen Änderungen erscheint. |Erweiterungen -| +| - |Funkionale Vorraussetzungen -| +| <> |=== + [cols="1h,2"] |=== |ID @@ -369,25 +320,28 @@ image::models/analysis/useCaseDiagram.svg[] |Personaldaten einsehen |Beschreibung -|Der Nutzer verfügt über die Berechtigung die personbezogenen Daten eines Angestelten einzusehen. +|Der Administrator verfügt über die Berechtigung die personbezogenen Daten eines Angestelten einzusehen. |Akteure -|Registrieter Nutzer +|Administrator |Trigger -| +|Der Administrator wählt Personl in der Navigation Bar. |Bedingungen -| +| Der Administrator ist angemeldet -|Essizielle Schritte -| +|Essizielle Schritte a| +1. Der Administrator wählt Personal in der Navigation Bar aus. +2. Eine Liste aller Mitarbeiter erscheint. +3. Der Administrator wählt den gewünschten Mitarbeiter. +4. Eine Liste von möglichen Änderungen erscheint (an denen keine Änderungen vorgenommen werden). |Erweiterungen -| +| - |Funkionale Vorraussetzungen -| +| <> |=== [cols="1h,2"] @@ -399,25 +353,29 @@ image::models/analysis/useCaseDiagram.svg[] |Personal entfernen |Beschreibung -|Der Nutzer verfügt über die Berechtigung einen Angestelten aus dem System zu entfernen. +|Der Administrator verfügt über die Berechtigung einen Angestelten aus dem System zu entfernen. |Akteure -|Registrieter Nutzer +|Administrator |Trigger -| +|Der Administrator wählt einen Mitarbeiter aus dem Bereich Personl und drückt auf Mitarbeiter entfernen. |Bedingungen -| +|Der Administrator ist angemeldet. -|Essizielle Schritte -| +|Essizielle Schritte a| +1. Der Administrator wählt Personal in der Navigation Bar aus. +2. Eine Liste aller Mitarbeiter erscheint. +3. Der Administrator wählt den gewünschten Mitarbeiter. +4. Eine Liste von möglichen Änderungen erscheint. +5. Der Administrator wählt „Mitarbeiter löschen“ |Erweiterungen -| +| - |Funkionale Vorraussetzungen -| +| <> |=== [cols="1h,2"] @@ -426,59 +384,94 @@ image::models/analysis/useCaseDiagram.svg[] |[UC0205] |Name -|Personal einem Auftrag zuordnen +|Arbeitszeitaufstellung einsehen |Beschreibung -|Der Nutzer verfügt über die Berechtigung einen Angestelten für einen Auftrag einzuteilen. +|Der Administrator verfügt über die Berechtigung die Arbeitszeitaufstellungen des Personals einzusehen. |Akteure -|Registrieter Nutzer +|Administrator |Trigger -| +|Der Administrator wählt einen Mitarbeiter im Bereich Arbeitszeitaufstellung |Bedingungen -| +|Der Administrator ist angemeldet. -|Essizielle Schritte -| +|Essizielle Schritte a| +1. Der Administrator wählt Arbeitszeitaufstellung in der Navigation Bar aus. +2. Eine Liste der Mitarbeiter erscheint. +3. Der Administrator wählt einen Mitarbeiter. +4. Eine Ansicht von Informationen über dessen Arbeit erscheint. |Erweiterungen -| +| - |Funkionale Vorraussetzungen -| +| <> |=== -===== Rechnungswesen +[cols="1h,2"] +|=== +|ID +|[UC0206] + +|Name +|Personaleinteilung einsehen + +|Beschreibung +|Der Administrator verfügt über die Berechtigung die Personaleinteilung einzusehen. + +|Akteure +|Administrator + +|Trigger +|Der Administrator wählt Personaleinteilung in der Navigation Bar. + +|Bedingungen +|Der Administrator ist angemeldet. + +|Essizielle Schritte a| +1. Der Administrator wählt Personaleinteilung in der Navigation Bar. +2. Ein Ansicht erschint mit den zeitlichen Einteilungen. + +|Erweiterungen +| - + +|Funkionale Vorraussetzungen +| <> +|=== + +===== Inventarverwaltung [cols="1h,2"] |=== |ID |[UC0301] |Name -|Rechnung hinzufügen +|Inventar einsehen |Beschreibung -|Der Nutzer verfügt über die Berechtigung eine Rechnung dem System hinzuzufügen. +|Der Administrator verfügt über die Berechtigung das Inventar einzusehen. |Akteure -|Registrieter Nutzer +|Administrator |Trigger -| +|Der Administrator wählt Inventar in der Navigation Bar. |Bedingungen -| +|Der Administrator ist angemeldet. -|Essizielle Schritte -| +|Essizielle Schritte a| +1. Der Administrator wählt Inventar in der Navigation Bar. +2. Eine Auflistung der Artikel im Inventar erscheint. |Erweiterungen -| +|- |Funkionale Vorraussetzungen -| +| <> |=== [cols="1h,2"] @@ -487,28 +480,31 @@ image::models/analysis/useCaseDiagram.svg[] |[UC0302] |Name -|Rechnungen bearbeiten +|Inventar bearbeiten |Beschreibung -|Der Nutzer verfügt über die Berechtigung eine bereits vorhandene Rechnung zu bearbeiten. +|Der Administrator verfügt über die Berechtigung den Inhalt des Inventars zu bearbeiten. |Akteure -|Registrieter Nutzer +|Administrator |Trigger -| +|Der Administrator wählt einen Artikel im Bereich Inventar aus. |Bedingungen -| +|Der Administrator ist angemeldet. -|Essizielle Schritte -| +|Essizielle Schritte a| +1. Der Administrator wählt Inventar in der Navigation Bar. +2. Eine Auflistung der Artikel im Inventar erscheint. +3. Der Administrator wählt ein Artikel. +4. Eine Liste möglicher Optionen erscheint. |Erweiterungen -| +|- |Funkionale Vorraussetzungen -| +| <> |=== [cols="1h,2"] @@ -517,28 +513,30 @@ image::models/analysis/useCaseDiagram.svg[] |[UC0303] |Name -|Rechnung bezahlen +|Artikel zum Inventar hinzuzufügen |Beschreibung -|Der Nutzer verfügt über die Berechtigung eine Rechnung als bezahlt einzustufen. +|Der Administrator verfügt über die Berechtigung einen neuen Artikel dem Inventar hinzuzufügen. |Akteure -|Registrieter Nutzer +|Administrator |Trigger -| +|Der Administrator wählt Hinzufügen im Bereich Inventar. |Bedingungen -| +|Der Administrator ist angemeldet. -|Essizielle Schritte -| +|Essizielle Schritte a| +1. Der Administrator wählt Inventar in der Navigation Bar. +2. Eine Auflistung der Artikel im Inventar erscheint. +3. Der Administrator wählt „Neuer Artikel“. |Erweiterungen -| +|- |Funkionale Vorraussetzungen -| +| <> |=== [cols="1h,2"] @@ -547,59 +545,66 @@ image::models/analysis/useCaseDiagram.svg[] |[UC0304] |Name -|Rechnung einsehen +|Artikel vom Inventar enftfernen |Beschreibung -|Der Nutzer verfügt über die Berechtigung den Inhalt einer Rechnung einzusehen. +|Der Administrator verfügt über die Berechtigung einen Artikel aus dem Inventar zu enftfernen. |Akteure -|Registrieter Nutzer +|Administrator |Trigger -| +|Der Administrator drückt auf Enfternen, nach dem ein Artikel im Inventar ausgewählt wurde. |Bedingungen -| +|Der Administrator ist angemeldet. -|Essizielle Schritte -| +|Essizielle Schritte a| +1. Der Administrator wählt Inventar in der Navigation Bar. +2. Eine Auflistung der Artikel im Inventar erscheint. +3. Der Administrator wählt ein Artikel. +4. Eine Liste möglicher Optionen erscheint. +5. Der Administrator wählt Enfternen. |Erweiterungen -| +| - |Funkionale Vorraussetzungen -| +| <> |=== -===== Auftragverwaltung +===== Berechtigungen eines Nutzers + [cols="1h,2"] |=== |ID -|[U0401] +|[UC0401] |Name -|Auftragsdaten bearbeiten +|Account löschen |Beschreibung -|Der Nutzer verfügt über die Berechtigung den Inhalt eines vorhandenen Auftrags zubearbeiten. +|Der Nutzer verfügt über die Berechtigung dessen Account zu löschen. |Akteure -|Registrieter Nutzer +|Nutzer |Trigger -| +|Der Nutzer wählt „Account löschen“ im Bereich Account. |Bedingungen -| +|Der Nutzer ist angemeldet. -|Essizielle Schritte -| +|Essizielle Schritte a| +1. Der Nutzer wählt Account. +2. Eine Liste von Optionen wird angezeigt. +3. Der Nutzer wählt „Account löschen“. |Erweiterungen -| +| - |Funkionale Vorraussetzungen -| +| <> |=== [cols="1h,2"] @@ -608,28 +613,28 @@ image::models/analysis/useCaseDiagram.svg[] |[UC0402] |Name -|Auftragsdaten einsehen +|Logout |Beschreibung -|Der Nutzer verfügt über die Berechtigung den Inhalt eines vorhandenen Auftrags einzusehen. +|Der Nutzer verfügt über die Berechtigung sich abzumelden. |Akteure -|Registrieter Nutzer +|Nutzer |Trigger -| +|Der Nutzer wählt Abmelden in der Navigation Bar. |Bedingungen -| +|Der Nutzer ist angemeldet. -|Essizielle Schritte -| +|Essizielle Schritte a| +1. Der Nutzer wählt Abmelden in der Navigation Bar. |Erweiterungen -| +| - |Funkionale Vorraussetzungen -| +| Fehlt |=== [cols="1h,2"] @@ -638,89 +643,62 @@ image::models/analysis/useCaseDiagram.svg[] |[UC0403] |Name -|Auftrag entfernen +|Auftrag einsehen |Beschreibung -|Der Nutzer verfügt über die Berechtigung einen vorhandenen Auftrag aus dem System zu entfernen. +|Der Nutzer verfügt über die Berechtigung dessen Auftrag einzusehen. |Akteure -|Registrieter Nutzer +|Nutzer |Trigger -| +|Der Nutzer wählt Aufträge in der Navigation Bar. |Bedingungen -| +|Der Nutzer ist angemeldet. -|Essizielle Schritte -| +|Essizielle Schritte a| +1. Der Nutzer wählt Aufräge in der Navigation Bar. +2. Eine Auflistung aller Aufträge erscheint. |Erweiterungen -| +|- |Funkionale Vorraussetzungen -| +| <>,<> |=== -[cols="1h,2"] -|=== -|ID -|[UC0404] +===== Berechtigungen eines Kundens -|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 +|Rechnung einsehen |Beschreibung -|Der Nutzer verfügt über die Berechtigung das Inventar einzusehen. +|Der Nutzer verfügt über die Berechtigung dessen Rechnung einzusehen. |Akteure -|Registrieter Nutzer +|Kunde |Trigger -| +|Der Kunde wählt Rechnungen in der Navigation Bar. |Bedingungen -| +|Der Kunde ist angemeldet. -|Essizielle Schritte -| +|Essizielle Schritte a| +1. Der Kunde wählt Rechnungen in der Navigation Bar. +2. Eine Liste aller Rechnungen erscheint. |Erweiterungen -| +|Filtern zwischen Bezahlt und „Nicht Bezahlt“ |Funkionale Vorraussetzungen -| +| <> (wahrscheinlich noch einsehen zu Funktionalen Anforderung hinzufügen) |=== [cols="1h,2"] @@ -729,59 +707,99 @@ image::models/analysis/useCaseDiagram.svg[] |[UC0502] |Name -|Inventar bearbeiten +|Auftrag aufgeben |Beschreibung -|Der Nutzer verfügt über die Berechtigung den Inhalt des Inventars zu bearbeiten. +|Der Kunde verfügt über die Berechtigung einen Auftrag aufzugeben. |Akteure -|Registrieter Nutzer +|Kunde |Trigger -| +|Der Kunde wählte Angebote in der Navigation Bar. |Bedingungen -| +|Der Kunde ist angemeldet. -|Essizielle Schritte -| +|Essizielle Schritte a| +1. Der Kunde wählt Angebote in der Navigation Bar. +2. Eine Ansicht mit allen Angeboten erscheint. +3. Der Kunde wählt eins dieser Angebote. +4. Eine Ansicht mit Informationen über dieses Angebot erscheint. +5. Der Kunde wählt „Zum Warenkorb hinzufügen“. +6. Der Kunde wählt Warenkorb in der Navigation Bar. +7. Eine Liste mit allen Artikeln im Warenkorb erscheint. +8. Der Kunde drückt bestellen. |Erweiterungen -| +|- |Funkionale Vorraussetzungen -| +| <> |=== -===== Administration +[cols="1h,2"] +|=== +|ID +|[UC0503] + +|Name +|Auftragsdaten bearbeiten + +|Beschreibung +|Der Kunde verfügt über die Berechtigung dessen Aufräge zu bearbeiten. + +|Akteure +|Kunde + +|Trigger +|Der Kunde wählt einen Auftrag im Bereich Aufträge. + +|Bedingungen +|Der Kunde ist angemeldet. + +|Essizielle Schritte a| +1. Der Kunde wählt Aufträge in der Navigation. +2. Eine Liste aller Aufträge erscheint. +3. Der Kunde wählte einen dieser Aufträge. +4. Eine Ansicht mit Optionen erscheint. + +|Erweiterungen +| - + +|Funkionale Vorraussetzungen +| <> +|=== + +===== Ohne Authentifikation [cols="1h,2"] |=== |ID |[UC0601] |Name -|Registrieten Nutzer hinzufügen +|Login |Beschreibung -|Der Admin verfügt über die Berechtigung einen registrieten Nutzer anzulegen. +|Der unregistrierte Nutzer verfügt über die Berechtigung sich anzumelden. |Akteure -|Registrieter Nutzer +|Unregistrierter Nutzer |Trigger -| +|Der unregistrierte Nutzer wählt Anmelden in der Navigation Bar. |Bedingungen -| +| - -|Essizielle Schritte -| +|Essizielle Schritte a| +1. Der unregistrierte Nutzer wählt Anmelden in der Navigation Bar. |Erweiterungen -| +| - |Funkionale Vorraussetzungen -| +| Fehlt |=== [cols="1h,2"] @@ -790,89 +808,28 @@ image::models/analysis/useCaseDiagram.svg[] |[UC0602] |Name -|Registrieten Nutzer entfernen +|Registrieren |Beschreibung -|Der Admin verfügt über die Berechtigung einen registrieten Nutzer aus dem System zu entfernen. +|Der unregistrierte Nutzer verfügt über die Berechtigung sich ein Kundenkonto zu erstellen. |Akteure -|Registrieter Nutzer +|Unregistrierter Nutzer |Trigger -| +|Der unregistrierte Nutzer wählt Registrieren in der Navigation Bar. |Bedingungen -| +| - -|Essizielle Schritte -| +|Essizielle Schritte a| +1. Der unregistrierte Nutzer wählt Registrieren in der Navigation Bar. |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