MODUL-DOKUMENTATIONS-VORLAGE
=================
Diese Vorlage dient zur einheitlichen technischen Dokumentation aller Module im ToolBoxx CRM. Sie ist für MediaWiki optimiert und kann als TXT vorbereitet und anschließend ins Wiki übernommen werden.
MODUL: <Modulname>
Kurzbeschreibung des Moduls (1–3 Sätze). Welches Problem löst das Modul, wofür wird es eingesetzt?
======================================
1. ZIEL & ZWECK
======================================
Beschreibt den fachlichen Zweck des Moduls.
- Welche Aufgaben erfüllt das Modul? - Für welche Benutzerrollen ist es relevant? - In welchen Geschäftsprozessen wird es eingesetzt?
======================================
2. BENUTZERHANDBUCH (KURZÜBERSICHT)
======================================
(Optional, falls Modul auch für Endanwender relevant ist)
- Wo findet der Benutzer das Modul im System? - Welche Hauptfunktionen sind sichtbar? - Welche Aktionen sind typisch?
Beispiel: - Dokumente hochladen - Dokumente filtern - Dokumente verknüpfen
======================================
3. ROUTEN & CONTROLLER
======================================
Tabelle aller relevanten Routen des Moduls.
Route | HTTP | Controller | Methode | Beschreibung
| ---- | ---------- | ------- | ------------
<route.name> | GET | <Controller> | <method> | Beschreibung
======================================
4. UI / FRONTEND
======================================
Beschreibung der UI-Komponenten (Inertia, React, Vue, etc.)
4.1 Views / Pages
- Seitenname / Route - Zweck der Seite - Besonderheiten
4.2 Tabellen (InertiaUI)
Falls das Modul Tabellen nutzt:
- Tabellenklasse: App\Tables\<Name> - Suchfelder:
- feld_1 - feld_2
- Standardsortierung:
- feld (ASC/DESC)
4.2.1 Spalten (Columns)
Name | Typ | Sortierbar | Umschaltbar | Beschreibung
| --- | ---------- | ----------- | ------------
<name> | TextColumn | Ja | Nein | Beschreibung
4.2.2 Filter
Name | Typ | Standard | Beschreibung
| --- | -------- | ------------
<name> | DateFilter | Ja | Beschreibung
4.2.3 Aktionen
Name | Typ | Beschreibung
| --- | ------------
<Vorschau> | Drawer | Öffnet Vorschau
4.2.4 Exporte
- CSV - Excel - PDF - Nicht vorhanden
======================================
5. DATENQUELLE & MODELLE
======================================
5.1 Primäres Model
Model: - App\Models\<Modul>\<Model>
Relevante Felder: - feld_1 - feld_2 - feld_3
5.2 Relationen
Relation | Typ | Beschreibung
| --- | ------------
contact | belongsTo | Verknüpfung zum Kontakt
======================================
6. DATENTRANSFORMATION
======================================
Beschreibung aller Transformationslogiken (z. B. transformModel).
- Welche Felder werden verändert? - Warum? - In welchem Format werden sie ausgegeben?
======================================
7. BUSINESS-LOGIK
======================================
7.1 Observer
Observer: - <Model>Observer
Reagiert auf: - created - updated - deleted
Beschreibung der Logik: - Was passiert bei welchem Event? - Welche Nebenwirkungen gibt es?
7.2 Jobs / Queue
Job | Zweck | Trigger --- | ----- | ------- <JobName> | Beschreibung | Event / Cron
7.3 Services
Service | Zweck
| -----
<SystemService> | Beschreibung
======================================
8. EVENTS & NEBENWIRKUNGEN
======================================
- Erzeugt Kontakt-Historien? - Erzeugt Benachrichtigungen? - Greift auf andere Module zu? - Löscht oder verändert Fremddaten?
======================================
9. BERECHTIGUNGEN & SICHERHEIT
======================================
- Rollen - Policies - Zugriffsbeschränkungen - Mandantenfähigkeit
======================================
10. FEHLER & EDGE CASES
======================================
- Typische Fehler - Validierungsprobleme - Sonderfälle - Bekannte Einschränkungen
======================================
11. GLOSSAR-ERWEITERUNG
======================================
Neue oder modulspezifische Begriffe, die ins Glossar aufgenommen werden sollten.
Glossar-Kandidaten
Begriff | Kurzbeschreibung | Kategorie
| ---------------- | ---------
<Begriff> | Beschreibung | Modul / Technik
Hinweis: Jeder Begriff sollte zusätzlich als eigene Glossar-Seite angelegt werden.
======================================
12. CHANGELOG / ENTWICKLERHINWEISE
======================================
Version | Datum | Änderung
| ----- | --------
v1.0 | YYYY-MM-DD | Initiale Dokumentation
======================================
ENDE DER MODUL-DOKUMENTATION