From 63a1e79147c5484661ed4cbddf5dda2e4bd49a99 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mathias=20Gla=CC=88ser?= Date: Mon, 15 Jun 2026 10:06:42 +0200 Subject: [PATCH] Add module ownership docs --- docs/modules/README.md | 15 +++++++ docs/modules/buchhaltung/README.md | 34 ++++++++++++++++ docs/modules/erp/README.md | 36 +++++++++++++++++ docs/modules/erp/artikel-mapping/README.md | 31 +++++++++++++++ docs/modules/erp/bestellungen/README.md | 37 ++++++++++++++++++ docs/modules/erp/direktverkauf/README.md | 35 +++++++++++++++++ docs/modules/erp/import-integration/README.md | 35 +++++++++++++++++ docs/modules/erp/kontakte/README.md | 37 ++++++++++++++++++ docs/modules/erp/lager/README.md | 39 +++++++++++++++++++ docs/modules/kundenberatung/README.md | 33 ++++++++++++++++ docs/modules/shared/README.md | 29 ++++++++++++++ docs/modules/system/README.md | 25 ++++++++++++ 12 files changed, 386 insertions(+) create mode 100644 docs/modules/README.md create mode 100644 docs/modules/buchhaltung/README.md create mode 100644 docs/modules/erp/README.md create mode 100644 docs/modules/erp/artikel-mapping/README.md create mode 100644 docs/modules/erp/bestellungen/README.md create mode 100644 docs/modules/erp/direktverkauf/README.md create mode 100644 docs/modules/erp/import-integration/README.md create mode 100644 docs/modules/erp/kontakte/README.md create mode 100644 docs/modules/erp/lager/README.md create mode 100644 docs/modules/kundenberatung/README.md create mode 100644 docs/modules/shared/README.md create mode 100644 docs/modules/system/README.md diff --git a/docs/modules/README.md b/docs/modules/README.md new file mode 100644 index 0000000..89288eb --- /dev/null +++ b/docs/modules/README.md @@ -0,0 +1,15 @@ +# Module Ownership Docs +Stand: 2026-06-15 + +Diese Ordnerstruktur dokumentiert die fachliche und technische Ownership der Module. + +Regeln: +- Ein Ordner pro Hauptmodul oder technischem Bereich. +- Jedes Modul bekommt eine kurze README mit Zweck, Ownership, Reads, Writes und Grenzen. +- Submodule werden im README des owning Moduls kurz benannt, wenn sie nicht eigenes Ownership tragen. +- Code, Doku und Datenmodell sollen dieser Struktur folgen. + +Referenz: +- [Technische Architektur](../architektur/technical_architecture.md) +- [Modulkarte](../architektur/modulkarte.md) + diff --git a/docs/modules/buchhaltung/README.md b/docs/modules/buchhaltung/README.md new file mode 100644 index 0000000..3e687c8 --- /dev/null +++ b/docs/modules/buchhaltung/README.md @@ -0,0 +1,34 @@ +# Buchhaltung +Stand: 2026-06-15 + +## Zweck + +Finanzbuchhaltung mit Kontierung, Verbuchung, Offene-Posten und Abschluss. + +## Owns + +- Buchungssaetze +- Konten +- OP-Positionen +- Steuerdaten + +## Writes + +- Verbuchung +- OP-Pflege +- Zahlungslauf +- Mahnwesen +- Abschlusslaeufe + +## Reads + +- Freigegebene ERP-Belege +- Zahlungsdaten +- Kontenplan + +## Grenzen + +- Keine operative Lagerlogik. +- Keine Beratungslogik. +- Keine UI-Sonderlogik fuer ERP-Prozesse. + diff --git a/docs/modules/erp/README.md b/docs/modules/erp/README.md new file mode 100644 index 0000000..29f2eec --- /dev/null +++ b/docs/modules/erp/README.md @@ -0,0 +1,36 @@ +# ERP +Stand: 2026-06-15 + +## Zweck + +ERP ist der operative Container fuer die Kerndomane des Tagesgeschaefts. + +## Enthaltene Module + +- Kontakte +- Bestellungen +- Lager +- Artikel-Mapping +- Import-Integration +- Direktverkauf + +## Ownership + +- Owns keine fachlichen Daten als Container. +- Owns nur die Strukturierung der operativen ERP-Module. +- Fachliche Verantwortung liegt immer in den Untermodulen. + +## Grenzen + +- Keine Buchhaltung. +- Keine Kundenberatung. +- Keine technischen `shared`-Hilfen. +- Keine Runtime-Logik. + +## Relevante Entry-Points + +- `public/order-import.php` +- `order-import.php` +- `public/api/otc-order.php` +- `public/otc/index.php` + diff --git a/docs/modules/erp/artikel-mapping/README.md b/docs/modules/erp/artikel-mapping/README.md new file mode 100644 index 0000000..1a1cb28 --- /dev/null +++ b/docs/modules/erp/artikel-mapping/README.md @@ -0,0 +1,31 @@ +# Artikel-Mapping +Stand: 2026-06-15 + +## Zweck + +Aufloesung externer Shopdaten auf interne verkaufbare Artikel und Produkte. + +## Owns + +- `sellable_item` +- `external_item_alias` +- `sellable_item_component` + +## Writes + +- Aliaspflege +- Zuordnung externer Artikel +- Komponentenpflege + +## Reads + +- Bestellungen +- Import-Integration +- Lager + +## Grenzen + +- Keine Bestellverarbeitung. +- Keine Lagerbewegungen. +- Keine Buchhaltung. + diff --git a/docs/modules/erp/bestellungen/README.md b/docs/modules/erp/bestellungen/README.md new file mode 100644 index 0000000..6cc57c9 --- /dev/null +++ b/docs/modules/erp/bestellungen/README.md @@ -0,0 +1,37 @@ +# Bestellungen +Stand: 2026-06-15 + +## Zweck + +Operative Verarbeitung von Bestellungen, Positionen und Status. + +## Owns + +- `sales_order` +- `sales_order_line` +- Bestellstatus + +## Writes + +- Bestellung anlegen und aktualisieren +- Positionen pflegen +- Status fortschreiben + +## Reads + +- Kontakte +- Artikel-Mapping +- Lager + +## Submodule + +- Bestellkopf +- Positionen +- Status + +## Grenzen + +- Keine Buchhaltung. +- Keine Lagerbestandswahrheit. +- Kein Direktverkaufs-UI. + diff --git a/docs/modules/erp/direktverkauf/README.md b/docs/modules/erp/direktverkauf/README.md new file mode 100644 index 0000000..71bffbe --- /dev/null +++ b/docs/modules/erp/direktverkauf/README.md @@ -0,0 +1,35 @@ +# Direktverkauf +Stand: 2026-06-15 + +## Zweck + +Manuelle Erfassung von Direktverkaeufen und deren operative Ausloesung. + +## Owns + +- Direktverkaufsbelege +- Erfassungsdaten +- OTC-UI und OTC-API + +## Writes + +- Direktverkauf erfassen +- Folgeschritte im ERP ausloesen + +## Reads + +- Kontakte optional +- Lager +- Bestellungen + +## Relevante Entry-Points + +- `public/otc/index.php` +- `public/api/otc-order.php` + +## Grenzen + +- Keine Buchhaltung. +- Keine allgemeine Bestellverwaltung. +- Keine technische Runtime-Logik. + diff --git a/docs/modules/erp/import-integration/README.md b/docs/modules/erp/import-integration/README.md new file mode 100644 index 0000000..89ddf61 --- /dev/null +++ b/docs/modules/erp/import-integration/README.md @@ -0,0 +1,35 @@ +# Import-Integration +Stand: 2026-06-15 + +## Zweck + +Technische Annahme externer Eingangsdaten und Weiterleitung an die owning Module. + +## Owns + +- Import- und Webhook-Einstiege +- technische Importzustandsdaten +- technische Events oder Ausfuehrungsmarker + +## Writes + +- Importausloesung +- technische Verarbeitungsereignisse +- kontrollierte Weitergabe an Fachmodule + +## Reads + +- Externe Payloads +- Konfiguration +- Zielmodul-Schnittstellen + +## Relevante Entry-Points + +- `public/order-import.php` +- `order-import.php` + +## Grenzen + +- Keine Fachlogik fuer Bestellungen, Lager oder Buchhaltung. +- Keine Dateninterpretation, die einem Fachmodul gehoert. + diff --git a/docs/modules/erp/kontakte/README.md b/docs/modules/erp/kontakte/README.md new file mode 100644 index 0000000..de82ad7 --- /dev/null +++ b/docs/modules/erp/kontakte/README.md @@ -0,0 +1,37 @@ +# Kontakte +Stand: 2026-06-15 + +## Zweck + +Zentraler Kontaktstamm fuer Kunden, Lieferanten und sonstige Parteien. + +## Owns + +- `party` +- `address` +- `contact` + +## Writes + +- Kontaktstamm +- Adressen +- Kommunikationsdaten + +## Reads + +- Bestellungen +- Buchhaltung +- Kundenberatung + +## Grenzen + +- Keine Bestelllogik. +- Keine Lagerlogik. +- Keine Buchungslogik. + +## Relevante Schnittstellen + +- Kontaktanlage +- Kontaktabfrage +- Lookup fuer andere Module + diff --git a/docs/modules/erp/lager/README.md b/docs/modules/erp/lager/README.md new file mode 100644 index 0000000..446e113 --- /dev/null +++ b/docs/modules/erp/lager/README.md @@ -0,0 +1,39 @@ +# Lager +Stand: 2026-06-15 + +## Zweck + +Bestand, Charge, MHD und Bewegungen. + +## Owns + +- `product` +- `stock_lot` +- `stock_move` +- `v_stock_lot_balance` + +## Writes + +- Warenzugang +- Warenabgang +- Umlagerung +- Chargenpflege + +## Reads + +- Bestellungen +- Import-Integration +- Direktverkauf + +## Submodule + +- Chargen +- Bewegungen +- Bestandsfuehrung + +## Grenzen + +- Keine Buchhaltung. +- Keine Beratungslogik. +- Keine fachfremden Artikelzuordnungen. + diff --git a/docs/modules/kundenberatung/README.md b/docs/modules/kundenberatung/README.md new file mode 100644 index 0000000..70905a1 --- /dev/null +++ b/docs/modules/kundenberatung/README.md @@ -0,0 +1,33 @@ +# Kundenberatung +Stand: 2026-06-15 + +## Zweck + +Fall- und gespraechsbezogene Kundenberatung mit Rueckmeldung und Follow-up. + +## Owns + +- Beratungsgespraeche +- Empfehlungen +- Rueckmeldungen +- Follow-ups + +## Writes + +- Gespraech erfassen +- Bedarf dokumentieren +- Empfehlungen pflegen +- Rueckmeldungen nachhalten + +## Reads + +- Kontakte +- Produkte +- Bestellungen + +## Grenzen + +- Keine Buchhaltung. +- Keine Lagerbestandswahrheit. +- Keine technische Importlogik. + diff --git a/docs/modules/shared/README.md b/docs/modules/shared/README.md new file mode 100644 index 0000000..8534ea0 --- /dev/null +++ b/docs/modules/shared/README.md @@ -0,0 +1,29 @@ +# Shared +Stand: 2026-06-15 + +## Zweck + +Fachlich neutrale, wiederverwendbare technische Bausteine. + +## Enthalten + +- UI-Komponenten +- Layout-Bausteine +- Tabellen, Formulare, Statusdarstellung +- Validierung ohne Fachentscheidung +- Datums-, Geld- und Formatierungshelfer +- technische API-Clients +- Logging- und Session-nahe Hilfen + +## Ownership + +- Keine fachliche Primärverantwortung. +- Keine Business-Logik. + +## Grenzen + +- Keine Lagerlogik. +- Keine Buchhaltungslogik. +- Keine Beratungslogik. +- Keine Bestellfachlogik. + diff --git a/docs/modules/system/README.md b/docs/modules/system/README.md new file mode 100644 index 0000000..ee4b1cc --- /dev/null +++ b/docs/modules/system/README.md @@ -0,0 +1,25 @@ +# System +Stand: 2026-06-15 + +## Zweck + +Technische Laufzeit-, Start-, Trigger- und Supervisor-Logik. + +## Enthalten + +- Webhook-/Trigger-Logik +- Start- und Deploy-Hooks +- technische Jobsteuerung +- Laufzeit- und Betriebslogik + +## Ownership + +- Keine fachliche Primärverantwortung. +- Nur technische Infrastruktur- und Runtime-Funktionen. + +## Grenzen + +- Keine operativen Fachprozesse. +- Keine Modul-Domain-Logik. +- Keine Geschäftsregeln. +