この章では、テクニカルライティングの中でも最も重要な用途のひとつであるインストラクションに焦点を当てます。 ご存知のように、指示とは何かを行う方法、つまり物事を組み立てたり、操作したり、修理したり、メンテナンスしたりする方法を段階的に説明するものです。
Writing Instructions
テクニカルライティングの最も一般的かつ最も重要な用途の1つは指示-何かを行う方法を段階的に説明するものです：何かの組み立て、何かの操作、何かの修理、何かの定期メンテナンスなどです。 しかし、一見簡単で直感的に理解できるように見える説明書ですが、その書き方は最悪の部類に入ります。 私もそうですが、皆さんもひどい説明書を見て腹立たしい思いをしたことがあるのではないでしょうか。 この章で紹介するのは、説明書の書き方についての万全のガイドではありませんが、プロが考える最高のテクニックを紹介します。
結局のところ、良いインストラクションの書き方には以下のことが必要です。
- 明瞭でシンプルな文章
- 手順の技術的な詳細を完全に理解していること
- 読者の立場に立って、その指示を使用しようとする人の立場に立つ能力
- 手順の詳細を視覚化して、その認識を紙に書き出す能力
- そして最後に、さらなる距離を置いて、その指示を書いた人にテストする意欲があるかどうかです。
ここまでで、あなたはおそらく見出し、リスト、および特別な通知について勉強してきました。 ただ、議論を番号付きの縦書きリストに分割し、明白なポイントに特別な注意を投げ込めば、それで完了です。 そうではありませんが、これは素晴らしいスタートです。 この章では、命令をより複雑にする可能性のある、命令の特徴をいくつか探ります。
いくつかの前置き
説明書を書くプロジェクトの始めに、あなたが書こうとしている特定の手順の構造や特徴を決定することが重要です
Audience and situation. プロセスの早い段階で、インストラクションの対象者と状況を定義します。 聴衆を定義することは、そのトピックに対する親しみの度合いや他の詳細を定義することを意味することを忘れないでください。 聴衆の定義と聴衆の定義で使用する手順の説明を参照してください。
最も重要なことは、ライティングコースにいる場合、聴衆の説明を書き、それを指示に添付する必要があるということです。 これにより、講師は意図された読者に対する指示の正しさの観点から、あなたの指示を評価することができます。 また、テクニカルライティングのコースでは、専門家ではない読者に向けて書くことが望ましいということも覚えておいてください-ライターとしてのあなたにとって、より多くの挑戦です。 あなたが書こうとしている手順には、いくつのタスクがありますか。 ここでは、手順という用語を使って、あなたの指示で議論することを意図した一連の活動全体を指すことにしましょう。 タスクは手順の中の半独立した行動のグループです。例えば、電子レンジの時計をセットすることは、電子レンジを操作するという大きな全体の手順の中の1つのタスクです。
車のオイル交換のような単純な手順には1つのタスクしか含まれておらず、半独立した活動のグループは存在しない。 電子レンジを使うような複雑な手順には、時計を合わせる、電力レベルを設定する、タイマーを使う、電子レンジを掃除してメンテナンスする、などの半独立したタスクがたくさん含まれています。 (カメラの使用に関する説明書はタスクで構成されています。)
タスクは1つだけですが、その1つのタスクの中に多くのステップがある説明書もあります。 たとえば、子供用のブランコを組み立てるための一連の説明書を想像してください。 私自身の経験では、130 以上のステップがありました! これはちょっと大変なことです。 そこで、似たような手順や関連する手順をフェーズごとにまとめ、新しいフェーズに入るたびに手順番号を付け直すという方法が有効です。 フェーズとは、1つのタスクの手順の中で、類似したステップをまとめたものです。 ブランコの例では、フレームを設置するのがフェーズ、地面に固定するのがフェーズ、箱型ブランコを組み立てるのがフェーズとなります。
ステップバイステップの議論に最適なアプローチです。 もう1つの考慮点は、もしかしたら早い段階で判断できないかもしれませんが、インストラクションをどのように集中させるかということです。 ほとんどの指示では、タスクに焦点を当てることもできますし、ツール (またはツールの機能) に焦点を当てることもできます。
電話代行サービスの使用に関する指示に対するタスクアプローチ（タスク指向としても知られている）では、次のセクションがあります。
- 挨拶を録音する
- メッセージを再生する
- メッセージを保存する
- メッセージを転送する
- メッセージを削除する、など
これらはタスク、つまり機械でやりたいことの典型的なものである。 さらなる議論はタスク解析の章を参照。
一方、コピー機の使い方を説明するツール・アプローチでは、このようなありえないセクションがあります。
- コピーボタン
- キャンセルボタン
- 拡大/縮小ボタン
- 折りたたみ/ホッチキスボタン
- コピーサイズボタン、など
この計画で説明書をデザインすると、コピー機のそれぞれのボタンや機能を使って手順を書いていくことになるのでしょう。 この道具のアプローチによる説明書は、うまく作るのが難しいです。 ボタンの名前と関連するタスクがまったく一致しないこともありますし、タスクを達成するために1つのボタンだけでなく複数のボタンを使わなければならないこともあります。 それでも、ツール/機能アプローチが望ましい場合があります。
タスクのグループ化。 タスクをリストアップすることは、必要なことのすべてではないかもしれません。 非常に多くのタスクがあり、読者が個々のタスクをより簡単に見つけることができるように、それらをグループ化しなければならないかもしれません。 例えば、以下はインストラクションでよく使われるタスクのグループ化である。
- 開梱とセットアップタスク
- インストールとカスタマイズタスク
- 基本操作タスク
- 定期メンテナンスタスク
- トラブルシューティングタスク、など
Common Sections in Instructions
以下は、指示書によく含まれるセクションについての概説です。 それぞれが実際に書く命令の中になければならないとか、ここで紹介する順序でなければならないとか、一組の命令の中で可能な唯一のセクションであるとは思わないでください。
命令によくあるセクションについての以下を読みながら、命令の例をチェックしてください。
命令の模式図。
Introduction: これは内容や構成に関する典型的または一般的なモデルであり、他の多くのモデルが可能であることを覚えておいてください。 説明書の序文を注意深く計画すること。
- 説明する特定のタスクや手順、およびカバーする範囲（何がカバーされないか）を示します。
- 手順とそれが達成することの一般的なアイデアを示す。
- これらの指示が使用されるべき（または使用すべきでない）条件を示す。
指示内容の概要を示す。
さらなる議論は導入のセクションを参照してください。 インストラクションは、しばしば読者に、機器をダメにする可能性、手順を失敗する可能性、そして自分自身を傷つける可能性について警告しなければなりません。 また、指示はしばしば重要なポイントや例外を強調しなければならない。 このような場合、特別な表示-注、警告、注意、危険の表示が使われます。 9583>
技術的な背景や理論。 ある種の指示の冒頭で（もちろん序文の後で）、手順に関連した背景の議論が必要な場合があります。 ある種のインストラクションでは、この背景は非常に重要です-さもなければ、手順のステップが意味をなしません。 例えば、赤、緑、青のスライダーバーを動かして自分の色を定義するアプレットソフトウェアを使ったことがあるかもしれません。 このような場合、色に関する知識がないと、何をやっているのかよくわかりません。 同様に、カメラを使用する特定のインストラクションでは、何らかの理論が必要であることは想像がつくでしょう。 ほとんどのインストラクションには、手順を開始する前に収集する必要があるもののリストが含まれていることに注意してください。 これには、手順で使用する道具である設備（ボウル、スプーン、パン焼き器、ハンマー、ドリル、のこぎりなど）と、手順で消費するものである消耗品（木材、塗料、油、小麦粉、釘など）が含まれます。 説明書では、これらは通常、単純な縦書きリストか、2列のリストのどちらかで記載されます。 例えば、ブランド名、サイズ、量、種類、モデル番号などである。
ステップの議論 実際にステップを書く際には、いくつかの注意点がある。 (1) それらのステップの構造と形式、(2) 必要と思われる補足情報、(3) 視点と一般的な書き方です。
構造と形式 通常、私たちは一組の指示書が縦の番号付きリストとしてフォーマットされていることを想像します。 そして、実際ほとんどがそうです。 通常、実際のステップバイステップの説明書もこのような書式にします。
- 固定順序の手順は、提示された順序で実行する必要がある手順です。 例えば、車のオイルを交換する場合、オイルを抜くことは新しいオイルを入れる前に行わなければならないステップです。 これらは番号付きリスト（通常、垂直番号付きリスト）です。
- 可変順序のステップとは、実質的にどのような順序でも実行できるステップのことです。 良い例としては、トラブルシューティングのガイドで、何かを修理しようとしているときに、これをチェックし、それをチェックするように指示するものがあります。 これらの種類のステップは、実質的に任意の順序で実行できます。 このタイプでは、箇条書きのリストが適切な形式です。
- 代替ステップは、同じことを達成するための2つ以上の方法が提示されるものです。 また、様々な条件が存在する場合にも代替手順が使用される。 このタイプでは、代替案の間にORを挿入した箇条書きリストを使用するか、代替案がこれから提示されることを示すリードインを使用する。
- Nested steps. いくつかのケースでは、プロシージャ内の個々のステップはそれ自体がかなり複雑で、サブステップに分解する必要があります。 この場合、さらにインデントし、サブステップをa、b、cというように並べる。 最後に、番号付き垂直リストを使用することができず、読者に直接指示することがほとんどできない命令が存在する。 状況によっては、一般化されていたり、可変的であったりするため、手順を示すことができないのである。
これらの可能性のスタイルとフォーマットについては、リストに関する章を参照してください。 多くの場合、読者にこうしなさい、ああしなさいと言うだけでは十分でないことがある。 読者は、ステップの前後で物事がどのように見えるべきか、なぜこのステップを行うことに注意を払うべきか、何をしているかの背後にある機械的原理は何か、さらにステップのよりミクロレベルの説明、ステップを構成する特定のアクションの議論を必要とします。 実際のステップ-読者が取るべき具体的な行動-を目立たせたいのです。 それが大量の言葉の中に埋もれてしまっては困ります。 この問題を避けるために、少なくとも 2 つのテクニックがあります。補足から説明を別の段落に分割する、または説明を太字にすることです。 太字にすることで、実際の動作と補足情報を区別しやすくなります。
書き方。 実際に指示を一文ずつ書く方法は、以前のライティングのクラスで教わったことと矛盾しているように見えるかもしれません。 しかし、「現実の」指示書がどのように書かれているかに注目してください。彼らは命令形（コマンド、または直接アドレス）の種類の文章をたくさん使い、「あなた」をたくさん使っています。 それはとても適切なことです。 読み手の顔を見て、その人の全神経を引きつけたいのです。 そのため、命令文のような文章は、次のようになります。 「さて、フロントパネルのポーズボタンを押して、ディスプレイを一時的に停止してください」「…に注意する必要があります」
特に問題となるのは、指示における受動態の使用です。 なぜか奇妙なことに、こんなふうに聞こえる指示がある。 “一時停止ボタンを押すと、表示が一時的に停止します。” 一時停止ボタンの精神状態が心配になるだけでなく、誰がそれを押せばいいのか（私に言っているのか）疑問です。 また、こんな例もあります。 “タイマーボタンは3時にセットされています。” ここでも、この指示に従う者として、あなたはこれを見逃すかもしれません。単に既存の状態を参照していると考えるかもしれませんし、”私に話しかけているのか？”と思うかもしれません。 また、三人称で表現するのもよくありません。 “ユーザーは一時停止ボタンを押すべきです。” ここでもまた、二度見されることになります。部屋を見回し、”私は誰？”と思ってしまうのです。 (詳細は受動態の問題を参照)
説明書の書き方に関する典型的な問題のもう一つは、人々が記事を省きたがるようだということです。 “Press Pause button on front panel to stop of information temporarily” とか “Earthperson, please provide address of nearest pizza restaurant.” といった具合です。 なぜ、このようなことをするのでしょうか？ みんな、内心ではロボットになりたいと思っているのでしょうか？
Graphics in Instructions
おそらく他のどの形式の文章よりも（たぶんマンガを除いて）、グラフィックは説明書に不可欠です。 時には、言葉だけではそのステップを説明できないことがあります。 イラストはしばしば、読者が何をすべきかを視覚化するのに重要です。
テクニカルライティングのコースでは、説明書にイラストや他の種類のグラフィック（通常使用されるものなら何でも）を含めるよう要求される場合があります。 もちろん、自分の指示に適したグラフィックが手に入らない、自分の絵心に自信がない、という問題もあるでしょう。 このような問題を解決する方法があります。 グラフィックスにある提案を見てください。 その章では、グラフィックを作成するための提案だけでなく、そのフォーマットに関する要件も記載されています。
Format in Instructions
Headings. 説明書では、見出しを上手に使ってください。 通常、背景のセクション、機器と消耗品のセクション、実際の指示セクションの一般的な見出し、およびそのセクション内の個々のタスクまたはフェーズの小見出しが必要です。 本章の冒頭の例を見てください。 一般的な要件については見出しを参照してください
Lists. 同様に、説明書は一般的にリスト、特に実際のステップバイステップの説明のための番号付き縦型リストを多用します。 機器や消耗品のセクションでは、シンプルな縦書きリストや2列のリストが通常適しています。 文章中のリストは、これから起こることの概要を説明する場合に適しています。 一般的な要件については、リストを参照。 インストラクションでは、読者が機器を損傷したり、消耗品を無駄にしたり、手順全体を失敗させたり、自分自身や他人を傷つけたりする可能性があることを警告する必要があります – 重傷または致命的であっても。 このような特別な注意事項がない、特別な注意事項の書き方が悪い、あるいは特別な注意事項が適切でないとして、企業が訴えられることがあります。 特別な注意事項の適切な使用方法、書式、説明書内の配置については、「特別な注意事項」を参照してください。
インストラクション内の通知のインデント（字下げ）。 最初の例では、通知が前のステップのテキストにインデントされていることに注目してください。 2番目の例では、厳しい通知がどのステップの前にも最初に置かれていることに注目してください。
数字、略語、記号。 説明書には、数字や略語、記号もふんだんに使われています。
Revision Checklist for Instructions
説明書を読み直し、修正する際には、次のような問題に気をつけましょう：
- Make sure you provide real instructions – how to build, operate, or repair something.
- Write a good introduction in it, indicate the exact procedure to be explained, indicate audience requirements, provide an overview of contents.
- 適切な場所で様々なタイプのリストを使用するようにしましょう。 特に、連続したステップには番号付きの縦書きリストを使用する。
- すべての主要セクションをマークするために見出しを使用し、サブセクションには小見出しを使用する。 (タイトルと最初の段落の間に「はじめに」という見出しは必要ないことを忘れないでください。 この課題では第一レベルの見出しを使用しないことを忘れないでください。
- 必要に応じて特別な注意を使用してください。
- 重要なアクションやオブジェクトを説明するためにグラフィックを使用する。
- 必要に応じて手順の補足説明を追加する。
この章に関するあなたの考え、反応、批判を感謝します：あなたの反応-デビッド・マクマーリー
.