Michael Schiemer
55a330b223
- Add DISCOVERY_LOG_LEVEL=debug - Add DISCOVERY_SHOW_PROGRESS=true - Temporary changes for debugging InitializerProcessor fixes on production
55 lines
2.0 KiB
Markdown
55 lines
2.0 KiB
Markdown
# KI-Assistent Dokumentation
|
|
|
|
## Übersicht
|
|
|
|
Diese Dokumentation beschreibt die Einrichtung und Verwendung des KI-Assistenten im Projekt. Der KI-Assistent hilft bei der Entwicklung durch Code-Generierung, Refactoring-Vorschläge und mehr, während er die Projektstandards einhält.
|
|
|
|
## Inhalte
|
|
|
|
- [Guidelines für KI-Assistenten](/ai/GUIDELINES-FÜR-AI-ASSISTANT.md) - Richtlinien für den KI-Assistenten
|
|
- [PhpStorm Einrichtung](/ai/EINRICHTUNG-PHPSTORM.md) - Anleitung zur Einrichtung in PhpStorm
|
|
|
|
## KI-Assistent Guidelines
|
|
|
|
Die [Guidelines für KI-Assistenten](/ai/GUIDELINES-FÜR-AI-ASSISTANT.md) stellen sicher, dass der KI-generierte Code den Projektstandards entspricht:
|
|
|
|
- Einhaltung der Coding-Standards
|
|
- Vermeidung externer Abhängigkeiten
|
|
- Verwendung moderner PHP-Features
|
|
- Konsistente Klassenstruktur
|
|
- Korrekte Fehlerbehandlung
|
|
|
|
## Einrichtung in PhpStorm
|
|
|
|
Die [PhpStorm Einrichtungsanleitung](/ai/EINRICHTUNG-PHPSTORM.md) führt Sie durch den Prozess der Integration des KI-Assistenten in Ihre IDE:
|
|
|
|
- Konfiguration der Custom Instructions
|
|
- Verwendung der projektspezifischen Einstellungen
|
|
- Testen der korrekten Einrichtung
|
|
- Fehlerbehebung bei Problemen
|
|
|
|
## Effektive Nutzung des KI-Assistenten
|
|
|
|
### Best Practices
|
|
|
|
1. **Klare Anfragen stellen**: Je präziser die Anfrage, desto besser das Ergebnis
|
|
2. **Kontext bereitstellen**: Dem Assistenten relevanten Kontext geben
|
|
3. **Ergebnisse überprüfen**: Generierte Code immer prüfen und verstehen
|
|
4. **Iterativ arbeiten**: Bei komplexen Aufgaben schrittweise vorgehen
|
|
|
|
### Häufige Anwendungsfälle
|
|
|
|
- Erstellung neuer Klassen und Interfaces
|
|
- Implementierung von Tests
|
|
- Refactoring bestehenden Codes
|
|
- Dokumentation generieren
|
|
- Code-Optimierung
|
|
|
|
## Datenschutz und Sicherheit
|
|
|
|
Beim Umgang mit dem KI-Assistenten sollten Sie folgende Punkte beachten:
|
|
|
|
- Keine sensiblen Daten oder Geschäftsgeheimnisse teilen
|
|
- Keine Passwörter, API-Schlüssel oder Zugangsdaten teilen
|
|
- Bei Unsicherheit den KI-Assistenten nicht verwenden
|