19855efacc
Some checks failed
Tests / Go Tests (push) Has been cancelled
Tests / Python Tests (push) Has been cancelled
Tests / Integration Tests (push) Has been cancelled
Tests / Go Lint (push) Has been cancelled
Tests / Python Lint (push) Has been cancelled
Tests / Security Scan (push) Has been cancelled
Tests / All Checks Passed (push) Has been cancelled
Security Scanning / Secret Scanning (push) Has been cancelled
Security Scanning / Dependency Vulnerability Scan (push) Has been cancelled
Security Scanning / Go Security Scan (push) Has been cancelled
Security Scanning / Python Security Scan (push) Has been cancelled
Security Scanning / Node.js Security Scan (push) Has been cancelled
Security Scanning / Docker Image Security (push) Has been cancelled
Security Scanning / Security Summary (push) Has been cancelled
CI/CD Pipeline / Go Tests (push) Has been cancelled
CI/CD Pipeline / Python Tests (push) Has been cancelled
CI/CD Pipeline / Website Tests (push) Has been cancelled
CI/CD Pipeline / Linting (push) Has been cancelled
CI/CD Pipeline / Security Scan (push) Has been cancelled
CI/CD Pipeline / Docker Build & Push (push) Has been cancelled
CI/CD Pipeline / Integration Tests (push) Has been cancelled
CI/CD Pipeline / Deploy to Staging (push) Has been cancelled
CI/CD Pipeline / Deploy to Production (push) Has been cancelled
CI/CD Pipeline / CI Summary (push) Has been cancelled
ci/woodpecker/manual/build-ci-image Pipeline was successful
ci/woodpecker/manual/main Pipeline failed
All services: admin-v2, studio-v2, website, ai-compliance-sdk, consent-service, klausur-service, voice-service, and infrastructure. Large PDFs and compiled binaries excluded via .gitignore.
2.3 KiB
2.3 KiB
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.mdhinzu
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)