simplified-technical-english

簡易テクニカル英語

管理言語の主要な参照資料として、ASD-STE100 Issue 9を使用します。一般的な言語上の好みよりも、プロジェクト用語と技術的な正確さを優先します。

ワークフロー

1. 読者、作業、必要な結果を特定します。
2. テキストを手順、説明、注記、安全上の指示に分類します。
3. 承認済みのプロジェクト用語、識別子、必須の文言を特定します。
4. 1つの概念には1つの用語を使用します。
5. 必要な内容をすべて含む最小限の文を作成します。
6. このファイルの該当する規則を適用します。
7. 正確な規則の対応関係を確認するとき、または詳細なレビューを行うときは、ライティング規則のリファレンスを読み込みます。
8. 語彙の詳細が重要な場合は、辞書のリファレンスを読み込みます。
9. 変更した各文を確認します。

完了したテキストは、次の条件を満たします。

• 技術的な意味を保っています。
• プロジェクト用語を一貫して使用しています。
• 解消されていない曖昧さがありません。
• 必要な条件、操作、結果、リスクがそれぞれ含まれています。

基本的なライティング規則

• 一般的で具体的な語を使用します。
• 正しい技術用語である場合は、プロジェクト用語を使用します。
• 承認済みの語は、承認された意味と語形でのみ使用します。
• プロジェクトで別の形式が必要な場合を除き、アメリカ英語を使用します。
• 能動態を使用します。
• 行為者が不明な場合に限り、受動態を使用します。
• 各操作には明確な動詞を使用します。
• 明確な動詞を名詞句に置き換えません。
• 技術用語の名詞を動詞として使用しません。
• 技術用語の動詞を名詞として使用しません。
• 複数の語で構成される名詞は、3語以内にします。
• 必要な長い用語は、わかりやすい短縮形を使用する前に導入します。
• 必要な語を省略しません。
• 短縮形を使用しません。
• 承認されていない句動詞を使用しません。
• セミコロンを使用しません。
• 複雑なテキストを読みやすくできる場合は、リストを使用します。
• 同じ対象や操作には、同じ用語と文のパターンを使用します。

手順

• 各文は最大20語にします。
• 各文には1つの指示を書きます。
• 操作が同時に行われる場合に限り、指示をまとめます。
• 各指示は命令形の動詞で始めます。
• 条件に依存するコマンドの前に条件を置きます。
• 条件の後にコンマを置きます。
• 前提条件は、それに依存する操作の前に記述します。
• 結果が重要な場合は、期待される結果を明記します。

説明と注記

• 各文は最大25語にします。
• 情報を段階的に示します。
• 各文の主語は1つにします。
• 各段落では1つの話題を扱います。
• 各段落は6文以内にします。
• 用語を繰り返すことで関連が明確になる場合は、重要な用語を繰り返します。
• 指示、要件、制限、安全に関する情報を注記に記載しません。

安全上の指示

• プロジェクトのリスクラベルを使用します。
• 負傷または死亡のリスクには警告を使用します。
• 損傷のリスクには注意を使用します。
• 明確なコマンドまたは条件から始めます。
• リスクまたは起こり得る結果を説明します。
• 安全に関する文言、測定値、制限、識別子、部品番号を保持します。

コードコメントとソフトウェアテキスト

• コードが存在する理由を説明します。
• コードが維持する規則、または自明ではない制約を明記します。
• コードの内容を言い換えて記述しません。
• 回避策の場合は、それを必要とする条件を記載します。
• 判明している場合は、関連する課題または削除条件を記載します。
• エラーメッセージには、失敗した操作または無効な値を明記します。
• ユーザーが問題を修正できる場合は、修正方法を記載します。
• メッセージが完全な文ではない場合は、リポジトリの形式を保持します。

助動詞

• 義務にはmustを使用します。
• 可能性、能力、許可にはcanを使用します。
• STEテキストでは、動詞としてmayを使用しません。
• 通常の命令文の前にmustを追加しません。

最終確認

次の質問に回答します。

• 読者は、行為者、動作、対象を特定できますか？
• 読者は、情報と指示を区別できますか？
• 各条件は、それに依存する動作より前に示されていますか？
• 各プロジェクト用語には、意味と表記がそれぞれ1つだけありますか？
• 代名詞が複数の名詞を指す可能性はありますか？
• 各手順の文は、20語以内ですか？
• 各説明または注記の文は、25語以内ですか？
• 読者が文を2通りに解釈する可能性はありますか？

確認に通らない文は、それぞれ書き直します。

ソースの確認

ソース PDF 全体をコンテキストウィンドウに読み込んだり、抽出したりしないでください。

1. Issue 9 の公式リクエストページから Issue 9 を入手します。
2. PDF を assets/ASD-STE100-ISSUE-9.pdf として保存します。
3. ASD_STE100_PDF に保存した PDF のパスを設定します。
4. 日常的な執筆とレビューには、このファイルを使用します。
5. ソースを正確に確認する必要がある場合は、範囲を限定した検索スクリプトを実行します。
6. 返された抜粋と引用されたページだけを読みます。
7. 1つの質問につき、隣接する PDF ページを3ページを超えて抽出しないでください。
8. 全体監査では、ルール群を分けて処理します。

スキルフォルダーから次のコマンドを実行します。

uv run scripts/search_issue_9.py "Rule 5.3"
uv run scripts/search_issue_9.py --word "may"
uv run scripts/search_issue_9.py --pdf ./assets/ASD-STE100-ISSUE-9.pdf "Rule 5.3"

完全なレビューを実施せずに、ASD-STE100 に完全準拠していると主張しないでください。

認証を受けている、または ASD の承認を得ていると主張しないでください。