Skip to content

Instantly share code, notes, and snippets.

@Korkmatik
Created April 22, 2021 10:09
Show Gist options
  • Save Korkmatik/38e49dae31787e20ae059fd369a33c3b to your computer and use it in GitHub Desktop.
Save Korkmatik/38e49dae31787e20ae059fd369a33c3b to your computer and use it in GitHub Desktop.
Markdown Vorlage für ein Pflichtenheft

Projekt: Online-Mitarbeiterverwaltung

Auftraggeber:
Fakecompany GmbH
Fakestreet. 43, 1234 Fakecity

Auftragnehmer:
Softwarecompany GmbH
Fakestreet. 43, 1234 Fakecity

Versionen

Version Datum Kommentar Status
1.0 05.04.2020 Erster Entwurf draft

Inhaltsverzeichnis

Zielbestimmung

Musskriterien

Hier werden alle Kriterien beschreiben, die das Produkt können muss, damit es für den vorgegebenen Einsatzzweck verwendet werden kann.

Mitarbeiter

[...snip...]

System

[...snip...]

Wunschkriterien

Hier werden alle Kriterien beschrieben, die das Produkt können sollte, um die Wünsche an das zu entwickelnde Produkt so gut wie möglich zu erfüllen.

Abgrenzungskriterien

Folgende Ziele werden bei dem neuen Produkt bewusst nicht verfolgt:

Produkteinsatz

Anwendungsbereich

Glossar

Zielgruppen

Betriebsbedingungen

Funktionale Anforderungen

Übersicht

Im nachfolgenden Diagramm sind alle Use Cases, Nutzer und Beziehungen zwischen diesen abgebildet.

Detailbeschreibung Use-Cases

[...snip...]

/UC6.1/ Eigene Jahres-Stunden-Übersicht einsehen

Übersicht

Ziel Einsicht in eigene Jahres-Stunden-Übersicht
Vorbedingung User ist als Mitarbeiter eingeloggt
Resultat User weiß wie viele Stunden er pro Monat im aktuellen Jahr gearbeitet hat
Nutzer Mitarbeiter
Auslöser Übersicht auswählen, unter der Funktion Zeiterfassung

Detailbeschreibung

Name: Einsicht in eigene Jahres-Stunden-Übersicht

Kurzbeschreibung: Der User hat die Möglichkeit seine eigene Jahres-Stunden-Übersicht zu sehen. Dadurch weiß er wieviel er pro Monat gearbeitet hat, wieviel er arbeiten hätte sollen und was sein Stundensaldo in dem Monat war. Für jeden Monat wird eine Box dargestellt mit diesen Daten.

Akteure:

  • Mitarbeiter
  • Zeiterfassungsdatenbank

Auslöser: Mitarbeiter führt das Mitarbeiterzeiterfassungsprogramm aus und geht auf Zeiterfassung

Ergebnisse: Jahres-Stunden-Übersicht im angegebenen Jahr wird angezeigt

Eingehende Daten:

  • Session ID
  • Mitarbeiter ID
  • Auswahl, dass der User Jahres-Stunden-Übersicht ansehen möchte
  • Das ausgewählte Jahr (kann auch ein Standardwert existieren, sodass das Jahr nicht vom User explizit angegeben werden muss)

Vorbedingung: User ist als Mitarbeiter eingeloggt

Nachbedingung User ist immernoch als Mitarbeiter eingeloggt; Anzeigen der Ansicht für die Jahres-Stunden-Übersicht

Essenzielle Schritte:

  1. Use Case Login
  2. User klickt auf Zeiterfassung
  3. User klickt auf Übersicht
  4. Zeiterfassungsdatenbank gibt Jahres-Stunden-Übersicht des Mitarbeiters zurück
  5. Jahres Stunden Übersicht wird angezeigt

Ausnahmen

  • zu 4: Falls noch keine Jahres-Stunden-Übersicht existiert:

    • 4a) Anzeigen, dass keine Jahres-Stunden-Übersicht existiert
  • zu 4: Datenbankfehler jeglicher Art

    • 4b) Operationen abbrechen
    • 4c) User anzeigen, dass es einen Fehler gab und dass er es noch einmal versuchen soll. Falls dieser Fehler besteht soll er einen Administrator kontaktieren
    • 4d) Bei 2. fortsetzen

Änderungshistorie:

  • 01.04.2020; Korkmatik; Anwendungsfall angelegt

[...snip...]

Offene Punkte

< Hier werden alle offenen Fragen gesammelt. In der Final-Version darf hier nichts mehr stehen! >

Produkteigenschaften

Systemumgebung

Hardwareumgebung

Softwareumgebung

Nicht-funktionale Anforderungen

Portability: Maintainability: Reliability:

Benutzbarkeit

Effizienz

Wartbarkeit und Portierung

Sicherheitsanforderungen

Normen und gesetzliche Anforderungen

Produktdaten

Welche Benutzerdaten speichert das System?

Ergänzungen

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment