Files

Benjamin Boenisch c11270f8e0 Add CLAUDE.md, MkDocs docs, docs page in admin, .claude/rules

- CLAUDE.md: Comprehensive documentation for Compliance SDK platform
- docs-src: AI-Compliance-SDK docs (architecture, developer, auditor, SBOM)
- mkdocs.yml: Compliance-specific nav with purple theme
- docker-compose: Added docs service (port 8011, profile: docs)
- admin-compliance: New /development/docs page with iframe + quick links
- navigation.ts: Added development category with docs module
- .claude/rules: testing, docs, open-source, compliance-checklist

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

2026-02-12 00:49:28 +01:00

2.3 KiB

Raw Permalink Blame History

Dokumentations-Regeln

Automatische Dokumentations-Aktualisierung

WICHTIG: Bei JEDER Code-Änderung muss die entsprechende Dokumentation aktualisiert werden!

Wann Dokumentation aktualisieren?

API-Änderungen

Wenn du einen Endpoint änderst, hinzufügst oder entfernst:

Aktualisiere /docs/api/consent-service-api.md (Go Endpoints)
Aktualisiere /docs/api/backend-api.md (Python Endpoints)

Neue Funktionen/Klassen

Wenn du neue Funktionen, Klassen oder Module erstellst:

Aktualisiere /docs/consent-service/README.md (für Go)
Aktualisiere /docs/backend/README.md (für Python)

Architektur-Änderungen

Wenn du die Systemarchitektur änderst:

Aktualisiere /docs/architecture/system-architecture.md
Aktualisiere /docs/architecture/data-model.md (bei DB-Änderungen)

Neue Konfigurationsoptionen

Wenn du neue Umgebungsvariablen oder Konfigurationen hinzufügst:

Aktualisiere die entsprechende README
Füge zur guides/local-development.md hinzu

Dokumentations-Format

API-Endpoints dokumentieren

### METHOD /path/to/endpoint

Kurze Beschreibung.

**Request Body:**
\`\`\`json
{
  "field": "value"
}
\`\`\`

**Response (200):**
\`\`\`json
{
  "result": "value"
}
\`\`\`

**Errors:**
- `400`: Beschreibung
- `401`: Beschreibung

Funktionen dokumentieren

### FunctionName (file.go:123)

\`\`\`go
func FunctionName(param Type) ReturnType
\`\`\`

**Beschreibung:** Was macht die Funktion?

**Parameter:**
- `param`: Beschreibung

**Rückgabe:** Beschreibung

Checkliste nach Code-Änderungen

Vor dem Abschluss einer Aufgabe prüfe:

Wurden neue API-Endpoints hinzugefügt? → API-Docs aktualisieren
Wurden Datenmodelle geändert? → data-model.md aktualisieren
Wurden neue Konfigurationen hinzugefügt? → README aktualisieren
Wurden neue Abhängigkeiten hinzugefügt? → requirements.txt/go.mod UND Docs
Wurde die Architektur geändert? → architecture/ aktualisieren

Beispiel: Vollständige Dokumentation einer neuen Funktion

Wenn du z.B. GetUserStats() im Go Service hinzufügst:

Code schreiben in internal/services/stats_service.go
API-Doc aktualisieren in docs/api/consent-service-api.md
Service-Doc aktualisieren in docs/consent-service/README.md
Test schreiben (siehe testing.md)

2.3 KiB Raw Permalink Blame History