177 lines
7.8 KiB
Markdown
177 lines
7.8 KiB
Markdown
# MYP Platform - Finale Dokumentationsstruktur
|
|
|
|
## 📋 Konsolidierte Kerndokumentation (5 Dateien)
|
|
|
|
Diese finale Dokumentationsstruktur wurde im Januar 2025 auf exakt 5 essenzielle Dokumente reduziert, die das gesamte MYP-System vollständig abbilden.
|
|
|
|
## 🎯 Die 5 Kerndokumente
|
|
|
|
### 1. [README.md](./README.md) - **Projektübersicht und Navigation**
|
|
**Zentrale Einstiegsseite** - Orientierung und Dokumentationsnavigation
|
|
- Projektbeschreibung und Zielsetzung
|
|
- Navigationsstruktur der Dokumentation
|
|
- Schnellstart-Anleitung für verschiedene Nutzergruppen
|
|
- Versionsinformationen und aktueller Status
|
|
|
|
### 2. [MYP_SYSTEMDOKUMENTATION.md](./MYP_SYSTEMDOKUMENTATION.md) - **Vollständige Systemdokumentation**
|
|
**Technische Referenz** - Alle Aspekte des Systems für Entwickler und Administratoren
|
|
- **Architektur**: Flask-Blueprint-Architektur, Design-Patterns, Core-Struktur
|
|
- **Installation**: Systemvoraussetzungen, Installationsmodi, Systemd-Services
|
|
- **Konfiguration**: SSL-Zertifikate, Netzwerk-Sicherheit, Remote-Zugang
|
|
- **Performance**: Raspberry Pi-Optimierungen, Caching-Strategien, Datenbank-Tuning
|
|
- **Integration**: TP-Link Tapo Smart Plugs, E-Mail-Benachrichtigungen, Datei-Uploads
|
|
- **Sicherheit**: SSL/TLS, CSRF-Schutz, Berechtigungssystem
|
|
- **Wartung**: Logging-System, automatische Wartung, System-Monitoring
|
|
- **Troubleshooting**: Debug-Tools, Backup und Recovery, Entwicklungsumgebung
|
|
|
|
### 3. [MYP_BENUTZERHANDBUCH.md](./MYP_BENUTZERHANDBUCH.md) - **Benutzer- und Admin-Handbuch**
|
|
**Funktionsreferenz** - Alle Features für Endbenutzer und Administratoren
|
|
- **Admin-Funktionen**: Dashboard, CRUD-Operationen, System-Administration
|
|
- **Gastauftrag-System**: OTP-Code-System, Status-Abfrage, Sicherheitsfeatures
|
|
- **Warteschlangen-System**: Offline-Drucker-Management, automatische Job-Aktivierung
|
|
- **Benutzerinterface**: Glassmorphism UI, Do Not Disturb System, Performance-Features
|
|
- **Drucker-Management**: Smart-Plug-Integration, Konflikt-Management
|
|
- **Job-Verwaltung**: Status-System, unterstützte Dateiformate
|
|
- **Sicherheit**: Berechtigungssystem, CSRF-Schutz, Audit-Logging
|
|
|
|
### 4. [RASPBERRY_PI_PERFORMANCE.md](./RASPBERRY_PI_PERFORMANCE.md) - **Performance-Optimierung**
|
|
**Optimierungsreferenz** - Speziell für Raspberry Pi und ressourcenbeschränkte Umgebungen
|
|
- **System-Optimierungen**: Kernel-Parameter, Service-Deaktivierung, Boot-Konfiguration
|
|
- **Application-Optimierungen**: Python/Flask-Tuning, Datenbank-Optimierungen
|
|
- **Frontend-Optimierungen**: CSS/JavaScript-Performance, Kiosk-Optimierungen
|
|
- **Monitoring**: Temperatur-Monitoring, Performance-Metriken, automatische Wartung
|
|
- **Hardware-Empfehlungen**: Kompatibilität, erweiterte Optimierungen
|
|
|
|
### 5. [COMMON_ERRORS.md](./COMMON_ERRORS.md) - **Troubleshooting und Fehlerbehebung**
|
|
**Problemlösungsreferenz** - Alle bekannten Probleme und deren Lösungen
|
|
- **Drucker-Status-Check**: Implementierung und Fehlerbehebung
|
|
- **Job-Scheduler**: Steckdosensteuerung, Job-Verwaltung, Sicherheitsmaßnahmen
|
|
- **Benutzer-Authentifizierung**: Schema-Probleme, Flask-Login-Fehler
|
|
- **Datenbank-Fehler**: SQLite-Probleme, Detached-Instance-Fehler
|
|
- **Frontend-Fehler**: CSP-Probleme, JavaScript-Fehler, Service Worker
|
|
- **API-Endpunkte**: 404-Fehler, Performance-Probleme
|
|
|
|
## 🎯 Navigationslogik
|
|
|
|
### Für Schnellstart
|
|
- **Neuer Admin**: README.md → MYP_SYSTEMDOKUMENTATION.md (Installation) → MYP_BENUTZERHANDBUCH.md (Admin-Funktionen)
|
|
- **Entwickler**: README.md → MYP_SYSTEMDOKUMENTATION.md (Architektur) → RASPBERRY_PI_PERFORMANCE.md
|
|
- **Endbenutzer**: README.md → MYP_BENUTZERHANDBUCH.md
|
|
- **Bei Problemen**: COMMON_ERRORS.md
|
|
|
|
### Zielgruppen-Matrix
|
|
| Dokument | Endbenutzer | Admin | Entwickler | DevOps |
|
|
|----------|-------------|-------|------------|--------|
|
|
| README.md | ✅ | ✅ | ✅ | ✅ |
|
|
| MYP_SYSTEMDOKUMENTATION.md | ❌ | ✅ | ✅ | ✅ |
|
|
| MYP_BENUTZERHANDBUCH.md | ✅ | ✅ | ❌ | ❌ |
|
|
| RASPBERRY_PI_PERFORMANCE.md | ❌ | ❌ | ✅ | ✅ |
|
|
| COMMON_ERRORS.md | ❌ | ✅ | ✅ | ✅ |
|
|
|
|
## 📁 Konsolidierte Inhalte
|
|
|
|
**Alle wichtigen Informationen aus folgenden Dokumenten wurden in die 5 Kerndokumente integriert:**
|
|
|
|
### In MYP_SYSTEMDOKUMENTATION.md integriert:
|
|
- SETUP_ANLEITUNG.md, INSTALLATION_DEBIAN_KIOSK.md, KIOSK_INSTALLATION_FINAL.md
|
|
- DATENBANK_KONFIGURATION.md, DNS_KONFIGURATION.md, LOGGING_README.md
|
|
- ERROR_MONITORING_SYSTEM_DOCUMENTATION.md, REQUIREMENTS.md
|
|
- FEHLERBEHANDLUNG.md, ROADMAP.md
|
|
|
|
### In MYP_BENUTZERHANDBUCH.md integriert:
|
|
- ADMIN_FUNKTIONEN.md, GASTAUFTRAG_OTP_DOKUMENTATION.md
|
|
- WARTESCHLANGEN_SYSTEM_DOKUMENTATION.md, GLASSMORPHISM_UND_DND_SYSTEM.md
|
|
|
|
### In RASPBERRY_PI_PERFORMANCE.md integriert:
|
|
- MYP_PERFORMANCE_OPTIMIERUNG.md und alle Performance-bezogenen Dokumente
|
|
- KIOSK_TEST_ANLEITUNG.md, STECKDOSEN_TEST_DOKUMENTATION.md
|
|
|
|
### In COMMON_ERRORS.md integriert:
|
|
- Alle troubleshooting-bezogenen Dokumente
|
|
- SCHULUNG_SCREENSHOT_TOOL.md, spezifische Fix-Dokumentationen
|
|
|
|
## 📋 Projektbeschreibung
|
|
|
|
**MYP (Manage Your Printers)** ist ein umfassendes 3D-Drucker-Verwaltungssystem für Mercedes-Benz, entwickelt für den Betrieb auf Debian/Linux-Systemen (speziell Raspberry Pi) im HTTPS-Kiosk-Modus.
|
|
|
|
### 🚀 Hauptfeatures
|
|
- **Benutzer- und Rollenverwaltung** mit granularen Berechtigungen
|
|
- **3D-Drucker-Management** mit Smart-Plug-Integration (TP-Link Tapo)
|
|
- **Job-Planung und -Überwachung** mit intelligenter Konfliktlösung
|
|
- **Gastauftrag-System** mit sicherem OTP-Code-System
|
|
- **Warteschlangen-Management** für Offline-Drucker
|
|
- **Admin-Dashboard** mit umfassenden Verwaltungsfunktionen
|
|
- **Hochperformante Raspberry Pi-Integration** mit optimiertem Kiosk-Modus
|
|
|
|
### 🏗️ Technische Basis
|
|
- **Backend**: Flask 3.1+ mit Blueprint-Architektur
|
|
- **Database**: SQLite mit WAL-Modus und Performance-Optimierungen
|
|
- **Frontend**: TailwindCSS mit Vanilla JavaScript
|
|
- **Security**: SSL/TLS, CSRF-Schutz, rollenbasierte Berechtigungen
|
|
- **Platform**: Debian/Raspberry Pi OS mit systemd-Integration
|
|
|
|
## 📊 Finale Konsolidierung
|
|
|
|
**Dokumentationsreduktion erfolgreich abgeschlossen:**
|
|
- **Ausgangslage**: 67+ einzelne Dokumentationsdateien
|
|
- **Finale Struktur**: 5 essenzielle Kerndokumente
|
|
- **Konsolidierte Inhalte**: 100% Informationserhalt in strukturierter Form
|
|
- **Reduktion**: ~93% bei vollständiger Funktionalitätsabdeckung
|
|
|
|
**Qualitätsgarantien:**
|
|
- ✅ Vollständige Systemabdeckung in 5 Dokumenten
|
|
- ✅ Klare Zielgruppen-Orientierung
|
|
- ✅ Keine Informationsverluste
|
|
- ✅ Optimierte Navigation und Querverweise
|
|
- ✅ Professionelle, wartbare Struktur
|
|
|
|
## ⚡ Schnellstart
|
|
|
|
### Für neue Administratoren
|
|
```bash
|
|
# 1. System installieren
|
|
sudo ./setup.sh
|
|
|
|
# 2. Dokumentation lesen
|
|
# - MYP_SYSTEMDOKUMENTATION.md (Installation)
|
|
# - MYP_BENUTZERHANDBUCH.md (Admin-Funktionen)
|
|
|
|
# 3. Bei Problemen
|
|
# - COMMON_ERRORS.md konsultieren
|
|
```
|
|
|
|
### Für Entwickler
|
|
```bash
|
|
# 1. Entwicklungsumgebung
|
|
pip install -r requirements.txt
|
|
npm install && npm run build:css
|
|
|
|
# 2. Dokumentation
|
|
# - MYP_SYSTEMDOKUMENTATION.md (Architektur)
|
|
# - RASPBERRY_PI_PERFORMANCE.md (Optimierungen)
|
|
|
|
# 3. Development Server
|
|
python app.py --debug
|
|
```
|
|
|
|
## 🔧 Wartungsrichtlinien
|
|
|
|
**Dokumentationspflege:**
|
|
- **Neue Features**: Integration in entsprechende Kerndokumente
|
|
- **Bugfixes**: Dokumentation in COMMON_ERRORS.md
|
|
- **Performance-Updates**: In RASPBERRY_PI_PERFORMANCE.md integrieren
|
|
- **Keine neuen Dokumentationsdateien** ohne zwingende Notwendigkeit
|
|
|
|
**5-Dokumente-Regel:**
|
|
- Maximal 5 .md Dateien im docs/ Verzeichnis
|
|
- Jede neue Information wird in bestehende Struktur integriert
|
|
- Quartalsweise Review auf Aktualität und Relevanz
|
|
- Versionsinformationen werden zentral in README.md gepflegt
|
|
|
|
---
|
|
|
|
**Status**: ✅ Finale 5-Dokumente-Struktur implementiert
|
|
**Letzte Aktualisierung**: Januar 2025
|
|
**Version**: 3.1.3 - Finale Dokumentationskonsolidierung
|
|
**Konsolidierung**: 67+ Dateien → 5 Kerndokumente (93% Reduktion)
|
|
**Informationserhalt**: 100% bei optimaler Struktur |