docs: Add MkDocs documentation for Document Crawler and SDK modules
Adds documentation pages for: - Document Crawler (architecture, API endpoints, gap analysis) - Academy/Schulungsmodul - Whistleblower/Hinweisgebersystem (HinSchG) - Incidents/Datenschutzvorfaelle (Art. 33/34 DSGVO) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
33
docs-src/services/sdk-modules/whistleblower.md
Normal file
33
docs-src/services/sdk-modules/whistleblower.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# Whistleblower — Hinweisgebersystem
|
||||
|
||||
HinSchG-konformes Hinweisgebersystem fuer anonyme Meldungen und sichere Fallbearbeitung.
|
||||
|
||||
## Features
|
||||
|
||||
- **Anonyme Meldungen** — Sichere, anonyme Eingabe von Hinweisen
|
||||
- **Fallbearbeitung** — Workflow fuer Sichtung, Untersuchung und Abschluss
|
||||
- **Fristen-Management** — Automatische Ueberwachung der gesetzlichen Bearbeitungsfristen (7 Tage Eingangsbestaetigung, 3 Monate Rueckmeldung)
|
||||
- **Kommunikationskanal** — Anonymer Austausch zwischen Hinweisgeber und Ombudsperson
|
||||
- **Audit-Trail** — Lueckenlose Dokumentation aller Bearbeitungsschritte
|
||||
|
||||
## API Endpoints
|
||||
|
||||
Alle unter `/api/v1/whistleblower/`, benoetigen `X-Tenant-ID` Header.
|
||||
|
||||
| Method | Endpoint | Beschreibung |
|
||||
|--------|----------|-------------|
|
||||
| GET | `/reports` | Meldungen auflisten |
|
||||
| POST | `/reports` | Neue Meldung erstellen |
|
||||
| GET | `/reports/{id}` | Meldungsdetails |
|
||||
| PUT | `/reports/{id}/status` | Status aktualisieren |
|
||||
| POST | `/reports/{id}/messages` | Nachricht hinzufuegen |
|
||||
| GET | `/reports/{id}/messages` | Nachrichten abrufen |
|
||||
| GET | `/statistics` | Statistiken |
|
||||
|
||||
## Frontend
|
||||
|
||||
Seite unter `/sdk/whistleblower` mit Meldungsuebersicht, Falldetails und Statistik-Dashboard.
|
||||
|
||||
## Datenbank
|
||||
|
||||
Migration `009_whistleblower_schema.sql` erstellt Tabellen fuer Meldungen, Nachrichten und Bearbeitungsschritte.
|
||||
Reference in New Issue
Block a user