Rédaction en anglais technique simplifié
ASD-STE100 est une norme de langage contrôlé. L'industrie aérospatiale et de la défense l'a créée pour qu'un technicien ne puisse pas mal lire une instruction de maintenance. Elle supprime les deux plus grandes sources de mauvaise lecture : les mots qui ont plus d'un sens, et les phrases qui acceptent plus d'une structure.
La même discipline corrige l'échec habituel de la prose générée par agent. Le résultat d'un agent est souvent correct et illisible : phrases longues, accumulation de réserves, voix passive, et une rotation de synonymes qui fait ressembler une action à trois. Le lecteur n'a pas d'auteur à qui poser des questions, donc l'ambiguïté lui coûte une relecture au mieux et une mauvaise action au pire.
Appliquez les règles ci-dessous au moment où vous écrivez. N'écrivez pas un brouillon dense et ne le nettoyez pas après coup.
Quand l'utiliser
Utilisez-la pour un texte sur lequel une personne ou un autre agent doit agir :
- Rapports, résultats et résumés.
- Descriptions de PR, messages de commit et commentaires de code.
- Instructions passées à un autre agent, et prompts.
- Descriptions d'outils, messages d'erreur, états vides et lignes de log.
Ne l'utilisez pas quand la voix est l'enjeu : texte marketing, articles de blog, ou tout ce qui est persuasif. STE est délibérément plat. Laissez aussi le texte cité tel quel. Si vous citez un utilisateur, un log ou un document, citez-le comme il est.
Les règles
| Règle | Faire | Ne pas faire |
|---|---|---|
| Un sens par mot | Choisir un verbe par action et le réutiliser à chaque fois | Alterner « vérifier », « confirmer » et « valider » pour la même action |
| Une partie du discours par mot | « Appliquer l'huile sur la valve » | « Huiler la valve » |
| Voix active | « Le technicien supprime le fichier. » | « Le fichier est supprimé. » |
| Temps simples | « Nous avons reçu le rapport. » | « Nous avions reçu le rapport. » |
| Une idée par phrase | « Ouvrir le fichier. Lire la ligne 3. » | « Ouvrir le fichier et lire la ligne 3, puis vérifier qu'elle correspond. » |
| Longueur de phrase | 20 mots ou moins pour les instructions, 25 ou moins pour les descriptions | Chaînes de propositions subordonnées |
| Groupes nominaux | 3 mots ou moins (« valve de pompe à carburant ») | « assemblage d'entrée de pompe à carburant haute pression » |
| Pas de mots manquants | Conserver le sujet, le verbe et l'article, même si c'est plus long | « Les fichiers non sauvegardés seront perdus », qui cache quels fichiers |
| Une réserve, au maximum | « La version client est probablement obsolète. » | « Une erreur peut s'être produite qui pourrait être causée par... » |
| Paragraphes | Un sujet, 6 phrases ou moins | Paragraphes multi-sujets |
| Listes | Utiliser une liste pour 3 étapes ou conditions ou plus | Une séquence enfouie dans une phrase |
| Jargon | Conserver le terme technique dont vous avez besoin et le définir une fois | Utiliser un nom interne que le lecteur n'a jamais vu |
Le style maison PostHog repose sur ces règles et prime là où les deux divergent. Nous utilisons l'anglais américain, la casse de titre, et la virgule d'Oxford. Nous n'utilisons pas le tiret cadratin.
Comment réécrire
- Lire le texte une fois pour comprendre le sens. Ne commencez pas à réécrire avant de savoir ce qui doit rester.
- Aller phrase par phrase. Nommer la règle que chaque phrase transgresse.
- Réécrire la phrase pour corriger cette transgression. Conserver chaque fait, nombre, condition et qualificatif.
- Vérifier le résultat par rapport aux règles à nouveau. Une réécriture introduit souvent une nouvelle phrase longue.
La précision prime sur la brièveté. Si une phrase plus courte perdrait une condition de sécurité, un qualificatif de portée ou un nombre, conserver la phrase plus longue et expliquer pourquoi.
Si le texte suit déjà les règles, le dire. Ne pas changer le texte conforme.
Autovérification
Avant d'envoyer le texte, le relire une fois et se poser :
- Une phrase dépasse-t-elle 25 mots ?
- Une phrase porte-t-elle deux instructions ?
- La même action apparaît-elle sous deux verbes différents ?
- Une phrase passive peut-elle nommer son acteur ?
- Un lecteur qui arrive ici, sans contexte, saurait-il quoi faire ensuite ?
Références
references/writing-rules.md: le détail derrière le tableau, plus les sources.references/before-after.md: exemples travaillés de la réécriture, incluant la sortie d'agent.