ASD-STE100 簡易化テクニカル・イングリッシュは何をしますか？

STEは制御言語です。53の執筆ルールと、約900の承認された単語（それぞれが1つの意味と1つの品詞を持つ）からなる辞書で構成されます。目的は、限られた英語力の読者や翻訳者でも、各文を唯一の方法で理解できるようにすることです。

ジョブの選択

ジョブ	ユーザーが提供するもの	返すもの
作成 (Write)	メモ、事実、概要、または依頼	STEに準拠した新しい文書
チェック (Check)	既存の文書	指摘事項レポート。書き換えは行いません。
編集 (Edit)	既存の文書	STEに準拠した文書と変更サマリー

リクエストが不明瞭な場合（「この文書を見て」など）は、チェックを実行し、編集も提案してください。

リソース

references/rules.md — 全53ルールと例。チェックまたは編集ジョブの際、およびルールに確信が持てない場合に読んでください。
references/dictionary.md — 不承認語句と承認された代替語、品詞の落とし穴、テクニカル名詞とテクニカル動詞のカテゴリ、およびソフトウェアテキスト用のセクション。すべてのジョブで読んでください。ほとんどの違反は語彙選択に関するものです。
scripts/ste_check.py — プログラムで検出可能な違反を見つけます。実行はしてください。読む必要はありません。Python 3標準ライブラリのみを使用します。1つのファイルを読み込み、指摘事項を出力します。ファイルを変更したり、ネットワークを使用したりしません。

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

--terms は、各行に1つのテクニカル名詞または動詞（例：press, torque）を記述したファイルを指定します。スクリプトはそれらの単語を報告しなくなります。

このスクリプトは第一パスです。長い複合名詞、間違った意味、冠詞の欠落、用語の不統一を見つけることはできません。また、正しいテキスト（形容詞として使われた過去分詞が受動態のように見える場合など）を報告することもあります。各指摘事項を確認してください。

最も違反の多いルール

承認された単語（1.1–1.3）。 辞書の単語を、承認された品詞と意味で使用してください。Check と test は名詞です（「Do a check of…」、「Make sure that…」）。Close は動詞です（「near」と書きます）。
テクニカル名詞とテクニカル動詞（1.5–1.13）。 分野固有の単語は辞書の外から来ます。部品、工具、材料、ソフトウェアオブジェクト、単位（名詞）、および drill、weld、click、deploy などの特定のプロセス（動詞）です。1つのものには1つの用語を使用してください。一般動詞（verify、perform、utilize）はテクニカル動詞ではありません。
動詞の形（3.1–3.5）。 不定詞、命令形、単純現在、単純過去、単純未来、および形容詞としての過去分詞。完了時制（「has failed」）や進行形（「is running」）は不可。テクニカル名詞（「bearing」、「operating temperature」）でない限り、ing形は不可。
法助動詞。 CAN と MUST のみ。should, may, might, could, would, shall は不可。
能動態（3.6）。 手順書では常に能動態を使用。説明文では、行為者が不明または重要でない場合にのみ受動態が許可されます。
文の長さ（5.1, 6.3）。 手順書：20語。説明文：25語。コード、単位付き数字、ラベル、括弧内のテキストはそれぞれ1語としてカウントします。
各文に1つの指示（5.2–5.4）。 命令文を書いてください。2つの動作が同時に発生する場合にのみ、それらを組み合わせてください。条件は先に置き、カンマで区切ります。
単語を省略しない（4.2, 4.5）。 冠詞と「that」を保持してください。短縮形は使用しないでください。
複合名詞（2.1）。 名詞は最大3つまで。それ以上長い場合は、「of」、「for」、「that」、またはハイフンで分割してください。
安全に関する注意と注記（7.1–7.3, 5.5）。 警告または注意は、命令文または条件文で始め、リスクを示し、それが適用される手順の前に配置します。注記は情報のみを提供します。注記に指示が含まれている場合は、それを手順にしてください。安全テキストは同じ動詞ルールに従います：「The threads can become damaged」または「This can cause damage to the threads」であり、「The threads can be damaged」ではありません。
段落（6.4–6.6）。 1つのトピック、トピックセンテンスを最初に、最大6文。3つ以上の並列項目には縦方向リストを使用してください（4.3）。セミコロンは使用しないでください（8.1）。

単語だけでなく構文も変更してください（9.1）。 STEは同義語の置き換えではありません。

STEではない	悪い例（単語の置き換え）	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.

全3ジョブに共通の原則

正確性を最優先。 STEは言い回しを変えるものであり、内容を変えるものではありません。各事実、値、許容差、条件、範囲の制限を保持してください。ソースに含まれていない手順、警告、値を追加しないでください。可能性のあるギャップは未解決質問として記載してください。

黙って推測しない。 ソースが曖昧な場合（「check the oil」— レベルか状態か？）、最も可能性の高い意味を選択し、その点を未解決質問としてリストアップしてください。リストは短く保ってください：回答がテキストを変更する点のみ。良い質問が3つあれば回答が得られます。10個あれば得られません。

散文以外のテキストはそのままにしておく： コード、コマンド、パス、UIラベル、部品番号、銘板テキスト、引用テキスト、法的テキスト。

dictionary.mdにない単語。 このファイルはサブセットであるため、ほとんどの単語は含まれていません。以下の順序で判断し、「確認用」の通常の単語のリストを作成しないでください。

不承認テーブルにありますか？代替語を使用してください。
その分野の物や特定のプロセスを命名していますか？それはテクニカル名詞またはテクニカル動詞です。一貫して使用してください。
承認されていると分かっているより簡単な単語（コア動詞リスト、またはSTEの例にある単語）はありますか？その単語を使用してください。
そうでなく、その単語が平易でここで明確な意味を持つ場合は、それを使用してください。間違った選択が意味を変える可能性がある場合にのみ、単語にフラグを立ててください。

大文字。 辞書ファイルは、承認された単語を表記法として大文字で示しています。文書やレポートテキストでは通常の大文字小文字で記述してください（「use MUST」ではなく「use must」）。

ユーザーに書くものはすべてSTEであること： 提案された修正、変更サマリー、注記も同様です。それ自体に違反がある修正（「is usually done by deploying…」）は間違ったことを教えることになります。ファイル名は指定しますが、完全なファイルシステムパスは指定しないでください。

主張。 文書が認定または完全準拠しているとは言わないでください。STEルールに照らして作成またはチェックしたと言ってください。辞書の制限については、一度だけ一文で述べてください。コンプライアンスが契約要件である場合は、公式仕様書（asd-ste100.orgにリクエストすれば無料）を用いてSTE訓練を受けた人物によるレビューを推奨してください。

ワークフロー：作成（Write）

各部分が手順書（読者が何かを行う）か説明文（読者が何かを学ぶ）かを特定してください。制限が異なります。
用語リストを作成します：各物に対して1つのテクニカル名詞、各プロセスに対して1つの動詞。ユーザーの用語集があればそれを使用してください。
ドラフトを書きます。
- 手順書：番号付きステップ、各ステップ1つのコマンド、条件は先に。各警告または注意はそのステップの直前に、各注記はそのステップの後に配置します。
- 説明文：短い段落、トピックセンテンスを最初に。
- 見出し：短い名詞句またはコマンド（「Start the unit」）、ing形は避けます。
scripts/ste_check.py を実行します。指摘事項を修正します。再度実行します。残った各指摘事項が、自分が確認して受け入れたものである状態になるまで続けます。
スクリプトでは見つけられないポイントについてドラフトを読み直します：複合名詞、品詞、冠詞、1つのものに対する1つの用語、各ステップ内の1つの指示。
文書を提供します。提供後、返信内（または区切り線の下に、作成者向けのメモとしてマークして）、以下を記載します。
- 辞書外のテクニカル名詞とテクニカル動詞（remove や install などの承認語は除く）。
- 未解決質問。

ワークフロー：チェック（Check）

references/rules.md と references/dictionary.md を読みます。
文書に対して scripts/ste_check.py を実行します。
指摘事項を確認し、誤検出を破棄します。次に、スクリプトでは見つけられないポイント（作成のステップ5）と、構造（警告の位置、注記内の指示、複数のアクションを含むステップ）について文書を読み直します。
以下の構造でレポートを作成します。実行可能な程度に短く保ってください：問題のある各文に対して1行、多くの場所で繰り返される問題に対して1行。

# STEレポート: <ファイル名>

## サマリー
<3-5文：テキストタイプ、全体的なレベル、最初に修正すべき最も重要な3つのポイント。>

| ルール | トピック | 指摘件数 |
|---|---|---|
| 1.1 | 不承認単語 | 12 |

## 指摘事項
| # | 場所 | ルール | 原文 | 問題点 | 推奨STEテキスト |
|---|---|---|---|---|---|
| 1 | Step 2 | 3.6, 1.1 | "The cover should be removed" | 受動態。「should」は不承認。 | "Remove the cover." |

## 未解決質問
<ある場合のみ。最大5つ。>

レポートのルール：

各行にルール番号（複数の場合あり）を記載してください。原文を正確に引用してください。
各行に修正案を提示し、その修正案がルール（長さ、動詞の形、能動態、承認された単語）に従っていることを確認してください。
見出しが長文である、または名詞が3つ以下の複合名詞であるとは報告しないでください。
安全指示のレベルが正しくないように見える場合（例：データ損失に対してWARNING）、その行でその旨を述べてください。WARNINGは傷害用、CAUTIONは損傷またはデータ損失用です。
レポートの作成方法（スクリプトのカウント、破棄した誤検出、「制限」セクション）を含めないでください。サマリー内の辞書制限に関する一文で十分です。
ユーザーから依頼がない限り、文書全体を書き換えないでください。

ワークフロー：編集（Edit）

チェックのステップ1～3を実行します。指摘事項は作業リストであり、成果物ではありません。
文書を書き換えます。構造、見出し、番号、およびすべての技術的内容を保持してください。長い文と複数アクションのステップを分割します。各警告または注意をそれが適用されるステップの前に移動します。注記内の指示をステップまたは安全指示に変更します。
結果に対して scripts/ste_check.py を実行します。修正後、作成のステップ4と同様に再度スクリプトを実行します。
ソースと同じ形式で文書を提供します。その後、簡単な変更サマリーを提供します：主要な変更タイプ（それぞれにビフォーアフターの例を1つずつ）、構造や記述の強さを変更した箇所（「should」から「must」へ、注記からステップへ）、および未解決質問。ユーザーが完全な変更履歴を要求しない限り、変更された各文をリストアップする必要はありません。

ASD-STE100 簡易化テクニカル・イングリッシュ