Free-cat/ste100

ASD-STE100 Simplified Technical English

STE ist eine kontrollierte Sprache: 53 Schreibregeln und ein Wörterbuch mit etwa 900 genehmigten Wörtern, jedes mit einer Bedeutung und einer Wortart. Der Zweck ist, dass ein Leser mit begrenzten Englischkenntnissen oder ein Übersetzer jeden Satz nur auf eine Weise verstehen kann.

Wählen Sie die Aufgabe

Aufgabe	Der Benutzer gibt Ihnen	Sie geben zurück
Schreiben	Notizen, Fakten, eine Gliederung oder eine Anfrage	Ein neues Dokument in STE
Prüfen	Ein bestehendes Dokument	Einen Ergebnisbericht. Keine Umschreibung.
Bearbeiten	Ein bestehendes Dokument	Das Dokument in STE und eine Änderungsübersicht

Wenn die Anfrage unklar ist („Sehen Sie sich dieses Dokument an“), führen Sie eine Prüfung durch und bieten Sie eine Bearbeitung an.

Ressourcen

• references/rules.md — alle 53 Regeln mit Beispielen. Lesen Sie es für eine Prüf- oder Bearbeitungsaufgabe und wenn Sie sich bei einer Regel nicht sicher sind.
• references/dictionary.md — nicht genehmigte Wörter mit genehmigten Alternativen, Wortart-Fallen, technische Nomen- und technische Verbkategorien sowie ein Abschnitt für Softwaretexte. Lesen Sie es für jede Aufgabe. Die meisten Verstöße sind Wortwahlfehler.
• scripts/ste_check.py — findet die Verstöße, die ein Programm finden kann. Führen Sie es aus; lesen Sie es nicht. Nur Python 3 Standardbibliothek. Es liest eine Datei und gibt Ergebnisse aus. Es ändert keine Dateien und verwendet kein Netzwerk.

python3 scripts/ste_check.py <datei> [--typ auto|procedure|description] [--begriffe begriffe.txt] [--json]

--begriffe erwartet eine Datei mit je einem technischen Nomen oder Verb pro Zeile (z. B. press, torque). Das Skript meldet diese Wörter dann nicht mehr.

Das Skript ist ein erster Durchlauf. Es kann keine langen mehrteiligen Nomen, eine falsche Bedeutung, fehlende Artikel oder inkonsistente Begriffe finden. Es meldet auch einige korrekte Texte (ein Partizip Perfekt, das als Adjektiv verwendet wird, sieht aus wie Passiv). Überprüfen Sie jeden Befund.

Die Regeln, die die meisten Verstöße verursachen

1. Genehmigte Wörter (1.1–1.3). Verwenden Sie Wörter aus dem Wörterbuch mit ihrer genehmigten Wortart und Bedeutung. Check und test sind Nomen („Do a check of…“, „Make sure that…“). Close ist ein Verb (schreiben Sie „near“).
2. Technische Nomen und Verben (1.5–1.13). Fachbereichswörter stammen von außerhalb des Wörterbuchs: Teile, Werkzeuge, Materialien, Softwareobjekte, Einheiten (Nomen) und spezifische Prozesse wie drill, weld, click, deploy (Verben). Verwenden Sie einen Begriff für eine Sache. Ein allgemeines Verb (verify, perform, utilize) ist niemals ein technisches Verb.
3. Verbformen (3.1–3.5). Infinitiv, Imperativ, einfache Gegenwart, einfache Vergangenheit, einfache Zukunft und das Partizip Perfekt als Adjektiv. Keine vollendete Zeit („has failed“), keine Verlaufsform („is running“), keine -ing-Form, es sei denn, es handelt sich um ein technisches Nomen („bearing“, „operating temperature“).
4. Modalverben. Nur CAN und MUST. Nicht should, may, might, could, would, shall.
5. Aktiv (3.6). Immer in Verfahren. In Beschreibungen ist das Passiv nur erlaubt, wenn der Handelnde unbekannt oder unwichtig ist.
6. Satzlänge (5.1, 6.3). Verfahren: 20 Wörter. Beschreibung: 25 Wörter. Code, eine Zahl mit ihrer Einheit, eine Bezeichnung und Text in Klammern zählen jeweils als ein Wort.
7. Ein Befehl pro Satz (5.2–5.4). Schreiben Sie einen Befehl. Kombinieren Sie zwei Handlungen nur, wenn sie gleichzeitig auftreten. Setzen Sie eine Bedingung zuerst, dann ein Komma.
8. Lassen Sie keine Wörter weg (4.2, 4.5). Behalten Sie Artikel und „that“. Keine Zusammenziehungen.
9. Mehrteilige Nomen (2.1). Maximal drei Nomen. Teilen Sie ein längeres mit „of“, „for“, „that“ oder einem Bindestrich.
10. Sicherheit und Hinweise (7.1–7.3, 5.5). Eine Warnung oder ein Vorsichtshinweis beginnt mit einem Befehl oder einer Bedingung, nennt das Risiko und steht vor dem Schritt, auf den er sich bezieht. Ein Hinweis gibt nur Informationen. Wenn ein Hinweis eine Anweisung enthält, machen Sie daraus einen Schritt. Sicherheitstexte befolgen dieselben Verbregeln: „The threads can become damaged“ oder „This can cause damage to the threads“, nicht „The threads can be damaged“.
11. Absätze (6.4–6.6). Ein Thema, zuerst der Themensatz, maximal sechs Sätze. Verwenden Sie eine vertikale Liste für drei oder mehr parallele Elemente (4.3). Keine Semikolons (8.1).

Ändern Sie die Konstruktion, nicht nur die Wörter (9.1). STE ist kein Synonymtausch.

Nicht STE	Schlecht (Worttausch)	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.

Grundsätze für alle drei Aufgaben

Genauigkeit zuerst. STE ändert, wie Sie etwas sagen, nicht, was Sie sagen. Behalten Sie jede Tatsache, jeden Wert, jede Toleranz, jede Bedingung und jede Bereichsgrenze bei. Fügen Sie keine Schritte, Warnungen oder Werte hinzu, die die Quelle nicht enthält; nennen Sie eine mögliche Lücke in den offenen Fragen.

Nicht stillschweigend raten. Wenn die Quelle mehrdeutig ist („check the oil“ — den Füllstand oder den Zustand?), wählen Sie die wahrscheinlichste Bedeutung und listen Sie den Punkt als offene Frage. Halten Sie die Liste kurz: nur Punkte, bei denen die Antwort den Text ändert. Drei gute Fragen erhalten eine Antwort. Zehn nicht.

Nicht-Prosa-Text unverändert lassen: Code, Befehle, Pfade, UI-Bezeichnungen, Teilenummern, Schildtexte, zitierte Texte, rechtliche Texte.

Wörter, die nicht in dictionary.md stehen. Die Datei ist ein Ausschnitt, daher stehen die meisten Wörter nicht darin. Entscheiden Sie in dieser Reihenfolge und erstellen Sie keine Liste gewöhnlicher Wörter „zur Bestätigung“:

1. Steht es in den Tabellen der nicht genehmigten Wörter? Verwenden Sie die Alternative.
2. Benennt es ein Ding oder einen spezifischen Prozess des Fachgebiets? Es ist ein technisches Nomen oder Verb. Verwenden Sie es, konsistent.
3. Gibt es ein einfacheres Wort, von dem Sie wissen, dass es genehmigt ist (die Kernverbliste oder ein Wort in den STE-Beispielen)? Verwenden Sie dieses Wort.
4. Wenn nicht und das Wort schlicht ist und hier eine eindeutige Bedeutung hat, verwenden Sie es. Markieren Sie ein Wort nur, wenn eine falsche Auswahl die Bedeutung ändern kann.

Großbuchstaben. Die Wörterbuchdatei zeigt genehmigte Wörter in GROSSBUCHSTABEN als Notation. Schreiben Sie sie in Dokumenten und in Berichtstexten in normaler Groß-/Kleinschreibung („use must“, nicht „use MUST“).

Alles, was Sie für den Benutzer schreiben, ist auch in STE: Korrekturvorschläge, Änderungsübersichten und Hinweise. Eine Korrektur, die selbst Verstöße enthält („is usually done by deploying…“), lehrt das Falsche. Geben Sie Dateinamen, keine vollständigen Dateisystempfade an.

Behauptungen. Sagen Sie nicht, dass ein Dokument zertifiziert oder vollständig konform ist. Sagen Sie, dass Sie es gemäß den STE-Regeln geschrieben oder geprüft haben. Geben Sie die Wörterbuchgrenze einmal in einem Satz an. Wenn die Einhaltung ein Vertragserfordernis ist, empfehlen Sie eine Überprüfung durch eine STE-geschulte Person mit der offiziellen Spezifikation (kostenlos auf Anfrage von asd-ste100.org).

Arbeitsablauf: Schreiben

1. Identifizieren Sie jeden Teil als Verfahren (der Leser tut etwas) oder Beschreibung (der Leser erfährt etwas). Die Grenzen sind unterschiedlich.
2. Erstellen Sie die Begriffsklärung: ein technisches Nomen für jedes Ding, ein Verb für jeden Prozess. Verwenden Sie das Glossar des Benutzers, falls vorhanden.
3. Schreiben Sie den Entwurf.
   • Verfahren: nummerierte Schritte, ein Befehl pro Schritt, Bedingungen zuerst. Setzen Sie jede Warnung oder jeden Vorsichtshinweis unmittelbar vor seinen Schritt und jeden Hinweis nach seinem Schritt.
   • Beschreibung: kurze Absätze, zuerst der Themensatz.
   • Überschriften: eine kurze Nominalphrase oder ein Befehl („Gerät starten“), keine -ing-Form.
4. Führen Sie scripts/ste_check.py aus. Korrigieren Sie die Befunde. Führen Sie es erneut aus. Stoppen Sie, wenn jeder verbleibende Befund einer ist, den Sie untersucht und akzeptiert haben.
5. Lesen Sie den Entwurf auf die Punkte, die das Skript nicht finden kann: mehrteilige Nomen, Wortart, Artikel, ein Begriff für eine Sache, ein Befehl pro Schritt.
6. Liefern Sie das Dokument. Geben Sie danach in der Antwort (oder unter einer Trennlinie, als Anmerkungen für den Autor):
   • die technischen Nomen und Verben von außerhalb des Wörterbuchs (keine genehmigten Wörter wie remove oder install);
   • die offenen Fragen.

Arbeitsablauf: Prüfen

1. Lesen Sie references/rules.md und references/dictionary.md.
2. Führen Sie scripts/ste_check.py auf dem Dokument aus.
3. Untersuchen Sie die Befunde und verwerfen Sie die falschen. Lesen Sie dann das Dokument auf die Punkte, die das Skript nicht finden kann (Schritt 5 des Schreibens), und auf die Struktur: Position von Warnungen, Anweisungen in Hinweisen, Schritte mit mehr als einer Handlung.
4. Schreiben Sie den Bericht mit dieser Struktur. Halten Sie ihn kurz genug, um danach zu handeln: eine Zeile für jeden Satz mit einem Problem und eine Zeile für ein Problem, das sich an vielen Stellen wiederholt.

# STE-Bericht: <dateiname>

## Zusammenfassung
<3-5 Sätze: Texttyp, allgemeines Niveau, die drei wichtigsten Dinge, die zuerst korrigiert werden sollten.>

| Regel | Thema | Befunde |
|---|---|---|
| 1.1 | Nicht genehmigtes Wort | 12 |

## Befunde
| # | Ort | Regel | Originaltext | Problem | Vorgeschlagener STE-Text |
|---|---|---|---|---|---|
| 1 | Schritt 2 | 3.6, 1.1 | "The cover should be removed" | Passiv. „should“ ist nicht genehmigt. | „Remove the cover.“ |

## Offene Fragen
<Nur wenn es welche gibt. Maximal fünf.>

Regeln für den Bericht:

• Geben Sie für jede Zeile die Regelnummer(n) an. Zitieren Sie den Originaltext genau.
• Geben Sie für jede Zeile eine Korrektur an und stellen Sie sicher, dass die Korrektur die Regeln einhält (Länge, Verbformen, Aktiv, genehmigte Wörter).
• Melden Sie eine Überschrift nicht als langen Satz oder als mehrteiliges Nomen, wenn sie drei oder weniger Nomen hat.
• Wenn die Stufe einer Sicherheitsanweisung falsch aussieht (z. B. WARNUNG für Datenverlust), sagen Sie dies in der Zeile. WARNUNG ist für Verletzungen, VORSICHT für Schäden oder Datenverlust.
• Fügen Sie nicht hinzu, wie Sie den Bericht erstellt haben (Skriptzahlen, falsche Befunde, die Sie verworfen haben, ein Abschnitt „Grenzen“). Ein Satz über die Wörterbuchgrenze in der Zusammenfassung ist ausreichend.
• Schreiben Sie das vollständige Dokument nicht neu, es sei denn, der Benutzer bittet darum.

Arbeitsablauf: Bearbeiten

1. Führen Sie die Prüfschritte 1–3 durch. Die Befunde sind Ihre Arbeitsliste, nicht das Ergebnis.
2. Schreiben Sie das Dokument um. Behalten Sie die Struktur, die Überschriften, die Nummern und den gesamten technischen Inhalt bei. Teilen Sie lange Sätze und Schritte mit mehreren Handlungen auf. Verschieben Sie jede Warnung oder jeden Vorsichtshinweis an die Position vor seinem Schritt. Ändern Sie eine Anweisung in einem Hinweis in einen Schritt oder eine Sicherheitsanweisung um.
3. Führen Sie scripts/ste_check.py auf dem Ergebnis aus. Korrigieren Sie es und führen Sie das Skript erneut aus, wie in Schritt 4 des Schreibens.
4. Liefern Sie das Dokument im selben Format wie die Quelle. Geben Sie dann eine kurze Änderungsübersicht: die wichtigsten Änderungsarten mit einem Vorher-Nachher-Beispiel für jede, alle Stellen, an denen Sie die Struktur oder die Stärke einer Aussage geändert haben („should“ zu „must“, ein Hinweis zu einem Schritt), und die offenen Fragen. Listen Sie nicht jeden geänderten Satz auf, es sei denn, der Benutzer bittet um ein vollständiges Änderungsprotokoll.