Technical Writing Essentials

Descriptive technical writingは、視覚とテキストの組み合わせで、伝えている情報を「見せる」と「伝える」ことの両方を行います。 より創造的な説明のように、技術的な説明は、読者が説明されているものを完全に概念化できるように、時には「五感」や比喩的な比較(アナロジー)を利用することがあります。 しかし、より多くの場合、具体的で測定可能な説明文に依存します。 技術的な説明には、目的や読者によってさまざまな形態があります。 説明文は、短い文章から段落、報告書の一部分全体、あるいはマニュアル全体まで、さまざまなものがあります。 技術的な説明文の書き方が悪いと、混乱を招き、時間を浪費し、大惨事につながることさえあります。 製品の技術的な説明は、安全性やコンプライアンスを確保するために、しばしば法律で義務付けられています。 979>

製品仕様では、設計上の特徴を詳細に説明する必要があり、説明書では、読者に何をすべきかを「示す」ために、特定の記述の詳細を必要とすることがよくあります。 979>

  • Mechanism Descriptions: 可動部品を持ち、特定の機能を実行するように設計されたツール、マシンまたは他の機械装置の物理的側面の詳細な概要を提供します。 これらは、販売や製造のための製品説明、設計仕様の文書化、情報グラフィクスなどになりえます。 この章では、この種の記述に詳しく焦点を当てる。
  • プロセス記述:特定の結果を達成するために特定の順序で起こる一連のイベント(自然/生物/生態、機械、社会、または心理現象)を詳しく記述する。 これらは、非教育的プロセス(内燃機関の仕組みのプロセス分析、光合成などの自然プロセスなど)と教育的プロセス(推奨/必須手順や従うべき明確なステップバイステップの指示など)に分類される。 (指示の書き方の詳細については7.7節を参照)
  • 定義:特定の意味を明確にし、しばしば特定の文脈に関連し、または定義されている用語の本質を表現する。 これらは、単純な明確化のためのフレーズから、数ページの拡張文書まで、さまざまな長さがあります。 定義には、詳細な説明やアイデアを説明するためのビジュアルが含まれることがよくあります。 以下のリンクをクリックすると、技術的な目的のための効果的な定義の書き方に関する生徒用パワーポイントプレゼンテーションが表示されます。

Definitions in Technical Writing – Sample student presentation (.pdf)

Mechanism descriptions should provide a clear understanding of the object being described, including

  • General appearance and physical properties
  • Overall function/purpose
  • 構成部品
  • 部品がどのようにして機能しているかを明確に説明すること。

読者は、説明されているオブジェクトの性質、それが何を行い、どのように機能するかを明確にイメージでき、したがって理解できなければならない。

読者にとってこの明確さを達成するために、書き手は重要な詳細を選択し、情報を論理的に整理しなければならない。 例えば、

色質感、匂いなど、正確かつ測定可能に記述できる詳細を選択する。 味
形状 構成部品 仕上げ
サイズ 特性 パターン.platterns.platterns, デザイン
寸法 動作原理 相互作用

読者のニーズに応じて、説明は数文を要する一般概要から、技術問題のトラブルシューティングと修理完了のためにメカニズムの部品と機能のあらゆる側面を詳述する数章のマニュアルまで、さまざまであるかもしれません。 後者の楽しい例として、「スタートレック:ザ・ネクスト・ジェネレーション」をご覧ください。 979>

Cover of manual
Figure 7.4.1 Cover Page of “Star Trek: The Next Generation”: Technical Manual」

説明の下書きを始める前に、目的と読者を考慮する必要があります。 なぜ聴衆はこの説明を必要とするのでしょうか。 読者はなぜこの説明を必要とするのか、何のために使うのか。 一般消費者向けに、さまざまな種類のソーラーパネルについて説明し、ニーズに合ったものを選べるようにするためでしょうか。 979>

目的と対象者を明確に定めたら、次の要素を含む説明文を起草します:

  1. 定義。
  2. 概要:それは何であり、その主な目的は何ですか。 メカニズムの全体的な外観(「全体像」)を記述する。 ラベルの付いたセクションに主な構成部品を記述します。ここでは情報の順序を慎重に考慮してください。
  3. 説明:その機能を果たすために部品はどのように連携しているのか? その機能を支配する重要な原則は何か?
  4. ビジュアル:メカニズムおよび/またはその部品を明確に説明するグラフィックスを含める。 デバイスを全体として示し、拡大図、カットアウエイ、ラベル付きダイアグラムで特定の詳細を示すことを検討する。 デバイスの動作を示すビデオを埋め込むか、リンクしてもよい。
  5. 結論:目的に応じて、製品の歴史、入手可能性、製造、コスト、警告などをレビューすることができる。

以下の「技術説明テンプレート」のようなテンプレートの使用を検討してもよいでしょう。

さらに情報が必要でしょうか? 歴史? 警告は? 文脈? コスト? etc.

対象者および目的 誰がこの説明を読むのか、またその理由
定義および機能 これは何なのか? それは何をするものですか? その目的は何ですか?
概観 全体的な外観(形、サイズ、色。
構成要素と説明 構成要素(最も関連性の高い機能を選択)を説明し、それらがどのように作用するかを説明する
ビジュアル どんな説明用画像を使用しますか。 どこで?

  • 写真

  • 切り取り図

  • 展開図

結論
使用したソース、または提案する補足ソース

サンプル説明文

図 7.4.2 の「アップゴーアファイブ」についての説明文を調べてください(拡大するには画像をクリックしてください)。 979>

Blueprint of rocket, labeled using silly-sounding simplistic language such as fire comes out here"
Figure 7.4.2 A description of the blueprints for NASA Saturn Five rocket using only the 1000 most commonly used English words

Compare the description in Figure 7.4の記述を比較します(図7.2.2)。4.2の説明を、火星探査機キュリオシティ・ローバーに関するNASAのウェブサイトに記載されている情報と比較します。

説明の詳細度、語彙、および全体の目的の違いに注目します。 NASAのサイトの情報を使って技術説明テンプレートに記入した場合、次のようなチャートになるかもしれません。 目的

定義 Curiosity Rover – NASA の火星探査用ロボット
機能 火星のゲール クレーターを回り、データを収集して地球に送信する。 火星が生命を維持できたかどうか、そして人類がいつかそこで生存できるかどうかを確認するのが任務である
概要 車サイズの6輪ロボットで、身長は約7フィート(約126cm)。 ほぼ正方形のシャーシに、さまざまな種類のセンサーを格納する付属品がいくつか接続されている
コンポーネント
  • 本体はコンピューターを保護しています。 979>

  • シャーシの中心から出ているマストのような「ネック&ヘッド」は、ローバーの多くのカメラを収納しています。 979>

  • アーム – 約7フィートの長さで(「肩、肘、手首」の関節を持つ)、端に「手」があり、シャーシの前面から伸びています。 これには穴あけ、サンプル収集などのための多くのツールが含まれています。

  • 「Tail」 – ローバーの動力源となるラジオアイソトープのパワーソースが含まれています

視覚情報
  • 全体図(正面と側面? トップビュー?)

  • ラベル付けされた腕の様子

  • ラベル付けされた頭部と首の様子

結論/補足 寿命に関する情報? 移動速度? エネルギー使用量?
NASA website – Mars Curiosity Rover page

これらの要素のいくつかは必要ないことがわかるかもしれませんが、ターゲットオーディエンスがすでに知っていることを再度検討してみてください。 不必要に明白なことを述べたり、読者に欠けている知識があると誤って仮定したりすることのバランスをとることです。

説明とその構成要素の詳細を洗練させるには、以下を考慮してください:

  • 構成。
    • 上から下へ(または土台から上)
    • 左から右へ(または右から左)
    • 内から外へ(または外から内)
    • 最も重要な機能から最も重要でない機能
    • 中心部品から周辺部品
    • 材料の特性など

    言語:

  • ± 2223>

  • 論理原則を使用して説明を構成すること。 具体的、正確、具体的な用語を使用する – あいまいな用語や一般的すぎる用語を避ける
    • 正しい用語を使用する – 聴衆のために必要に応じて用語を定義する
    • よく知らないものをよく知るものの観点から説明するために類似を使用する
    • 客観的言語を使用 – 「ad speak」または主観的用語なし
    • 現在形を使用する。 デバイスがどのように現れ、何をするのかを説明するために、能動動詞を使用する。

    一般的で日常的なオブジェクト(図7.4.3のオブジェクトの1つなど)を選択し、オブジェクトに精通していない聴衆のための技術説明を起草します。 まず、対象者や目的を想像し、技術説明のテンプレートに詳細な情報を記入してみてください。 テンプレートの情報を使って、1-2段落の短い説明を起草し、適切にキャプションを付けたビジュアルを追加しましょう。

    Figure 7.4.3 Common objects for practice description.

    1. R.A.。 Sturnback and M. Okuna, Star Trek: The Next Generation: テクニカル・マニュアル. New York: ポケットブックス、1991年。 ↵
    2. R. マンロー、「アップゴーアファイブ」. 入手可能。 https://xkcd.com/1133/ また、「1133 Up Goer Five – explained,” Explain xkcd wiki . 利用可能です。 https://www.explainxkcd.com/wiki/index.php/1133:_Up_Goer_Five . CC-BY-NC 2.5。 ↵
    3. . . 利用可能です。 https://www.flickr.com/photos/dogbomb/527733767 と https://www.flickr.com/photos/8205548@N08/4607907389. CC BY 2.0. ↵

コメントを残す

メールアドレスが公開されることはありません。