From 512b7cd881d3d42488445c1acf0bde4c5980faa3 Mon Sep 17 00:00:00 2001 From: UMTS at Teleco Date: Tue, 27 Jan 2026 08:19:47 +0100 Subject: Hoppela Vergessen zu Committen --- Abgaben/Beepzone-Stack-Projektplanung.md | 928 +++++++++++++++------ Abgaben/GANTT.drawio | 235 ++++++ Abgaben/Netzplan.drawio | 250 ++++++ Abgaben/PSP.drawio | 202 ++--- .../Projekt-Dateien/72-1-1_Front-End-Ueberflug.md | 78 ++ .../Projekt-Dateien/72-1-2_Back-End-Ueberflug.md | 15 + .../Projekt-Dateien/Json-Derulo-SeckelAPI-Notes.md | 13 + 7 files changed, 1377 insertions(+), 344 deletions(-) create mode 100644 Abgaben/GANTT.drawio create mode 100644 Abgaben/Netzplan.drawio create mode 100644 Abgaben/Projekt-Dateien/72-1-1_Front-End-Ueberflug.md create mode 100644 Abgaben/Projekt-Dateien/72-1-2_Back-End-Ueberflug.md create mode 100644 Abgaben/Projekt-Dateien/Json-Derulo-SeckelAPI-Notes.md (limited to 'Abgaben') diff --git a/Abgaben/Beepzone-Stack-Projektplanung.md b/Abgaben/Beepzone-Stack-Projektplanung.md index 30283d7..b6be00d 100644 --- a/Abgaben/Beepzone-Stack-Projektplanung.md +++ b/Abgaben/Beepzone-Stack-Projektplanung.md @@ -2,50 +2,57 @@ ## Projektidee ### Inventar System BeepZone Finalisieren -> BeepZone : Eine sehr Effiziente, Funktionsreiche als auch Integrierbare Inventarisierungslösung geschrieben in Rust +> BeepZone : Eine Effiziente, Funktionsreiche als auch Integrierbare Inventarisierungslösung geschrieben in Rust *T.Bachmann (aka. crt / umts) - 2025-12-09* -## SMART definitionen +## SMART Ziele -- Spezifisch: - - Finalisierung des BeepZone Inventarsystems (Backend: MySQL + SeckelAPI, Frontend: EGUI-EMO Desktop Client) für einen initialen Testlauf. Implementation/Umsetzung von mindestens folgendem : Client RBAC Support, minimales Client Admin Panel, alle UI Elemente im Client funktionstüchtig, Code des ganzen Stacks aufräumen, Funktionsprüfungen/Tests und Saubere Dokumentation des Systems. Das ganze als Open-Source Lösung welches durch andere für Ihre Zwecke angepasst/verbessert werden kann. -- Messbar: - - Erfolg messbar durch: 100% Abdeckung der Kernfeatures (z.B. mindestens 5 neue Funktionen im Admin Panel implementiert), mindestens 80% Code-Coverage durch Tests, vollständige Dokumentation (mindestens 20 Seiten Setup-Anleitung und API-Docs) und erfolgreiche Deployment auf dem internen Server. Fortschritt tracken durch wöchentliche Checkpoints. {Meh} -- Ausführbar: - - Das Ziel ist erreichbar, da es auf bestehendem Code aufbaut (Backend läuft schon grossteils stabil), ich als einziger Entwickler habe Erfahrung in Rust und Zeit bis das ganze um zu Setzen bis Deadline. Keine bekannten unmögliche Sprünge, wie z.B. aus dem Nix von Grund auf das System bauen, es geht nur um die Initiale Finalisierung, nicht um Neuentwicklung. Zwar Anspruchsvoll, aber machbar ohne externe Hilfe. -- Realistisch: - - Passt zu meinem Ressourcenmanagement: Keine Überstunden nötig, da es in 5 Wochen geplant ist mit Puffern für Bugs. Nutzt vorhandene Tools (Rust, MySQL), und internen Bedarf deckt es realistisch ab (z.B. weniger Diebstahl durch bessere Tracking). Kein Traumziel wie globaler Marktstandart, sondern fokussiert auf Individualisierten Einsatz und Open Source Release. -- Terminiert: - - Projektabschluss bis 2026-01-12, mit Meilensteinen pro KW (siehe GANTT im Planung-Abschnitt). Start: 2025-12-09, Ende: Fix vor Zimmerkontrollen. +- **Spezifisch:** + - Finalisierung des BeepZone Inventarsystems (Backend: MySQL + SeckelAPI, Frontend: EGUI EMO Desktop Client) für einen initialen Testlauf. Konkret umfasst dies: Client RBAC Support, minimales Client Admin Panel, alle UI Elemente im Client funktionstüchtig, Code des ganzen Stacks aufräumen, Funktionsprüfungen/Tests und saubere Dokumentation des Systems. Das ganze als Open Source Lösung welche durch andere für ihre Zwecke angepasst/verbessert werden kann. -## Projektanforderungen definieren +- **Messbar:** + - Erfolg messbar durch: 100% Abdeckung der definierten Kernfeatures laut Arbeitspaketen, alle 23 Arbeitspakete abgeschlossen, vollständige Dokumentation (Setup Anleitung und API Docs), erfolgreiche Deployment auf dem internen Server. Fortschritt wird durch Kanban Board und wöchentliche Checkpoints getrackt. -Leifaden/Info:
-> Todo +- **Attraktiv:** + - Das Projekt ist sinnvoll und motivierend weil: + - Intern: Es schliesst die aktuelle Lücke im Bereich Inventarisierung, reduziert unbemerkten Diebstahl und erleichtert Audits von Zimmern und deren zugewiesenen Objekten erheblich. + - Extern: Es entsteht ein vorzeigbares Open Source Projekt das von anderen verwendet erweitert und verbessert werden kann. + - Persönlich: Die Arbeit mit Rust und EGUI motiviert da es meinem bevorzugten Tech Stack entspricht. -## Risikoanalyse +- **Realistisch:** + - Das Ziel ist erreichbar da: + - Es auf bestehendem grösstenteils funktionierendem Code aufbaut (keine Neuentwicklung von Grund auf). + - Ich als einziger Entwickler die nötige Erfahrung in Rust habe und die Codebasis kenne. + - 10 Wochen Projektzeit mit eingeplantem Puffer für Bugs zur Verfügung stehen. + - Vorhandene Tools (Rust, MySQL, EGUI) genutzt werden keine neuen Technologien erlernen nötig. + +- **Terminiert:** + - Projektstart: 2026-05-11 + - Projektabschluss: 2026-07-20 (Zimmerkontrollen beim Kunden) + - Gesamtdauer: 51 Arbeitstage (~10 Wochen) + - Meilensteine pro Phase im GANTT Diagramm definiert. -| Risiko | Auswirkung | Wahrscheinlichkeit | Gegenmassnahme | -| ------------------------------------ | ---------------------------- | ------------------------ | --------------------------------------------------------- | -| Prokastination und Zeitmangel | Terminverzug | Hoch | Wichtigste Features Priorisieren und Zeitpuffer einplanen | -| Unerwartete Bugs nach Code Aufräumen | Funktionsausfälle | Mittel | Kleine Änderunen Schrittweise anwenden und immer testen | -| Unklare Anforderungen im Admin Panel | Fehlende Funktionen | Mittel | Bei zukünftigen Administratoren nach gewünschtem fragen | -| Nicht genug Tests | Bugs und Sicherheitsprobleme | Niedrig | Realistische Testfälle machen und Seed Daten erstellen | +## Risikoanalyse --> Schadensausmass als spalte hinzufügen --> Risikomatrix Kompatibel Machen (X Achse : Schadenshöhe, Y Achse : Eintrittswahrscheinlichkeit, Je 3 Stufen, Gering, Mittel, Hoch) --> Punkte Nummerieren --> Punkt 1: Zeit Start und Zeit Ende definieren, Wecker/Timer Setzen und dann mal schauen wie weit ich der Zeit gekommen bin. Musik --> Punkt 2: Besser Formulieren, +| Nr. | Risiko | Auswirkung | Schadensausmass | Eintrittswahrscheinlichkeit | Gegenmassnahme | +| --- | ------ | ---------- | --------------- | --------------------------- | -------------- | +| R1 | Prokrastination und Zeitmangel | Terminverzug, unfertige Features | Hoch | Hoch | Feste Zeitblöcke mit Timer setzen, Musik an, wichtigste Features priorisieren, Zeitpuffer einplanen | +| R2 | Unerwartete Bugs nach Refactoring | Funktionsausfälle, Regressionen | Mittel | Mittel | Kleine Änderungen schrittweise anwenden, nach jeder Änderung testen, Git Commits granular halten | +| R3 | Unklare Anforderungen Admin Panel | Fehlende oder falsche Funktionen | Mittel | Mittel | Frühzeitig bei zukünftigen Admins nachfragen was sie brauchen | +| R4 | Ungenügende Testabdeckung | Bugs und Sicherheitsprobleme im Prod | Hoch | Gering | Realistische Testfälle schreiben, Seed Daten für Tests erstellen | +### Risikomatrix -## SWOT-Analyse -> Todo (Abklären ob überhaupt nötig evt?) +| | Gering | Mittel | Hoch | +|------------------------|------------|------------|----------| +| Hoch (Wahrsch.) | | | R1 | +| Mittel (Wahrsch.) | | R2, R3 | | +| Gering (Wahrsch.) | | | R4 | ## PESTEL-Analyse -> Todo (Eigentlich redundant da gemacht in person mit LP) +> Mit LP In Person gemacht worden. # Definition @@ -76,7 +83,7 @@ EGUI-EMO --> Kurze Beschreibung was es schon kann, was es noch braucht (beim Soll unten) ### Projektergebnis (Soll) -BeepZone-Stack produktionsreif machen, veröffentlichen und für internen Einsatz bereit stellen. +BeepZone Stack produktionsreif machen, veröffentlichen und für internen Einsatz bereit stellen. #### Teilziele - Fehlende im UI angezeigte Funktionen implementieren. @@ -107,416 +114,837 @@ Projektabschluss bis 2026-01-26 (Start der Zimmerkontrollen). ## Projektstrukturplan (PSP) [PSP.drawio](https://git.teleco.ch/crt/m306-v2-tbz.git/plain/Abgaben/PSP.drawio) -## Arbeitspakete +# Arbeitspakete Allgemeine Infos (für alle Pakete gleich): -- **Projektname:** Inventar System BeepZone Finalisieren -- **Projekt Nummer:** 72 -- **Projekt Kürzel:** EGUI-EMO -- **Datum Arbeitspaket Finalisierung:** 2026-01-06 -- **Verantwortlicher/Leiter/Mann für alles:** T.Bachmann +- **Projektname:** + - Inventar System BeepZone Finalisieren +- **Projekt Nummer:** + - 72 +- **Projekt Kürzel:** + - EGUI-EMO +- **Datum Finalisierung:** + - 2026-01-06 +- **Verantwortlicher/Leiter/Mann für alles:** + - T.Bachmann + +
## Arbeitspakete für 72.1 Bestandsaufnahme und Planung ### Arbeitspaket: 72.1.1 Überflug Frontend -**Arbeitspaket Titel:** Überflug Frontend -**PSP Nummer:** 72.1.1 +- **Arbeitspaket Titel:** + - Überflug Frontend +- **PSP Nummer:** 72.1.1 -**Arbeitspaketbeschreibung:** Kurzer Check des BeepZone-eGUI EMO Desktop Clients visuell und im Code und eine Liste mit fehlenden Features, Problemen und Notizen machen +- **Arbeitspaketbeschreibung:** + - Check des BeepZone eGUI EMO Desktop Clients sowohl visuell als auch im Code um eine Liste mit Problemen und ggf. fehlenden Features zu machen -**Ziele:** Lücken im Frontend finden um Planung zu machen. +- **Ziele:** + - Lücken im Frontend finden um realistische Planung zu gestallten. -**Ergebniserwartung:** Notizliste +- **Ergebniserwartung:** + - Markdown formatierte Liste mit Referenzen zum Quellcode Abschnitten oder Visuellen Features welche in betracht gezogen werden sollten. -**Schnittstellen zu anderen Arbeitspaketen:** Input für 72.1.3 und 72.2 +- **Schnittstellen zu anderen Arbeitspaketen:** + - Input für 72.1.3 und 72.2 -**Voraussetzungen für das Arbeitspaket:** Code Zugang und VSCode + RustUp Setup +- **Voraussetzungen für das Arbeitspaket:** + - Code Zugang + - Lokal laufende Test Instanz SeckelAPI mit BeepZone Konfiguration + - Developer Laptop mit VSCode und Rustup Toolchain + - 1x Zebra Barcode Scanner -**Nicht Inhalte:** Keine Änderungen am Code +- **Nicht Inhalte:** + - Änderungen/Reparaturen am Code -**Sonstiges:** Priorisiere eindeutige Probleme +- **Sonstiges:** + - Festgestellte wiederholdende Probleme sollten, falls Sinnvoll, Code Modulen Zugewiesen werden um Effiziente Notizen zu schaffen und duplikate zu mindern + - Nah aneinanderliegende Probleme sollten unter einem Grösseren Task zusammengeführt werden um die Übernahme in den PSP sowie das Kanban zu vereinfachen. + - Bei Problemen welche nur auf einem Betriebssystem auftretet so muss dies so Notiert werden. + - Sollte hier abgelegt werden : [72-1-1_Front-End-Ueberflug.md](Projekt-Dateien/72-1-1_Front-End-Ueberflug.md) + +- **Aktivitäten:** + - [ ] Alle Module der Core Engine überfliegen + - [ ] Alle UI Views überfliegen + - [ ] Initialisierungs und API Files im root src folder überfliegen + - [ ] Barcode Scanner Integration Testen + - [ ] Markdown Finalisieren ### Arbeitspaket: 72.1.2 Überflug Backend -**Arbeitspaket Titel:** Überflug Backend -**PSP Nummer:** 72.1.2 +- **Arbeitspaket Titel:** + - Überflug Backend +- **PSP Nummer:** + - 72.1.2 + +- **Arbeitspaketbeschreibung:** + - Check der Backend Kompenente auf Code, Config und Schema basis um eine Liste mit Problemen und ggf. fehlenden Features zu machen. + +- **Ziele:** + - Backend Lücken finden + +- **Ergebniserwartung:** + - Markdown formatierte Liste mit Referenzen zum Quellcode Abschnitten oder Visuellen Features welche in betracht gezogen werden sollten. + +- **Schnittstellen zu anderen Arbeitspaketen:** + - Input für 72.1.3 und 72.2 + +- **Voraussetzungen für das Arbeitspaket:** + - Code Zugang + - Lokal laufende Test Instanz SeckelAPI mit BeepZone Konfiguration + - Developer Laptop mit VSCode und Rustup Toolchain + +- **Nicht Inhalte:** + - Änderungen am Code, Schema sowie Config Templates. + +- **Sonstiges:** + - Originales "Lesbares" Schema wurde durch Datenverlust verloren und existiert nur noch in "Dump Schema" Format, Aufräumarbeiten welche der lesbar/verständlich-keit dienen sind erlaubt solange diese keine Änderungen des eigentlichen Schemas mit sich bringen. + - Stellen die in Betracht gezogen werden sollten vorerst nur in 4 Kategorien eingestuft werden : + - Gravierendes -> Gröberes welches Nutzen, Sicherheit, Stabilität stark beinträchtigen + - Einfach Behebbares -> Kleinigkeiten welche jedoch einen Relevanten unterschied machen. + - Diverses -> Alles was nicht in die anderen zwei Einstufungen passt. + - Später -> Sieht eventuel nicht schön aus (Code als auch Visuel) jedoch funktionstüchtig + - Sollte hier abgelegt werden : [72-1-2_Back-End-Ueberflug.md](Projekt-Dateien/72-1-2_Back-End-Ueberflug.md) + +- **Aktivitäten:** + - [ ] Verwendete Route Module der Backend in dessen Code prüfen + - [ ] Config welche als Template geliefert wird prüfen + - [ ] Schema Prüfen und ggf. etwas Aufräumen + - [ ] Markdown Finalisieren -**Arbeitspaketbeschreibung:** Check der SeckelAPI und des Beepzone MySQL Schemas, evt. Liste mit fehlenden Teilen und Problemen machen. +### Arbeitspaket: 72.1.3 Planungsrelevante Dokumente Vervollständigen +- **Arbeitspaket Titel:** + - Planungsrelevante Dokumente Vervollständigen +- **PSP Nummer:** + - 72.1.3 -**Ziele:** Backend Lücken finden +- **Arbeitspaketbeschreibung:** + - Dokumente wie Risikoanalyse,SWOT,PSP usw. basierend auf Notizen aus Arbeitspaketen 72.1.1 und 72.1.2 updaten/erstellen. -**Ergebniserwartung:** Notizliste für Planung +- **Ziele:** + - Grundbausteine der Projektplanung Vervollständigt -**Schnittstellen zu anderen Arbeitspaketen:** Input für 72.1.3 und 72.2 +- **Ergebniserwartung:** + - Projektplanungs Abschnitte welche von Arbeitspaketen 72.1.1 sowie 72.1.2 Abhängig sind sowie Grundlagen soweit finalisiert um mit 7.1.4 Fortzufahren -**Voraussetzungen für das Arbeitspaket:** Backend Server Zugang und VSCode RustUp Setup. +- **Schnittstellen zu anderen Arbeitspaketen** + - Nutzt Markdown Notiz Datein aus [72.1.2](Projekt-Dateien/72-1-1_Back-End-Ueberflug.md) und [72.1.2](Projekt-Dateien/72-1-2_Back-End-Ueberflug.md) + - Input für 72.1.4. -**Nicht Inhalte:** Keine Fixes +- **Voraussetzungen für das Arbeitspaket:** + - In Schnittstellen erwähnte Markdown Notizen -### Arbeitspaket: 72.1.3 Planungsrelevante Dokumente Vervollständigen -**Arbeitspaket Titel:** Planungsrelevante Dokumente Vervollständigen -**PSP Nummer:** 72.1.3 +- **Nicht Inhalte:** + - Weitere Code/Applikations Analysen + - Änderungen der Notizen -**Arbeitspaketbeschreibung:** Dokumente wie Risikoanalyse SWOT usw. basierend auf Überflügen updaten. +- **Sonstiges:** + - Feedback von Projektplanungs Fachperson (in diesem Fall Modul Lehrer) holen bei ungewissheit. -**Ziele:** Vollständige Planungsdoks für den Rest des Projekts. +- **Aktivitäten:** + - [ ] SMART Ziele richtig definiert + - [ ] PSP Diagram vervollständigen + - [ ] Arbeitspakete (exklusiv Zeitangaben) Finalisiert + - [ ] Netzplan Erstellt + - [ ] GANTT Diagramm Erstellt + - [ ] Arbeitspaket mit Zeitangaben ergänzen + - [ ] Markdown zur Kontrolle kurz überfliegen -**Ergebniserwartung:** Aktualisierte Markdown Datei. +### Arbeitspaket: 72.1.4 Planung Kontrollieren +- **Arbeitspaket Titel:** + - Planung Kontrollieren +- **PSP Nummer:** + - 72.1.4 -**Schnittstellen zu anderen Arbeitspaketen** Nutzt Notizen aus 72.1.1/72.1.2, Input für 72.1.4. +- **Arbeitspaketbeschreibung:** + - Planung auf Lücken Prüfen -**Voraussetzungen für das Arbeitspaket:** Vorhandene Markdown. +- **Ziele:** + - Sichere Planung, Risiken minimieren. -**Nicht Inhalte:** Keine neuen Analysen +- **Ergebniserwartung:** + - Projektplanung wird mich Fachperson (Modul Lehrperson) angeschaut und allfällige Lücken werden behoben. -**Sonstiges:** Kurz Halten. +- **Schnittstellen zu anderen Arbeitspaketen:** + - Baut auf 72.1.3, Input für 72.1.5. -### Arbeitspaket: 72.1.4 Planung Kontrollieren -**Arbeitspaket Titel:** Planung Kontrollieren -**PSP Nummer:** 72.1.4 +- **Voraussetzungen für das Arbeitspaket:** + - Die im Arbeitspacket 72.1.3 finalisierte Projektplanung -**Arbeitspaketbeschreibung:** Planung prüfen auf Lücken, Zeitpuffer einbauen. +- **Nicht Inhalte:** + - Jegliche Arbeiten am/mit Code -**Ziele:** Sichere Planung ohne Risiken. +- **Sonstiges:** + - Prokrastinations Check !!! -**Ergebniserwartung:** Geprüfte Planung. +- **Aktivitäten:** + - [ ] Kontrolle mit Fachperson + - [ ] Korrektur Allfälliger Lücken -**Schnittstellen zu anderen Arbeitspaketen:** Baut auf 72.1.3, Input für 72.1.5. +### Arbeitspaket: 72.1.5 Projekt in Kanban aufnehmen +- **Arbeitspaket Titel:** + - Projekt in Kanban aufnehmen +- **PSP Nummerr:** + - 72.1.5 -**Voraussetzungen für das Arbeitspaket:** Halt so Fertige Doks. +- **Arbeitspaketbeschreibung:** + - Projekt in Kanban aufnehmen Pakete in Tasks wandeln und dazugehörige Aktivitäten als Todos dessen Tasks erfassen. -**Nicht Inhalte:** Prefferabel: Noch Kein Start der Umsetzung. +- **Ziele:** + - Übersichtliches und Familiäres Tracking von Arbeitsvortschritt. -**Sonstiges:** Prokrastinations Check !!! +- **Ergebniserwartung:** + - Kanban Board erstellt und alle in Projektplanung erstellten Arbeitspakete als auch deren dazugehörige Aktivitäten erfasst. -### Arbeitspaket: 72.1.5 Projekt in Kanban aufnehmen -**Arbeitspaket Titel:** Projekt in Kanban aufnehmen -**PSP Nummerr:** 72.1.5 +- **Schnittstellen zu anderen Arbeitspaketen:** + - Nutzt alles aus 72.1, Voraussetzung für Start Abschnitt 72.2. -**Arbeitspaketbeschreibung:** Projekt in Kanban aufnehmen Pakete in Tasks wandeln, Checklisten machen. +- **Voraussetzungen für das Arbeitspaket:** + - Kanban Tool (Wahrscheinlich Wekan) -**Ziele:** Übersichtliches Tracking +- **Nicht Inhalte:** + - Keine Arbeit an Features -**Ergebniserwartung:** Kanban Board ready +- **Aktivitäten:** + - [ ] Erstellung Kanban Board + - [ ] Erstellen von Phasen Orientierter Arbeitspaket Tags + - [ ] Übertragung von Arbeitspaketen und deren Aktivitäten -**Schnittstellen zu anderen Arbeitspaketen:** Nutzt alles aus 72.1, Start für 72.2. +## Arbeitspakete für 72.2 Umsetzung -**Voraussetzungen für das Arbeitspaket:** Kanban Tool (Wahrscheinlich Wekan) +### Arbeitspaket: 72.2.1 Zusammenführung der History, Editor und Viewer Module +- **Arbeitspaket Titel:** + - Zusammenführung der History, Editor und Viewer Module +- **PSP Nummer:** + - 72.2.1 -**Nicht Inhalte:** Keine Arbeit an Features +- **Arbeitspaketbeschreibung:** + - History, Editor und Viewer sind momentan drei separate Module die alle irgendwie das gleiche machen aber halt anders. Das ganze als ein neues "ObjectInteractor" Modul zusammenführen. Die alten Module sind eher PoC-Qualität und haben diverse Bugs. -## Arbeitspakete für 72.2 Umsetzung +- **Ziele:** + - Ein Modul für Asset/Object Interaktionen statt drei halbfertige + - JSON, Bilder und Dateien sollen korrekt laden + +- **Ergebniserwartung:** + - Neuer ObjectInteractor der auf verschiedene Tables anwendbar ist + - Item View funktioniert richtig (ist die komplexeste Table View) + - Binary Files und Bildformate (gif, tiff, jpeg2000) gehen -### Arbeitspaket: 72.2.1 Item History View Vervollständigen -**Arbeitspaket Titel:** Item History View Vervollständigen -**PSP Nummer.:** 72.2.1 +- **Schnittstellen zu anderen Arbeitspaketen:** + - Basis für Issue View (72.2.4) -**Arbeitspaketbeschreibung:** Vollständige Item History Ansicht im Frontend. +- **Voraussetzungen für das Arbeitspaket:** + - Bestehender Code der drei Module -**Ziele:** Funktionale View für Item History. +- **Nicht Inhalte:** + - Backend Änderungen -**Ergebniserwartung:** Lauffähigee History Komponent. +- **Sonstiges:** + - Fokus auf Code Vereinfachung durch Modul Zusammenführung -**Schnittstellen zu anderen Arbeitspaketen:** Aus Notizen 72.1.1, Link zu 72.2.5 +- **Aktivitäten:** + - [ ] Konzepierung des neuen ObjectInteractor Moduls + - [ ] Grobes Umsetzung des ObjectInteractor + - [ ] Aufruf von JSON Data Entries korrigieren + - [ ] Support für Binary Data Entries implementieren + - [ ] Support für Bildformate implementieren (gif, tiff, jpeg2000) -**Voraussetzungen für das Arbeitspaket:** Rust/EGUI. +### Arbeitspaket: 72.2.2 Workflows finalisieren +- **Arbeitspaket Titel:** + - Workflows finalisieren +- **PSP Nummer:** + - 72.2.2 -**Nicht-Inhalte:** Noch keine Arbeit an Kiosk Overlay. +- **Arbeitspaketbeschreibung:** + - Halbfertige Workflows fertig machen, vor allem Replacement und die Quick Actions in der Inventory View. -**Sonstiges:** KISS (Keep it simple stupid) +- **Ziele:** + - Geplante Workflows tatsächlich benutzbar machen. -### Arbeitspaket: 72.2.2 Audit Workflow polieren -**Arbeitspaket Titel:** Audit Workflow polieren -**PSP Nummer:** 72.2.2 +- **Ergebniserwartung:** + - Replacement Workflow geht + - Quick Actions im Ribbon sind aufgeräumt und funktionieren -**Arbeitspaketbeschreibung:** Audit Workflow im Frontend abschliessen und UI polieren. +- **Schnittstellen zu anderen Arbeitspaketen:** + - Nutzt Template Logik. -**Ziele:** Fertiger Workflow für Audits +- **Voraussetzungen für das Arbeitspaket:** + - Grundlegende UI Struktur. -**Ergebniserwartung:** Polierter Code +- **Nicht Inhalte:** + - Schema Änderungen. -**Schnittstellen zu anderen Arbeitspaketen:** Zu 72.2.1, Input für Tests +- **Sonstiges:** + - Überflüssige Aktionen welche schon anderst besser implementiert wurde ausblenden/entfernen. -**Voraussetzungen für das Arbeitspaket:** Bestehender Code +- **Aktivitäten:** + - [ ] Replacement Workflow fertig implementieren + - [ ] Quick Action: "Inventarize Room" implementieren + - [ ] Quick Action: "Add Multiple from Template" implementieren + - [ ] Einfache Kiosk Relevante Workflows implementieren (Scan Item Only) + - [ ] Nicht benötigte Quick Actions im Inventory Ribbon entfernen -**Nicht Inhalte:** Keine neuen Features +### Arbeitspaket: 72.2.3 Schema Änderungen im Client fertig Implementieren +- **Arbeitspaket Titel:** + - Schema Änderungen im Client fertig Implementieren +- **PSP Nummer:** + - 72.2.3 -**Sonstiges:** Fokus auf Usability +- **Arbeitspaketbeschreibung:** + - Client an die letzten Schema Änderungen anpassen. Aktuell gibt es Mismatches zwischen Backend Schema und was der Client erwartet. -### Arbeitspaket: 72.2.3 Item Replacement und Relationship implementieren -**Arbeitspaket Titel:** Item Replacement und Relationship implementieren -**PSP Nummer:** 72.2.3 +- **Ziele:** + - Client passt zum aktuellen DB Schema und nutzt es auch richtig. -**Arbeitspaketbeschreibung:** System für Item Replacement und Relationships bauen +- **Ergebniserwartung:** + - Joins (Supplier, Zone, Category) werden richtig angezeigt + - Belongs To Spalte und Min Role sind drin + - Workflow Table Definitionen stimmen mit Schema überein -**Ziele:** Logisches System für Ersetzungen und Verbindungen +- **Schnittstellen zu anderen Arbeitspaketen:** + - Eng gekoppelt mit Backend Schema. -**Ergebniserwartung:** Implementierter Code/Feature +- **Voraussetzungen für das Arbeitspaket:** + - Aktuelles Backend Schema -**Schnittstellen zu anderen Arbeitspaketen:** Zu Backend, Link zu 72.2.1. +- **Nicht Inhalte:** + - DB Schema Änderungen selbst -**Voraussetzungen für das Arbeitspaket:** Notizen +- **Sonstiges:** + - Asset Generation String Übernahme in Workflows und Clone Aktionen sicherstellen -**Nicht-Inhalte:** Kein Polieren +- **Aktivitäten:** + - [ ] Min Role Anzeige im Asset Editor hinzufügen + - [ ] Joins auf Inventory View reparieren (Supplier, Zone, Category) + - [ ] Belongs To implementieren + - [ ] Workflow definitions auf neues Schema aktualisieren -**Sonstiges:** Sollte robust sein +### Arbeitspaket: 72.2.4 Issue View Realisieren +- **Arbeitspaket Titel:** + - Issue View Realisieren +- **PSP Nummer:** + - 72.2.4 -### Arbeitspaket: 72.2.4 RBAC Support im Frontend polieren -**Arbeitspaket Titel:** RBAC Support im Frontend polieren -**PSP Nummer:** 72.2.4 +- **Arbeitspaketbeschreibung:** + - Issue View ist aktuell nur ein Platzhalter. Das soll eine richtige View werden. -**Arbeitspaketbeschreibung:** RBAC im Frontend finalisieren +- **Ziele:** + - Issues können angeschaut und bearbeitet werden -**Ziele:** Für User Rolle nicht funktionelle Views und Features verstecken +- **Ergebniserwartung:** + - Table Renderer Config für Issues + - Editor Renderer Config für Issues + - Ribbon UI das Sinn macht -**Ergebniserwartung:** Poliertes RBAC im Client +- **Schnittstellen zu anderen Arbeitspaketen:** + - Nutzt Editor Renderer aus 72.2.1. -**Schnittstellen zu anderen Arbeitspaketen:** Zu Backend;, Input für 72.3. +- **Voraussetzungen für das Arbeitspaket:** + - Funktionierendes Basis Framework. -**Voraussetzungen für das Arbeitspaket:** Halbfertiger Code +- **Nicht Inhalte:** + - Perfektion (soll "knapp gut genug" sein). -**Nicht-Inhalte:** Keine extras oder Client Admin Panele +- **Sonstiges:** + - Priorisierung der Grundfunktion. -**Sonstiges:** Bitte Testen auf Prod Tauglichkeit +- **Aktivitäten:** + - [ ] Table Renderer für Issues implementieren + - [ ] Viewer/Editor/History Modul für Issues integrieren + - [ ] Ribbon UI Elemente für Issues gestalten -### Arbeitspaket: 72.2.5 Issue View und Reporting fertig implementieren -**Arbeitspaket Titel:** Issue View und Reporting fertig implementieren -**PSP Nummer:** 72.2.5 +### Arbeitspaket: 72.2.5 Reporting Funktion Umsetzen und Integrieren +- **Arbeitspaket Titel:** + - Reporting Funktion Umsetzen und Integrieren +- **PSP Nummer:** + - 72.2.5 -**Arbeitspaketbeschreibung:** Issue View und Reporting fertig machen. +- **Arbeitspaketbeschreibung:** + - Reports sollen generiert und gedruckt werden können, z.B. nach Audits. Baut auf der Label Template Engine auf. -**Ziele:** Vollständige Views für Issues und Reports. +- **Ziele:** + - Berichte aus dem System raus bekommen (Papier oder Digital) -**Ergebniserwartung:** Funktionale Komponente +- **Ergebniserwartung:** + - Label Template Engine kann auch Reports + - Label und Report Templates sind in einer View zusammen -**Schnittstellen zu anderen Arbeitspaketen:** Zu 72.2.2, Für Non Techpowerusers. +- **Schnittstellen zu anderen Arbeitspaketen:** + - Audit Workflow -**Voraussetzungen für das Arbeitspaket:** Grobes Design Konzept +- **Voraussetzungen für das Arbeitspaket:** + - Label Template Engine -**Nicht-Inhalte:** Keine Analytics extras +- **Nicht Inhalte:** + - Komplexe Analytics -**Sonstiges:** Fokus auf Drucksystem. +- **Sonstiges:** + - Fokus auf Audit Berichterstattung + +- **Aktivitäten:** + - [ ] Label Template Engine reportfähig machen + - [ ] Report Template View implementieren und mit Label Template View zusammenführen + - [ ] Tabelle für Report Template Views anlegen ### Arbeitspaket: 72.2.6 Kiosk Kompatibles Frontend Vervollständigen -**Arbeitspaket Titel:** Kiosk Kompatibles Frontend Vervollständigen -**PSP Nr.:** 72.2.6 +- **Arbeitspaket Titel:** + - Kiosk Frontend Vervollständigen +- **PSP Nummer:** + - 72.2.6 + +- **Arbeitspaketbeschreibung:** + - Vereinfachter Kiosk Modus für schnelles Ausleihen/Zurückgeben. Soll auch für Leute bedienbar sein die nicht so technisch affin sind. -**Arbeitspaketbeschreibung:** Vereinfachtes Kiosk Overlay für nicht so schlaues IT Staff bauen +- **Ziele:** + - Einfache Bedienung für jeden + - Grundfunktionen von Inventory, Category, Supplier, Borrowing verfügbar -**Ziele :** Einfache UI für Basisnutzung +- **Ergebniserwartung:** + - Separate View, reduziert aufs Wesentliche, für Kiosk Betrieb -**Ergebniserwartung:** Fertiges Overlay +- **Schnittstellen zu anderen Arbeitspaketen:** + - Input für End User Tests (72.3.4) -**Schnittstellen zu anderen Arbeitspaketen:** Aus Feedback Notizen, Zu 72.3.4. +- **Voraussetzungen für das Arbeitspaket:** + - Client Code -**Voraussetzungen für das Arbeitspaket:** Client Code? +- **Nicht Inhalte:** + - Kein komplettes Redesign der eignetlichen Views im Client -**Nicht Inhalte:** Kein Full on Redesign +- **Sonstiges:** + - Grosse Buttons, Touch freundlich und klare Anweisungen und help buttons. -**Sonstiges:** Design sollte leicht anpassbar sein (Evt. reimplementation früher entwickelter deprecated JSONderuloUI Language) +- **Aktivitäten:** + - [ ] Kiosk View Layout (Grosse Schrift, wenig Details) entwerfen + - [ ] Schnelles User Switching und auto logout möglich + - [ ] Konfigurations Option zum Starten im Kiosk Modus hinzufügen -### Arbeitspaket: 72.2.7 Client Code Aufräumen -**Arbeitspaket Titel:** Client Code Aufräumen -**PSP Nummer.:** 72.2.7 +### Arbeitspaket: 72.2.7 Feinschliff und Bug Behebung +- **Arbeitspaket Titel:** + - Feinschliff und Bug Behebung +- **PSP Nummer:** + - 72.2.7 -**Arbeitspaketbeschreibung:** Frontend Code bisschen säubern grottenhässliches Ghüdder entfernen +- **Arbeitspaketbeschreibung:** + - Bugs fixen die beim Überflug und während der Umsetzung aufgetaucht sind. Alles was sich so angesammelt hat. -**Ziele:** Sauberer Code als zuvor +- **Ziele:** + - Das Ding soll sauber aussehen und stabil laufen + - RBAC soll auch im UI richtig greifen -**Ergebniserwartung:** Aufgeräumteres Repo +- **Ergebniserwartung:** + - Visuelle Bugs weg (Margins, Scaling, Ribbon spinnt nicht mehr rum) + - RBAC blendet Sachen aus die der User nicht sehen soll + - Tables werden richtig angezeigt + - Alte/peinliche Texte sind raus -**Schnittstellen zu anderen Arbeitspaketen:** Nach allen Umsetzungen, Für 72.4.3. +- **Schnittstellen zu anderen Arbeitspaketen:** + - Abschluss der Entwicklungsphase vor dem Testen. -**Voraussetzungen für das Arbeitspaket:** Fertige Features +- **Voraussetzungen für das Arbeitspaket:** + - Hauptfeatures implementiert. -**Nicht-Inhalte:** Kein anfangen mit Backend Aufräumen +- **Nicht Inhalte:** + - Grosse neue Features. + +- **Sonstiges:** + - Siehe Liste "Einfaches" und "Wichtiges" aus Überflug, Falls Zeit vorhanden noch an echter modulisierung des Clients Arbeiten. + +- **Aktivitäten:** + - [ ] RBAC Implementierung im Client polieren + - [ ] Print Preview Text Scaling reparieren + - [ ] Window Frame Margins korrigieren + - [ ] "Bye" Button zu "Logout" umbenennen und verhindern das er den Client Crasht + - [ ] Help Text Popups aktualisieren + - [ ] Verbleibende nicht implementierte Features im Ribbon UI ausblenden + - [ ] Ungenutzte Imports und Dead Code entfernen + - [ ] `TODO` und `HILFE` Kommentare abarbeiten ## Arbeitspakete für 72.3 Testen ### Arbeitspaket: 72.3.1 Tests der Client Komponente -**Arbeitspaket Titel:** Tests der Client Komponente -**PSP Nummer:** 72.3.1 +- **Arbeitspaket Titel:** + - Tests der Client Komponente +- **PSP Nummer:** + - 72.3.1 -**Arbeitspaketbeschreibung:** Prüfung/Testimplementation der einzelnen Frontend Teile +- **Arbeitspaketbeschreibung:** + - Frontend Module durchtesten ob alles geht wie es soll. Automatisierte Tests einbauen wo sinnvoll. -**Ziele:** Bugs im Client finden mit so min. 80% Abdeckung +- **Ziele:** + - Bugs finden und fixen -**Ergebniserwartung:** Test Liste und liste mit danach gebrauchten Fixes +- **Ergebniserwartung:** + - Liste was getestet wurde und was kaputt war + - Unit Tests mit Rust built-in Framework -**Schnittstellen zu anderen Arbeitspaketen:** Aus 72.2, Input für 72.3.2. +- **Schnittstellen zu anderen Arbeitspaketen:** + - Basierend auf Features aus 72.2. + - Geht über in 72.3.2. -**Voraussetzungen für das Arbeitspaket:** Rust Tests +- **Voraussetzungen für das Arbeitspaket:** + - Ausführbarer Client Build für MacOS, Linux und Windows. + - Test Backend -**Nicht Inhalte:** Keine Gesamt Tests +- **Nicht Inhalte:** + - Keine End to End Tests mit echtem Backend (hier nur Mocking oder Unit). -**Sonstiges:** Ganze mit Beispiel Daten machen für Real World applicability. +- **Sonstiges:** + - Edge Cases (leere Listen, Netzwerkfehler) besonders beachten. + +- **Aktivitäten:** + - [ ] Unit Tests für State Management Logik schreiben + - [ ] GUI Komponenten isoliert prüfen (soweit möglich in Egui) + - [ ] Input Validierung bei Formularen testen + - [ ] Fehlerbehandlung bei API Timeouts simulieren + - [ ] Testbericht erstellen ### Arbeitspaket: 72.3.2 Tests der Gesamtfunktion -**Arbeitspaket Titel:** Tests der Gesamtfunktion -**PSP Nummer:** 72.3.2 +- **Arbeitspaket Titel:** + - Tests der Gesamtfunktion +- **PSP Nummer:** + - 72.3.2 + +- **Arbeitspaketbeschreibung:** + - Integrationstests: Schaut ob Client und Backend zusammen funktionieren wie sie sollten. -**Arbeitspaketbeschreibung:** Check ob Client und Backend happy mit einander zusammenpassen und Client als gesamtes Funktioniert +- **Ziele:** + - Daten werden gespeichert und richtig abgerufen + - Komplexe Workflows (Ausleihe, Rückgabe usw.) laufen durch -**Ziele:** Ganzer Ablauf prüfen +- **Ergebniserwartung:** + - Alles spielt zusammen ohne Probleme + - Bug Liste für letzte Fixes -**Ergebniserwartung:** Bericht mit Fixlist +- **Schnittstellen zu anderen Arbeitspaketen:** + - Nach 72.3.1, vor 72.3.3. -**Schnittstellen zu anderen Arbeitspaketen:** Nach 72.3.1 +- **Voraussetzungen für das Arbeitspaket:** + - Laufendes Backend (Staging/Dev) und aktueller Client. -**Voraussetzungen für das Arbeitspaket:** Lauffähiges System +- **Nicht Inhalte:** + - Keine User Acceptance Tests (das ist 72.3.4). -**Nicht Inhalte:** Noch kein User Feedback +- **Sonstiges:** + - Testdaten sollten realistisch sein (keine "asdf" Namen). -**Sonstiges:** Möglichst reale Szenarien verfolgen. +- **Aktivitäten:** + - [ ] Vollständigen "Happy Path" durchspielen (Login -> Item suchen -> Ausleihen -> Logout) + - [ ] "Unhappy Path" testen (Falsches Passwort, Gewollt Probleme verursachen) + - [ ] Barcode Scanner Integration mit echten Hardware Scans testen + - [ ] Datenbank Integrität nach komplexen Transaktionen prüfen ### Arbeitspaket: 72.3.3 Sicherheits und Performance Tests -**Arbeitspaket Titel:** Sicherheits und Performance Tests -**PSP Nummer:** 72.3.3 +- **Arbeitspaket Titel:** + - Sicherheits und Performance Tests +- **PSP Nummer:** + - 72.3.3 -**Arbeitspaketbeschreibung:** Prüfung auf Sicherheits und Performance Lücken +- **Arbeitspaketbeschreibung:** + - Checken ob es offensichtliche Sicherheitslücken gibt und ob das System performant genug ist. -**Ziele (Welche Leistungen sollen erbracht werden?):** Ein Sexy Sicheres und schnelles System +- **Ziele:** + - Keine dummen Sicherheitslöcher + - UI bleibt responsive auch bei vielen Daten -**Ergebniserwartung:** Problem Liste. +- **Ergebniserwartung:** + - Kurzer Security Check Bericht + - Performance Messungen -**Schnittstellen zu anderen Arbeitspaketen:** Nach 72.3.2, Für Doks und so. +- **Schnittstellen zu anderen Arbeitspaketen:** + - Nach 72.3.2. -**Voraussetzungen für das Arbeitspaket Ressourcen:** Tools und so +- **Voraussetzungen für das Arbeitspaket:** + - Tools (Wireshark, Browser DevTools, Benchmark Scripts). -**Nicht Inhalte:** Keine Funktions Tests +- **Nicht Inhalte:** + - Keine Penetration Tests auf Enterprise Niveau. -**Sonstiges:** Intern fokussiert +- **Sonstiges:** + - Fokus auf typische Angriffsvektoren (SQL Injection, XSS, Privileg Escalation). + +- **Aktivitäten:** + - [ ] API Endpoints auf Autorisierungs Prüfungen testen (Kann User X Admin Dinge tun?) + - [ ] Input Felder auf Injection Anfälligkeit prüfen + - [ ] Ladezeiten bei grossen Listen (zB 1000+ Items) messen + - [ ] Speicherverbrauch des Clients über längere Zeit beobachten (Memory Leaks) + - [ ] Netzwerk Traffic auf unnötige Datenübertragung analysieren ### Arbeitspaket: 72.3.4 End User Tests -**Arbeitspaket Titel:** End User Tests -**PSP Nummer:** 72.3.4 +- **Arbeitspaket Titel:** + - End User Tests +- **PSP Nummer:** + - 72.3.4 + +- **Arbeitspaketbeschreibung:** + - Echte Leute (oder so) das System benutzen lassen und schauen wo sie hängen bleiben. -**Arbeitspaketbeschreibung:** Tests mit Nutzern +- **Ziele:** + - Feedback kriegen ob die UI verständlich ist + - Wo stolpern Leute? -**Ziele:** Feedback zu Anpassungen +- **Ergebniserwartung:** + - Liste mit Usability Problemen und Vorschlägen + - Grünes Licht für Release -**Ergebniserwartung:** Feedback Notizen +- **Schnittstellen zu anderen Arbeitspaketen:** + - Letzter Schritt vor Doku & Abschluss. -**Schnittstellen zu anderen Arbeitspaketen:** Nach Tests, Für 72.5. +- **Voraussetzungen für das Arbeitspaket:** + - Testpersonen (Mitschüler, Freunde). + - Bereitgestellte Testumgebung. -**Voraussetzungen für das Arbeitspaket:** System und Zeit zukünftiger User +- **Nicht Inhalte:** + - Keine technischen Debugging Sessions. -**Nicht Inhalte:** Keine Techpoweruser Tests (Also somit eigentlich tests meiner Seits) +- **Sonstiges:** + - "Think Aloud" Methode bei den Tests anwenden. -**Sonstiges:** 1 bis 2 Sessions +- **Aktivitäten:** + - [ ] Test Szenarien für User vorbereiten (Aufgabenstellung) + - [ ] User bei der Durchführung beobachten (nicht helfen!) + - [ ] Feedback und Schwierigkeiten notieren + - [ ] Kurzes Interview nach dem Test durchführen + - [ ] Ergebnisse auswerten und ggf. Quick Fixes erstellen ## Arbeitspakete für 72.4 Dokumentieren ### Arbeitspaket: 72.4.1 Back End Dokumentation -**Arbeitspaket Titel:** Back End Dokumentation -**PSP Nummer:** 72.4.2 +- **Arbeitspaket Titel:** + - Back End Dokumentation +- **PSP Nummer:** + - 72.4.1 + +- **Arbeitspaketbeschreibung:** + - Technische Doku fürs Backend schreiben (API, Datenbank). Damit später jemand anderes auch noch durchblickt. -**Arbeitspaketbeschreibung:** Docs für Backen schreiben. +- **Ziele:** + - Andere Entwickler können verstehen was Sache ist -**Ziele:** Klare Backend Nutzungs als auch grobe Code Doks. +- **Ergebniserwartung:** + - Markdown Files im Repo oder Wiki -**Ergebniserwartung:** Dokumentation zu Bakend +- **Schnittstellen zu anderen Arbeitspaketen:** + - Parallel zu 72.4.2. -**Schnittstellen zu anderen Arbeitspaketen:** Aus 72.2, Zu 72.4.3. +- **Voraussetzungen für das Arbeitspaket:** + - Finaler Code Stand. -**Voraussetzungen für das Arbeitspaket:** Backend Code und Laufendes Backend System +- **Nicht Inhalte:** + - Keine Endanwender Doku. -**Nicht Inhalte:** Kein Frontend Doks +- **Sonstiges:** + - Automatisch generierte Docs wo möglich nutzen (rustdoc, swagger). + +- **Aktivitäten:** + - [ ] API Komplett beschreiben (Request/Response) + - [ ] Datenbankschema dokumentieren + - [ ] Environment Variablen und Konfiguration erklären + - [ ] Deployment Abhängigkeiten auflisten ### Arbeitspaket: 72.4.2 Front End Dokumentation -**Arbeitspaket Titel:** Front End Dokumentation -**PSP Nummer:** 72.4.2 +- **Arbeitspaket Titel:** + - Front End Dokumentation +- **PSP Nummer:** + - 72.4.2 + +- **Arbeitspaketbeschreibung:** + - Technische Doku für den Client. Wie ist der Code aufgebaut, wie funktionieren die Module. -**Arbeitspaketbeschreibung:** Docs für Frontend schreiben. +- **Ziele:** + - Leute die neue Module bauen wollen sollen sich reindenken können -**Ziele:** Klare Frontend Nutzungs und grobe Code Doks. +- **Ergebniserwartung:** + - Code Struktur und UI Konzepte dokumentiert -**Ergebniserwartung:** Dokumentation zu Frontend +- **Schnittstellen zu anderen Arbeitspaketen:** + - Parallel zu 72.4.1. -**Schnittstellen zu anderen Arbeitspaketen:** Aus 72.2, Zu 72.4.3. +- **Voraussetzungen für das Arbeitspaket:** + - Finaler Client Code. -**Voraussetzungen für das Arbeitspaket:** Frontend Code und Laufender Stack +- **Nicht Inhalte:** + - Keine Bedienungsanleitung. -**Nicht Inhalte:** Kein Backend Doks +- **Sonstiges:** + - Screenshots zur Erklärung von UI Komponenten nutzen. + +- **Aktivitäten:** + - [ ] Modul Struktur des Frontends aufzeichnen + - [ ] Wichtige UI Komponenten und deren Parameter dokumentieren + - [ ] Build Prozess und Voraussetzungen (Rust) festhalten + - [ ] Bekannte Limitationen und Bugs auflisten ### Arbeitspaket: 72.4.3 Setup und Benutzeranleitung -**Arbeitspaket Titel:** Setup und Benutzeranleitung -**PSP Nummer:** 72.4.3 +- **Arbeitspaket Titel:** + - Setup und Benutzeranleitung +- **PSP Nummer:** + - 72.4.3 + +- **Arbeitspaketbeschreibung:** + - Handbuch für Admins (wie installiert man das) und normale User (wie bedient man das). + +- **Ziele:** + - Leute können das System selbst aufsetzen und benutzen ohne ständig fragen zu müssen -**Arbeitspaketbeschreibung:** Anleitung für Setup und Nutzung schreiben. +- **Ergebniserwartung:** + - PDF oder Markdown Handbuch -**Ziele:** Einfaches jedoch ausführliches Guide für User +- **Schnittstellen zu anderen Arbeitspaketen:** + - Konsolidiert Infos aus 72.4.1 und 72.4.2 für Laien. -**Ergebniserwartung:** Vollständige Anleitung +- **Voraussetzungen für das Arbeitspaket:** + - Funktionierendes System zum Screenshots machen. -**Schnittstellen zu anderen Arbeitspaketen:** Aus Tests, Für Release. +- **Nicht Inhalte:** + - Keine internen Code Details. -**Voraussetzungen für das Arbeitspaket:** System Kenntnisse welche ich habe. +- **Sonstiges:** + - Verständliche Sprache, Schritt für Schritt Anleitungen. -**Nicht Inhalte:** Keine Code Docs +- **Aktivitäten:** + - [ ] Quick Start Guide für die Installation schreiben + - [ ] Bebilderte Anleitung für Standard Workflows (Ausleihe, Rückgabe) + - [ ] Admin Guide (User anlegen, Items importieren) + - [ ] Troubleshooting FAQ erstellen + - [ ] Anleitung Korrekturlesen lassen ### Arbeitspaket: 72.4.4 Code Kommentare von Fluchwörtern befreien -**Arbeitspaket Titel:** Code Kommentare von Fluchwörtern befreien -**PSP Nummer:** 72.4.4 +- **Arbeitspaket Titel:** + - Code Kommentare von Fluchwörtern befreien +- **PSP Nummer:** + - 72.4.4 + +- **Arbeitspaketbeschreibung:** + - Frust Kommentare und andere schöne Wörter aus dem Code entfernen. Soll ja Open Source werden. + +- **Ziele:** + - Code der vorzeigbar ist -**Arbeitspaketbeschreibung:** Code Kommentare säubern und unprofessionelles entfernen. +- **Ergebniserwartung:** + - Sauberer Code ohne peinliche Kommentare -**Ziele:** Saubere Kommentare +- **Schnittstellen zu anderen Arbeitspaketen:** + - Letzter Schritt vor Release. -**Ergebniserwartung:** Bereinigter Code +- **Voraussetzungen für das Arbeitspaket:** + - Zugriff auf alle Sourcen. -**Schnittstellen zu anderen Arbeitspaketen:** Aus 72.2.7, Für Open Source Release <3 +- **Nicht Inhalte:** + - Keine Funktionsänderungen mehr. -**Voraussetzungen für das Arbeitspaket:** Repos +- **Sonstiges:** + - Search & Replace ist dein Freund. -**Nicht Inhalte:** Kein Neuschreiben von Code +- **Aktivitäten:** + - [ ] Globale Suche nach Blacklist Wörtern (Flüche, Slang) + - [ ] Unpassende `TODO`s entfernen oder umschreiben + - [ ] Auskommentierten "Müll" Code löschen + - [ ] Rechtschreibung in öffentlichen Doc Strings prüfen + - [ ] Commit Messages prüfen (falls History rewrite geplant) ## Arbeitspakete für 72.5 Abschluss ### Arbeitspaket: 72.5.1 Beta Release auf Git erstellen -**Arbeitspaket-Titel:** Beta Release auf Git erstellen -**PSP-Nr.:** 72.5.1 +- **Arbeitspaket-Titel:** + - Beta Release auf Git erstellen +- **PSP-Nr.:** + - 72.5.1 -**Arbeitspaketbeschreibung:** Beta Version auf Git pushen. +- **Arbeitspaketbeschreibung:** + - Release Tag machen und Binaries/Source auf Git hochladen. -**Ziele (Welche Leistungen sollen erbracht werden?):** Erster Tagged Release +- **Ziele:** + - Entwicklung ist offiziell durch + - Es gibt was zum Runterladen -**Ergebniserwartung:** Git Release. +- **Ergebniserwartung:** + - Git Tag gesetzt, Release Notes, Binaries hochgeladen -**Schnittstellen zu anderen Arbeitspaketen:** Nach Doks, Für Einsatz +- **Schnittstellen zu anderen Arbeitspaketen:** + - Das Ende der Fahnenstange. -**Voraussetzungen für das Arbeitspaket :** Scheinbar Fertiges System +- **Voraussetzungen für das Arbeitspaket :** + - Alle Tests grün, Doku fertig. -**Nicht-Inhalte:** Kein Final non-Beta Release. +- **Nicht-Inhalte:** + - Kein Deployment auf Server (das ist separater Schritt/Task). + +- **Sonstiges:** + - Ein kleiner Feier-Moment. + +- **Aktivitäten:** + - [ ] Versionsnummern in Config Dateien (`Cargo.toml`) erhöhen + - [ ] CHANGELOG.md aktualisieren + - [ ] Git Tag setzen (z.B. `v1.0.0-beta`) und pushen + - [ ] Release auf Plattform (Gitea/GitHub/GitLab) erstellen + - [ ] Binaries kompilieren und anhängen ### Arbeitspaket: 72.5.2 Rückblick auf gelerntes und Zukünftiges -**Arbeitspaket Titel:** Rückblick auf gelerntes und Zukünftiges -**PSP Nummer:** 72.5.2 +- **Arbeitspaket Titel:** + - Rückblick auf gelerntes und Zukünftiges +- **PSP Nummer:** + - 72.5.2 + +- **Arbeitspaketbeschreibung:** + - Schauen was gut lief und was nicht. Was kommt als nächstes? + +- **Ziele:** + - Aus Fehlern lernen + - Grobe Ideen für v2.0 + +- **Ergebniserwartung:** + - Kurzer Abschlussbericht / Lessons Learned + +- **Schnittstellen zu anderen Arbeitspaketen:** + - Bezieht sich auf das gesamte Projekt. + +- **Voraussetzungen für das Arbeitspaket:** + - Projektabschluss. + +- **Nicht Inhalte:** + - Keine Entwicklung. + +- **Sonstiges:** + - Ehrlich zu sich selbst sein. -**Arbeitspaketbeschreibung:** Review des Projekts, "Lessons Learned" notieren +- **Aktivitäten:** + - [ ] Soll/Ist Vergleich der Zeitplanung durchführen + - [ ] Analyse der aufgetretenen Risiken + - [ ] Feedback von Nutzern konsolidieren + - [ ] Liste mit Ideen für "BeepZone 2.0" erstellen + - [ ] Persönliches Fazit schreiben -**Ziele:** Abschluss Notizen für Zukunft. +### Arbeitspaket: 72.5.3 Deployment auf internem Server +- **Arbeitspaket Titel:** + - Deployment auf internem Server +- **PSP Nummer:** + - 72.5.3 -**Ergebniserwartung:** Review Doks. +- **Arbeitspaketbeschreibung:** + - BeepZone Stack auf dem internen Server aufsetzen für produktiven Einsatz. -**Schnittstellen zu anderen Arbeitspaketen:** Gesamtes Projekt. +- **Ziele:** + - System läuft produktiv und ist nutzbar -**Voraussetzungen für das Arbeitspaket:** Alles +- **Ergebniserwartung:** + - Laufende Instanz auf Server -**Nicht Inhalte:** Keine neuen Features oder so. +- **Schnittstellen zu anderen Arbeitspaketen:** + - Nach 72.5.1 (Release muss existieren) -**Sonstiges:** Für nächste Projekte und später zu implementierende Features. +- **Voraussetzungen für das Arbeitspaket:** + - Fertiges Release + - Serverzugang -## Netzplan -(Hier Kommt das referenz Drawio Netzplan, Später) +- **Nicht Inhalte:** + - Weitere Entwicklung -## GANTT Diagram +- **Sonstiges:** + - Docker oder direkt je nach Serverumgebung -| Woche / Zeitraum | Phase | Kernaufgaben | -|------------------------------|------------------------------|-----------------------------------------------------------------------------| -| KW50 (09.12.–15.12.2025) | Bestandsaufnahme und Planung | - Repo grob aufräumen
- Notizen erstellen
- Planung grob finalisieren | -| KW51 (16.12.–22.12.2025) | Umsetzung und Planung | - Fehlende Features implementieren
- Planung vervollständigen | -| KW52 (23.12.–29.12.2025) | Umsetzung und Planung | - Fehlende Features implementieren
- Planung vervollständigen | -| KW01 (30.12.2025–05.01.2026) | Umsetzung | - Fehlende Features implementieren
- Planung vervollständigen | -| KW02 (06.01.–11.01.2026) | Umsetzung | - Fehlende Features implementieren
- Code polieren | -| KW03 (12.01.–18.01.2026) | Testen und Bugfixes | - Tests für Features durchführen
- Leistungstests
- Bugreparaturen basierend auf Test Ergebnissen | -| KW04 (19.01.–25.01.2026) | Dokumentieren | - API Dokumentatieren
- Manuals schreiben
- Entwickler Notes
| -| 26.01.2026 | Abschluss | - Qualitätschecks
- Publizikation Beta Release Tags
- Aufsetzen Prod Instanz auf Server| \ No newline at end of file +- **Aktivitäten:** + - [ ] Server vorbereiten (MySQL, Dependencies) + - [ ] Backend deployen und konfigurieren + - [ ] Initialdaten laden + - [ ] Client Binaries bereitstellen + - [ ] Kurzer Funktionstest auf Prod diff --git a/Abgaben/GANTT.drawio b/Abgaben/GANTT.drawio new file mode 100644 index 0000000..2d76675 --- /dev/null +++ b/Abgaben/GANTT.drawio @@ -0,0 +1,235 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Abgaben/Netzplan.drawio b/Abgaben/Netzplan.drawio new file mode 100644 index 0000000..df9af6d --- /dev/null +++ b/Abgaben/Netzplan.drawio @@ -0,0 +1,250 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Abgaben/PSP.drawio b/Abgaben/PSP.drawio index 61bde7b..daa3083 100644 --- a/Abgaben/PSP.drawio +++ b/Abgaben/PSP.drawio @@ -1,6 +1,6 @@ - + @@ -85,14 +85,14 @@ - + - + @@ -101,7 +101,7 @@ - + @@ -110,13 +110,27 @@ - + + + + + + + + + + + + + + + @@ -127,21 +141,21 @@ - + - + - + @@ -158,21 +172,21 @@ - + - + - + @@ -184,7 +198,7 @@ - + @@ -192,7 +206,7 @@ - + @@ -200,7 +214,7 @@ - + @@ -222,22 +236,6 @@ - - - - - - - - - - - - - - - - @@ -245,14 +243,14 @@ - + - + @@ -262,14 +260,6 @@ - - - - - - - - @@ -277,124 +267,148 @@ - - - + + + - + - + - + - + - - - + + + - + - + - + - + - - - + + + - + - + - + - + - - - + + + - + - - - + + + - + - + - + - + - - - + + + - + - - - + + + + + + + + + + + - + - + - + - + - - - + + + - + - - - + + + - + - + - + + + + + + + + + + + + + + + + + - + diff --git a/Abgaben/Projekt-Dateien/72-1-1_Front-End-Ueberflug.md b/Abgaben/Projekt-Dateien/72-1-1_Front-End-Ueberflug.md new file mode 100644 index 0000000..51827b2 --- /dev/null +++ b/Abgaben/Projekt-Dateien/72-1-1_Front-End-Ueberflug.md @@ -0,0 +1,78 @@ +# BeepZone Egui Emo Client Code Ueberflug + +## Todo: + +### Zusammenführung der History, Editor und Viewer Module +Funktionsmässig gesehen sind alle 3 Module zu etwa 90 Prozent fertig jedoch eher als proof of concept mit sehr niedriger intuität im Aspekt Benutzerfreundlichkeit. Zudem gibt es noch diversen bugs. Um dem positiv entgegen zu kommen werden diese Module Kombiniert was eine Einheitliche Oberfläche schaffen wird und im aspekt code einfacher zu Implementieren ist. Alle dazu relevanten Punkte sind hier notiert + +- Viewer/Editor diverser Tables nicht funktionstüchtig +- Item View (Momentan History View) sehr verwirrend und unübersichtlich +- JSON Data Entries werden nicht richtig aufgerufen +- File/Binary Data Entries werden noch nicht unterstützt +- Bild Data Entries werden bei manchen Formaten nicht unterstützt (gif, tiff und jpeg2000) + +### Workflows finalisieren +Diese sind meisst recht einfach zu Implementieren jedoch sind einige davon noch nicht Implementiert bzw. noch nicht fertig, alle relevanten Punkte dazu welche nicht mir Schemänderungen zu tun haben sind somit hier eingetragen. + +- Replacement Workflow nicht fertig Implementiert +- Quick Action Workflows im Inventory Ribbon sind nicht fertig Implementiert + - Folgende Ausblenden (anderseitigs möglich) : + - Add Using another Item + - Add Multiple from Another Item + - Folgende Implementieren : + - Inventarize Room + - Add Multiple from Template + +### Schema Änderungen im Client fertig Implementieren +Während der Schema erstellung wurden Feedback der Potenziellen End-Nutzern natürlich mit einbezogen um die Anforderungen best möglichst zu erfüllen jedoch wird man immer auf Lücken stossen welche zur Folge bringen das Schema anpassungen notwendig sein werden welche Teils noch nicht vollständig im Client Implementiert sind. Damit verbunden Punkte sind somit hier erfasst + +- Min Role Nicht im Asset Editor ersichtlich +- Joins scheinbar nicht mehr komplett funktionstüchtig auf Inventory View : Supplier, Zone, Category +- Belongs To Column nicht fertig Implementiert +- Create from Template Workflow noch nicht mit neuem Schema geupdated und AGS werden nicht übernommen. + +## Issue View Realisieren +Wurde momentan nur durch semifunktionaler Platzhalter implementiert und muss vorerst nur knapp gut genug für die Benutzung sein. Um das zu erfüllen müssen folgende Punkte abgehakt werden: + +- Table Renderer Implementieren +- Viewer/Editor/History Modul Implementieren +- Ribbon UI Elemente Sinnvoll gestalten + +## Reporting Funktion Umsetzen und Integrieren +Dies wurde bei der Planung etwas übersehen, darunter zu verstehen ist die Funktion Dokumente zu Arbeiten welche via das Inventarsystem ausgeführt werden drucken zu können, Beispiel wäre das man nach einem Audit (Inventarkontrolle einer oder mehrer Zonen) die Option zu haben eine Berichtserstattung zu Drucken welche anzeigt was bei der Kontrolle für Diskrepenzen aufgefallen sind, dies ist vorerst auch die einzige grundlegende Anforderung welche diese Funktion erfüllen muss was folgendes beinhaltet: + +- Label Template Engine auch Report fähig machen +- Label Template View mit neuer Report Templates View, ähnlich wie bei Audit View, Zusammenführen +- Neue Tabelle für Report Template Views anlegen + +### Feinschliff und Bug Behebung +Um den Zeitlichen Anforderungen konform zu bleiben wurden hier die gefundenen Punkte in drei Unterkategorien aufgeteilt: + +#### Einfaches +Mir aus Erfahrung leicht zu behebenden Punkte welche durch wenig aufwand viel Erbringen und Umgesetzt werden sollten, jedoch sollte auf die Zeit stark geachtet werden und nicht zuviel aufwand darin Investiert werden. + +- Window Frame Margins werden Ignoriert oder sind evt. falsch gesetzt. +- Bye Button mit Logout Beschrifften +- Help Text Popup hat veralltete infos +- Features welche im in Ribbon UI erwähnt werden die noch nicht implementiert sind sollten ausgeblendet werden. + +#### Wichtiges +Zum Planungszeitpunkt aufgefundene Punkte welche nicht mit anderen Arbeiten zusammen passen jedoch behoben sein müssen vor Alpha Publikation, hierfür muss ein Grosser Zeitpuffer eingerechnet werden da es mir schwierig fällt das ausmass und erforderlichen Aufwand einzuschätzen und zudem im verlaufe des Projektes weiter davon aufkommen könnten. + +- RBAC Implementierung im Client Polieren +- Print Preview Text Scaling Reparieren + +#### Zukünftiges, Ideen und Optionales +Hier werden Punkte erfasst an welchen bei früzeitigem Abschluss, der in diesem Arbeitspaket erwähnetn Punkte, gearbeitet werden kann oder in zukünftigeren Versionen implementiert wird. + +- Due Date Column auf Inventory View benutzt amerikanisches datums format +- Filter Builder Integration auf Audit Ribbon nicht vorhanden +- Audit Tables etwas Übersichtlicher gestallten. +- Letzte Ribbon UI Kategorie Elemente werden fälschlicherweise horizontal zerdrückt bei zu Schmallem Fenster. +- Frei Anordbare Widget Views Implementieren (hängt von server synced user settings integration ab) +- CSV Import/Export funktion +- Bessere Bulk Action Implementation +- Column Rearangement +- Preference saving Implementieren +- Consumable Assets sind mit Ausleihbaren gegenständen gleichgestellt, sollte besser integriert werden mit auto availability counter vom DB schema +- Text Fields welche Buttons in gleicher Row haben sind nicht richtig Vertikal Zentriert diff --git a/Abgaben/Projekt-Dateien/72-1-2_Back-End-Ueberflug.md b/Abgaben/Projekt-Dateien/72-1-2_Back-End-Ueberflug.md new file mode 100644 index 0000000..c46d348 --- /dev/null +++ b/Abgaben/Projekt-Dateien/72-1-2_Back-End-Ueberflug.md @@ -0,0 +1,15 @@ +# BeepZone Schema + Seckel API Ueberflug + +## Status SeckelAPI +Nach anschauen der Backend müssen vorerst lediglich im Verlaufe des Projektes kleinigkeiten bezüglich Konfiguration angepasst werden und die Dokumentation erstellt werden. + +Backend unterstütz soweit alle requests welcher vom BeepZone Client verwendet, dies da dieser mit nicht in Worte Gefasster Json Derulo API Spezifikation v0.0.1 Kompatibel ist welches jeglich die Low-Level Query Funktion beinhaltete und somit nur von Schema abhängig ist. + +Backend wird in eigener Freizeit, Notfalls mässig, jedoch mal mindestens beta v0.1.0 Release fähig gemacht was folgendes beinhaltet: +- Code Aufräumen und für kommende Änderungen in beta v0.2.0 leicht vorbereiten. +- Json Derulo API Speifikation endlich in Worte fassen und fertig konzepieren. +Siehe Json-Derulo-SeckelAPI-Notes.md weshalb ich arbeiten an Backend möglichst minimal in dieses Projekte einbezogen habe. + +## Status Schema +Kleinere Änderungen sind während des Projektes erforderlich da die Software jedoch noch nicht Publiziert ist wird dies keine Probleme darstellen. +Wird im teil Feinschliff und Bug Behebung noch etwas leserlicher gestalltet diff --git a/Abgaben/Projekt-Dateien/Json-Derulo-SeckelAPI-Notes.md b/Abgaben/Projekt-Dateien/Json-Derulo-SeckelAPI-Notes.md new file mode 100644 index 0000000..07c64ca --- /dev/null +++ b/Abgaben/Projekt-Dateien/Json-Derulo-SeckelAPI-Notes.md @@ -0,0 +1,13 @@ +# Json Derulo API Spec und SeckelAPI +Notfalls Chaos Management + +## Problem +Durch fehlkommunikationen und weiteren Schmerzpunkten wird nun dringenst eine Software Lösung welche die Gong/Durchsagen Anlagen programmierung Übernehmen kann benötigt um neuen Regulationen bezüglich Amok durchsagen und dessen abdeckungsbereichen zu Entsprechen als auch bei Schul Theater aufführungen zuverlässig exklusiv auf die Visuellen und nicht Akustischen Alarm Elemente eines bestimmten Gebäudes zu schalten. + +Eine neue/zusätliche API/Backend von Grund auf zu schreiben als auch weiterhin exklusiv mit der Low-Level v0.0.1 Jason Derulo API Spezifikation zu arbeiten ist in solch kurzer Zeit unmöglich und scheint mir als sehr mühsam als auch innefizient. + +Das gleiche gilt für den Aspekt ein Sinnvollen Client sowohl auf Web als auch Desktop basis zu konzepieren. + +Momentan wurde ein Minimal-Funktionsabdeckendes Semi-Statisches Web-UI für Alarm Steuerung der Anlage entwickelt um die recherche bezüglich des Bodet Harmony / Sigma Master Clock Protokolls wenigstens halbwegs zum Einsatz zu bringen jedoch kann dies nicht die Aufgaben der Sigma Master Clock übernehmen. + +Um alles irgendwie noch hinzukriegen wird die backend in der Freizeit schon mal um einiges erweitert. -- cgit v1.2.3-70-g09d2