stefan
114 lines
2.5 KiB
Markdown
114 lines
2.5 KiB
Markdown
# [TECHNOLOGIE-NAME] Guidelines
|
|
|
|
---
|
|
guideline_type: "technology"
|
|
scope: "[spezifischer-bereich-identifier]"
|
|
audience: ["developers", "ai-assistants", "devops"]
|
|
last_updated: "[YYYY-MM-DD]"
|
|
dependencies: ["master-guideline.md", "[weitere-abhängigkeiten]"]
|
|
related_files: ["[relevante-projekt-dateien]", "config/[konfig-dateien]"]
|
|
ai_context: "[Deutsche Kurzbeschreibung für KI-Verständnis]"
|
|
---
|
|
|
|
## 🚀 Überblick und Philosophie
|
|
|
|
[Kurze Einführung in die Technologie und ihre Rolle im Meldestelle-Projekt]
|
|
|
|
### Grundprinzipien
|
|
|
|
- **Prinzip 1**: Beschreibung
|
|
- **Prinzip 2**: Beschreibung
|
|
- **Prinzip 3**: Beschreibung
|
|
|
|
> **🤖 AI-Assistant Hinweis:**
|
|
> [Wichtige Informationen für KI-Assistenten, URLs, Ports, etc.]
|
|
|
|
## 📋 [HAUPTBEREICH 1]
|
|
|
|
### [Unterbereich 1.1]
|
|
|
|
[Detaillierte Beschreibung mit Code-Beispielen]
|
|
|
|
```bash
|
|
# Beispiel-Befehle
|
|
[command-examples]
|
|
```
|
|
|
|
### [Unterbereich 1.2]
|
|
|
|
[Weitere technische Details]
|
|
|
|
## 🎯 AI-Assistenten: [TECHNOLOGIE]-Schnellreferenz
|
|
|
|
### Häufige Aufgaben
|
|
|
|
| Aufgabe | Befehl | Beschreibung |
|
|
|---------|---------|--------------|
|
|
| [Task 1] | `[command]` | [Beschreibung] |
|
|
| [Task 2] | `[command]` | [Beschreibung] |
|
|
| [Task 3] | `[command]` | [Beschreibung] |
|
|
|
|
### Wichtige URLs/Endpoints
|
|
- **[Service 1]:** http://localhost:[PORT]
|
|
- **[Service 2]:** http://localhost:[PORT]
|
|
- **[Monitoring]:** http://localhost:[PORT]
|
|
|
|
### Debug-Commands
|
|
|
|
```bash
|
|
# [Debug-Zweck]
|
|
[debug-commands]
|
|
|
|
# [Troubleshooting-Zweck]
|
|
[troubleshooting-commands]
|
|
```
|
|
|
|
## 🔧 [HAUPTBEREICH 2]
|
|
|
|
### [Konfiguration/Setup]
|
|
|
|
[Konfigurationsdetails mit Beispielen]
|
|
|
|
### [Best Practices]
|
|
|
|
1. **[Practice 1]:** [Beschreibung]
|
|
2. **[Practice 2]:** [Beschreibung]
|
|
3. **[Practice 3]:** [Beschreibung]
|
|
|
|
## 📊 Monitoring und Observability
|
|
|
|
[Monitoring-spezifische Informationen, falls relevant]
|
|
|
|
### Metrics
|
|
|
|
| Metric | Typ | Beschreibung |
|
|
|--------|-----|--------------|
|
|
| `[metric_name]` | [Typ] | [Beschreibung] |
|
|
|
|
## 🚨 Troubleshooting
|
|
|
|
### Häufige Probleme
|
|
|
|
#### [Problem 1]
|
|
```bash
|
|
# Diagnose
|
|
[diagnostic-commands]
|
|
|
|
# Lösung
|
|
[solution-commands]
|
|
```
|
|
|
|
#### [Problem 2]
|
|
[Weitere Problemlösungen]
|
|
|
|
---
|
|
|
|
**Navigation:**
|
|
- [Docker-Overview](./docker/docker-overview.md) - [falls relevant]
|
|
- [Master-Guideline](../master-guideline.md) - Projekt-Überblick
|
|
- [Architecture Principles](../project-standards/architecture-principles.md) - Architektur-Grundlagen
|
|
|
|
---
|
|
|
|
> **Basis-Prinzipien:** Diese Guidelines erweitern die [Master-Guideline](../master-guideline.md) um [TECHNOLOGIE]-spezifische Aspekte und folgen den allgemeinen Projektstandards.
|