diff --git a/docs/BENUTZERHANDBUCH.md b/docs/BENUTZERHANDBUCH.md new file mode 100644 index 0000000..b63d6e9 --- /dev/null +++ b/docs/BENUTZERHANDBUCH.md @@ -0,0 +1,103 @@ +# MABEA – Benutzerhandbuch + +Kurzübersicht über Funktionen, Rollen und Tastenkombinationen. Ergänzt die +technische Doku in `arbeitskacheln/` (Backlog/Epics) und `GESAMTDOKUMENT.md` +(Projekthistorie) um eine reine Nutzer-Perspektive. + +## Rollen + +| Rolle | Kernaufgabe | +|---|---| +| Mitarbeiter | Kontrolliert Objekte, füllt nach, meldet Mängel | +| Materialverantwortlicher | sieht Fehlbestände, genehmigt Mindermengen, pflegt Material/Lager | +| Leitungsverantwortlicher | erweiterte Sicht (Dashboard, Kontrollverantwortung, Eskalation) | +| Administration | Stammdaten, Benutzer, Rollen, volle Verwaltung | + +"Verantwortliche" (Materialverantwortlicher/Leitungsverantwortlicher/ +Administration) sehen zusätzlich Dashboard, Fehlbestände und +Verwaltung/Administration in der Seitenleiste. + +## Tastenkombinationen + +| Kombination | Aktion | +|---|---| +| `Strg`/`⌘` + `K` | Globale Suche & Quick Actions öffnen (Command Palette) | +| `Esc` | Command Palette schließen | + +In der Command Palette: Objekt-Name oder Code eintippen (springt direkt zur +Akte), oder eine der Quick Actions wählen (QR scannen, Material/Lager/ +Personal/Ausgabe/Verwaltung, je nach Rolle). + +## Grundfunktionen + +### Objekte + +- **Objekte** (Seitenleiste): Liste aller Fahrzeuge/Rucksäcke/Ausstattung. + Suche nach Name oder Code, Button "Scannen" öffnet die Kamera für QR-Codes. +- Klick auf ein Objekt startet die **Kontrolle** (Soll-/Ist-Abgleich je + Position, Fortschritt sichtbar, Abweichungen führen automatisch zu einem + **Fehlbestand**). +- Link "Akte ansehen" öffnet die **Objektakte**: Stammdaten, Verantwortlichkeit, + Geräte-Prüfungen, Mängel, Dokumente, Historie an einer Stelle. Ein + QR-Scan führt direkt hierher (nicht mehr in die Kontrolle). + +### Mängel + +- **Mängel** (Seitenleiste): alle gemeldeten Mängel, Priorität + niedrig/normal/hoch. Kritische (hoch, offen) Mängel blockieren die + Einsatzbereitschaft eines Objekts. + +### Fehlbestände (Verantwortliche) + +- Liste aller offenen/erledigten Fehlbestände. Nachfüllung reduziert die + Fehlmenge, bei 0 automatisch erledigt. Mindermengen können mit Begründung + genehmigt werden (Objekt bleibt dann "eingeschränkt einsatzbereit"). + +### Dashboard (Verantwortliche) + +- Karte **"Was ist jetzt zu tun?"** ganz oben: offene Fehlbestände, kritische + Mängel, überfällige Prüfungen, abgelaufene Chargen, nie kontrollierte + Objekte – mit Direktlinks. +- Karte **Einsatzbereitschaft**: einsatzbereit/eingeschränkt/unbekannt/nicht + einsatzbereit als Zahl und Badge, "Details anzeigen" listet die + betroffenen Objekte mit Begründung. +- Weitere Karten: nächste Prüftermine, bevorstehende Ablaufdaten, + Kennzahlen, Mängel, Qualifikationsablauf. +- Ist standardmäßig die Startseite für Verantwortliche nach dem Login (in + der Seitenleiste per Dropdown "Startseite: automatisch/Dashboard/Objekte" + umstellbar). + +### Verwaltung / Administration + +Tabs je nach Rolle sichtbar (in der URL als `/admin?tab=...` verlinkbar, +z. B. aus der Command Palette): + +- **Objekte, Vorlagen, Material, Struktur, Standorte** – Stammdaten. +- **Lager** – Lagerort-Hierarchie, Lagerplätze, Bestand, Ein-/Auslagern, + Umlagern zwischen Lagerplätzen. +- **Ausgabe/Rückgabe** – wer hat gerade welches Material/Leihgerät (z. B. + Funkgerät), Rückgabe schließt den Vorgang. +- **Benutzer, Rollen & Rechte** – Zugänge und Berechtigungen. +- **Zuständigkeit, Kontrollverantwortung** – wer ist wofür zuständig. +- **Personal** – Qualifikationen, Einheiten. +- **Eskalation** – Zeitschwellen für automatische Erinnerungs-/Eskalations- + E-Mails bei lange offenen Fehlbeständen. +- **Änderungslog, Lagerbewegungen** – Nachvollziehbarkeit. + +## Darstellung + +- **Dark Mode**: Schalter oben in der Seitenleiste (System/Hell/Dunkel), + Einstellung bleibt über Neuladen hinweg erhalten. +- **Online-/Sync-Status**: Badge oben rechts (🟢 Online, 🟡 Synchronisiert + gerade, 🔴 Offline) – bei fehlender Verbindung werden Kontroll-Eingaben + lokal zwischengespeichert und automatisch übertragen, sobald wieder online. +- **Status-Farben**: 🟢 einsatzbereit, 🟡 eingeschränkt, 🔴 nicht + einsatzbereit, ⚪ unbekannt/nie kontrolliert – "unbekannt" wird nie wie + "einsatzbereit" dargestellt. + +## Benachrichtigungen + +- Neuer Fehlbestand löst sofort eine E-Mail an zuständige + Verantwortliche aus (falls E-Mail hinterlegt und SMTP konfiguriert). +- Bleibt ein Fehlbestand lange offen, folgen automatische Erinnerungs- und + Eskalations-E-Mails (Zeitschwellen unter Verwaltung → Eskalation).