docs
This commit is contained in:
75
docs/README2.md
Normal file
75
docs/README2.md
Normal file
@@ -0,0 +1,75 @@
|
||||
# 📚 Entwicklerdokumentation für CPLv4.0 Frontend
|
||||
|
||||
Willkommen zur technischen Dokumentation des CPLv4.0 Frontends.
|
||||
Dieses Verzeichnis enthält alle Details zur Architektur, zu den Datenflüssen, zum Redux-Management und zu den verwendeten APIs.
|
||||
|
||||
---
|
||||
|
||||
## 📆 Übersicht
|
||||
|
||||
Dieses Dokument erklärt die technische Struktur und den Ablauf des Projekts für Entwickler. Es dient als Einstiegspunkt für die detaillierte Dokumentation in den jeweiligen Unterordnern.
|
||||
|
||||
- **Architektur**: Aufbau des Systems und der Hauptkomponenten
|
||||
- **Datenflüsse**: Flowcharts und Sequenzdiagramme wichtiger Abläufe
|
||||
- **Redux**: State-Management über Slices und Thunks
|
||||
- **APIs**: Beschreibung der genutzten API-Endpunkte
|
||||
- **Deployment**: Schritte für Build und Veröffentlichung auf CPL
|
||||
- **Glossar**: Erklärung wichtiger technischer Begriffe
|
||||
|
||||
---
|
||||
|
||||
## 📂 Verzeichnisstruktur
|
||||
|
||||
```plaintext
|
||||
/docsForDev/
|
||||
├── Architektur/
|
||||
│ ├── ArchitekturUebersicht.md
|
||||
│ └── KomponentenDiagramm.md
|
||||
├── Datenflüsse/
|
||||
│ ├── SystemVoltTempFlow.md
|
||||
│ ├── TDRSequenz.md
|
||||
│ └── MeldungenFlow.md
|
||||
├── Redux/
|
||||
│ ├── ReduxStateUebersicht.md
|
||||
│ └── WichtigeThunks.md
|
||||
├── APIs/
|
||||
│ ├── SystemAPI.md
|
||||
│ └── KabelueberwachungAPI.md
|
||||
├── Deployment/
|
||||
│ └── DeploymentCPL.md
|
||||
├── Glossar/
|
||||
│ └── Begriffe.md
|
||||
└── README.md # Diese Datei
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Inhalte
|
||||
|
||||
- **Technische Zusammenhänge** zwischen Frontend, Backend und Embedded-System
|
||||
- **Redux-Slices** und **Thunks** im Detail beschrieben
|
||||
- **Flowcharts und Sequenzdiagramme** zur Veranschaulichung der Abläufe
|
||||
- **API-Dokumentation** für Datenabrufe und Systembefehle
|
||||
- **Mock-Daten-Strategie** für Entwicklung ohne Hardware
|
||||
- **Deployment-Anleitung** für CPL ("out"-Verzeichnis Upload)
|
||||
|
||||
---
|
||||
|
||||
## 💬 Hinweise für Entwickler
|
||||
|
||||
- Neue Redux-Slices oder Thunks bitte hier in den passenden Dateien dokumentieren.
|
||||
- Anpassungen an Komponenten oder APIs sollten mit neuen Diagrammen oder Updates versehen werden.
|
||||
- Mock-Daten sollten beschrieben werden, wenn neue Felder hinzukommen.
|
||||
- Deployment-Anweisungen aktualisieren, falls sich der Ablauf ändert.
|
||||
|
||||
---
|
||||
|
||||
## 📣 Ziel
|
||||
|
||||
Eine klare, aktuelle und wartbare technische Dokumentation für das gesamte CPLv4.0 Frontend Projekt, die sowohl neue als auch bestehende Entwickler effektiv unterstützt.
|
||||
|
||||
---
|
||||
|
||||
## 👨💼 Kontakt
|
||||
|
||||
Bei Fragen oder Unklarheiten zur Dokumentation bitte an das CPLv4.0 Entwicklungsteam wenden.
|
||||
Reference in New Issue
Block a user