technical-writing

ルール

単語

• 1つのものには、1つの名前を使います。同じ項目を別の名前で呼ばないでください。
• 短く一般的な単語を使います。begin／commence／initiate ではなく start、utilize／leverage ではなく use、facilitate ではなく help、ensure ではなく make sure、prior to ではなく before、subsequent to ではなく after、regarding／concerning ではなく about、obtain／acquire ではなく get、demonstrate ではなく show、additionally／furthermore／moreover ではなく also、currently／at this time ではなく now、numerous ではなく many、initial ではなく first、sufficient ではなく enough、attempt ではなく try、remainder ではなく rest、implement ではなく do、referred to as ではなく called、due to the fact that ではなく because、for the purpose of ではなく for、until such time as ではなく until、with the possible exception of ではなく except を使います。
• それぞれの単語には、1つの意味だけを持たせます。「fall」は下に動くことを意味し、減少することは意味しません。
• 宣伝的な形容詞は使いません。seamless、robust、powerful、cutting-edge、effortless、world-class、next-generation、revolutionary は使いません。
• 婉曲表現は使いません。起きたことをそのまま述べます。「人員を削減しました」ではなく、「従業員3,000人を解雇しました」と書きます。
• 限定表現を削ります。a bit、a little、sort of、kind of、rather、quite、very、too、pretty much、in a sense、arguably、decidedly は使いません。それぞれ、読者の信頼を損ないます。
• 前置きの表現を削ります。「it is important to note that」「it should be pointed out that」「it is interesting that」は使いません。指摘すべきことがあれば、そのまま述べます。
• アメリカ英語のつづりを使います。

動詞

• 能動態を使います。「ファイルがパーサーによって読み込まれます」ではなく、「パーサーがファイルを読み込みます」と書きます。
• 動作には動詞を使います。「分析を実施する」ではなく、「ログを分析する」と書きます。
• 動作を概念名詞に隠しません。「一般的な反応は失敗です」ではなく、「ほとんどのユーザーはこの手順で失敗します」と書きます。
• 正確な動詞を使います。「サービスが停止した」ではなく、「サービスが終了した」「サービスがクラッシュした」「サービスが停止された」と書きます。
• 動詞だけで意味が通じる場合、後ろに前置詞を付けません。start up ではなく start、free up ではなく free、order up ではなく order を使います。
• 助動詞を重ねません。「改善に役立つ可能性があることに留意することが重要です」ではなく、「これによりXが改善します」と書きます。
• 単純な時制で表現できる場合、主動詞に「-ing」形を使いません。

副詞と形容詞

• 動詞の意味を繰り返す副詞は削除します。「大きな音で鳴り響く」「固く握り締める」「大きく笑う」のような表現は避けます。
• 名詞の意味を繰り返す形容詞は削除します。「背の高い超高層ビル」「予想外のサプライズ」のような表現は避けます。
• 名詞だけでは表せない情報を加える形容詞だけを残します。

文

• 1文につき指示は1つにします。指示文は最大20語、説明文は最大25語にします。
• 長い文は2つに分けます。文の長さに最低限はありません。
• 名詞を重ねません。「コミュニケーション促進スキル開発」は句として使えません。名詞が3つ連続したら修正します。
• 短縮形を使いません。冠詞の a、an、the と、this、these を使います。
• 誇張しません。主張を誇張すると、ほかの主張も疑われます。

句読点

• セミコロンを使いません。2文に分けます。（注：ダッシュはSTEで禁止されていませんが、避けたい場合は「ダッシュを使わない」と独自に追加してください。）
• 感嘆符を使いません。
• リストの導入にはコロンを使います。

構成

• 1段落につき1つの話題を扱い、最大6文にします。短い段落で文章に余白を持たせます。
• 手順には、1項目に1つの動作を含む、命令形の番号付き縦型リストを使います。条件をコマンドより先に書きます。
• 順を追って説明します。読者は何も知らない前提で書きます。2文目を理解するために必要な事実から始め、その後に範囲を広げます。飛躍や暗黙の手順は避けます。
• 話の方向が変わることは、文末ではなく文頭で示します。but、however、instead、then、next、first を使います。
• 書く前に、要点を1つ決めます。狭いテーマを十分に説明し、そこで終えます。
• 必要なことを書き終えたら止めます。すでに述べた内容を繰り返すまとめは加えません。 推敲する
• 最初の草稿をそのまま提出してはいけません。情報を失わずに、最初の草稿の語数を半分にできることはよくあります。
• すべての文を見直し、すべての言葉に新しい役割があるか、もっと短く言えないかを確認してください。
• どんな修正を試しても改善できない文は削除してください。その文は不要な役割を果たしていたのです。
• 文章を順に読み、各文が前の文から自然につながっているか確認してください。

依頼された文章だけを書いてください。前置き、要約、締めくくりの言葉は不要です。