Technical Writing Essentials

はじめに: 説明書のはじめは慎重に計画しましょう。 以下のいずれかが含まれるかもしれません（ただし、必ずしもこの順序である必要はありません）。

• 説明する特定のタスクや手順、範囲（何がカバーされ、されないか）を示す
• 指示を理解するために、知識と背景の面で聴衆が必要とするものを示す
• 手順とそれが達成するものの概要のアイデアを与える
• これらの指示を使用すべき（またはすべきでない）状況を示す
• 指示内容の概要を与えることです。

一般的な警告、注意、危険に関する通知：指示はしばしば、機器を台無しにしたり、手順を失敗したり、自分自身を傷つけたりする可能性について読者に警告しなければならないことがあります。 また、指示はしばしば重要なポイントや例外を強調しなければなりません。 このような場合、特別な表示-注、警告、注意、危険の表示を使用します。 6760>

技術的背景または理論： ある種の指示の最初（導入部の後）には、手順に関連する背景の議論が必要な場合があります。 ある種のインストラクションでは、この背景は非常に重要です-さもなければ、手順のステップが意味をなしません。 例えば、赤、緑、青のスライダーバーを動かして自分の色を定義するアプレットソフトウェアを使ったことがあるかもしれません。 このような場合、色に関する知識がないと、何をやっているのかよくわかりません。 同様に、カメラを使用する特定の指示では、ある程度の理論が必要かもしれないと想像できます。

設備と消耗品： ほとんどの指示には、手順を開始する前に収集する必要があるもののリストが含まれていることに注目してください。 これには、手順で使用する道具である設備（ボウル、スプーン、パン焼き器、ハンマー、ドリル、のこぎりなど）と、手順で消費するものである消耗品（木材、塗料、油、小麦粉、釘など）が含まれます。 説明書では、これらは通常、単純な縦書きリストか、2列のリストのどちらかで記載されます。 例えば、ブランド名、サイズ、量、種類、モデル番号などである。

ステップの議論：ステップを実際に書くとき、心に留めておくべきいくつかの事柄がある。 (1) それらのステップの構造と形式、(2) 必要と思われる補足情報、(3) 視点と一般的な書き方。

構造と形式：通常、一連の説明書は、縦長の番号付きリストとして形式化されていると想像されます。 そして、実際ほとんどがそうです。 通常、実際のステップバイステップの説明書もこのような形式をとります。

• 固定順序の手順は、提示された順序で実行する必要がある手順です。 例えば、車のオイルを交換する場合、オイルを排出することは、新しいオイルを入れる前に行わなければならないステップである。
• 可変順序ステップとは、実質的にどのような順序でも実行できるステップのことである。 良い例としては、トラブルシューティングのガイドで、何かを修理しようとしているときに、これをチェックし、それをチェックするように指示するものがあります。 これらの種類のステップは、実質的に任意の順序で実行できます。 このタイプでは、箇条書きのリストが適切な形式である。
• 代替ステップは、同じことを達成するための2つ以上の方法が提示されているものである。 代替ステップは、さまざまな条件が存在する場合にも使用される。 このタイプでは、代替案の間にORを挿入した箇条書きリストを使用するか、代替案がこれから提示されることを示すリードインを使用する。
• 入れ子ステップは、手順内の個々のステップがそれ自体かなり複雑で、サブステップに分解する必要がある場合に使用されることがある。 この場合、さらにインデントし、サブステップをa、b、cのように並べる。
• 「ステップレス」命令は、番号付き垂直リストを本当に使用できない場合や、読者にストレートなインストラクションスタイルの指示を提供する場合に使用することができる。 状況によっては、一般化されていたり、可変的であったりするため、ステップを示すことができない。

補足説明：しばしば、読者にこうしなさい、ああしなさいというだけでは十分ではない。 例えば、ステップの前後で物事がどのように見えるべきか、なぜこのステップを行うことに注意を払うべきなのか、何をしているのかの背後にある機械的原理は何か、さらにステップのミクロレベルの説明、つまりステップを構成する特定のアクションの議論が必要である。 実際のステップ、つまり読者が取るべき具体的なアクションを目立たせたいのです。 それが大量の文字に埋もれてしまっては困ります。 この問題を避けるために、少なくとも2つのテクニックがあります。補足から指示を別の段落に分けるか、指示を太字にするのです。