mirror of
https://github.com/complexcaresolutions/frontend.blogwoman.de.git
synced 2026-03-17 19:44:00 +00:00
CCS Admin
4311a1960d
- Initialize Next.js 16 with React 19, TypeScript, and Tailwind CSS 4 - Add prompts/ directory for concept AI instructions - Add docs/ directory for project documentation - Include README files explaining workflow and conventions Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
45 lines
1.3 KiB
Markdown
45 lines
1.3 KiB
Markdown
# Dokumentation
|
|
|
|
Dieser Ordner enthält die Projektdokumentation und Referenzmaterialien für blogwoman.de.
|
|
|
|
## Struktur
|
|
|
|
```
|
|
docs/
|
|
├── README.md # Diese Übersicht
|
|
├── architecture/ # Architektur-Entscheidungen & Diagramme
|
|
├── components/ # Komponentendokumentation
|
|
├── api/ # API-Dokumentation (falls benötigt)
|
|
└── guides/ # Anleitungen & How-Tos
|
|
```
|
|
|
|
## Dokumentationstypen
|
|
|
|
### Architektur-Dokumentation
|
|
Technische Entscheidungen, Systemübersichten und Architektur-Diagramme.
|
|
|
|
### Komponenten-Dokumentation
|
|
Beschreibungen der React-Komponenten, Props, Verwendungsbeispiele.
|
|
|
|
### Anleitungen
|
|
Schritt-für-Schritt-Anleitungen für wiederkehrende Aufgaben.
|
|
|
|
## Zusammenspiel mit Prompts
|
|
|
|
| Ordner | Zweck |
|
|
|--------|-------|
|
|
| `/prompts/` | Anweisungen **vor** der Umsetzung |
|
|
| `/docs/` | Dokumentation **nach** der Umsetzung |
|
|
|
|
## Konventionen
|
|
|
|
- Markdown-Format für alle Dokumentation
|
|
- Klare, präzise Sprache
|
|
- Code-Beispiele wo hilfreich
|
|
- Regelmäßige Aktualisierung bei Änderungen
|
|
|
|
## Verwandte Ressourcen
|
|
|
|
- [Prompts](/prompts/README.md) - Anweisungen der Konzept-KI
|
|
- [Next.js Dokumentation](https://nextjs.org/docs) - Framework-Referenz
|
|
- [React Dokumentation](https://react.dev) - UI-Bibliothek-Referenz
|