StefanMoCoAt 7e0b56a247 einige Ergänzungen

2025-07-25 23:16:16 +02:00

8.8 KiB

Raw Blame History

Bilingual Documentation Index / Zweisprachiger Dokumentations-Index

Overview / Übersicht

This document provides a comprehensive index of all bilingual documentation available in the Meldestelle project. All technical documentation is provided in both English and German versions to ensure accessibility for all team members and stakeholders.

Dieses Dokument bietet einen umfassenden Index aller zweisprachigen Dokumentation im Meldestelle-Projekt. Alle technische Dokumentation wird sowohl in englischer als auch in deutscher Version bereitgestellt, um die Zugänglichkeit für alle Teammitglieder und Stakeholder zu gewährleisten.

Summary Documents / Zusammenfassungs-Dokumente

Database Implementation / Datenbank-Implementierung

English	German	Description
DATABASE_FIXES_SUMMARY.md	DATABASE_FIXES_SUMMARY-de.md	Database initialization fixes implementation summary
DATABASE_DIAGNOSTIC_REPORT-en.md	DATABASE_DIAGNOSTIC_REPORT.md	Comprehensive database diagnostic analysis
STARTUP_ORDER_ANALYSIS.md	STARTUP_ORDER_ANALYSIS-de.md	Startup order coordination analysis

Service Implementation / Service-Implementierung

English	German	Description
IMPLEMENTATION_SUMMARY.md	IMPLEMENTATION_SUMMARY-de.md	Overall service implementation summary
HORSES_MODULE_OPTIMIZATION_SUMMARY.md	HORSES_MODULE_OPTIMIZATION_SUMMARY-de.md	Horses module analysis and optimization
MEMBERS_MODULE_OPTIMIZATION_SUMMARY.md	MEMBERS_MODULE_OPTIMIZATION_SUMMARY-de.md	Members module analysis and optimization

Client Implementation / Client-Implementierung

English	German	Description
CLIENT_OPTIMIZATION_SUMMARY-en.md	CLIENT_OPTIMIZATION_SUMMARY.md	Client implementation optimization summary

Architecture Documentation / Architektur-Dokumentation

Architecture Decision Records (ADRs)

English	German	Description
docs/architecture/adr/0004-event-driven-communication.md	docs/architecture/adr/0004-event-driven-communication-de.md	Event-driven communication pattern
docs/architecture/adr/0005-polyglot-persistence.md	docs/architecture/adr/0005-polyglot-persistence-de.md	Polyglot persistence strategy
docs/architecture/adr/0006-authentication-authorization-keycloak.md	docs/architecture/adr/0006-authentication-authorization-keycloak-de.md	Authentication and authorization with Keycloak
docs/architecture/adr/0007-api-gateway-pattern.md	docs/architecture/adr/0007-api-gateway-pattern-de.md	API Gateway pattern implementation
docs/architecture/adr/0008-multiplatform-client-applications.md	docs/architecture/adr/0008-multiplatform-client-applications-de.md	Multiplatform client applications

C4 Architecture Diagrams

English	German	Description
docs/architecture/c4/03-component-events-service.puml	docs/architecture/c4/03-component-events-service-de.puml	Events service component diagram

Development Documentation / Entwicklungs-Dokumentation

English	German	Description
docs/development/getting-started.md	docs/development/getting-started-de.md	Getting started guide for developers
docs/development/environment-variables.md	docs/development/environment-variables-de.md	Environment variables documentation

Migration Documentation / Migrations-Dokumentation

English	German	Description
docs/migration-summary.md	docs/migration-summary-de.md	Migration summary and recommendations
docs/migration-status.md	docs/migration-status-de.md	Current migration status
docs/migration-plan.md	docs/migration-plan-de.md	Detailed migration plan

Implementation Reports / Implementierungs-Berichte

English	German	Description
docs/final-report.md	docs/final-report-de.md	Final implementation report
docs/client-data-fetching-implementation-summary.md	docs/client-data-fetching-implementation-summary-de.md	Client data fetching implementation

Configuration Documentation / Konfigurations-Dokumentation

English	German	Description
config/ssl/README.md	config/ssl/README-de.md	SSL configuration guide

Documentation Standards / Dokumentations-Standards

Naming Convention / Namenskonvention

English documents: Use standard filename (e.g., document-name.md)
German documents: Add -de suffix (e.g., document-name-de.md)
Englische Dokumente: Verwenden Sie den Standard-Dateinamen (z.B. document-name.md)
Deutsche Dokumente: Fügen Sie das Suffix -de hinzu (z.B. document-name-de.md)

Content Standards / Inhalts-Standards

All technical documentation must be available in both languages
Translations should maintain technical accuracy and consistency
Code examples and technical terms should remain consistent across languages
Update dates should be synchronized between language versions
Alle technische Dokumentation muss in beiden Sprachen verfügbar sein
Übersetzungen sollten technische Genauigkeit und Konsistenz beibehalten
Code-Beispiele und technische Begriffe sollten sprachübergreifend konsistent bleiben
Aktualisierungsdaten sollten zwischen den Sprachversionen synchronisiert werden

Validation / Validierung

The project includes automated validation scripts to ensure documentation completeness:

Das Projekt enthält automatisierte Validierungsskripte zur Sicherstellung der Dokumentationsvollständigkeit:

scripts/validation/validate-docs.sh - Validates bilingual documentation coverage
scripts/validation/validate-docs.sh - Validiert die zweisprachige Dokumentationsabdeckung

Contributing / Mitwirken

When creating or updating documentation:

Beim Erstellen oder Aktualisieren von Dokumentation:

Always provide both language versions / Stellen Sie immer beide Sprachversionen bereit
Maintain consistent formatting / Behalten Sie konsistente Formatierung bei
Update this index when adding new documents / Aktualisieren Sie diesen Index beim Hinzufügen neuer Dokumente
Run validation scripts before committing / Führen Sie Validierungsskripte vor dem Commit aus

Last Updated / Letzte Aktualisierung

Date / Datum: July 25, 2025 / 25. Juli 2025
Version / Version: 1.0.0
Total Documents / Gesamtdokumente: 14 bilingual pairs / 14 zweisprachige Paare

This index is automatically maintained and should be updated whenever new bilingual documentation is added to the project.

Dieser Index wird automatisch gepflegt und sollte aktualisiert werden, wenn neue zweisprachige Dokumentation zum Projekt hinzugefügt wird.

8.8 KiB Raw Blame History