docs: restructure docs to diataxis and finalize DOCS-RESTRUCTURE-001
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
# Architektur-Kompass
|
||||
|
||||
Letzte Aktualisierung: 2026-03-04
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Ziel
|
||||
|
||||
@@ -91,7 +91,7 @@ flowchart TD
|
||||
## Instanziierungsregeln (MUSS)
|
||||
|
||||
- Composition Root: `web/index.php` + `lib/App/registerContainer.php`
|
||||
(→ Details: `/docs/di-container.md`).
|
||||
(→ Details: `/docs/explanation-di-container.md`).
|
||||
- `new ...Factory()` nur im Composition Root und in `*Factory.php`.
|
||||
- In `lib/Service/**` außerhalb von `*Factory.php` keine direkten `new ...Factory()`.
|
||||
- In `lib/Service/**` außerhalb von `*Factory.php` keine direkten `new ...Service()`, `new ...Gateway()` oder `new ...Repository()`.
|
||||
@@ -148,6 +148,6 @@ docker compose exec php vendor/bin/phpunit tests/Architecture/CoreStarterkitCont
|
||||
|
||||
## Vertiefung
|
||||
|
||||
- `/docs/lib-standards.md`
|
||||
- `/docs/sicherheitsmodell.md`
|
||||
- `/docs/rbac-permissions-playbook.md`
|
||||
- `/docs/reference-lib-standards.md`
|
||||
- `/docs/explanation-sicherheitsmodell.md`
|
||||
- `/docs/howto-rbac-permissions-playbook.md`
|
||||
@@ -1,5 +1,7 @@
|
||||
# Dependency Injection Container
|
||||
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Was ist das und wozu brauchen wir es?
|
||||
|
||||
Statt dass jede Action-Datei ihre Services selbst zusammenbaut
|
||||
@@ -1,15 +1,15 @@
|
||||
# Docker-Betrieb
|
||||
|
||||
Letzte Aktualisierung: 2026-02-21
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Übersicht
|
||||
|
||||
Die Docker-Dokumentation ist in zwei klare Pfade getrennt:
|
||||
|
||||
1. Lokal entwickeln:
|
||||
- `/docs/docker-lokal.md`
|
||||
- `/docs/howto-docker-lokal.md`
|
||||
2. Produktiv betreiben:
|
||||
- `/docs/docker-produktiv.md`
|
||||
- `/docs/howto-docker-produktiv.md`
|
||||
|
||||
## Empfehlung
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Einstellungen: Speicherung (DB + Cache)
|
||||
|
||||
Letzte Aktualisierung: 2026-02-22
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Kurzfassung
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Sicherheitsmodell
|
||||
|
||||
Letzte Aktualisierung: 2026-03-03
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Ziel
|
||||
|
||||
@@ -108,6 +108,6 @@ API-Sonderfall:
|
||||
|
||||
## Vertiefung
|
||||
|
||||
- `/docs/anfragelimits.md`
|
||||
- `/docs/06-security-tenant-scope.md`
|
||||
- `/docs/rbac-permissions-playbook.md`
|
||||
- `/docs/howto-anfragelimits.md`
|
||||
- `/docs/tutorial-07-security-tenant-scope.md`
|
||||
- `/docs/howto-rbac-permissions-playbook.md`
|
||||
@@ -1,6 +1,6 @@
|
||||
# Anfragelimits (Rate Limiting)
|
||||
|
||||
Letzte Aktualisierung: 2026-02-24
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Ziel
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Auth/SSO Smoke-Test
|
||||
|
||||
Letzte Aktualisierung: 2026-02-22
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
Dieser Runbook prüft die 5 kritischen Flows nach Auth/SSO-Änderungen:
|
||||
- Login (Passwort)
|
||||
@@ -1,6 +1,6 @@
|
||||
# Benutzerdefinierte Felder (V1) Kurzreferenz
|
||||
|
||||
Letzte Aktualisierung: 2026-02-21
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Ziel
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Betriebscheck mit `bin/doctor.php`
|
||||
|
||||
Letzte Aktualisierung: 2026-02-25
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Ziel
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Docker lokal
|
||||
|
||||
Letzte Aktualisierung: 2026-03-03
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Ziel
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Docker produktiv
|
||||
|
||||
Letzte Aktualisierung: 2026-03-03
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Ziel
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Dokumentation erweitern
|
||||
|
||||
Letzte Aktualisierung: 2026-02-24
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Ziel
|
||||
|
||||
@@ -14,14 +14,14 @@ Neue Seiten schnell, konsistent und langfristig wartbar ergänzen.
|
||||
- Docs-Suche
|
||||
- Vollsuche (`/search`)
|
||||
|
||||
Hauptbereiche in genau dieser Reihenfolge:
|
||||
Die Dokumentation folgt dem Diataxis-Modell mit genau vier Quadranten in dieser Reihenfolge:
|
||||
|
||||
1. Lernpfad (chronologisch)
|
||||
2. Konzepte (Explanation)
|
||||
3. Aufgabenanleitungen (How-to)
|
||||
4. Referenz (Reference)
|
||||
5. Betrieb (Operations)
|
||||
6. Mitwirken (Contributor Guide)
|
||||
1. **Tutorials** — Lernorientierte Schritt-fuer-Schritt-Anleitungen
|
||||
2. **How-to Guides** — Aufgabenorientierte Anleitungen fuer konkrete Ziele
|
||||
3. **Explanation** — Verstaendnisorientierte Hintergrunderklaerungen
|
||||
4. **Reference** — Informationsorientierte Fakten und Nachschlagewerke
|
||||
|
||||
Dateinamenformat: `<quadrant-prefix>-<slug>.md`, wobei Prefix nur `tutorial-`, `howto-`, `explanation-`, `reference-` ist.
|
||||
|
||||
## Format pro Seite (kurz und klar)
|
||||
|
||||
@@ -38,8 +38,8 @@ Richtwert: zuerst kurz, Details als Verweis auf Referenzseiten.
|
||||
|
||||
## Standardablauf
|
||||
|
||||
1. Datei in `docs/*.md` anlegen (`a-z`, `0-9`, `-`).
|
||||
2. Seite im passenden Bereich in `docs/index.md` eintragen.
|
||||
1. Datei in `docs/<prefix>-<slug>.md` anlegen (Prefix: `tutorial-`, `howto-`, `explanation-`, `reference-`).
|
||||
2. Seite im passenden Diataxis-Quadranten in `docs/index.md` eintragen.
|
||||
3. Aussagekräftige H2/H3-Überschriften setzen (für Suche).
|
||||
4. Relevante Querverweise ergänzen.
|
||||
5. Datum aktualisieren.
|
||||
@@ -49,9 +49,9 @@ Richtwert: zuerst kurz, Details als Verweis auf Referenzseiten.
|
||||
1. Seite ist in `docs/index.md` eingetragen.
|
||||
2. Struktur ist kurz, klar, ohne Redundanz.
|
||||
3. Pfade, Routen, Permissions stimmen mit dem Code.
|
||||
4. Instanziierungsregeln sind konsistent mit `/docs/architektur.md` und `/docs/lib-standards.md`.
|
||||
4. Instanziierungsregeln sind konsistent mit `/docs/explanation-architektur.md` und `/docs/reference-lib-standards.md`.
|
||||
5. Mindestens ein konkretes Beispiel ist enthalten.
|
||||
6. Begriffe sind konsistent mit `/docs/02-domain-glossar.md`.
|
||||
6. Begriffe sind konsistent mit `/docs/reference-domain-glossar.md`.
|
||||
|
||||
## Häufige Fehler
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Leitfaden für die erste Änderung
|
||||
|
||||
Letzte Aktualisierung: 2026-02-24
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Ziel
|
||||
|
||||
@@ -51,4 +51,4 @@ Ein neuer Entwickler soll den ersten Change strukturiert und reproduzierbar umse
|
||||
|
||||
Vor PR/Merge diese Liste gegenprüfen:
|
||||
|
||||
- `/docs/entwickler-checkliste.md`
|
||||
- `/docs/reference-entwickler-checkliste.md`
|
||||
@@ -1,6 +1,6 @@
|
||||
# Fehlerbehebung
|
||||
|
||||
Letzte Aktualisierung: 2026-02-23
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## App reagiert nicht wie erwartet
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Geplante Aufgaben
|
||||
|
||||
Letzte Aktualisierung: 2026-02-24
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Ziel
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Globale Suche erweitern
|
||||
|
||||
Letzte Aktualisierung: 2026-02-24
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Ziel
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Importe
|
||||
|
||||
Letzte Aktualisierung: 2026-02-24
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Ziel
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Lokale Entwicklung
|
||||
|
||||
Letzte Aktualisierung: 2026-02-24
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Ziel
|
||||
|
||||
@@ -60,5 +60,5 @@ Bei JS-Änderungen zusätzlich Browser-Smoke mit DevTools-Console (keine JS-Erro
|
||||
|
||||
## Vertiefung
|
||||
|
||||
- `/docs/entwickler-checkliste.md`
|
||||
- `/docs/03-architektur-request-flow.md`
|
||||
- `/docs/reference-entwickler-checkliste.md`
|
||||
- `/docs/tutorial-04-architektur-request-flow.md`
|
||||
@@ -1,6 +1,6 @@
|
||||
# RBAC Permission Playbook
|
||||
|
||||
Letzte Aktualisierung: 2026-02-25
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
Ziel: Neue Rechte konsistent und ohne Legacy-Pfade ergänzen.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Request Input + Validation
|
||||
|
||||
Letzte Aktualisierung: 2026-02-25
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
Kurzstandard fuer neue Actions/Endpoints.
|
||||
|
||||
153
docs/index.md
153
docs/index.md
@@ -1,104 +1,101 @@
|
||||
# Dokumentation
|
||||
|
||||
Letzte Aktualisierung: 2026-03-04
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
Diese Dokumentation folgt einem klaren Lernpfad (einfach -> fortgeschritten) und trennt Lernen von Nachschlagen.
|
||||
Diese Dokumentation ist nach dem Diataxis-Modell in vier Quadranten gegliedert: Tutorials zum Lernen, How-to Guides zum Nachschlagen von Aufgaben, Explanation zum Verstehen und Reference zum Nachschlagen von Fakten.
|
||||
|
||||
## Lernpfad (chronologisch)
|
||||
## Tutorials
|
||||
|
||||
1. `/docs/00-systemueberblick.md`
|
||||
1. `/docs/tutorial-01-erste-schritte.md`
|
||||
- Schnellstart: Repo klonen, Container starten, erster Login.
|
||||
2. `/docs/tutorial-02-systemueberblick.md`
|
||||
- Produktbild, Kernmodule und Lernziel in 10 Minuten.
|
||||
2. `/docs/01-setup-und-erster-login.md`
|
||||
3. `/docs/tutorial-03-setup-und-erster-login.md`
|
||||
- Lokales Setup, erster Login, erster Smoke-Test.
|
||||
3. `/docs/02-domain-glossar.md`
|
||||
- Zentrale Begriffe (Tenant, Role, Permission, Scope, Policy).
|
||||
4. `/docs/03-architektur-request-flow.md`
|
||||
4. `/docs/tutorial-04-architektur-request-flow.md`
|
||||
- Request-Flow, Schichtmodell, Do/Don't.
|
||||
5. `/docs/04-erste-aenderung-ui.md`
|
||||
- Erste sichere UI-Änderung im Admin-Bereich.
|
||||
6. `/docs/05-erste-aenderung-backend.md`
|
||||
- Erste Backend-/Service-/Repository-Änderung.
|
||||
7. `/docs/06-security-tenant-scope.md`
|
||||
5. `/docs/tutorial-05-erste-aenderung-ui.md`
|
||||
- Erste sichere UI-Aenderung im Admin-Bereich.
|
||||
6. `/docs/tutorial-06-erste-aenderung-backend.md`
|
||||
- Erste Backend-/Service-/Repository-Aenderung.
|
||||
7. `/docs/tutorial-07-security-tenant-scope.md`
|
||||
- Sicherheitsgrundlagen, Tenant-Scope, Pflichtchecks.
|
||||
8. `/docs/07-api-erweitern.md`
|
||||
- API-Änderung sauber mit OpenAPI und Tests umsetzen.
|
||||
9. `/docs/08-advanced-scheduler-sso.md`
|
||||
8. `/docs/tutorial-08-api-erweitern.md`
|
||||
- API-Aenderung sauber mit OpenAPI und Tests umsetzen.
|
||||
9. `/docs/tutorial-09-advanced-scheduler-sso.md`
|
||||
- Fortgeschrittene Themen: Scheduler, Lifecycle, SSO.
|
||||
|
||||
## Konzepte (Explanation)
|
||||
## How-to Guides
|
||||
|
||||
- `/docs/architektur.md`
|
||||
- Architektur-Kompass mit verbindlichen Leitplanken.
|
||||
- `/docs/di-container.md`
|
||||
- Wie der AppContainer funktioniert und neue Services registriert werden.
|
||||
- `/docs/sicherheitsmodell.md`
|
||||
- Vollständiges Sicherheitsmodell (Auth, Permission, Scope).
|
||||
- `/docs/einstellungen-speicherung.md`
|
||||
- Warum Settings in DB + Datei-Cache koexistieren.
|
||||
|
||||
## Aufgabenanleitungen (How-to)
|
||||
|
||||
- `/docs/globale-suche.md`
|
||||
- `/docs/howto-erste-aenderung.md`
|
||||
- Schritt-fuer-Schritt durch die erste Codeaenderung.
|
||||
- `/docs/howto-globale-suche.md`
|
||||
- Neue Resource in der globalen Suche integrieren.
|
||||
- `/docs/importe.md`
|
||||
- `/docs/howto-importe.md`
|
||||
- Importfluss, Regeln und Fehlercodes.
|
||||
- `/docs/benutzerdefinierte-felder.md`
|
||||
- `/docs/howto-benutzerdefinierte-felder.md`
|
||||
- Tenant/User-Zusatzfelder korrekt erweitern.
|
||||
- `/docs/geplante-aufgaben.md`
|
||||
- `/docs/howto-geplante-aufgaben.md`
|
||||
- Neue Scheduler-Jobs registrieren und betreiben.
|
||||
- `/docs/auth-sso-smoke-test.md`
|
||||
- SSO-Funktionalität manuell verifizieren.
|
||||
- `/docs/anfragelimits.md`
|
||||
- `/docs/howto-auth-sso-smoke-test.md`
|
||||
- SSO-Funktionalitaet manuell verifizieren.
|
||||
- `/docs/howto-anfragelimits.md`
|
||||
- Rate-Limits verstehen und testen.
|
||||
- `/docs/rbac-permissions-playbook.md`
|
||||
- RBAC-Rechte sauber erweitern (neue Permission, neue Ability, UI/API-Fälle).
|
||||
- `/docs/request-input-validation.md`
|
||||
- Einheitliches Request/Input- und Validation-Muster für Web + API.
|
||||
|
||||
## Referenz (Reference)
|
||||
|
||||
- `/docs/api.md`
|
||||
- API-Referenz-Einstieg.
|
||||
- `/docs/konfiguration.md`
|
||||
- ENV-Variablen und Produktions-Defaults.
|
||||
- `/docs/konventionen.md`
|
||||
- Projektweite Konventionen (kurz und verbindlich).
|
||||
- `/docs/lib-standards.md`
|
||||
- Regeln speziell für `lib/**`.
|
||||
- `/docs/benutzer-lifecycle-policy.md`
|
||||
- Policy- und Laufzeitreferenz für User Lifecycle.
|
||||
|
||||
## Betrieb (Operations)
|
||||
|
||||
- `/docs/docker-lokal.md`
|
||||
- `/docs/howto-rbac-permissions-playbook.md`
|
||||
- RBAC-Rechte sauber erweitern (neue Permission, neue Ability, UI/API-Faelle).
|
||||
- `/docs/howto-request-input-validation.md`
|
||||
- Einheitliches Request/Input- und Validation-Muster fuer Web + API.
|
||||
- `/docs/howto-docker-lokal.md`
|
||||
- Lokaler Docker-Betrieb.
|
||||
- `/docs/docker-produktiv.md`
|
||||
- `/docs/howto-docker-produktiv.md`
|
||||
- Produktivbetrieb mit Docker.
|
||||
- `/docs/docker-betrieb.md`
|
||||
- Übersicht und Entscheidungshilfe für Dev/Prod.
|
||||
- `/docs/betriebscheck-doctor.md`
|
||||
- `/docs/howto-betriebscheck-doctor.md`
|
||||
- Schneller Systemcheck mit `bin/doctor.php`.
|
||||
- `/docs/fehlerbehebung.md`
|
||||
- Häufige Fehler und schnelle Lösungen.
|
||||
- `/docs/howto-fehlerbehebung.md`
|
||||
- Haeufige Fehler und schnelle Loesungen.
|
||||
- `/docs/howto-lokale-entwicklung.md`
|
||||
- Tages-Workflow fuer Entwicklung und Checks.
|
||||
- `/docs/howto-dokumentation-erweitern.md`
|
||||
- Regeln fuer konsistente, wachsende Doku.
|
||||
|
||||
## Mitwirken (Contributor Guide)
|
||||
## Explanation
|
||||
|
||||
- `/docs/lokale-entwicklung.md`
|
||||
- Tages-Workflow für Entwicklung und Checks.
|
||||
- `/docs/entwickler-checkliste.md`
|
||||
- `/docs/explanation-architektur.md`
|
||||
- Architektur-Kompass mit verbindlichen Leitplanken.
|
||||
- `/docs/explanation-di-container.md`
|
||||
- Wie der AppContainer funktioniert und neue Services registriert werden.
|
||||
- `/docs/explanation-sicherheitsmodell.md`
|
||||
- Vollstaendiges Sicherheitsmodell (Auth, Permission, Scope).
|
||||
- `/docs/explanation-einstellungen-speicherung.md`
|
||||
- Warum Settings in DB + Datei-Cache koexistieren.
|
||||
- `/docs/explanation-docker-betrieb.md`
|
||||
- Uebersicht und Entscheidungshilfe fuer Dev/Prod.
|
||||
|
||||
## Reference
|
||||
|
||||
- `/docs/reference-domain-glossar.md`
|
||||
- Zentrale Begriffe (Tenant, Role, Permission, Scope, Policy).
|
||||
- `/docs/reference-api.md`
|
||||
- API-Referenz-Einstieg.
|
||||
- `/docs/reference-konfiguration.md`
|
||||
- ENV-Variablen und Produktions-Defaults.
|
||||
- `/docs/reference-konventionen.md`
|
||||
- Projektweite Konventionen (kurz und verbindlich).
|
||||
- `/docs/reference-lib-standards.md`
|
||||
- Regeln speziell fuer `lib/**`.
|
||||
- `/docs/reference-benutzer-lifecycle-policy.md`
|
||||
- Policy- und Laufzeitreferenz fuer User Lifecycle.
|
||||
- `/docs/reference-frontend-css.md`
|
||||
- CSS-Schichtsystem und Namenskonventionen.
|
||||
- `/docs/reference-frontend-javascript.md`
|
||||
- JS-Module, DOM-Utilities und Patterns.
|
||||
- `/docs/reference-entwickler-checkliste.md`
|
||||
- Definition of Done vor Merge.
|
||||
- `/docs/codex-prompts.md`
|
||||
- Standard-Prompts für Skill-basierte Planung und Implementierung.
|
||||
- `/docs/dokumentation-erweitern.md`
|
||||
- Regeln für konsistente, wachsende Doku.
|
||||
|
||||
## Agent Workflow
|
||||
|
||||
- `/docs/agents/overview.md`
|
||||
- `/docs/reference-codex-prompts.md`
|
||||
- Standard-Prompts fuer Skill-basierte Planung und Implementierung.
|
||||
- `/docs/reference-agents-overview.md`
|
||||
- Einstieg in das Rollenmodell und die Artefakte.
|
||||
- `/docs/agents/roles.md`
|
||||
- `/docs/reference-agents-roles.md`
|
||||
- Klare Verantwortung je Rolle (Planner, Executor, Reviewer, Finalizer).
|
||||
- `/docs/agents/flow.md`
|
||||
- `/docs/reference-agents-flow.md`
|
||||
- State-Flow mit Fail-Loop zur Executor-Iteration.
|
||||
- `/agent-system/README.md`
|
||||
- Technische Basis mit Contracts, Templates, Prompts und Checks.
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
# Agent Workflow
|
||||
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## State Machine
|
||||
- `planned`
|
||||
- `executing`
|
||||
@@ -1,5 +1,7 @@
|
||||
# Agent Workflow Overview
|
||||
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
This project uses a multi-role workflow for issue and feature delivery.
|
||||
|
||||
Roles:
|
||||
@@ -1,5 +1,7 @@
|
||||
# Agent Roles
|
||||
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Planner
|
||||
- Input: issue or feature request
|
||||
- Output: `plan.json` (see `agent-system/contracts/planner.schema.json`)
|
||||
@@ -1,6 +1,6 @@
|
||||
# REST-API (v1)
|
||||
|
||||
Letzte Aktualisierung: 2026-02-25
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Single Source of Truth
|
||||
|
||||
@@ -50,6 +50,6 @@ Alle fachlichen und technischen API-Details stehen nur in `/docs/openapi.yaml`.
|
||||
|
||||
## Verwandte Dokumente
|
||||
|
||||
- Rate Limiting: `/docs/anfragelimits.md`
|
||||
- Sicherheit/Permissions: `/docs/sicherheitsmodell.md`
|
||||
- Troubleshooting: `/docs/fehlerbehebung.md`
|
||||
- Rate Limiting: `/docs/howto-anfragelimits.md`
|
||||
- Sicherheit/Permissions: `/docs/explanation-sicherheitsmodell.md`
|
||||
- Troubleshooting: `/docs/howto-fehlerbehebung.md`
|
||||
@@ -1,6 +1,6 @@
|
||||
# Benutzer-Lifecycle-Policy
|
||||
|
||||
Letzte Aktualisierung: 2026-02-22
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Ziel
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Codex Prompt-Standards
|
||||
|
||||
Letzte Aktualisierung: 2026-03-04
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Ziel
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Domain-Glossar
|
||||
|
||||
Letzte Aktualisierung: 2026-02-24
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Ziel
|
||||
|
||||
@@ -28,5 +28,5 @@ Wenn ein Begriff unklar ist, zuerst hier klären und dann implementieren.
|
||||
|
||||
## Danach
|
||||
|
||||
- Architekturfluss: `/docs/03-architektur-request-flow.md`
|
||||
- Sicherheitskontext: `/docs/06-security-tenant-scope.md`
|
||||
- Architekturfluss: `/docs/tutorial-04-architektur-request-flow.md`
|
||||
- Sicherheitskontext: `/docs/tutorial-07-security-tenant-scope.md`
|
||||
@@ -1,6 +1,6 @@
|
||||
# Entwickler-Checkliste
|
||||
|
||||
Letzte Aktualisierung: 2026-03-04
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Ziel
|
||||
|
||||
@@ -49,7 +49,7 @@ Kurze Definition of Done vor Merge.
|
||||
|
||||
- [ ] Rechte serverseitig geprüft
|
||||
- [ ] Tenant-Scope serverseitig geprüft
|
||||
- [ ] Bei RBAC-Änderungen Playbook angewendet (`/docs/rbac-permissions-playbook.md`)
|
||||
- [ ] Bei RBAC-Änderungen Playbook angewendet (`/docs/howto-rbac-permissions-playbook.md`)
|
||||
- [ ] Schreibaktionen mit POST + CSRF abgesichert
|
||||
- [ ] Confirm-Dialoge über Datencontract (`data-confirm-message` / `data-detail-confirm-message`), keine inline `confirm(...)`
|
||||
- [ ] Keine sensiblen Daten in Fehlern/Logs
|
||||
@@ -58,7 +58,7 @@ Kurze Definition of Done vor Merge.
|
||||
- [ ] Für `pages/api/v1/**`: kein `ApiResponse::readJsonBody(...)`, Input nur über `requestInput()`
|
||||
- [ ] Bei MultiSelect-Filtern: CSV-Query (`foo=a,b`) + serverseitige `IN`-Filter mit Limit
|
||||
- [ ] Keine Listen-Alias-Keys (`*_id` neben `*_ids`) neu einführen
|
||||
- [ ] Input nur über `requestInput()` und Validation über `FormErrors` (`/docs/request-input-validation.md`)
|
||||
- [ ] Input nur über `requestInput()` und Validation über `FormErrors` (`/docs/howto-request-input-validation.md`)
|
||||
|
||||
## Qualitätschecks
|
||||
|
||||
@@ -88,7 +88,7 @@ Kurze Definition of Done vor Merge.
|
||||
|
||||
## Vertiefung
|
||||
|
||||
- `/docs/lib-standards.md`
|
||||
- `/docs/sicherheitsmodell.md`
|
||||
- `/docs/rbac-permissions-playbook.md`
|
||||
- `/docs/dokumentation-erweitern.md`
|
||||
- `/docs/reference-lib-standards.md`
|
||||
- `/docs/explanation-sicherheitsmodell.md`
|
||||
- `/docs/howto-rbac-permissions-playbook.md`
|
||||
- `/docs/howto-dokumentation-erweitern.md`
|
||||
@@ -1,6 +1,6 @@
|
||||
# Frontend CSS
|
||||
|
||||
Letzte Aktualisierung: 2026-02-21
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Ziel
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Frontend JavaScript
|
||||
|
||||
Letzte Aktualisierung: 2026-03-05
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Ordnerstruktur
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Konfiguration (ENV-Variablen)
|
||||
|
||||
Letzte Aktualisierung: 2026-02-21
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
Alle Konfiguration erfolgt über Umgebungsvariablen in der `.env`-Datei.
|
||||
Vorlage: `.env.example` — niemals echte Credentials committen.
|
||||
@@ -1,6 +1,6 @@
|
||||
# Konventionen (kurz und verbindlich)
|
||||
|
||||
Letzte Aktualisierung: 2026-02-26
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## 1) Code
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# lib-Standards
|
||||
|
||||
Letzte Aktualisierung: 2026-03-05
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
Praktische Regeln nur für `lib/**`. Ergänzt `docs/architektur.md`.
|
||||
|
||||
@@ -52,7 +52,7 @@ Praktische Regeln nur für `lib/**`. Ergänzt `docs/architektur.md`.
|
||||
## 3) Instanziierung
|
||||
|
||||
- Composition Root ist `web/index.php` + `lib/App/registerContainer.php`
|
||||
(→ Details: `/docs/di-container.md`).
|
||||
(→ Details: `/docs/explanation-di-container.md`).
|
||||
- Domain-Abhängigkeiten mit `new` nur im Composition Root und in `*Factory.php`.
|
||||
- In `pages/**`, `templates/**`, `lib/Support/**` und Gateway-/Service-Fallbacks nur über `app(Foo::class)` auflösen.
|
||||
- In Actions bevorzugt direkte Service/Gateway-Bindings (`app(Service::class)`) statt `app(...Factory::class)->create...()`.
|
||||
@@ -103,7 +103,7 @@ Erwartung jeweils: `0`.
|
||||
5. Template konsumiert nur `$viewAuth`.
|
||||
6. Architektur-/Service-Tests und Doku aktualisieren.
|
||||
|
||||
Details und Sonderfälle: `/docs/rbac-permissions-playbook.md`
|
||||
Details und Sonderfälle: `/docs/howto-rbac-permissions-playbook.md`
|
||||
|
||||
## 5) `data().php`-Standard
|
||||
|
||||
@@ -143,7 +143,7 @@ Details und Sonderfälle: `/docs/rbac-permissions-playbook.md`
|
||||
- Web-Templates bekommen weiterhin kompakte Listen (`$errors`) aus `FormErrors::toFlatList()`.
|
||||
- `Flash` nicht als primäre Validation-Struktur verwenden; nur für Redirect-/Outcome-Meldungen.
|
||||
|
||||
Kurz-How-to: `/docs/request-input-validation.md`
|
||||
Kurz-How-to: `/docs/howto-request-input-validation.md`
|
||||
|
||||
## 8) Definition of Done für `lib/**`
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Erste Schritte
|
||||
|
||||
Letzte Aktualisierung: 2026-02-21
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Ziel
|
||||
|
||||
@@ -19,7 +19,7 @@ cp .env.example .env
|
||||
docker compose up --build -d
|
||||
```
|
||||
|
||||
> Alle ENV-Variablen sind dokumentiert in /docs/konfiguration.md.
|
||||
> Alle ENV-Variablen sind dokumentiert in /docs/reference-konfiguration.md.
|
||||
> docker compose up startet auch den globalen Scheduler-Runner (Service scheduler) im Hintergrund.
|
||||
|
||||
Danach erreichbar:
|
||||
@@ -74,7 +74,7 @@ Bei JS-Änderungen zusätzlich Browser-Smoke mit DevTools-Console (keine JS-Erro
|
||||
|
||||
## 6) Nächste Doku-Schritte
|
||||
|
||||
- Täglicher Workflow: `/docs/lokale-entwicklung.md`
|
||||
- Erster kleiner Change: `/docs/erste-aenderung.md`
|
||||
- Architekturüberblick: `/docs/architektur.md`
|
||||
- Sicherheitsmodell: `/docs/sicherheitsmodell.md`
|
||||
- Täglicher Workflow: `/docs/howto-lokale-entwicklung.md`
|
||||
- Erster kleiner Change: `/docs/howto-erste-aenderung.md`
|
||||
- Architekturüberblick: `/docs/explanation-architektur.md`
|
||||
- Sicherheitsmodell: `/docs/explanation-sicherheitsmodell.md`
|
||||
@@ -1,6 +1,6 @@
|
||||
# Systemüberblick
|
||||
|
||||
Letzte Aktualisierung: 2026-02-24
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Ziel
|
||||
|
||||
@@ -37,6 +37,6 @@ Kernmodule:
|
||||
|
||||
## Danach
|
||||
|
||||
1. Setup und erster Login: `/docs/01-setup-und-erster-login.md`
|
||||
2. Begriffe sicher verstehen: `/docs/02-domain-glossar.md`
|
||||
3. Architekturfluss verinnerlichen: `/docs/03-architektur-request-flow.md`
|
||||
1. Setup und erster Login: `/docs/tutorial-03-setup-und-erster-login.md`
|
||||
2. Begriffe sicher verstehen: `/docs/reference-domain-glossar.md`
|
||||
3. Architekturfluss verinnerlichen: `/docs/tutorial-04-architektur-request-flow.md`
|
||||
@@ -1,6 +1,6 @@
|
||||
# Setup und erster Login
|
||||
|
||||
Letzte Aktualisierung: 2026-02-24
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Ziel
|
||||
|
||||
@@ -48,5 +48,5 @@ docker compose up --build -d
|
||||
|
||||
## Danach
|
||||
|
||||
- Begriffe: `/docs/02-domain-glossar.md`
|
||||
- Tagesworkflow: `/docs/lokale-entwicklung.md`
|
||||
- Begriffe: `/docs/reference-domain-glossar.md`
|
||||
- Tagesworkflow: `/docs/howto-lokale-entwicklung.md`
|
||||
@@ -1,6 +1,6 @@
|
||||
# Architektur und Request-Flow
|
||||
|
||||
Letzte Aktualisierung: 2026-03-03
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Ziel
|
||||
|
||||
@@ -81,6 +81,6 @@ Action
|
||||
|
||||
## Vertiefung
|
||||
|
||||
- Vollständiger Kompass: `/docs/architektur.md`
|
||||
- Regeln für `lib/**`: `/docs/lib-standards.md`
|
||||
- RBAC-Rechte erweitern: `/docs/rbac-permissions-playbook.md`
|
||||
- Vollständiger Kompass: `/docs/explanation-architektur.md`
|
||||
- Regeln für `lib/**`: `/docs/reference-lib-standards.md`
|
||||
- RBAC-Rechte erweitern: `/docs/howto-rbac-permissions-playbook.md`
|
||||
@@ -1,6 +1,6 @@
|
||||
# Erste Änderung (UI)
|
||||
|
||||
Letzte Aktualisierung: 2026-02-24
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Ziel
|
||||
|
||||
@@ -31,5 +31,5 @@ Bei JS-Änderungen zusätzlich Browser-Smoke mit DevTools-Console (keine JS-Erro
|
||||
|
||||
## Vertiefung
|
||||
|
||||
- Detailleitfaden: `/docs/erste-aenderung.md`
|
||||
- UI-Standards: `/docs/entwickler-checkliste.md`
|
||||
- Detailleitfaden: `/docs/howto-erste-aenderung.md`
|
||||
- UI-Standards: `/docs/reference-entwickler-checkliste.md`
|
||||
@@ -1,6 +1,6 @@
|
||||
# Erste Änderung (Backend)
|
||||
|
||||
Letzte Aktualisierung: 2026-02-24
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Ziel
|
||||
|
||||
@@ -30,5 +30,5 @@ docker compose exec php vendor/bin/phpstan analyse -c phpstan.neon --no-progress
|
||||
|
||||
## Vertiefung
|
||||
|
||||
- `lib/**`-Regeln: `/docs/lib-standards.md`
|
||||
- API-Prozess: `/docs/07-api-erweitern.md`
|
||||
- `lib/**`-Regeln: `/docs/reference-lib-standards.md`
|
||||
- API-Prozess: `/docs/tutorial-08-api-erweitern.md`
|
||||
@@ -1,6 +1,6 @@
|
||||
# Security und Tenant-Scope
|
||||
|
||||
Letzte Aktualisierung: 2026-02-24
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Ziel
|
||||
|
||||
@@ -27,5 +27,5 @@ Die wichtigsten Sicherheitsregeln verstehen, bevor Features erweitert werden.
|
||||
|
||||
## Vertiefung
|
||||
|
||||
- Vollständiges Modell: `/docs/sicherheitsmodell.md`
|
||||
- Rate Limits: `/docs/anfragelimits.md`
|
||||
- Vollständiges Modell: `/docs/explanation-sicherheitsmodell.md`
|
||||
- Rate Limits: `/docs/howto-anfragelimits.md`
|
||||
@@ -1,6 +1,6 @@
|
||||
# API erweitern
|
||||
|
||||
Letzte Aktualisierung: 2026-02-24
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Ziel
|
||||
|
||||
@@ -28,5 +28,5 @@ curl -H "Authorization: Bearer <TOKEN>" \
|
||||
|
||||
## Vertiefung
|
||||
|
||||
- API-Referenz: `/docs/api.md`
|
||||
- Sicherheitsdetails: `/docs/sicherheitsmodell.md`
|
||||
- API-Referenz: `/docs/reference-api.md`
|
||||
- Sicherheitsdetails: `/docs/explanation-sicherheitsmodell.md`
|
||||
@@ -1,6 +1,6 @@
|
||||
# Advanced: Scheduler und SSO
|
||||
|
||||
Letzte Aktualisierung: 2026-02-24
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Ziel
|
||||
|
||||
@@ -12,14 +12,14 @@ Fortgeschrittene, betriebskritische Themen strukturiert einordnen.
|
||||
- Neue Jobs werden über Handler + Registry integriert.
|
||||
- Parallelität wird über Locking begrenzt.
|
||||
|
||||
Vertiefung: `/docs/geplante-aufgaben.md`
|
||||
Vertiefung: `/docs/howto-geplante-aufgaben.md`
|
||||
|
||||
## User Lifecycle
|
||||
|
||||
- Automatisierte Deaktivierung/Löschung nach Policy.
|
||||
- Audit/Restore-Pfade sind separat abgesichert.
|
||||
|
||||
Vertiefung: `/docs/benutzer-lifecycle-policy.md`
|
||||
Vertiefung: `/docs/reference-benutzer-lifecycle-policy.md`
|
||||
|
||||
## Microsoft SSO
|
||||
|
||||
@@ -28,8 +28,8 @@ Vertiefung: `/docs/benutzer-lifecycle-policy.md`
|
||||
|
||||
Vertiefung:
|
||||
|
||||
- `/docs/auth-sso-smoke-test.md`
|
||||
- `/docs/sicherheitsmodell.md`
|
||||
- `/docs/howto-auth-sso-smoke-test.md`
|
||||
- `/docs/explanation-sicherheitsmodell.md`
|
||||
|
||||
## Betriebsregel
|
||||
|
||||
Reference in New Issue
Block a user