Free-cat/ste100

ASD-STE100 Anglais Technique Simplifié

STE est une langue contrôlée : 53 règles rédactionnelles et un dictionnaire d'environ 900 mots approuvés, chacun avec un seul sens et une seule catégorie grammaticale. Le but est qu'un lecteur avec un anglais limité, ou un traducteur, puisse comprendre chaque phrase d'une seule manière.

Sélectionnez la tâche

Tâche	L'utilisateur vous donne	Vous retournez
Écrire	Notes, faits, un plan ou une demande	Un nouveau document en STE
Vérifier	Un document existant	Un rapport de constatations. Pas de réécriture.
Éditer	Un document existant	Le document en STE, et un résumé des modifications

Si la demande n'est pas claire ("regardez ce doc"), effectuez une Vérification et proposez une Édition.

Ressources

• references/rules.md — les 53 règles avec exemples. Lisez-le pour une tâche de Vérification ou d'Édition, et lorsque vous n'êtes pas sûr d'une règle.
• references/dictionary.md — mots non approuvés avec alternatives approuvées, pièges de catégorie grammaticale, catégories de noms techniques et verbes techniques, et une section pour le texte logiciel. Lisez-le pour chaque tâche. La plupart des violations sont des choix de mots.
• scripts/ste_check.py — trouve les violations qu'un programme peut trouver. Exécutez-le ; ne le lisez pas. Seulement la bibliothèque standard Python 3. Il lit un fichier et imprime les constatations. Il ne modifie pas les fichiers et n'utilise pas le réseau.

python3 scripts/ste_check.py <fichier> [--type auto|procedure|description] [--terms termes.txt] [--json]

--terms prend un fichier avec un nom technique ou un verbe technique sur chaque ligne (par exemple press, torque). Le script cesse alors de signaler ces mots.

Le script est une première passe. Il ne peut pas trouver les noms multi-mots longs, un mauvais sens, les articles manquants ou les termes incohérents. Il signale également certains textes corrects (un participe passé utilisé comme adjectif ressemble à une voix passive). Examinez chaque constatation.

Les règles qui causent le plus de violations

1. Mots approuvés (1.1–1.3). Utilisez les mots du dictionnaire avec leur catégorie grammaticale et leur sens approuvés. Check et test sont des noms ("Do a check of…", "Make sure that…"). Close est un verbe (écrivez "near").
2. Noms techniques et verbes techniques (1.5–1.13). Les mots de domaine viennent de l'extérieur du dictionnaire : pièces, outils, matériaux, objets logiciels, unités (noms), et processus spécifiques comme drill, weld, click, deploy (verbes). Utilisez un terme pour une chose. Un verbe général (verify, perform, utilize) n'est jamais un verbe technique.
3. Formes verbales (3.1–3.5). Infinitif, impératif, présent simple, passé simple, futur simple, et le participe passé comme adjectif. Pas de temps perfect ("has failed"), pas de progressif ("is running"), pas de forme en -ing sauf s'il s'agit d'un nom technique ("bearing", "operating temperature").
4. Verbes modaux. CAN et MUST uniquement. Pas de should, may, might, could, would, shall.
5. Voix active (3.6). Toujours dans les procédures. Dans les descriptions, la passive n'est autorisée que si l'agent est inconnu ou sans importance.
6. Longueur des phrases (5.1, 6.3). Procédure : 20 mots. Description : 25 mots. Un code, un nombre avec son unité, une étiquette et du texte entre parenthèses comptent chacun pour un mot.
7. Une instruction dans chaque phrase (5.2–5.4). Écrivez un ordre. Combinez deux actions uniquement si elles se produisent en même temps. Mettez la condition en premier, puis une virgule.
8. N'omettez pas les mots (4.2, 4.5). Gardez les articles et "that". Pas de contractions.
9. Noms multi-mots (2.1). Trois noms maximum. Divisez un nom plus long avec "of", "for", "that" ou un trait d'union.
10. Sécurité et notes (7.1–7.3, 5.5). Un avertissement ou une précaution commence par un ordre ou une condition, donne le risque, et va avant l'étape à laquelle il s'applique. Une note donne uniquement des informations. Si une note contient une instruction, faites-en une étape. Le texte de sécurité obéit aux mêmes règles verbales : "The threads can become damaged" ou "This can cause damage to the threads", pas "The threads can be damaged".
11. Paragraphes (6.4–6.6). Un sujet, phrase sujet en premier, six phrases maximum. Utilisez une liste verticale pour trois éléments parallèles ou plus (4.3). Pas de points-virgules (8.1).

Changez la construction, pas seulement les mots (9.1). STE n'est pas un échange de synonymes.

Pas STE	Médiocre (échange de mots)	STE
The system should be allowed to cool down prior to commencing disassembly.	The system must be let to cool before start disassembly.	Let the system become cool. Then, disassemble the unit.
Having confirmed the valve is closed, proceed with removal of the pump.	After you made sure the valve is closed, continue with removal of the pump.	Make sure that the valve is closed. Then, remove the pump.
The cache may need to be cleared if stale data is displayed.	The cache must possibly be cleared if old data is shown.	If the page shows old data, clear the cache.

Principes pour les trois tâches

Exactitude d'abord. STE change comment vous dites quelque chose, pas ce que vous dites. Gardez chaque fait, valeur, tolérance, condition et limite de portée. N'ajoutez pas d'étapes, d'avertissements ou de valeurs que la source ne contient pas ; placez un éventuel écart dans les questions ouvertes.

Ne devinez pas en silence. Si la source est ambiguë ("check the oil" — le niveau ou l'état ?), sélectionnez le sens le plus probable et listez le point comme une question ouverte. Gardez la liste courte : uniquement les points où la réponse change le texte. Trois bonnes questions obtiennent une réponse. Dix, non.

Laissez le texte non prosaïque tel quel : code, commandes, chemins, étiquettes d'interface, numéros de pièces, texte de plaque, texte cité, texte juridique.

Mots qui ne sont pas dans dictionary.md. Le fichier est un sous-ensemble, donc la plupart des mots n'y sont pas. Décidez dans cet ordre, et ne faites pas une liste de mots ordinaires "à confirmer" :

1. Est-il dans les tableaux non approuvés ? Utilisez l'alternative.
2. Nomme-t-il une chose ou un processus spécifique du domaine ? C'est un nom technique ou un verbe technique. Utilisez-le, de manière cohérente.
3. Y a-t-il un mot plus simple que vous savez être approuvé (la liste des verbes de base, ou un mot dans les exemples STE) ? Utilisez ce mot.
4. Sinon, et si le mot est simple et a un sens clair ici, utilisez-le. Signalez un mot uniquement lorsqu'un mauvais choix peut changer le sens.

Lettres majuscules. Le fichier dictionnaire montre les mots approuvés en MAJUSCULES comme une notation. Écrivez-les en minuscules normales dans les documents et dans le texte du rapport ("use must", pas "use MUST").

Tout ce que vous écrivez pour l'utilisateur est aussi en STE : corrections suggérées, résumés des modifications et notes. Une correction qui a ses propres violations ("is usually done by deploying…") enseigne la mauvaise chose. Donnez les noms de fichiers, pas les chemins complets du système de fichiers.

Affirmations. Ne dites pas qu'un document est certifié ou entièrement conforme. Dites que vous l'avez écrit ou vérifié selon les règles STE. Donnez la limite du dictionnaire en une phrase, une fois. Si la conformité est une exigence contractuelle, recommandez une révision par une personne formée STE avec la spécification officielle (gratuite sur demande auprès de asd-ste100.org).

Flux de travail : Écrire

1. Identifiez chaque partie comme une procédure (le lecteur fait quelque chose) ou une description (le lecteur apprend quelque chose). Les limites sont différentes.
2. Faites la liste des termes : un nom technique pour chaque chose, un verbe pour chaque processus. Utilisez le glossaire de l'utilisateur s'il y en a un.
3. Rédigez le brouillon.
   • Procédure : étapes numérotées, un ordre chacune, conditions en premier. Placez chaque avertissement ou précaution immédiatement avant son étape, et chaque note après son étape.
   • Description : courts paragraphes, phrase sujet en premier.
   • Titres : une courte phrase nominale ou un ordre ("Start the unit"), pas une forme en -ing.
4. Exécutez scripts/ste_check.py. Corrigez les constatations. Exécutez-le à nouveau. Arrêtez-vous lorsque chaque constatation qui reste est une que vous avez examinée et acceptée.
5. Relisez le brouillon pour les points que le script ne peut pas trouver : noms multi-mots, catégorie grammaticale, articles, un terme pour une chose, une instruction dans chaque étape.
6. Remettez le document. Après celui-ci, dans la réponse (ou sous une ligne de règle, marquée comme notes pour l'auteur), donnez :
   • les noms techniques et verbes techniques de l'extérieur du dictionnaire (pas les mots approuvés tels que remove ou install) ;
   • les questions ouvertes.

Flux de travail : Vérifier

1. Lisez references/rules.md et references/dictionary.md.
2. Exécutez scripts/ste_check.py sur le document.
3. Examinez les constatations et écartez les fausses. Puis lisez le document pour les points que le script ne peut pas trouver (Écrire étape 5), et pour la structure : position des avertissements, instructions dans les notes, étapes avec plus d'une action.
4. Rédigez le rapport avec cette structure. Gardez-le assez court pour agir : une ligne pour chaque phrase qui a un problème, et une ligne pour un problème qui se répète à de nombreux endroits.

# Rapport STE : <nom du fichier>

## Résumé
<3-5 phrases : type de texte, niveau général, les trois choses les plus importantes à corriger en premier.>

| Règle | Sujet | Constatations |
|---|---|---|
| 1.1 | Mot non approuvé | 12 |

## Constatations
| # | Emplacement | Règle | Texte original | Problème | Texte STE suggéré |
|---|---|---|---|---|---|
| 1 | Étape 2 | 3.6, 1.1 | "The cover should be removed" | Voix passive. "should" n'est pas approuvé. | "Remove the cover." |

## Questions ouvertes
<Uniquement s'il y en a. Maximum cinq.>

Règles pour le rapport :

• Donnez le numéro ou les numéros de règle pour chaque ligne. Citez le texte original exactement.
• Donnez une correction pour chaque ligne, et assurez-vous que la correction obéit aux règles (longueur, formes verbales, voix active, mots approuvés).
• Ne signalez pas un titre comme une longue phrase ou comme un nom multi-mot s'il a trois noms ou moins.
• Si le niveau d'une instruction de sécurité semble incorrect (par exemple WARNING pour une perte de données), dites-le dans la ligne. WARNING est pour les blessures, CAUTION pour les dommages ou la perte de données.
• N'incluez pas comment vous avez fait le rapport (comptes de script, fausses constatations que vous avez écartées, une section "limites"). Une phrase sur la limite du dictionnaire dans le résumé est suffisante.
• Ne réécrivez pas le document complet sauf si l'utilisateur le demande.

Flux de travail : Éditer

1. Faites les étapes de Vérification 1 à 3. Les constatations sont votre liste de travail, pas le livrable.
2. Réécrivez le document. Gardez la structure, les titres, les numéros et tout le contenu technique. Divisez les longues phrases et les étapes multi-actions. Déplacez chaque avertissement ou précaution à la position avant son étape. Transformez une instruction dans une note en une étape ou une instruction de sécurité.
3. Exécutez scripts/ste_check.py sur le résultat. Corrigez-le et exécutez à nouveau le script, comme à l'étape 4 d'Écrire.
4. Remettez le document dans le même format que la source. Puis donnez un court résumé des modifications : les principaux types de modification avec un exemple avant-après pour chacun, chaque endroit où vous avez modifié la structure ou la force d'une déclaration ("should" en "must", une note en une étape), et les questions ouvertes. Ne listez pas chaque phrase modifiée sauf si l'utilisateur demande un journal complet des modifications.