Technical Writing for Technicians

テクニカルライティングの最も一般的かつ重要な用途の1つは、指示書です。何かを組み立てる、何かを操作する、何かを修理する、あるいは読者がより理解し、場合によっては自分で使えるように、個人のプロセス（たとえば、大学への入学）を説明する、というように、何かを行う方法を段階的に説明しています。 学校では、教師が頻繁にプロセス課題を課します。 例えば、人文科学の教授は、芸術や文学の時代がどのように発展してきたかについての説明を求め、歴史の教授は、文化の指導者たちの時代にわたる貢献について、社会科学の教授は、発明の年表について、工学の教授は、音が電気信号に変わる仕組みについての説明を、ビジネスの教授は、連邦準備制度の仕組みや製品の売り方について求めます。

日常的には、レシピ、新しいソフトウェアのユーザーマニュアル、ダイエット方法、学校や職業で成功するにはというアドバイスコラムなどの記述式のプロセスを読むことができます。 これらのテキストは、次の質問のいずれかに答えることに焦点を当てています：

• 「これはどのように行われますか」
• 「これを行うにはどうしたらいいですか」

プロセス レポートや一連の説明書のトピックはさまざまですが、多くは類似点を共有しています：ほとんどが何かが機能する方法を説明するために書かれており、ほとんどは番号が付いたステップを使って時系列に構成されており、ほとんどは視覚に広く頼っています。 たとえば、新しいソフトウェアプログラムを学習するための説明書を書く場合、ライターはスクリーンショットやスクリーンビデオを使用して、チュートリアルを通してユーザーに説明することがあります。 しかし、ビジュアルの使用は、聴衆と指示の使用目的によって異なる場合があります。 ビジュアルは、言葉だけでは説明しにくい概念を明確にするのに役立ちます。 グラフィックは、何かがどのように見えるか、ステップが完了した後に何かがどのように見えるべきか、何かがどのように行われるか、または構築されるか、傾向や関係を示す、プロジェクトに活気を与える、または単に情報を整理するために使用することができます。 グラフィックは、ほとんどすべての人（子供や異なる言語の人を含む）が視覚的な指示を理解し、完了する必要があるものを正確に見ることができるので便利です。

Types of Instructions

There are three main types of process texts:

• • Descriptive processes: these answer the question, “How is this done? これらのテキストは、読者がそれをよりよく理解できるように、プロセスがどのように発生するかを説明します。 たとえば、直接ではなく、オンラインでコースを登録した方法について説明的なプロセスを書くと、オンライン登録を行ったことがない人に役立つかもしれません。

• • 処方プロセス：これらは本質的に説明しています；それは、何かがどう行われる（または行われるべき）かを、読者が自分で行えるように説明する。 これらは、最も一般的なタイプの説明文書である。 例えば、オイル交換、スパークプラグのチェック、ブレーキパッドの交換など、車の基本的なメンテナンスの方法を説明するユーザー向けの処方的プロセスガイドを書くことができます。

• • • ブレンド記述的および記述的プロセスは、読者がどのようにプロセスを実行できるかを要約するいくつかのセクションを持つ文書の主な推論は、説明プロセスであることができます。 言い換えれば、書き手は1つのテキストの異なる部分で「どのようにこれを行うことができますか」と「どのようにこれを行うのですか」の両方を扱うことができます。 あるいは、同じ文書の異なるバージョンを、ユーザーのオーディエンスと利害関係者のオーディエンスの2つのオーディエンス向けに開発するかもしれません。1

      インストラクションを書くプロジェクトや課題の始めに、読者を考慮し、書く予定の特定の手順の特徴（タスクやステップの数）を決めることが重要です。

      Audience and situation: プロセスの早い段階で、指示の対象者と状況を定義します。 読者を定義することは、そのトピックに関する知識や親しみのレベルを定義することであることを忘れないでください。 最初に自分自身に聴衆を説明し、それが聴衆に適切であることを確認するために、最後にメッセージを評価するためにそれを使用することは、時には便利です。 タスクの数：重要な考慮点は、インストラクションを書いているプロシージャーにいくつのタスクがあるかということです。 タスクは、手順内の半独立したアクションのグループを定義するために使用される一方で、手順という用語は、あなたのインストラクションが議論するアクティビティのセット全体を参照するために使用することができます。 たとえば、モデムを設定することは、コンピュータをインターネットに接続する全体的な手順の 1 つのタスクです。

      別の例として、車のオイル交換のような単純な手順には 1 つのタスクだけが含まれており、他のアクティビティの半独立したグループはありません。 電子レンジの使用などのより複雑な手順には、クロックの設定、パワーレベルの設定、タイマーの使用、電子レンジのクリーニングとメンテナンスなど、多くの半独立タスクが含まれています。 たとえば、子供用のブランコを組み立てるための一連の指示書を想像してみてください。 1 つの効果的なアプローチは、類似および関連するステップをフェーズにグループ化し、新しいフェーズごとにステップの番号を変更することです。 フェーズとは、1つのタスクの手順の中で、類似したステップをグループ化したものです。 ブランコの例では、フレームを設置するのが 1 つのフェーズ、地面に物を固定するのが別のフェーズ、ボックス ブランコを組み立てるのがさらに別のフェーズになります。

      Focusing Instructions

      もう 1 つの考慮事項は、おそらく初期には決定できないことですが、指示に焦点を当てる方法です。

      • • 電話応答機の使用に関する説明へのタスクのアプローチでは、挨拶の録音、メッセージの再生、メッセージの保存、メッセージの転送、およびメッセージの削除に関するセクションがあるでしょう。
    • • • 一方、コピー機の使い方のツールアプローチでは、コピーボタン、キャンセルボタン、拡大/縮小ボタン、丁合/綴じ込みボタン、用紙トレイ、コピーサイズボタンなどに関するセクションがあります。 この計画で説明書を設計した場合、コピー機の各ボタンや機能の使用手順を書くことになるでしょう。

    説明書の内容

    説明書を作る前に必ず「文書の設計」の項を読んでください。 以下の項目を含めてください：

    はじめに。

    • • • 説明する特定のタスクや手順を示す。
        • 指示を理解するために、聴衆が知識や背景で何が必要かを示す。
        • 手順とそれが達成することの一般的なアイデアを示す。
        • これらの指示を使用すべき（または使用すべきでない）条件を示す。

    一般警告、注意、危険告知を行う。 インストラクションは、読者が装置を壊したり、手順を失敗したり、怪我をしたりする可能性があることを警告しなければなりません。 また、重要なポイントや例外を強調する必要があります。 これらの状況では、Note、Warning、Caution、Danger などの特別な通知を使用する必要があります。 いくつかのインストラクションの最初(通常イントロダクションの後)で、プロシージャーに関連した背景の議論が必要な場合があります。 ある種のインストラクションでは、この背景は非常に重要です-さもなければ、プロシージャのステップが意味をなしません。 場合によっては、インストラクションの作成者は、プロセスに関わる実際のステップに進む前に、読者に物事を説明するためにかなりの時間を費やす必要があるかもしれません。 ほとんどの説明書には、手順を開始する前に収集する必要があるもののリストが含まれています。 これには、手順で使用する道具である設備（ボウル、スプーン、パン焼き器、ハンマー、ドリル、のこぎりなど）と、手順で消費するものである消耗品（木材、塗料、油、小麦粉、釘など）が含まれます。 説明書では、これらは通常、単純な縦のリストか、説明書の最初にある2列のリストのどちらかに記載されます。 ブランド名、サイズ、量、種類、モデル番号など、一部またはすべての項目に仕様を追加する必要がある場合は、2列のリストを使用する

    手順の考察 ステップを実際に書く際には、ステップの構成や形式、必要と思われる補足情報、説明書の視点や一般的な書き方を慎重に検討する必要があります。

    * 一般的に言って、インストラクションを書く人は以下のことを心がけるべきである。

• • プロセスを技術的に詳しく完全に理解すること。

• • あなたの指示を使用する読者の立場に立つよう努力すること。2
    

    生徒用指示サンプル

    • 溶接指示サンプル（生徒用サンプル）
    • メカトロ指示サンプル – ダイオードのテスト & トランジスタ（生徒用サンプル）
    • 自動車/ディーゼル指示 – トヨタカローラのリアスウェイバーを交換する方法（生徒用サンプル）
    • ベッド 乗換案内（生徒用サンプル）
    • ギターの弦の交換方法（生徒用サンプル）

    プロ用指導サンプル

    • 溶接について 説明書サンプル1（プロ用サンプル）
    • バービードリームハウス（プロ用サンプル）
    • トランポリン組み立て（プロ用サンプル）

    。