diff --git a/docs/user-guide.md b/docs/user-guide.md index 7e48b1a..286e52c 100644 --- a/docs/user-guide.md +++ b/docs/user-guide.md @@ -1,18 +1,26 @@ # TicketTracker Benutzeranleitung -Diese Anleitung beschreibt die Nutzung von TicketTracker im Arbeitsalltag: Zeiten erfassen, Sessions bewerten, CRM-Zeiten eintragen, fixe Abrechnungen verwalten und Monatsauswertungen abschliessen. +Diese Anleitung beschreibt die Nutzung von TicketTracker im Arbeitsalltag: Zeiten erfassen, Sessions bewerten, Teamspace-Zeiten eintragen, fixe Abrechnungen verwalten, Statistiken lesen und den Monatsabschluss durchfuehren. ## Grundprinzip -TicketTracker ersetzt nicht das Ticketsystem oder CRM. Die App dient dazu, Arbeitszeiten sauber zu messen, auszuwerten und fuer die spaetere Abrechnung vorzubereiten. +TicketTracker ersetzt nicht das Ticketsystem und nicht das CRM. Die App ist die Arbeitszeiterfassung und Auswertung daneben. -Es gibt drei Zeitebenen: +Es gibt drei zentrale Zeitebenen: - Session-Zeit: Die gemessene oder manuell erfasste Arbeitszeit einer einzelnen Taetigkeit. -- Tages-CRM-Zeit: Die Zeit, die fuer ein Ticket an einem konkreten Tag wirklich im CRM eingetragen wurde. -- Monatsabschluss: Ein Ticket wird fuer einen Monat geschlossen, wenn alle Sessions dieses Tickets im Monat bewertet sind. +- Teamspace-Zeit: Die Zeit, die fuer ein Ticket an einem konkreten Tag wirklich im CRM beziehungsweise Teamspace eingetragen wurde. +- Monatsabschluss: Der Abschluss eines ganzen Monats, sobald alle Sessions des Monats bewertet sind. -## Anmeldung +Wichtig: Tickets werden nicht geschlossen. Tickets dienen nur als Gruppierung fuer Sessions. Abgeschlossen wird ausschliesslich der Monat. + +## Hilfe und FAQ + +Die App hat eine eigene Unterseite `FAQ`. Dort steht die ausfuehrliche Bedienungsanleitung mit Abschnitten zu Timer, Auswertung, Teamspace, Monatsabschluss, Statistiken, fixen Abrechnungen, Profil und Adminbereich. + +An vielen Stellen in der Oberflaeche gibt es ein Fragezeichen-Icon. Ein Klick darauf oeffnet ein kurzes Hilfe-Modal zur jeweiligen Card oder Funktion. Im Modal gibt es einen Link zum passenden ausfuehrlichen FAQ-Abschnitt. + +## Anmeldung und Navigation 1. App im Browser oeffnen. 2. Mit Benutzername und Passwort anmelden. @@ -20,18 +28,47 @@ Es gibt drei Zeitebenen: Normale Benutzer sehen ihre eigenen Zeiten, Auswertungen, fixen Abrechnungen und ihr Profil. Administratoren sehen zusaetzlich den Adminbereich. +Die Navigation ist in Workflows gegliedert: + +- Timer +- Auswertung +- Monatsabschluss +- Statistiken +- Fixe Abrechnung +- Profil +- Benutzer, nur fuer Admins +- FAQ + +Nach `Auswertung`, nach `Monatsabschluss` und vor `FAQ` trennt eine Linie die Bereiche optisch. + +## Globaler Timer-Schnellstart + +Oben im Header gibt es auf allen Unterseiten ein Ticket-Eingabefeld fuer den schnellen Timerstart. + +1. Ticketnummer im Format `Ticket#XXXXXX` eingeben. +2. `Timer starten` klicken. +3. Der neue Timer startet sofort. + +Wenn fuer diese Ticketnummer bereits ein Timer existiert, wird dieser vorhandene Timer aktiviert. Alle anderen Timer werden automatisch pausiert. + +Wenn zu der Ticketnummer bereits Ticketdaten vorhanden sind, zeigt der Timer auch die Organisation an. + ## Timer Die Seite `Timer` ist fuer laufende Arbeit an Tickets gedacht. 1. Ticketnummer im Format `Ticket#XXXXXX` eingeben. -2. `Session beginnen` klicken. +2. `Timer starten` klicken. 3. Der Timer startet. -4. Bei Bedarf kann der Timer pausiert, fortgesetzt, beendet oder zurueckgesetzt werden. +4. Bei Bedarf kann der Timer pausiert, aktiviert, beendet oder entfernt werden. -Es koennen mehrere Timer vorbereitet sein, aber immer nur ein Timer laeuft aktiv. Wird ein anderer Timer gestartet oder fortgesetzt, werden alle anderen laufenden Timer automatisch pausiert. +Es koennen mehrere Timer vorbereitet sein, aber immer nur ein Timer laeuft aktiv. Wird ein anderer Timer aktiviert, werden alle anderen Timer automatisch pausiert. -Beim Klick auf `Beenden` stoppt der Timer sofort. Danach wird die Session fertig gespeichert: +Alle laufenden und pausierten Timer stehen in der Seitenleiste. Dadurch bleiben sie auf allen Unterseiten sichtbar. + +Beim Klick auf `Beenden` stoppt der Timer sofort. Das spaetere Ausfuellen des Modals verlaengert die gemessene Zeit nicht. + +Beim Speichern nach dem Beenden gilt: - Existiert das Ticket bereits, werden Organisation und Art vom Ticket uebernommen. - Dann muss nur noch die Taetigkeit eingetragen werden. @@ -41,7 +78,7 @@ Die gemessene Zeit wird auf Minuten gerundet. Pausen werden von der Gesamtdauer ## Session Nachtragen -Sessions koennen auch manuell nachgetragen werden, zum Beispiel wenn ein Timer vergessen wurde. +Sessions koennen manuell nachgetragen werden, zum Beispiel wenn ein Timer vergessen wurde. Normale Benutzer koennen eigene Sessions nachtragen. Administratoren koennen Sessions fuer andere Benutzer nachtragen. @@ -51,11 +88,16 @@ Beim Nachtragen werden angegeben: - Organisation - Art: Support oder Consulting - Datum -- Von- und Bis-Uhrzeit +- Von-Uhrzeit +- Bis-Uhrzeit - Taetigkeit Das Taetigkeitsfeld ist mehrzeilig. Zeilenumbrueche bleiben in der Auswertung erhalten. +Das Ende muss nach dem Beginn liegen. Die Dauer wird automatisch berechnet und auf Minuten gerundet. + +In der Ticketdetailansicht gibt es ebenfalls `Session nachtragen`. Dort wird die neue Session direkt dem geoeffneten Ticket zugeordnet. + ## Ticketdaten Bearbeiten In der Ticketdetailansicht koennen Ticketdaten nachtraeglich korrigiert werden: @@ -64,11 +106,17 @@ In der Ticketdetailansicht koennen Ticketdaten nachtraeglich korrigiert werden: - Organisation - Art -Aenderungen an Organisation und Art werden auf vorhandene manuelle Sessions des Tickets uebernommen. Bei wiederkehrend erzeugten Sessions bleibt die Art aus der Regel erhalten und kann nur ueber die fixe Abrechnung geaendert werden. +Aenderungen an Organisation und Art werden auf vorhandene manuelle Sessions des Tickets uebernommen. + +Bei wiederkehrend erzeugten Sessions bleibt die Art aus der Regel erhalten und kann nur ueber die fixe Abrechnung geaendert werden. + +Wenn ein Ticket bereits durch einen anderen Benutzer existiert, koennen die Ticketdaten beim Beenden eines Timers uebernommen werden. Die Session selbst bleibt trotzdem dem angemeldeten Benutzer zugeordnet. ## Organisationen -Organisationen werden aus Zammad synchronisiert. Danach koennen Organisationen in TicketTracker nur noch aus der Liste ausgewaehlt werden, nicht mehr frei als Text eingetragen werden. +Organisationen werden aus Zammad synchronisiert. Danach koennen Organisationen in TicketTracker nur noch aus der lokalen Liste ausgewaehlt werden. Freitext ist nicht mehr moeglich. + +Der Grund: Nur mit eindeutigen Organisationen sind saubere Auswertungen pro Kunde ueber mehrere Monate moeglich. Bereits vorhandene alte Freitexte muessen bei Bedarf manuell korrigiert werden, indem das Ticket oder die Session bearbeitet und eine Organisation aus der Liste ausgewaehlt wird. @@ -79,13 +127,13 @@ Die Seite `Auswertung` hat zwei Ansichten: - Monat - Tag -Mit den Pfeilen neben dem Datumsfeld kann ein Monat oder Tag vor- und zurueckgeschaltet werden. Die Daten aktualisieren sich automatisch. +Mit den Pfeilen neben dem Datumsfeld kann ein Monat oder Tag vor- und zurueckgeschaltet werden. Die Daten aktualisieren sich automatisch. Ein separater Aktualisieren-Button ist nicht notwendig. Die oberen Karten zeigen: - Tickets: Anzahl der Tickets im Zeitraum - Sessions: Anzahl der Sessions im Zeitraum -- Zeit: Summe der erfassten Session-Zeit, plus CRM-Zeit +- Zeit: Summe der erfassten Session-Zeit und, sofern vorhanden, die dazugehoerige Teamspace-Zeit als Vergleichswert - Offen: Anzahl unbewerteter Sessions Der Graph `Gesamtaufwand` zeigt den Aufwand im Zeitraum: @@ -93,7 +141,7 @@ Der Graph `Gesamtaufwand` zeigt den Aufwand im Zeitraum: - In der Monatsansicht pro Tag - In der Tagesansicht pro Stunde -## Tickets Im Zeitraum +## Tickets im Zeitraum Unter `Tickets im Zeitraum` werden alle Tickets angezeigt, die im gewaehlten Zeitraum Sessions haben. @@ -115,6 +163,33 @@ Der Status bedeutet: - `offen`: Es gibt noch unbewertete Sessions. - `bewertet`: Alle Sessions dieses Tickets im gewaehlten Zeitraum sind bewertet. +### Filtern, Gruppieren und Sortieren + +Die Ticketliste kann gefiltert, gruppiert und sortiert werden. + +Filter: + +- Suche nach Ticketnummer oder Organisation +- Typ +- Organisation +- Status + +Gruppierung: + +- Keine +- Typ +- Organisation +- Status + +Sortierung: + +- Ticket +- Typ +- Organisation +- Status + +Die Einstellungen bleiben im Browser gespeichert, auch nach Aktualisierung oder Browserneustart. Mit `Zuruecksetzen` werden sie auf Standard gesetzt. + ## Ticketdetailansicht Ein Ticket wird aus der Auswertung heraus geoeffnet. @@ -122,24 +197,30 @@ Ein Ticket wird aus der Auswertung heraus geoeffnet. In der Ticketdetailansicht sieht man: - Ticketnummer mit Copy-Icon -- Abschlussstatus +- Status des Monats - Ticketdaten - Session-Eintraege nach Tagen gruppiert +- Teamspace-Wert pro Ticket und Tag - Moeglichkeit, direkt eine Session zu diesem Ticket nachzutragen Die Sessions sind pro Tag gruppiert. In jeder Tagesgruppe stehen: - Tagesdatum - `Tag gesamt`: Summe der erfassten Session-Zeit dieses Tages -- `CRM`: Stunden, die fuer dieses Ticket an diesem Tag wirklich im CRM eingetragen wurden +- `Teamspace`: Stunden, die fuer dieses Ticket an diesem Tag wirklich im CRM eingetragen wurden -Das CRM-Feld wird in Stunden eingetragen, zum Beispiel: +Das Teamspace-Feld wird in Stunden eingetragen, zum Beispiel: - `1` - `1,5` - `2.25` +- `0,75` -Ein leeres CRM-Feld entfernt den gespeicherten CRM-Wert fuer diesen Ticket-Tag. Der Wert ist derselbe in Monats- und Tagesansicht. +Der Teamspace-Wert wird nicht waehrend der Eingabe gespeichert. Sobald sich der Wert geaendert hat, erscheint ein Speichern-Button. Erst dieser Button speichert den Wert. + +Ein leeres Teamspace-Feld entfernt den gespeicherten Teamspace-Wert fuer diesen Ticket-Tag. + +Der Wert ist derselbe in Monats- und Tagesansicht. Wenn er in einer Ansicht gespeichert wird, ist er in der anderen Ansicht identisch gesetzt. ## Sessions Bewerten @@ -150,6 +231,8 @@ Jede Session kann bewertet werden als: Ein erneuter Klick auf den bereits gewaehlten Zustand nimmt die Bewertung zurueck. Dadurch wird die Session wieder offen. +Nicht abrechenbare Sessions gelten als bewertet. Sie blockieren den Monatsabschluss nicht. + Es gibt keinen Ticketabschluss. Tickets dienen nur als Gruppierung fuer Sessions. Abgeschlossen wird ausschliesslich der Monat. Wenn der Monat bereits abgeschlossen ist, muss er zuerst wieder geoeffnet werden, bevor Bewertungen geaendert werden. @@ -169,6 +252,8 @@ Bearbeitbar sind: Bei wiederkehrenden Sessions ist die Art gesperrt. Sie kommt aus der Regel der fixen Abrechnung. +Von und Bis beziehen sich nur auf die Uhrzeit. Das Datum ist ein eigenes Feld. + ## Sessions Loeschen Eine Session kann ueber das Papierkorb-Icon geloescht werden. @@ -177,13 +262,30 @@ Wird die letzte Session eines Tickets geloescht, wird das Ticket entfernt. Die A Bei wiederkehrenden Sessions wird das Loeschen als Ausnahme gespeichert. Dadurch wird die Session fuer diesen Tag nicht automatisch wieder neu erzeugt. -## Zeitraum Abschliessen +Wenn eine wiederkehrende Leistung an einem anderen Tag erbracht wurde, kann die erzeugte Session bearbeitet beziehungsweise verschoben werden. + +## Monatsabschluss + +Der Monatsabschluss ist eine eigene Unterseite. Ein Monat kann abgeschlossen werden, wenn: - Alle Sessions im Monat bewertet sind. -Einen separaten Tagesabschluss gibt es nicht. Die Tagesansicht ist nur eine gefilterte Kontrolle einzelner Tage. Bewertungen und CRM-Tageswerte wirken in Monats- und Tagesansicht auf dieselben Daten, abgeschlossen wird aber ausschliesslich der Monat. +Einen separaten Tagesabschluss gibt es nicht. Die Tagesansicht ist nur eine gefilterte Kontrolle einzelner Tage. Bewertungen und Teamspace-Tageswerte wirken in Monats- und Tagesansicht auf dieselben Daten, abgeschlossen wird aber ausschliesslich der Monat. + +Die Seite `Monatsabschluss` enthaelt: + +- Checkliste +- Offene Bewertungen +- Tage ohne Teamspace-Wert +- Button zum Monat abschliessen oder wieder oeffnen + +Offene Bewertungen werden nach Ticket gruppiert. Mit `Ticket oeffnen` gelangt man direkt zur Bewertung. + +Tage ohne Teamspace-Wert sind eine Pruefliste. Wenn ein Tag bewusst keinen Teamspace-Wert bekommen soll, kann der Eintrag mit `Zur Kenntnis` abgehakt werden. + +Zur Kenntnis genommene Eintraege koennen ueber die Checkbox `Zur Kenntnis anzeigen` wieder eingeblendet werden. Diese Anzeigeeinstellung bleibt im Browser gespeichert. Ein abgehakter Eintrag kann mit `Zuruecknehmen` wieder offen gemacht werden. ## Fixe Abrechnungen @@ -208,12 +310,93 @@ Eine fixe Abrechnung enthaelt: Wenn keine Ticketnummer hinterlegt ist, wird automatisch `Fix#ID` verwendet. +Muster: + +- `Wochentage`: Es werden einzelne Slots mit Wochentag, Startzeit und Dauer gepflegt. +- `Alle X Wochen`: Das Gueltig-von-Datum ist der Startpunkt. Das Intervall laeuft wochenweise. + Bayerische Feiertage werden bei der automatischen Erzeugung beruecksichtigt. Fuer Feiertage werden keine Sessions erzeugt. Fixe Abrechnungen koennen bearbeitet werden. Wenn Gueltigkeiten oder Slots geaendert werden, werden nicht mehr passende erzeugte Sessions entfernt oder angepasst. Fix erzeugte einzelne Sessions koennen geloescht werden, zum Beispiel wegen Urlaub oder Krankheit. Diese Loeschung wird als Ausnahme gespeichert, damit die Session nicht beim naechsten Aufruf wieder automatisch erscheint. +## Statistiken + +Die Seite `Statistiken` betrachtet immer einen Monat. Sie dient als Ueberblick fuer getrackte Zeiten, Teamspace-Vergleich, Bewertungsstand und Auffaelligkeiten. + +### Kennzahlen + +`Getrackt` zeigt die Summe aller Session-Zeiten des Monats. Dazu werden Sessionanzahl und Ticketanzahl angezeigt. Dieser Wert ist die Basis fuer den Vergleich mit Teamspace. + +`Teamspace` zeigt die Summe aller Teamspace-Tageswerte im Monat. Die Differenz wird immer so berechnet: + +```text +Teamspace-Zeit minus getrackte Session-Zeit +``` + +Das bedeutet: + +- Positive Differenz: In Teamspace steht mehr Zeit als getrackt wurde. +- Negative Differenz: In Teamspace steht weniger Zeit als getrackt wurde. +- Ausgeglichen: Beide Werte sind gleich. + +Farben: + +- Sessions: blau +- Teamspace: gruen +- Positive oder ausgeglichene Differenz: gruen +- Negative Differenz: rot +- Bewertet: violett +- Offen: gelb/orange + +`Bewertet` zeigt alle Sessions, die entweder `Abgerechnet` oder `Nicht abrechenbar` sind. Nicht abrechenbare Sessions zaehlen also mit. + +`Offen` zeigt Sessions ohne Bewertung. Diese blockieren den Monatsabschluss. + +### Monatsverlauf und Abrechnungsqualitaet + +Diese Card kombiniert den Tagesverlauf und die Bewertungsqualitaet. + +- Balken zeigen getrackte Session-Zeit. +- Die Linie zeigt Teamspace-Zeit. +- Der Bewertungsstand zeigt bewertete gegen offene Sessions. +- Der Teamspace-Abgleich zeigt die Gesamtdifferenz. +- Manuell und Fix trennen manuell erfasste Sessions von automatisch erzeugten Sessions. + +### Statistik pro Organisation + +Diese Card gruppiert den Aufwand nach Organisation. + +Sichtbar sind: + +- Organisation +- Sessions +- Zeiten: Sessions und Teamspace +- Differenz +- Anteil am Monat + +Bei vielen Organisationen wird paginiert. + +### Typen + +Die Typen-Card trennt Support und Consulting. + +Sie zeigt je Typ: + +- Tickets +- Sessions +- Session-Zeit +- Teamspace-Zeit +- Differenz +- Anzahl abgerechnet, nicht abrechenbar und offen + +### Ticket-Hotspots + +Ticket-Hotspots zeigen die groessten Zeitbloecke des Monats nach Ticket. + +Sie helfen, die groessten Aufwandstreiber schnell zu finden. Mit `Oeffnen` gelangt man direkt in die Ticketdetailansicht des Monats. + ## Profil Unter `Profil` kann jeder Benutzer seine eigenen Daten pflegen: @@ -222,7 +405,7 @@ Unter `Profil` kann jeder Benutzer seine eigenen Daten pflegen: - Voller Name - Passwort -Passwortaenderungen erfordern das aktuelle Passwort. +Passwortaenderungen erfordern das aktuelle Passwort. Bleiben die Passwortfelder leer, werden nur Benutzername und voller Name gespeichert. ## Adminbereich @@ -238,6 +421,8 @@ Administratoren koennen: Bei der Auswertung normaler Benutzer werden nur die Sessions des angemeldeten Benutzers beruecksichtigt. Ticketdaten koennen trotzdem von Sessions anderer Benutzer uebernommen werden, wenn dasselbe Ticket schon existiert. +Beim Umverteilen einer Session werden betroffene Monatsabschluesse fuer alten und neuen Besitzer wieder geoeffnet, damit Auswertung und Abschluss konsistent bleiben. + ## Zammad Sync Der Zammad-Sync ist nur fuer Administratoren sichtbar. @@ -251,21 +436,26 @@ Gespeichert werden: - Name - Zeitstempel -Neue Organisationen werden hinzugefuegt, geaenderte Namen aktualisiert und nicht mehr vorhandene Organisationen entfernt beziehungsweise von bestehenden Tickets geloest. +Neue Organisationen werden hinzugefuegt, geaenderte Namen aktualisiert und nicht mehr vorhandene Organisationen entfernt beziehungsweise von bestehenden Tickets und Sessions geloest. ## Typischer Monatsablauf 1. Im Alltag Sessions per Timer oder Nachtragen erfassen. -2. Am Monatsende `Auswertung` oeffnen. -3. Monat auswaehlen. -4. Offene Sessions pruefen. -5. Pro Ticket jede Session als `Abgerechnet` oder `Nicht abrechenbar` markieren. -6. Pro Tag und Ticket die wirklich ins CRM eingetragene Zeit im Feld `CRM` pflegen. -7. Wenn keine Sessions im Monat mehr offen sind, Monat abschliessen. +2. Optional fixe Abrechnungen pflegen, damit wiederkehrende Sessions automatisch erzeugt werden. +3. Am Monatsende `Auswertung` oeffnen. +4. Monat auswaehlen. +5. Offene Sessions pruefen. +6. Pro Ticket jede Session als `Abgerechnet` oder `Nicht abrechenbar` markieren. +7. Pro Tag und Ticket die wirklich in Teamspace eingetragene Zeit im Feld `Teamspace` pflegen. +8. `Monatsabschluss` oeffnen. +9. Offene Bewertungen abarbeiten. +10. Tage ohne Teamspace-Wert pruefen oder zur Kenntnis nehmen. +11. Wenn keine Sessions im Monat mehr offen sind, Monat abschliessen. ## Hinweise - Ticketnummern koennen ueber das Copy-Icon schnell in die Zwischenablage kopiert werden. - Die App aktualisiert Auswertungen automatisch beim Wechsel von Monat oder Tag. -- Eine zurueckgenommene Bewertung macht eine Session wieder offen und kann Abschluesse wieder oeffnen. -- CRM-Zeiten sind Tageswerte pro Ticket und Benutzer. Sie sind nicht an einzelne Sessions gebunden. +- Eine zurueckgenommene Bewertung macht eine Session wieder offen und kann den Monatsabschluss wieder verhindern. +- Teamspace-Zeiten sind Tageswerte pro Ticket und Benutzer. Sie sind nicht an einzelne Sessions gebunden. +- Fragezeichen-Icons oeffnen kurze Hilfen direkt in der aktuellen Ansicht.