Version 1.5

ANLEITUNG_ADMIN.md

@@ -0,0 +1,153 @@
+# TC Ingelfingen
+
+## Arbeitsstundenverwaltung
+
+### Benutzeranleitung Für Administratoren
+
+Diese Anleitung beschreibt die wichtigsten Funktionen der Arbeitsstundenverwaltung aus Sicht eines Administrators.
+
+Administratoren verwalten die Anwendung, pflegen Vereinswerte und führen Sicherungs- und Wiederherstellungsaufgaben durch.
+
+## 1. Anmeldung
+
+Melden Sie sich mit Ihrer E-Mail-Adresse und Ihrem Passwort an.
+
+Falls Sie Ihr Passwort vergessen haben, können Sie den Passwort-Reset über die Anmeldeseite nutzen.
+
+## 2. Dashboard
+
+Als Administrator sehen Sie im Dashboard die Gesamtübersicht über alle Mitglieder.
+
+Angezeigt werden insbesondere:
+
+- Pflichtstunden gesamt
+- geleistete Stunden gesamt
+- noch offene Stunden gesamt
+- die jeweiligen Werte in EUR
+- der Fortschritt der geleisteten Arbeitsstunden in Prozent
+
+Zusätzlich wird ein Informationskasten angezeigt, sofern dieser vom Verein gepflegt wurde.
+
+## 3. Profil
+
+Über Ihren Namen oben rechts gelangen Sie in Ihr Profil.
+
+Dort können Sie:
+
+- Ihren Vornamen ändern
+- Ihren Nachnamen ändern
+- Ihr eigenes Passwort ändern
+
+## 4. Benutzerverwaltung
+
+Im Bereich `Benutzerverwaltung` können Sie:
+
+- neue Benutzer anlegen
+- Benutzer löschen
+- Benutzerpasswörter zurücksetzen
+- Benutzerrollen ändern
+
+Die Benutzerliste ist nach Nachnamen sortiert und auf 50 Einträge pro Seite paginiert.
+
+## 5. Stundenbuchung
+
+Im Bereich `Stundenbuchung` können Sie:
+
+- Stunden für Mitglieder buchen
+- alle Stundenbuchungen einsehen
+- einzelne Stundenbuchungen löschen
+
+Die Liste der Stundenbuchungen ist auf 50 Einträge pro Seite paginiert.
+
+## 6. Vereinskonfiguration
+
+Im Bereich `Vereinskonfiguration` können Sie:
+
+- Pflichtstunden pro Mitglied festlegen
+- den Wert pro Stunde festlegen
+- den Informationskasten im Dashboard pflegen
+- Benutzerdaten als CSV exportieren
+- Stundenbuchungen als CSV exportieren
+
+## 7. Administration
+
+Im Bereich `Administration` finden Sie erweiterte Verwaltungsfunktionen.
+
+Dazu gehören:
+
+- SQL-Dump herunterladen
+- SQL-Dump wiederherstellen
+- Benutzerdaten per CSV importieren
+- alle Arbeitsstunden auf 0 zurücksetzen
+- Logansicht aller Verwaltungsaktionen
+
+Die Logansicht ist auf 50 Einträge pro Seite paginiert.
+
+## 8. SQL-Backup Und Wiederherstellung
+
+Für vollständige Datensicherungen steht ein SQL-Dump zur Verfügung.
+
+Empfohlene Vorgehensweise:
+
+1. Laden Sie vor größeren Änderungen einen SQL-Dump herunter.
+2. Bewahren Sie die Datei an einem sicheren Ort auf.
+3. Verwenden Sie für eine Wiederherstellung ausschließlich vertrauenswürdige SQL-Dateien.
+
+Wichtiger Hinweis:
+
+- Die Wiederherstellung eines SQL-Dumps überschreibt die bestehenden App-Daten.
+
+## 9. CSV-Import
+
+Der CSV-Import dient zur Übernahme von Benutzerdaten.
+
+Erwartet werden folgende Spalten:
+
+- `firstname`
+- `lastname`
+- `email`
+- `role`
+- `hours_worked`
+
+Benutzer werden anhand der E-Mail-Adresse erkannt.
+
+## 10. Arbeitsstunden Zurücksetzen
+
+Mit dieser Funktion werden alle gebuchten Arbeitsstunden aller Mitglieder auf 0 gesetzt.
+
+Diese Funktion ist insbesondere für den Jahreswechsel vorgesehen und sollte nur mit entsprechender Sorgfalt verwendet werden.
+
+## 11. Logansicht
+
+In der Logansicht werden unter anderem folgende Aktionen protokolliert:
+
+- Benutzer anlegen
+- Benutzer löschen
+- Rollen ändern
+- Passwort zurücksetzen
+- eigenes Passwort ändern
+- Passwort per Reset-Link neu setzen
+- Speichern von Vereinswerten
+- CSV-Exporte
+- CSV-Import
+- Arbeitsstunden auf 0 setzen
+- SQL-Dump exportieren und wiederherstellen
+
+## 12. Passwort Vergessen
+
+Falls Sie Ihr Passwort vergessen haben, können Sie den Reset-Link über die Anmeldeseite anfordern und anschließend ein neues Passwort vergeben.
+
+## 13. Darkmode
+
+Über den Schalter links neben `Abmelden` kann zwischen hellem und dunklem Farbschema gewechselt werden.
+
+## 14. Abmelden
+
+Bitte melden Sie sich nach Abschluss Ihrer Arbeiten stets über `Abmelden` ab.
+
+## 15. Empfehlungen Für Den Betrieb
+
+- Erstellen Sie regelmäßig SQL-Backups.
+- Nutzen Sie CSV-Exporte für Auswertungen und Weitergaben.
+- Prüfen Sie Importe vor der Ausführung sorgfältig.
+- Dokumentieren Sie größere organisatorische oder technische Änderungen zusätzlich außerhalb der Anwendung.