Cette version de GitHub Enterprise Server n'est plus disponible depuis le 2024-03-26. Aucune publication de correctifs n’est effectuée, même pour les problèmes de sécurité critiques. Pour de meilleures performances, une sécurité améliorée et de nouvelles fonctionnalités, effectuez une mise à niveau vers la dernière version de GitHub Enterprise. Pour obtenir de l’aide sur la mise à niveau, contactez le support GitHub Enterprise.

Rédaction de contenu à traduire

Notre documentation est traduite en plusieurs langues. La façon dont nous abordons la rédaction de la documentation en anglais peut considérablement améliorer la qualité de ces traductions.

Dans cet article

À propos de la rédaction de contenu facile à traduire

Suivez les instructions ci-dessous pour vérifier que le contenu que vous créez sera traduit correctement. Pour plus d’informations, consultez « Guide de style ».

  • Utilisez des exemples génériques, compréhensibles par la plupart des gens.
  • Évitez les exemples qui prêtent à controverse ou qui sont spécifiques à la culture d’un groupe.
  • Écrivez à la voix active.
  • Écrivez des phrases simples, courtes et faciles à comprendre.
  • Évitez d’utiliser trop de pronoms, car cela peut nuire à la clarté du texte.
  • Évitez l’argot et les blagues.
  • Évitez les phrases négatives.
  • Utilisez des acronymes standard chaque fois que cela est possible, et expliquez les acronymes personnalisés.
  • Utilisez le mode indicatif.
  • Éliminez les expressions redondantes et verbeuses.
  • Évitez l’utilisation excessive de modificateurs les uns à la suite des autres (chaînes de noms). Le traducteur risque de ne pas comprendre quel est le nom modifié.
  • Évitez les pluriels invisibles dans lesquels il est difficile de savoir si le premier nom est censé être au singulier ou au pluriel.
  • Évitez la nominalisation.
  • Évitez d’utiliser des verbes auxiliaires modaux ambigus.
  • Évitez les mots spécifiques à un genre.
  • Évitez les expressions prépositionnelles.
  • Évitez les noms et les pronoms vagues (sujet de phrase vague).
  • Limitez au minimum les liens inline. S’ils sont nécessaires, faites-les précéder d’une expression telle que « Pour plus d’informations, consultez [Titre du lien] ». Vous pouvez également ajouter les liens pertinents dans une section « Pour aller plus loin » à la fin de la rubrique.

Exemples

Cette section fournit des exemples sur la façon de suivre nos recommandations pour rédiger une documentation facile à traduire.

Éviter les informations spécifiques à un pays

Par exemple, évitez les numéros en 800 et les adresses spécifiques à un pays. Si nécessaire, mentionnez les pays auxquels les informations s’appliquent.

Éviter l’utilisation excessive de modificateurs les uns à la suite des autres (chaînes de noms)

De nombreux modificateurs successifs peuvent entraîner des traductions incorrectes, car il n’est pas facile de déterminer qui modifie quoi. Par exemple, « Default source settings for the public repository » (Paramètres sources par défaut pour le dépôt public) est plus clair que « Public repository default source settings » (Paramètres sources par défaut du dépôt public).

Éviter les pluriels invisibles

Par exemple, dans l’expression « file retrieval » (récupération de fichiers), il est difficile de savoir si vous faites allusion à un seul fichier ou tous les fichiers. Fournissez davantage de contexte pour éliminer toute ambiguïté. Dans l’exemple donné, vous pouvez utiliser « retrieving all the files » (récupération de tous les fichiers) ou « retrieving the source.md file » (récupération du fichier source.md).

Éviter la nominalisation

Par exemple, au lieu de « to reach a conclusion » (pour parvenir à une conclusion), utilisez « conclude » (en conclusion).

Évitez d’utiliser des verbes auxiliaires modaux ambigus.

Évitez d’utiliser des mots tels que « may » (peut) et « might » (pourrait). Soyez plus clair pour éviter toute ambiguïté.

Éviter les expressions prépositionnelles

Au lieu d’écrire « after trying many times » (après plusieurs tentatives) ou « according to the repository log » (d’après le journal du dépôt), écrivez de manière plus directe. Par exemple, « after trying three times » (après avoir essayé trois fois).

Éviter les noms et les pronoms vagues

Les noms et les pronoms vagues peuvent empêcher de savoir à qui ou à quoi vous faites référence, en particulier quand le contenu doit être traduit. Par exemple, « Maintainers and contributors have access to files and comments » (Les responsables et les contributeurs ont accès aux fichiers et aux commentaires). « In the pull request they make changes to it » (Dans la demande de tirage (pull request), ils y apportent des changements). Dans cette phrase, il est difficile de savoir si les changements sont apportés aux fichiers ou aux commentaires. Si un pronom semble faire référence à plusieurs antécédents, reformulez la phrase pour clarifier l’antécédent, ou remplacez le pronom par un nom pour éliminer toute ambiguïté.

Dans la mesure du possible, introduisez clairement les liens en suivant notre guide de style. Par exemple, à la place de la phrase suivante :

Read [more about OAuth2.](/apps/building-integrations/setting-up-and-registering-oauth-apps/) Note that OAuth2 tokens can be [acquired programmatically](/rest/reference/oauth-authorizations/#create-a-new-authorization), for applications that are not websites.

Vous pouvez utiliser ceci :

OAuth2 tokens can be acquired programmatically for applications that are not websites. For more information, see "[Setting up and registering OAuth Apps](apps/building-integrations/setting-up-and-registering-oauth-apps/)" and "[Create a new authorization](/rest/reference/oauth-authorizations/#create-a-new-authorization)."