Carambus Dokumentation¶

Willkommen bei der Carambus-Dokumentation! Dieses Verzeichnis enthält umfassende Dokumentation für das Carambus Billard-Turnierverwaltungssystem.

📚 Dokumentationsindex¶

Erste Schritte¶

README.md: Projektübersicht und Schnellstart-Anleitung
DEVELOPER_GUIDE.md: Umfassender Leitfaden für Entwickler
API.md: Vollständige API-Dokumentation mit Beispielen

Kern-Dokumentation¶

database_design.md: Datenbankschema und Beziehungen
tournament.md: Turnierverwaltungs-Workflows
einzelturnierverwaltung.md: Einzelturnierverwaltung
league.md: Ligaspieltage

Technische Dokumentation¶

datenbank-partitionierung-und-synchronisierung.md: Datenbank-Partitionierung
docker_installation.md: Docker-Installation
installation_overview.md: Installationsübersicht

Deployment & Betrieb¶

docker_installation.md: Produktions-Deployment-Anleitung
installation_overview.md: Installationsübersicht

Rechtliches & Datenschutz¶

terms.md: Nutzungsbedingungen

Projektinformationen¶

about.md: Projekt-Hintergrund und Entwicklerinformationen

Für neue Entwickler¶

Beginnen Sie mit README.md für Projektübersicht
Lesen Sie DEVELOPER_GUIDE.md für Setup-Anweisungen
Überprüfen Sie database_design.md für Datenmodell-Verständnis
Prüfen Sie API.md für Integrationsmöglichkeiten

Für Systemadministratoren¶

Überprüfen Sie docker_installation.md für Deployment
Lesen Sie installation_overview.md für Installationsübersicht
Prüfen Sie table_reservation_heating_control.md für Tischreservierung und Heizungssteuerung

Für Turnierorganisatoren¶

Lesen Sie tournament.md für Turnier-Workflows
Überprüfen Sie einzelturnierverwaltung.md für detaillierte Anleitung
Prüfen Sie league.md für Ligaverwaltung

Für API-Benutzer¶

Beginnen Sie mit API.md für vollständige API-Dokumentation
Überprüfen Sie database_design.md für Datenstruktur

📖 Dokumentationsstruktur¶

docs/
├── index.md                            # Hauptstartseite
├── de/                                 # Deutsche Dokumentation
│   ├── README.md                       # Diese Datei - Dokumentationsindex
│   ├── DEVELOPER_GUIDE.md              # Haupt-Entwicklerdokumentation
│   ├── API.md                          # API-Dokumentation
│   ├── database_design.md              # Datenbankschema
│   ├── tournament.md                   # Turnier-Workflows
│   ├── einzelturnierverwaltung.md      # Einzelturnierverwaltung
│   ├── league.md                       # Ligaspieltage
│   ├── docker_installation.md          # Docker-Installation
│   ├── installation_overview.md        # Installationsübersicht
│   ├── table_reservation_heating_control.md # Tischreservierung
│   ├── terms.md                        # Nutzungsbedingungen
│   └── about.md                        # Projektinformationen
└── en/                                 # Englische Dokumentation
    └── ...                             # Entsprechende Übersetzungen

🔄 Dokumentationswartung¶

Beitrag zur Dokumentation¶

Folgen Sie dem Beitragsleitfaden
Aktualisieren Sie relevante Dokumentation beim Hinzufügen von Features
Fügen Sie Code-Beispiele für neue APIs ein
Behalten Sie Konsistenz über alle Dokumente hinweg

Dokumentationsstandards¶

Verwenden Sie klare, prägnante Sprache
Fügen Sie praktische Beispiele ein
Stellen Sie deutsche und englische Versionen bereit, wo angemessen
Halten Sie Dokumentation mit Code-Änderungen aktuell

Versionskontrolle¶

Dokumentation ist mit der Codebasis versioniert
Große Änderungen erfordern Dokumentations-Updates
API-Änderungen müssen vor dem Release dokumentiert werden

📞 Hilfe erhalten¶

Dokumentationsprobleme¶

Melden Sie Dokumentationsfehler über GitHub Issues
Schlagen Sie Verbesserungen über GitHub Discussions vor

Technischer Support¶

Prüfen Sie den Entwicklerleitfaden für häufige Probleme
Überprüfen Sie die API-Dokumentation für Integrationshilfe
Konsultieren Sie die Docker-Installation für Deployment-Probleme

Community-Ressourcen¶

GitHub Issues: Bug-Reports und Feature-Requests
GitHub Discussions: Fragen und Community-Support
Projekt Wiki: Zusätzliche community-gewartete Dokumentation

🌐 Sprachunterstützung¶

Die Carambus-Dokumentation ist in mehreren Sprachen verfügbar:

Englisch: Primäre Dokumentationssprache
Deutsch: Wichtige Dokumente für deutsche Benutzer übersetzt
Zukunft: Zusätzliche Sprachunterstützung geplant

Sprachspezifische Dateien¶

*.en.md: Englische Dokumentation
*.de.md: Deutsche Dokumentation
*.md: Standardsprache (normalerweise Englisch)

Diese Dokumentation wird vom Carambus-Entwicklungsteam gepflegt. Für Fragen oder Beiträge siehe den Beitragsleitfaden.