docs: restructure docs to diataxis and finalize DOCS-RESTRUCTURE-001
This commit is contained in:
42
docs/tutorial-02-systemueberblick.md
Normal file
42
docs/tutorial-02-systemueberblick.md
Normal file
@@ -0,0 +1,42 @@
|
||||
# Systemüberblick
|
||||
|
||||
Letzte Aktualisierung: 2026-03-06
|
||||
|
||||
## Ziel
|
||||
|
||||
In 10 Minuten verstehen, was die Software tut, wie sie aufgebaut ist und welche Kernprinzipien immer gelten.
|
||||
|
||||
## Was ist IMVS?
|
||||
|
||||
IMVS ist eine mandantenfähige Admin-Software für Immobilienmakler-Prozesse mit klarer Rollen-/Rechtestruktur.
|
||||
|
||||
Kernmodule:
|
||||
|
||||
- Mandanten, Abteilungen, Benutzer, Rollen, Berechtigungen
|
||||
- Adressbuch und globale Suche
|
||||
- API (`/api/v1`)
|
||||
- Scheduler (geplante Aufgaben)
|
||||
- Optional Microsoft-SSO
|
||||
|
||||
## Kernprinzipien
|
||||
|
||||
- Multi-Tenant by default: Daten und Sichtbarkeit sind tenant-gebunden.
|
||||
- Security first: Auth, Permission und Tenant-Scope sind Pflicht, nicht optional.
|
||||
- Schichtentrennung: `pages` -> `Service` -> `Repository`.
|
||||
- API-Verträge sind UUID-first.
|
||||
|
||||
## Projektkarte
|
||||
|
||||
- `config/` Konfiguration
|
||||
- `db/` Schema/Updates
|
||||
- `lib/` Fachlogik
|
||||
- `pages/` Actions + Views
|
||||
- `templates/` Partials/Layout
|
||||
- `web/` CSS/JS/Assets
|
||||
- `docs/` Entwicklerdokumentation
|
||||
|
||||
## Danach
|
||||
|
||||
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`
|
||||
Reference in New Issue
Block a user