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:
35
docs-src/services/sdk-modules/academy.md
Normal file
35
docs-src/services/sdk-modules/academy.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# Academy — Schulungsmodul
|
||||
|
||||
Das Academy-Modul ermoeglicht die Verwaltung von Datenschutz-Schulungen und -Zertifizierungen.
|
||||
|
||||
## Features
|
||||
|
||||
- **Kursverwaltung** — DSGVO-, KI- und branchenspezifische Schulungskurse erstellen und verwalten
|
||||
- **Modulare Struktur** — Kurse bestehen aus Modulen mit Lektionen und Quizzes
|
||||
- **Teilnehmer-Tracking** — Fortschritt, Abschlussquoten und Zertifikatsverwaltung
|
||||
- **Compliance-Nachweis** — Automatische Generierung von Schulungsnachweisen fuer Audits
|
||||
|
||||
## API Endpoints
|
||||
|
||||
Alle unter `/api/v1/academy/`, benoetigen `X-Tenant-ID` Header.
|
||||
|
||||
| Method | Endpoint | Beschreibung |
|
||||
|--------|----------|-------------|
|
||||
| GET | `/courses` | Kurse auflisten |
|
||||
| POST | `/courses` | Neuen Kurs erstellen |
|
||||
| GET | `/courses/{id}` | Kursdetails |
|
||||
| PUT | `/courses/{id}` | Kurs aktualisieren |
|
||||
| DELETE | `/courses/{id}` | Kurs loeschen |
|
||||
| GET | `/courses/{id}/modules` | Module eines Kurses |
|
||||
| POST | `/courses/{id}/enroll` | Teilnehmer einschreiben |
|
||||
| GET | `/enrollments` | Einschreibungen auflisten |
|
||||
| POST | `/enrollments/{id}/complete` | Modul als abgeschlossen markieren |
|
||||
| GET | `/certificates` | Zertifikate auflisten |
|
||||
|
||||
## Frontend
|
||||
|
||||
Seite unter `/sdk/academy` mit Kursuebersicht, Modulverwaltung und Teilnehmer-Tracking.
|
||||
|
||||
## Datenbank
|
||||
|
||||
Migration `008_academy_schema.sql` erstellt Tabellen fuer Kurse, Module, Einschreibungen und Zertifikate.
|
||||
37
docs-src/services/sdk-modules/incidents.md
Normal file
37
docs-src/services/sdk-modules/incidents.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# Incidents — Datenschutzvorfaelle
|
||||
|
||||
Verwaltung und Dokumentation von Datenschutzvorfaellen gemaess Art. 33/34 DSGVO.
|
||||
|
||||
## Features
|
||||
|
||||
- **Vorfallerfassung** — Strukturierte Eingabe mit Schweregrad-Bewertung
|
||||
- **72-Stunden-Frist** — Automatisches Tracking der Meldefrist an die Aufsichtsbehoerde
|
||||
- **Risikobewertung** — Automatische Einschaetzung ob Meldepflicht besteht
|
||||
- **Behoerdenmeldung** — Vorausgefuellte Meldeformulare fuer Aufsichtsbehoerden
|
||||
- **Betroffenen-Benachrichtigung** — Vorlagen fuer die Benachrichtigung Betroffener (Art. 34 DSGVO)
|
||||
- **Massnahmen-Tracking** — Dokumentation von Gegenmassnahmen und Lessons Learned
|
||||
|
||||
## API Endpoints
|
||||
|
||||
Alle unter `/api/v1/incidents/`, benoetigen `X-Tenant-ID` Header.
|
||||
|
||||
| Method | Endpoint | Beschreibung |
|
||||
|--------|----------|-------------|
|
||||
| GET | `/incidents` | Vorfaelle auflisten |
|
||||
| POST | `/incidents` | Neuen Vorfall melden |
|
||||
| GET | `/incidents/{id}` | Vorfalldetails |
|
||||
| PUT | `/incidents/{id}` | Vorfall aktualisieren |
|
||||
| PUT | `/incidents/{id}/severity` | Schweregrad aendern |
|
||||
| POST | `/incidents/{id}/notify-authority` | Behoerdenmeldung ausloesen |
|
||||
| POST | `/incidents/{id}/notify-affected` | Betroffene benachrichtigen |
|
||||
| GET | `/incidents/{id}/timeline` | Ereignis-Timeline |
|
||||
| POST | `/incidents/{id}/measures` | Massnahme hinzufuegen |
|
||||
| GET | `/statistics` | Vorfall-Statistiken |
|
||||
|
||||
## Frontend
|
||||
|
||||
Seite unter `/sdk/incidents` mit Vorfallsuebersicht, Detailansicht mit Timeline, Fristen-Ampel und Statistiken.
|
||||
|
||||
## Datenbank
|
||||
|
||||
Migration `010_incidents_schema.sql` erstellt Tabellen fuer Vorfaelle, Massnahmen, Meldungen und Benachrichtigungen.
|
||||
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