修辞学的に効果的な取扱説明書を作る

取扱説明書

多くの人は、取扱説明書というと、家電製品やコンピューターの付属品、組み立てが必要な製品（例：家具）を連想するのではないでしょうか。取扱説明書を定期的に使用することがなかったり、特定の状況でのみ期待するようになるため、取扱説明書の重要性を忘れがちになるのです。そのため、取扱説明書がいかに優れたものであるかということに気づかないことがあります。しかし、本棚やおもちゃを組み立てるとき、あるいは特定の家電製品の設定を変更したり有効にしたりする方法を見つけ出そうとするときに、よく設計された取扱説明書の重要性が明らかになるのです」

取扱説明書の修辞状況を理解する

取扱説明書は、他のタイプのテキストと同様に修辞状況によって形作られる。テクニカルライターが内容や形式に関して行う選択は、取扱説明書の目的、想定読者、および取扱説明書が使用される状況によって異なります。

目的

一般的に、取扱説明書の目的は、ユーザーに製品をよく知ってもらうこと、および/または、タスクの完了につながる一連のステップを通じてユーザーを導くことです。しかし、各取扱説明書には、より具体的な成果もあります。その具体的な成果とは何かを特定することで、コンテンツやデザインについて、より効果的な修辞的決定を下すことができます。自問自答：

説明書の具体的な意図する結果は何ですか？ (例: ゼロからケーキを焼く、エアコンをインストールするなど)
ユーザーが主な目的の結果に到達するのを助けることに加えて、マニュアルが提供する他の目的はありますか。 (例: トラブルシューティングのアドバイスを提供する、主な目的を達成するために必要な追加の単純作業を達成する方法をユーザーに教える)

読者

読者のプロファイルを作成することは、範囲、内容、デザインについて熟考した選択をするために不可欠です。執筆前に、対象者に関する以下の質問を検討してください：

取扱説明書のトピックに関する対象者の慣れや専門知識はどの程度ですか？
ソフトウェア、アプリ、レシピなどに関連した新しいスキルを学ぶ対象者の一般的な快適度はどの程度ですか？

コンテキスト

コンテキストとは、取扱説明書の作成と使用を取り巻く時間的、社会的、技術的、文化的な状況のことだと考えてください。

この取扱説明書を完成させるためにどれくらいの時間がありますか？
ユーザーに時間の制約はありますか？
取扱説明書を作成するにあたって考慮しなければならない技術的制約がありますか？技術的なスキルやアクセスレベルを考慮してください。
読者はどのようにしてマニュアルにアクセスしますか。 (例: 受講者は会社のWebサイトからオンラインでマニュアルにアクセスできる)
受講者がすでに持っていると想定している追加のツールまたは資料は何ですか。彼らは指示に従うために必要な技術や材料にアクセスできますか。 (例: 本棚をうまく作るには、ユーザーはハンマー、ドライバー、オープンな作業スペースが必要です)
説明書を書くときは、どんな文化的観点からですか。読者はこの文化的背景を共有するのでしょうか。 (例：バニラシュガーというアメリカではなかなか手に入らない材料を使ったドイツのレシピは、アメリカのユーザー向けに修正する必要があるかもしれません)

Using Knowledge of Rhetorical Situation to Make Effective Rhetorical Choices

ほとんどの取扱説明書はいくつかの標準規約に依存していますが、それぞれの取扱説明書は与えられたコンテキスト内で特定のオーディエンスのために特定の目的を果たすよう調整されるべきものです。 5517>

Scope

修辞的な状況は、取扱説明書に含めるべき詳細の量を決定するのに役立ちます。たとえば、机を組み立てるための取扱説明書の範囲は、机を組み立てるという 1 つの結果しかないため、容易に決定できます。しかし、デジタル一眼レフカメラの取扱説明書は、アマチュアと経験者の両方を対象としており、基本的な作業（バッテリーやメモリーカードの取り付けなど）だけでなく、より高度な作業（例．

Content

取扱説明書の標準的なセクションには、フロント事項、導入、一連の手順、結論、バック事項がありますが、マニュアルによっては、これらのセクションのすべてを使用しない、またはこのようにラベル付けしないものもあります。例えば、より長く、より複雑なマニュアルでは、前面や背面の内容が充実していることがよくあります。しかし、ほとんどの説明書には、手順を安全かつ効率的に完了するために必要な情報を提供する序文が含まれています。序文には、誰がその作業を行うべきか（ある技術に熟練していることが必要かもしれません）、必要な材料、ユーザーが取るべき注意事項（安全上のヒントやその他の警告）、場合によっては作業にかかる時間の目安（レシピによく見られる特徴）などが記載されています。場合によっては、なぜその指示に従わなければならないかについての説明も必要です。例えば、車のオイル交換の指示では、なぜその作業が車の正常な機能のために必要なのかを説明することがある。

この導入資料に続くのは、ステップバイステップの指示のシーケンスである。明確で効果的なステップを起草する方法については、次の「言語」のセクションを参照してください。 5517>

言語

上記の「聴衆」と「文脈」についての質問は、効果的な言語選択をするための指針になります。以下のサブセクションでは、取扱説明書の一般的な言語的特徴の説明と、このジャンルで明確かつ簡潔に書くためのヒントがあります。

Imperative mood

命令は、命令のように、しばしば命令形を使用します。この方法で書くには、能動態と特定の動詞を使用して聴衆に直接対処します。

「赤いボタンを押してゲームを始めましょう」
「赤いボタンが押されるとゲームが始まります」
「操作者はボタンを押すべきです」

ユーザーはおそらくこれらの文章のどれかを理解することができますが、最初のものはユーザーが実行すべき動作について最も明確に説明するものです。 2 番目の受動構文は、誰がボタンを押すべきかを特定していません。 5517>

Word Choice

説明書を書くとき、場合によってはユーザーの安全が脅かされることもあるので、言葉の選択を慎重に検討することが重要です。このため、明確で簡潔な表現を心がけましょう。言葉の選択について効果的な決定をするために、主要な読者の専門知識のレベルや文化的背景を考慮する。

複雑な用語を定義する、
頭字語は初めて登場するときにスペルアウトする（例:,
ユーザーを混乱させるような比喩、隠喩、俗語、または置換を使用しない。
多言語への翻訳を含める。
簡潔で情報量の多い見出しや小見出しを使う。

一貫性と並列性

並列構造または並列性とは、情報や考えを示すために同じ文法構造を使用することです。

この指示の数値リストには、並列構造を破る手順が含まれています。

ネジを外して電池ケースを開けます。
電池ケースに表示されている画像に従って電池を挿入します。
これでコンパートメントを閉じて、ネジで閉めます。

ステップ3は指示動詞で始まっていないので、リストの並列構造を壊しています。

次の見出しは並列構造を使用していますか。 5517>

「バッテリーのインストール」
「デバイスをオフ/オンにする」
「デバイスを充電する方法」

デザイン

ドキュメントデザインとは、情報が整理されて提示される方法のことを指します。視覚的なものは処理に時間がかからないため、ユーザーは通常、コンテンツの質よりもデザインの質に注目し、反応するものです。画像やグラフィックスを含めないことを選択した場合でも、デザインを考慮する必要があります。これには、レイアウト、情報の順序、フォントサイズ、書体、見出し、色、余白などの選択が最低限必要です。デザインは、ユーザーがマニュアルをスムーズに読み進められるようにするための要素です。スキャン可能なドキュメントであれば、ユーザーはコンテンツ内を移動して特定の情報を見つけることができます。

一貫性/反復性

ドキュメント全体でデザイン要素を統一して使用することで、ユーザーに何を期待すればよいかを感じさせます（例：すべての見出しに同じ書体とサイズ、ページからページまで同じレイアウト）。

コントラスト

デザイン要素を使用して、マニュアルの特定の情報や特徴を強調する（例：単語を大文字にして強調する、項目の周りにボックスやボーダーを配置する、色を変えて強調するなど）。コントラストは、主に文書が全体的に一貫性を使用している場合に効果的です。

配置

水平および/または垂直配置でページ上のアイテムを整理すると、階層と構造ができ、バランス、コントラスト、または一貫性を達成するために使用することができます。たとえば、このドキュメントでは、左揃えのデザイン要素の名前と、インデントされたその説明の間に階層を作るために縦揃えを使用しています。

Balance

与えられたスペースにアイテムを均一に配置することです。これを達成するために、各項目の重み、つまり、ある項目に目が引き寄せられる傾向を考慮する必要があります。たとえば、画像はテキストよりも重みがあるので、画像の配置を決定する際は、視覚的な混乱を防ぐために、他の項目との重みのバランスを考慮する必要があります。

ホワイトスペース

ホワイトスペースを使用して、プロフェッショナルでバランスのとれたドキュメントを作成すること。スペースの色を示すのではなく、このデザイン要素は、画像やテキストがないことを指します。ホワイトスペースは、個々のアイテムやアイテムのグループ（マニュアルのセクションなど）を区別するのに役立ち、ドキュメントのスキャンを容易にします。

グループ化／近接

関連する画像やコンテンツを互いに近くに配置する。例えば、与えられたタスクを完了するために必要なすべての材料の画像をグループ化する。

カラー

コントラストや強調を作り、空間を超えて読者を誘導し、視覚的に楽しい文書を設計するために色を選択することです。一貫したカラースキームを作成するために、ドキュメント全体を考慮する必要があります。例えば、文書に青色を使用したい場合、それが一貫して使用され、他の文書の色を補完するようにしたいものです。

画像

与えられた文脈やマニュアルの目的に対して適切な画像を選択することです。画像が単独で使用されるのか、それとも書面による指示を補足するためのものなのかを検討する必要があります。図面、写真、グラフィックイラストなどの画像の種類と、画像の特定の部分を強調するために追加の吹き出しや注釈が必要かどうかを検討してください。

Conclusion

優れた取扱説明書は、目的、読者、文脈といった修辞的な状況を慎重に考慮することから始まります。この情報は、内容、言語、デザインについて適切かつ効果的な選択をするための鍵になります。理想的なタイムラインでは、テクニカルライターがユーザビリティテストを実施する機会があり、文書がその目的をどれだけ満たしているかを評価するように設計されています。

演習1 – 取扱説明書に慣れる

次のWebサイトには、オープンソースの取扱説明書の例がいくつか掲載されています。このリンクをたどって、リストを見て、深く見るために1つのマニュアルを選んでください。マニュアルにざっと目を通して、その内容やデザインに慣れ親しんでください。

修辞的状況を特定する

聴衆は誰ですか？どのようにして聴衆が誰であるかを知ることができますか。
マニュアルの内容やデザインの選択から、読者について何が推測できますか。これが主な目的であることをどのようにして知ることができますか（すなわち、どのようなコンテンツやデザインの選択が目的を知らせていますか）
このマニュアルの書かれたコンテンツやデザインはどのような文脈から情報を得ていますか

構成の選択を調べる

マニュアル全体の範囲と構成を記述してください。マニュアルはどの程度詳細ですか？何をカバーしていますか？情報はどのように構成されていますか？
コンテンツの「標準機能」はすべてこのマニュアルでカバーされていますか？その理由またはそうでない理由を教えてください。追加機能はありますか？それらは何ですか、またその目的は何ですか。
効果的な言語選択の例を探し出し、説明してください。なぜそれが効果的だと思うのか説明してください。
効果的なデザインの例を探し出し、説明する。
あなたがこのマニュアルの著者であったとしたら、どのような点を変え、その理由を説明しますか。

演習2-取扱説明書を企画する

あなたがよく知っているプロセスまたは製品の取扱説明書を書いていると想像して、次の指示に対処してください。