Traduction de documentation

Traduction de la documentation

Ce projet utilise le modèle Haiku 3.5 d’AWS Bedrock pour traduire automatiquement la documentation de l’anglais vers plusieurs langues. Le système de traduction est conçu pour être efficace, précis et facile à utiliser.

Langues prises en charge

Actuellement, les langues suivantes sont prises en charge :

Japonais (jp)
Français (fr)
Espagnol (es)
Allemand (de)
Chinois (zh)
Coréen (ko)

Fonctionnement

Le système de traduction fonctionne en :

Découpage des documents par en-têtes h2 - Permet un traitement plus efficace et un meilleur contexte pour le modèle de traduction
Préservation du formatage Markdown - Tous les éléments de syntaxe Markdown, blocs de code et balises HTML sont conservés pendant la traduction
Gestion spéciale du frontmatter - Le frontmatter YAML est traduit tout en conservant sa structure
Traduction incrémentielle - Seuls les fichiers modifiés sont traduits par défaut, permettant d’économiser temps et ressources

Exécution des traductions localement

Pour traduire la documentation localement, utilisez le script scripts/translate.ts :

# Traduire uniquement les fichiers modifiés en japonais (par défaut)
./scripts/translate.ts

# Traduire tous les fichiers
./scripts/translate.ts --all

# Traduire vers des langues spécifiques
./scripts/translate.ts --languages jp,fr,es

# Simuler la traduction sans l'exécuter
./scripts/translate.ts --dry-run

# Afficher les détails d'exécution
./scripts/translate.ts --verbose

Workflow GitHub

Un workflow GitHub traduit automatiquement la documentation lorsque des modifications sont apportées aux fichiers de documentation anglaise dans les pull requests. Ce workflow :

Détecte les modifications apportées aux fichiers de documentation anglaise
Traduit les fichiers modifiés avec AWS Bedrock
Commit les traductions dans la branche source
Met à jour le statut de traduction dans la PR

Déclenchement manuel du workflow

Vous pouvez également déclencher manuellement le workflow de traduction depuis l’onglet GitHub Actions. Utile pour :

Exécuter une traduction complète de toute la documentation
Traduire vers des langues spécifiques
Mettre à jour les traductions après des modifications du script de traduction

Configuration AWS

Le système de traduction utilise le modèle Haiku 3.5 d’AWS Bedrock. Pour utiliser cette fonctionnalité, vous avez besoin de :

Identifiants AWS - Pour le développement local, configurez vos identifiants AWS avec l’AWS CLI ou des variables d’environnement
Rôle IAM - Pour GitHub Actions, configurez un rôle IAM avec authentification OIDC et les permissions nécessaires pour AWS Bedrock

Permissions requises

Le rôle/utilisateur IAM doit avoir les permissions suivantes :

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "bedrock:InvokeModel"
      ],
      "Resource": [
        "arn:aws:bedrock:*::foundation-model/anthropic.claude-3-haiku-20240307-v1:0"
      ]
    }
  ]
}

Qualité des traductions

La qualité de traduction est généralement élevée, mais gardez à l’esprit que :

Termes techniques - Le système est configuré pour conserver les termes techniques en anglais
Blocs de code - Les blocs de code ne sont pas traduits car ils doivent rester dans leur forme originale
Conscience du contexte - Le modèle de traduction comprend le contexte de la documentation, ce qui améliore les traductions techniques

Personnalisation des traductions

Vous pouvez personnaliser le processus de traduction en modifiant le fichier scripts/translate.ts. Quelques personnalisations possibles :

Ajout de langues supplémentaires
Modification du modèle de traduction
Ajustement des prompts utilisés pour la traduction
Modification du traitement et du découpage des documents

Dépannage

Si vous rencontrez des problèmes avec le processus de traduction :

Vérifiez les identifiants AWS - Assurez-vous qu’ils sont correctement configurés
Vérifiez la région AWS - Utilisez une région où AWS Bedrock est disponible
Exécutez avec verbose - Utilisez le flag --verbose pour voir les logs détaillés
Vérifiez les limitations de débit - AWS Bedrock impose des limites qui peuvent affecter les gros travaux de traduction