📚 Gongomat - Dokumentations-Index

Gongomat V2 - Blazor Server Anwendung für Gong- und Prüfungsverwaltung
Framework: .NET 8, Entity Framework Core, SignalR
Stand: Dezember 2025

🚀 Schnellstart

Für wen?	Dokument	Beschreibung
Neue Entwickler	Entwicklungsumgebung	Entwicklungsumgebung einrichten (IDE, Datenbank, Git)
Endbenutzer	Benutzerhandbuch	Projektübersicht und grundlegende Konzepte
DevOps/Admin	Testsystem	Azure Deployment für Test- und Produktivsysteme

📖 Dokumentations-Übersicht

1. Projekt & Architektur

Dokument	Inhalt	Zielgruppe
README.md	Projektübersicht, Design-Konzepte, TODO-Liste	Alle
docs/ARCHITECTURE.md	Systemarchitektur, Komponenten, Datenfluss	Entwickler, Architekten
docs/DATABASE_DESIGN.md	Datenbankschema, ER-Diagramme, Migrationen	Entwickler, DBAs

2. Entwicklung

Dokument	Inhalt	Zielgruppe
Umgebung.md	Setup-Anleitung für lokale Entwicklung	Entwickler
docs/GIT_WORKFLOW.md	Git-Branching-Strategie, Commit-Konventionen	Entwickler
docs/CODING_STANDARDS.md	Code-Konventionen, Best Practices	Entwickler
.github/CONTRIBUTING.md	Beitrags-Richtlinien für externe Entwickler	Contributors

3. Features & Funktionen

Dokument	Inhalt	Zielgruppe
GONG_MANAGEMENT.md	Gong-Verwaltung, Sound-Upload, Play-Button	Entwickler, Benutzer
V2NeueFunktionen.md	Neue Features in Version 2 (Timeline, Drag & Drop)	Alle
docs/GONGPATTERN_MANAGEMENT.md	Gongsequenzen erstellen und bearbeiten	Entwickler, Benutzer
docs/EXAM_SCHEDULING.md	Prüfungsverwaltung und Kalender	Entwickler, Benutzer
docs/CLIENT_MANAGEMENT.md	Client-Verwaltung und SignalR-Integration	Entwickler

4. APIs & Integrationen

Dokument	Inhalt	Zielgruppe
docs/API_REFERENCE.md	REST API Endpunkte, Request/Response-Formate	Entwickler, Integratoren
docs/SIGNALR_HUBS.md	SignalR ClientHub, Protokollierung	Entwickler
docs/JAVASCRIPT_INTEROP.md	JS-Blazor-Interop, Audio-Player, Timeline	Entwickler

5. Deployment & Betrieb

Dokument	Inhalt	Zielgruppe
DEPLOYMENT_AZURE.md	Azure App Service & SQL Database Deployment	DevOps, Admins
docs/DEPLOYMENT_ONPREM.md	On-Premises IIS Deployment	DevOps, Admins
docs/MONITORING.md	Logging, Application Insights, Fehlerbehandlung	DevOps, Support
docs/BACKUP_RESTORE.md	Backup-Strategien, Disaster Recovery	Admins, DBAs

6. Sicherheit & Compliance

Dokument	Inhalt	Zielgruppe
docs/SECURITY.md	Authentifizierung, Autorisierung, Rollen	Entwickler, Security
docs/MULTI_TENANCY.md	Tenant-Isolation, Datentrennung	Entwickler, Architekten
docs/DATA_PRIVACY.md	DSGVO-Compliance, Datenverarbeitung	Compliance, Legal

7. Benutzer-Dokumentation

Dokument	Inhalt	Zielgruppe
docs/USER_MANUAL.md	Bedienungsanleitung für Endbenutzer	Endbenutzer, Support
docs/ADMIN_MANUAL.md	Administrator-Handbuch	Admins
docs/FAQ.md	Häufig gestellte Fragen	Alle
docs/TROUBLESHOOTING.md	Problemlösungen und bekannte Issues	Support, Entwickler

8. Testing & Qualität

Dokument	Inhalt	Zielgruppe
docs/TESTING_GUIDE.md	Unit-Tests, Integration-Tests, E2E-Tests	Entwickler, QA
docs/PERFORMANCE.md	Performance-Optimierung, Benchmarks	Entwickler, DevOps

🗂️ Verzeichnisstruktur

Gongomat240206/
├── README.md                          # Projekt-Übersicht
├── INDEX.md                           # Dieser Index (zentrale Navigation)
├── ENTWICKLUNGSUMGEBUNG.md            # Dev Setup
├── DEPLOYMENT_AZURE.md                # Azure Deployment
├── GONG_MANAGEMENT.md                 # Gong-Features (V2)
├── V2NeueFunktionen.md                # Neue Features
├── .github/
│   ├── CONTRIBUTING.md                # Contribution Guidelines
│   └── workflows/                     # CI/CD Pipelines
├── docs/                              # Detaillierte Dokumentation
│   ├── ARCHITECTURE.md
│   ├── DATABASE_DESIGN.md
│   ├── API_REFERENCE.md
│   ├── USER_MANUAL.md
│   ├── SECURITY.md
│   └── ... (weitere Dokumente)
├── Gongomat/                          # Hauptprojekt
│   ├── Components/
│   ├── Data/
│   ├── wwwroot/
│   └── ...
└── weiteres/                          # Screenshots, Assets

🔄 Dokumentations-Workflow

Für Entwickler

Neues Feature entwickelt?
- Aktualisiere relevante Dokumentation in docs/
- Füge Beispiele und Code-Snippets hinzu
- Update V2NeueFunktionen.md wenn User-sichtbar
API-Änderung?
- Aktualisiere docs/API_REFERENCE.md
- Versioniere API-Änderungen
Datenbank-Migration?
- Dokumentiere in docs/DATABASE_DESIGN.md
- Update ENTWICKLUNGSUMGEBUNG.md falls Setup geändert

Für Dokumentations-Autoren

Markdown-Konventionen: Verwende konsistentes Markdown (siehe .editorconfig)
Screenshots: Speichere in weiteres/ mit sprechendem Namen
Diagramme: Nutze Mermaid oder PNG-Bilder
Sprache: Deutsch für Benutzer-Doku, Code-Kommentare optional Englisch

🌐 Wiki-Integration (GitHub)

Das GitHub Wiki ist ein separates Repository. Synchronisation:

Option 1: Git Submodule

git submodule add https://github.com/internauten/Gongomat240206.wiki.git wiki

Option 2: Manuelle Synchronisation

Wichtige Dokumente aus docs/ ins Wiki kopieren
Wiki-URLs in diesem Index verlinken

Option 3: Automatische Sync (GitHub Actions)

.github/workflows/sync-wiki.yml erstellen
Bei Push auf main → Docs ins Wiki kopieren

Empfehlung: Verwende das Hauptrepository als "Single Source of Truth" und synchronisiere wichtige Teile ins Wiki für öffentliche Sichtbarkeit.

📝 Changelog & Releases

Versionierung: Semantic Versioning (MAJOR.MINOR.PATCH)
Changelog: CHANGELOG.md
Releases: GitHub Releases mit Tags (v2.0.0, v2.1.0, etc.)

Aktuelle Version

V2.0.0 (November 2024)

Neue Timeline-UI für Gongsequenzen und Prüfungsschemata
Drag & Drop Funktionalität
Sound-Upload und Play-Button
Siehe: V2NeueFunktionen.md

🔗 Nützliche Links

Externe Ressourcen

Projekt-Links

GitHub Repository: Gongomat240206
Branch: GomgomatV2
Issues: GitHub Issues
Wiki: GitHub Wiki

👥 Support & Kontakt

Issues: Für Bugs und Feature-Requests
Discussions: Für Fragen und Diskussionen
Contributing: Siehe CONTRIBUTING.md

📜 Lizenz

[Lizenzinformationen hier einfügen]

Zuletzt aktualisiert: Dezember 2025 Dokumentations-Version: 1.0
Projekt-Version: V2.0.0

Gongomat Dokumentation