36 lines
1.6 KiB
Markdown
36 lines
1.6 KiB
Markdown
# Projekt-Dokumentation
|
|
|
|
## Willkommen zur Projektdokumentation
|
|
|
|
Diese Dokumentation bietet umfassende Informationen zu Coding-Standards, Architektur, Best Practices und Framework-Komponenten des Projekts.
|
|
|
|
## Schnellzugriff
|
|
|
|
- [Coding-Guidelines](/standards/CODING-GUIDELINES.md)
|
|
- [Sicherheitsrichtlinien](/standards/SICHERHEITS-GUIDELINES.md)
|
|
- [Projektstruktur](/architecture/STRUKTUR-DOKUMENTATION.md)
|
|
- [Performance-Optimierung](/guidelines/PERFORMANCE-GUIDELINES.md)
|
|
- [KI-Assistent Einrichtung](/ai/EINRICHTUNG-PHPSTORM.md)
|
|
|
|
## Dokumentationsstruktur
|
|
|
|
Die Dokumentation ist in verschiedene Bereiche unterteilt:
|
|
|
|
- **Standards und Guidelines**: Grundlegende Prinzipien und Richtlinien für die Entwicklung
|
|
- **Framework-Module**: Dokumentation zu den einzelnen Framework-Komponenten
|
|
- **Entwicklungsrichtlinien**: Detaillierte Anleitungen zu Performance, Testing und mehr
|
|
- **Architektur**: Übersicht und Details zur Systemarchitektur
|
|
- **KI-Assistent-Integration**: Anleitung zur Verwendung des KI-Assistenten
|
|
|
|
## Für neue Entwickler
|
|
|
|
Wenn Sie neu im Projekt sind, empfehlen wir Ihnen, mit folgenden Dokumenten zu beginnen:
|
|
|
|
1. [Projektstruktur](/architecture/STRUKTUR-DOKUMENTATION.md) - Um einen Überblick zu bekommen
|
|
2. [Coding-Guidelines](/standards/CODING-GUIDELINES.md) - Um die Coding-Standards zu verstehen
|
|
3. [Modul-Checkliste](/framework/MODUL-CHECKLISTE.md) - Um die Modularisierung zu verstehen
|
|
|
|
## Beitragen zur Dokumentation
|
|
|
|
Die Dokumentation ist ein lebendiges Dokument. Wenn Sie Fehler finden oder Verbesserungen vorschlagen möchten, erstellen Sie bitte einen Pull Request mit Ihren Änderungen.
|