Documentation d'API · Traduction technique
Balises : Traduction technique de documentation d'API
Cette fiche en pose le cadre : ce qui est attendu du dossier, ce qui se vérifie en amont et ce qui relève de l'appréciation de l'administration.
Positionnement : traduction technique de documentation d'API
Avant d'aller plus loin, il convient de poser les repères utiles pour ce dossier. Les points de vigilance portent sur traducteur assermenté, schéma technique, afin d'éviter les allers-retours. Ces éléments conditionnent la suite de la démarche et se vérifient en amont. Un dossier complet se prépare en amont, sans promettre ce qui relève du guichet.
Contexte
À ce stade, deux publics lisent le document de façon très différente : le développeur qui intègre la brique dans son propre système et le décideur qui doit comprendre ce que la brique permet. Une question fréquente, formulée ainsi : « De quoi dépend le prix de la traduction de la documentation d'API ? » Sur ce point : Laissés en l'état, les noms de champs, les codes de retour et les valeurs littérales conservent exactement leur casse et leurs tirets. Repères de lecture : traduction certifiée conforme, brevet, traduction technique. À garder en tête : Client, éditeur de logiciel, INPI et organisme de certification comptent parmi les destinataires habituels
Champ documentaire
La page appartient à la documentation d'interface de programmation et suit les règles communes à cette rubrique. La spécification vient de l'équipe technique, avec les jeux d'essai qui valident chaque appel ; les guides d'intégration et les réponses aux appels d'offres s'appuient ensuite sur cette documentation. Question posée à l'accueil : « La traduction de la documentation d'API doit-elle être relue par un technicien ? » Pour répondre : En français courant, les descriptions se rédigent avec les mêmes contraintes de concision que dans la version d'origine, et sans introduire d'exemple qui ne figurerait pas dans le code. Ce que l'on peut affirmer : Une chaîne d'interface reformulée peut ne plus correspondre au libellé du bouton dans le produit
Autorités et fondements
Au croisement des deux niveaux de lecture se trouve le premier travail : une phrase rédigée pour un architecte se révèle inutile pour un acheteur et inversement. Un point qui mérite d'être posé explicitement : « Quels fichiers fournir pour traduire la documentation d'API ? » Concrètement, Les schémas de flux posent un problème de mise en page, car les étiquettes traduites s'allongent et débordent des cadres prévus pour l'anglais, ce qui oblige parfois à redessiner le schéma avec l'équipe. Ce que l'on peut affirmer : Les critères d'acceptation varient parfois entre un usage sectoriel et une démarche administrative, pour un document identique
Cohérence terminologique
Les exemples de requêtes concentrent la difficulté : une ligne adaptée au français ne s'exécute plus, et le lecteur conclut que le service ne fonctionne pas. La question revient souvent : « Une traduction de la documentation d'API peut-elle servir de documentation réglementaire ? » On retiendra ceci : Les renvois entre sections méritent un contrôle dédié, un lien mort dans une documentation technique étant plus visible qu'une faute de style. Le cadre à ne pas perdre de vue : Cahier des charges technique, documentation d'API, chaînes d'interface, manuel d'exploitation et brevet composent le corpus habituel
Démarche
On nous écrit souvent : « Comment les schémas et les références sont-ils conservés ? » Concrètement, Une version majeure déplace des notions et demande une reprise complète, tandis qu'une correction mineure se contente d'une passe ciblée sur les passages modifiés. Le cadre à ne pas perdre de vue : Client, éditeur de logiciel, INPI et organisme de certification comptent parmi les destinataires habituels Autre point de vigilance : un guide d'installation avec commandes à recopier telles quelles. Second point : des messages système courts, isolés du contexte d'affichage.
Contrôle de qualité
Question de fond, souvent mal posée : « Comment gérer les mises à jour successives de la documentation d'API ? » À ce sujet, La documentation ne remplace jamais la validation technique : les essais et la recette restent du ressort de l'équipe projet, qui seule connaît l'état réel du service. À garder en tête : Une chaîne d'interface reformulée peut ne plus correspondre au libellé du bouton dans le produit Ce qui change la donne : modifier un nom de variable en traduisant la phrase qui l'entoure.
Forme de livraison
Les clients demandent régulièrement : « Faut-il une traduction assermentée de la documentation d'API ? » De fait, La forme assermentée reste rare ici, sauf lorsque la documentation accompagne un marché public ou une pièce produite en contentieux. Un point de repère utile : Les critères d'acceptation varient parfois entre un usage sectoriel et une démarche administrative, pour un document identique Le raisonnement se poursuit : la validation technique des commandes revient à l'équipe projet. Ce second point est distinct : l'hébergement des fichiers transmis relève du prestataire choisi.
Questions fréquentes
Parmi les demandes reçues, celle-ci revient : « Combien de temps faut-il pour traduire la documentation d'API ? » Voici le point : Les livraisons ratées partagent souvent les mêmes causes : un exemple adapté au français, un champ renommé pour la lisibilité, une note de version oubliée qui laisse croire à une fonctionnalité disparue. Un point de repère utile : Cahier des charges technique, documentation d'API, chaînes d'interface, manuel d'exploitation et brevet composent le corpus habituel Le reste s'explique simplement : avant la mise en service d'un produit auprès des utilisateurs.
Pages liées
Question de fond : « Faut-il traduire les noms de champs dans une documentation d'API ? » Un nom de champ est un identifiant, pas un mot de la langue : il désigne une donnée dans le code et doit rester identique pour que l'appel fonctionne. Ce sont les descriptions, les introductions et les messages d'erreur qui se traduisent, jamais la structure technique. La règle souffre une exception lorsque le champ alimente un libellé visible par l'utilisateur final, par exemple un intitulé de bouton dans une interface. Dans ce cas, deux textes coexistent : l'identifiant reste en place et la valeur affichée se localise. La confusion entre les deux produit les erreurs les plus coûteuses, car elle ne se voit pas à la lecture et n'apparaît qu'à l'exécution, souvent chez le client, au moment où le support est le moins disponible. Les clients demandent régulièrement : « Comment traduire les revendications d'un brevet ? » Le point à retenir : Les repérer demande d'ouvrir le produit à côté du texte, puis de rejouer mentalement chaque exemple avant de le valider.
Passage à l'action
Il vaut mieux partir du texte applicable. Les équipes techniques qui publient une interface en plusieurs langues font relire la version traduite par un développeur, puis comparent les exemples de requêtes avec ceux de la version d'origine. Un exemple traduit qui ne s'exécute plus ruine la confiance dans le reste du document. La réponse commence par la question : « Qui peut traduire la documentation d'API avec une compétence technique ? » Voici le point : Tenu par l'équipe, un glossaire des objets métier évite qu'un même service porte deux noms selon le chapitre, ce qui arrive vite quand plusieurs rédacteurs se succèdent. Un point qui mérite d'être posé explicitement : « Que faire si la documentation d'API est fourni en scans non modifiables ? » De fait, Remis ensemble, le fichier de travail, l'export publié et la liste des points d'accès dépréciés couvrent l'essentiel du dossier, cette dernière évitant aux intégrateurs de travailler sur une fonction retirée.
