mcpField
S
simple-english

simple-english

github.com/vintaドキュメント14259 回インストール今日更新
リポジトリ

simple-english について

技術的な意味、事実、文体を保ちながら、文章をグローバル向けの英語に書き換えるスキルです。明確で翻訳しやすいドキュメントを作る人向けに、文ごとの手順と確認項目を備えています。

主な機能

  1. 01原文の事実と条件の維持
  2. 02明確で翻訳しやすい表現
  3. 03コードと識別子の保持
  4. 04用語と文の明瞭さの確認
  5. 05曖昧さや情報不足の報告

活用シーン

  1. 01技術ドキュメントの書き換え
  2. 02世界中の読者に伝わる文章への改善
  3. 03用語の一貫性の確認
  4. 04原文に不足する情報の指摘

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/vinta/hal-9000 --skill simple-english

インストール後、Claude Code で/simple-englishを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

agents/
openai.yaml
references/
README.md
writing-rules.md

詳細

シンプルな英語

与えられたテキストをグローバル英語に書き換えるか、新たに作成します。これは、Google、Microsoft、MDN、Red Hat、GitLab のドキュメントで使われている、世界中の読者を対象とした英語です。構成を明確にし、曖昧さのない言葉と翻訳しやすい文法を使います。管理語彙は定めず、単語数にも厳しい上限を設けません。書き換えた文章では、元の文章と同じ技術的な事実を伝え、ネイティブスピーカーが書いたような自然な表現を保ちます。

基本ルール

  • 意味は変えません。 元の文章にあるすべての事実、値、条件、但し書きを、書き換え後も保持します。義務の度合いを弱めた表現は、そのまま弱い表現にします。たとえば、元の文章が要件として意図していない限り、「should」は推奨を表すままにします。
  • 具体的な内容を作り出しません。 個々の事実は、元の文章と同じ精度で示し、不足があれば明記します。値、名前、条件をでっち上げてはいけません。
  • 引用テキストは変更しません。 コードスパンとコードブロック、コマンド、設定キー、ファイルパス、UI ラベル、エラーメッセージ、識別子は、そのままにします。それらを囲む文章を書き換えます。
  • 文章の個性を保ちます。 明瞭さのための編集によって、文章がぶつ切りの断片になってしまうのは後退です。「注意が必要です」のような冗長な表現は自由に削れますが、文章の個性は保ちます。

ワークフロー

  1. ルールを読み込みます。 references/writing-rules.md を最後まで読みます。文の構造、言葉選び、明瞭さを高める手法、語調、置き換え表を確認します。

  2. 元の文章を集めます。 会話に含まれる文章を使うか、ユーザーが指定したファイルやセクションを読みます。既存の文章の書き換えではなく新しい文章の作成を求められた場合は、会話、コード、ファイルから伝えるべき事実を集め、それを後続のすべての手順で元の情報として扱います。書き換えるすべての文章、または伝えるべきすべての事実を把握したら完了です。

  3. 各文章を分類します。 手順(作業を示す命令文)、説明(事実を述べる文章)、マイクロテキスト(見出し、UI ラベル、エラーメッセージ)に分類します。手順には命令形を使い、条件を先に示します。明瞭さのために動詞が必要な場合は、マイクロテキストにも動詞を加えます。

  4. 用語を整理します。 同じ概念が複数の名前で表されているものをすべて書き出し、概念ごとに用語を一つ選びます(プロジェクトで定着している名前を優先します)。選んだ用語を一貫して使います。どの概念にも複数の呼び名がなく、どの単語にも複数の意味がない状態になったら完了です。

  5. 一文ずつ書き換えます。 主語・動詞・目的語の順序で主語を早めに置き、一文につき一つの考えを示します。能動態と現在形を使い、条件を先に置きます。「that」「who」や冠詞などの小さな語も省略しません。指す対象が複数考えられる代名詞は名詞に置き換え、名詞を二つ以上修飾語で積み重ねないようにします。隠れた動詞を明示します(「perform an installation」ではなく「install」)。置き換え表に従って、慣用表現や冗長な句動詞を別の表現にします。編集のたびに、Kohl の基本ルールを適用します。ネイティブスピーカーにとって不自然に聞こえる変更はしません。

  6. 各段落と文をチェックリストに照らして確認します。

    • 一つの段落につき一つの話題を扱い、最初の文で要点を述べています。
    • 主語と動詞が早い段階にあり、連結された節は三つ以下です。「there is/are」で始めていません。
    • 手順は命令形で、条件を先に示しています。
    • すべての代名詞の指す対象が明確で、すべての略語が初出時に定義されています。
    • 用語は手順 4 で整理した内容と一致し、並列する考えは並列した形で表されています。
    • 慣用表現、文化固有の表現、ラテン語の略語、方向を示す相互参照(「上記」「以下」など)を使っていません。
    • 文を声に出して読んでも自然に聞こえます。

    すべての文が条件を満たすか、意図的に例外としていて、その旨を報告に記載したら完了です。

  7. 成果物を提示します。 書き換えた文章を提示します。ファイルの編集は、ユーザーがファイルの変更を求めた場合に限り、ファイル内で直接行います。書き換えた文章の後には、該当する項目だけを報告します。

    • 用語の選択をユーザーが確認できるよう、用語の対応表を示します。
    • 元の文章が曖昧で、書き換え時に一つの解釈を選んだ場合は、その判断を示します。
    • 読者に必要な具体的な情報が元の文章にない場合は、その不足を示します。

コメント