コンテンツ

• ステップに
• パート1/4：オーナーズマニュアルの計画
• パート2/4：重要な情報を埋め込む
• パート3/4：製品のメンテナンスについて説明する
• 4のパート4：読みやすいマニュアルを書く
• チップ

ソフトウェア、コンピューター、ゲーム、デバイスにはユーザーマニュアルが必要です。製品の使用方法（および使用しない方法）を説明するガイド。ユーザーマニュアルは、特定の構造を持つ正式なドキュメントであり、テクニカルライターや製品設計者など、製品を裏返しに知っている人が作成する必要があります。効果的なユーザーマニュアルを作成するには、誰が製品を使用するかを知っていることと、これらのユーザーを念頭に置いてマニュアルを作成する必要があります。手間のかからないユーザーエクスペリエンスを確保するために、文章を明確、正確、シンプルに保ちます。

ステップに

パート1/4：オーナーズマニュアルの計画

1. ユーザー分析を行います。 ユーザーマニュアルは、ユーザー（製品またはサービスを購入してユーザーマニュアルを読むユーザー）向けに作成する必要があります。ユーザー分析により、メインオーディエンスまたはターゲットオーディエンスが誰であるかがわかり、テキストの作成をガイドします。
   • デバイスを使用する人と話してください。制御された条件下で、テストユーザーにデバイスのプロトタイプとドラフトユーザーマニュアルを提供します。これらのテストユーザーに、ユーザーガイドで不明確または混乱していることについてのフィードバックを求め、このフィードバックに基づいてユーザーガイドに変更を加えます。
   • 聴衆全体を満足させることはできません。ターゲットオーディエンスまたは最大オーディエンスに合わせたマニュアルを作成します。
   • 年齢、健康状態（病気、学習障害、または障害がありますか？）、およびユーザーマニュアルを作成するための最良のアプローチを決定するための、聴衆の教育レベルを考慮してください。
2. ユーザーマニュアルのデザインを調整します。 デバイスまたは製品の設計と開発を支援したチームの一員である場合、製品がどのように機能するかを客観的に見て説明するのは難しい場合があります。したがって、ユーザーマニュアルの作成を支援するために、ライター（できれば指示を書いた経験のある人）とグラフィックデザイナーのアドバイスを求める必要があります。これらの人々は、外部のコンサルタントを通じて、またはあなた自身の会社や組織から選ぶことができます。
3. タスク分析を行います。 ジョブ分析は、デバイスの使用に必要な手順を特定して整理するプロセスです。徹底的なジョブ分析により、各ステップに必要な材料と機器（バッテリー、医薬品、その他のユーザー提供製品など）、および各ステップに必要なアクション、エラー、トラブルシューティングのアドバイスが特定されます。
   • 多くの異なるタスクまたはサブタスクを実行できる製品がある場合は、タスクごとにタスク分析を実行する必要があります。例：車の中で、ホーンを鳴らしたり、ストラップを締めたり、ヘッドライトをオンまたはオフにしたりできます。必要に応じて、これらのそれぞれについてジョブ分析を行います。
4. 製品がラベリングおよび販売承認の要件を満たしていることを確認してください。 これらの要件により、製品はユーザーの安全を念頭に置いて製造され、放射線や感電死などの危険な状態へのユーザーの曝露が制限されます。広告には、製品の目的と基本的な操作ガイドラインを明確に記載する必要があります。また、オーナーズマニュアルを作成する際には、これらのリソースを使用する必要があります。
   • 製品のユーザーマニュアルを有効にするには、製品に直接貼付されているラベルに従って作成する必要があります。
   • ユーザーマニュアルを作成する前に、デバイスが正式に販売ライセンスを取得していることを確認してください。
5. マニュアルのレイアウトを決定します。 マニュアルを合理化するための重要な方法がいくつかあります。各セクションの先頭に太字の見出しを付け、各単語を大文字にする必要があります。たとえば、「デバイスのセットアップ」、「デバイスの操作」、「トラブルシューティング」はすべて太字のセクション見出しにすることができます。
   • ガイドを合理化するもう1つの方法は、2つの列を使用することです。一方はテキストで右側に、もう一方はテキストのすぐ左側に、箇条書き、数字、または警告マークや赤い感嘆符などの小さなアイコンを表示します。
   • マニュアルは、主にデバイスを説明するために各画像の下にいくつかのテキストを含む画像で構成されている場合もあれば、いくつかの付随する画像のみを含むテキストである場合もあります。フローチャートを使用してユーザーをガイドすることもできます。あなたの製品と、それぞれの方法があなたのマニュアルを書くのにどのように役立つかを考えてください。ただし、1つのマニュアル内で異なるレイアウトを混在させることは避けてください。 1つを選び、それに固執します。

パート2/4：重要な情報を埋め込む

1. マニュアルを論理的に整理します。 マニュアルは、ユーザーがそれから最大の利益を得ることができるように構成する必要があります。マニュアルを製品の使用に適した章またはセクションに分割し、マニュアルの前に目次を含めて、各セクションをすばやく見つけられるようにします。
   • 特に長いマニュアルの場合、目次が必要です。
   • 聴衆がなじみがないかもしれないことを説明する多くの用語がある場合は、用語集または索引が必要です。ただし、用語集はお勧めしません。最良の選択は、マニュアル自体のテキストで紛らわしい用語を説明することです。用語集を含める場合は、マニュアルの前、目次の直​​後に配置します。
   • 表または図のリストは、マニュアルに数個以上の表または図がある場合にのみ必要です。
   • 説明する必要があるが、フローとフォーカスを混乱させるため、マニュアルの他の場所では説明できないものについては、付録が必要です。
2. 必要な警告を含めます。 一般的な警告または注意事項は、死亡または重傷を含む、製品の不適切な使用によって引き起こされる潜在的な危険に関する情報を提供する必要があります。これらの警告は、ユーザーが最初に表示できるように、マニュアルの一番前、フロントページの後に配置する必要があります。潜在的に危険なステップが提案された直後または直前に、特定の警告もマニュアルのテキストに含める必要があります。
   • たとえば、電気器具の一般的な警告は、雨が降っているときは使用しないことです。
   • 具体的な手順は、デバイスを電源コンセントに差し込む前に、手とデバイスの両方が乾いていることを確認することです。
   • 警告をIFUの他の方向と区別し、ユーザーの注意を引くために、画像（髑髏や骨など）または異なる色のテキスト（赤いテキストなど）を提供します。
3. デバイスについて説明します。 説明には、デバイスの目的の説明と、デバイスがどのように見えるかを示す小さなグラフィック表現の両方を含める必要があります。図には、デバイスに含まれるすべてのスイッチ、ボタン、および取り付け可能な部品にラベルを付けて名前を付ける必要があります。
4. インストール手順を提供します。 インストールセクションには、製品またはデバイスの使用準備方法に関する基本情報が含まれている必要があります。アプライアンスをホームユーザーが構築またはセットアップできない場合は、インストールセクションの上部にある太字の見出しにその旨を明記してください。また、以下を含める必要があります。
   • パーツリスト
   • 開梱手順
   • インストールの警告
   • 誤ったインストールの結果
   • インストール中に問題が発生した場合の連絡先
5. 操作に関する情報を提供します。 このセクションは、ユーザーマニュアルの最も重要な部分であり、デバイスの使用方法に関する具体的で詳細な情報を提供する必要があります。電源コードを差し込んだり、手を洗ったりするなど、本機を使用するための基本的な準備から始めます。デバイスの使用方法を説明する論理的な番号付きの手順と、デバイスを適切に使用したときにユーザーが期待できるフィードバック（たとえば、「クリック音が聞こえます...」）に進みます。
   • この章の終わりに、ユーザーはトラブルシューティングの章を参照して、すぐに説明できない問題を解決する必要があります。
   • 必要に応じて画像を配置します。いくつかのステップは、写真と言葉の両方で最もよく説明されています。マニュアルでの写真やイラストの使用を検討してください。
   • このセクションでは、他のセクションと同様に、不適切な使用または操作に関する関連する安全上の警告を含める必要があります。たとえば、チェーンソーのユーザーに、特定の薬を服用している間はアルコールを飲んだり、チェーンソーを使用したりしないように警告することができます。
   • ユーザーにメリットがあると思われる場合は、デバイスの適切な使用と操作を示すオンラインビデオへのリンクを含めることを検討してください。これらのビデオは、このセクションの最初、または（1つのステップのみを説明するビデオの場合）各ステップの最後に記録できます。
6. 最後に製品の概要を含めます。 要約は、基本的な操作手順を提供するために、マニュアルの最後、索引の直前に表示する必要があります。これは、運用情報を簡略化して簡略化したものであり、1ページ以内である必要があります。デバイスまたは製品の使用方法を要約します。基本的なアラート、製品の使用方法を説明する番号付きの手順、およびユーザーに支援を求める電話番号または電子メールアドレスを含めます。
   • ユーザーが要約シートを頻繁に取り外したり参照したりすることが予想される場合は、取り外し可能なラミネートカードまたは厚紙に印刷して、ユーザーが持ち運びや参照しやすいようにすることができます。
   • または、要約を製品に直接適用して、ユーザーがすばやく簡単に参照できるようにすることもできます。

パート3/4：製品のメンテナンスについて説明する

1. デバイスを掃除する方法を説明します。 デバイスまたは製品のクリーニングが必要な場合は、その方法を説明してください。必要な洗浄剤をリストしてください。読者に掃除の頻度を教えてください。次に、マニュアルの他の部分と同様に、クリーニング方法に関する番号付きのステップバイステップの説明を含めます。
   • クリーニングで製品を分解する必要がある場合、または特定の部品を取り外す必要がある場合は、製品を分解する方法を示してください。
   • デバイスのクリーニングに失敗した結果について警告を出します。たとえば、「デバイスをクリーニングしないと、パフォーマンスが最適とは言えません」と言うことができます。
2. 基本的なメンテナンスの実行方法をユーザーに数えます。 製品またはデバイスがパフォーマンスの問題を修正するためにユーザーが修理できる場合は、ユーザーにこれを行う方法について番号付きの指示を提供してください。たとえば、300時間の使用ごとに電池を交換する必要がある場合は、電池を交換する必要があるかどうかを確認する方法、切れた電池を取り外す方法、新しい電池を取り付ける方法について説明します。
   • 認定技術者のみが実行できる特定のメンテナンスタスクがある場合は、マニュアルのメンテナンス部分を2つの部分に分けてください。
3. ストレージオプションについて話し合います。 必要に応じて、マニュアルには製品またはデバイスを適切に保管する方法が説明されている必要があります。また、ストレージが必要な理由と不適切なストレージの結果に関する情報も含める必要があります。例：次のように書くことができます。
   • 製品は涼しく乾燥した場所に保管してください。不適切な保管は、湿気の蓄積により製品の寿命を縮める可能性があります。」
   • 「製品を熱にさらしたり、摂氏50度を超える温度で保管したりしないでください。そうした場合、燃焼につながる可能性があります。」
4. トラブルシューティング情報を提供します。 このセクションは、一般的な問題とその解決策のリストとして整理できます。同様の問題を論理的な見出しの下にグループ化します。このようにして、ユーザーは特定の問題をすばやく見つけることができます。
   • たとえば、コンピュータがブルースクリーンを表示する際にいくつかの問題がある場合は、「一般的な画面の問題」などの小見出しの下にグループ化します。
   • このセクションには、カスタマーサービス用の電話番号や電子メールも含める必要があります。

4のパート4：読みやすいマニュアルを書く

1. 他のユーザーガイドをお読みください。 自社製品のマニュアルを作成する前に、他の効果的なユーザーガイドを確認してください。構造、単語の選択、文型に注意してください。アップル、グーグル、マイクロソフトなどの主要ブランドは、より思慮深く書かれたユーザーガイドを作成するのに役立つ強力で効果的なユーザーガイドを作成しています。
   • ただ読むだけではありません すべて ユーザーマニュアル。あなたが販売する同様の製品のマニュアルを読んでください。たとえば、ベビー用品を販売している場合は、技術的なものではなく、ベビー用のマニュアルを読んでください。
2. 標準を選択してください。 スペル、単語の選択、および表現を標準化することで、ユーザーマニュアルがより使いやすくなります。 Chicago Manual ofStyleとMicrosoftManual of Styleは、オーナーズマニュアルを作成する際に役立つスタイルガイドにもなります。両方をチェックして、どちらかがマニュアルに適しているかどうかを確認してください。
   • たとえば、マニュアルで「電源スイッチ」と「電源ボタン」の両方を使用する代わりに、2つの用語のいずれかを選択してそれに従ってください。
3. 能動態を使用します。 能動態は、ユーザーの視点から物事を説明する書き方です。主題が定義されていない代替の受動態よりも理解しやすいです。
   • ヘミングウェイアプリ（www.hemmingwayapp.com）を試して、文章の受動態を特定してください。
   • これらの2つのサンプル文を調べてください。最初の文はアクティブで、2番目の文はパッシブです。
     • あなたはゆっくりと注意深くパッケージを開けなければなりません。
     • パッケージはゆっくりと注意深く開封する必要があります。
4. 番号付きの指示を書いてください。 数字で並べられた指示は、読者が問題の製品を使用、接続、または構築するプロセスにより集中するのに役立ちます。長くて冗長な段落や一連の番号のない段落を書く代わりに、それぞれが明確に番号が付けられた、単純で明示的な手順でユーザーガイドを作成します。
5. 命令から各ステップを開始します。 命令型は行動指向の動詞です。各ステップを動詞で開始することにより、ステップを完了するために必要なアクションについてのヒントを読者に提供します。たとえば、作成している製品に応じて、「接続」、「確認」、「スライド」などのコマンドで手順を開始できます。ただし、システムからの応答でステップを開始しないでください。
   • たとえば、画面が青色に変わって点滅し始めた場合は、「画面が点滅して青色に変わる」で手順を開始しないでください。「ホームキーを押し続けてください。画面が点滅して青に変わります。」
6. 使用する語彙を決定します。 あなたがヨーヨーマニュアルを書いているなら、あなたの聴衆はほとんど幼児です。簡単な単語と語彙を使用して、ヨーヨーがどのように機能するかを説明します。走査型電子顕微鏡のマニュアルを書いているとき、あなたの聴衆は非常に詳細な情報を理解できる非常に熟練した科学者で構成されているので、専門的な語彙や微妙な説明を使うことを躊躇しないでください。
   • 一般的に、専門用語や専門用語は避けようとします。
   • 可能な限り幅広いユーザーベースに効果を発揮するために、小学校の6年生から7年生までのレベルで書くようにしてください。
7. 製品を海外に発送するときは、翻訳が正確であることを確認してください。 翻訳者を雇って、ユーザーマニュアルを製品の発送先の国の母国語に翻訳してください。オンライン翻訳プログラムを使用することもできますが、ネイティブスピーカーに翻訳を読んでエラーをチェックするように依頼してください。
   • 聴衆に複数の言語グループが含まれている場合は、関連する各言語のユーザーマニュアルの翻訳を含めてください。
   • 単語ごとの翻訳ではない特定の用語について、ターゲット言語に異なる単語が存在する可能性があるため、翻訳者は製品に精通している必要があります。
8. 短い文章で書いてください。 いくつかの長い段落の代わりに、多くの短い段落を使用します。各セクションで論理的な区切りを探し、有用な情報を1文または2文のチャンクに要約します。文レベルでも同じことが言えます。文章を長く冗長にするのではなく、短くシンプルに保ちます。
   • ステップが長くなりすぎる場合は、小さなステップに分割してください。これによって単語数が減ることはありませんが、改行すると読みやすくなります。
9. マニュアルにエラーがないか確認してください。 マニュアルは、文法やスペルの誤りが原因で信頼性を失う可能性があります。同僚またはテクニカルライターにもマニュアルを編集して校正してもらいます。スペルと文法に加えて、校正者は次の点に注意を払う必要があります。
   • 受動態
   • 不明瞭または紛らわしい言葉
   • ラップされた文型
   • 段落が長すぎる

チップ

• 人々はさまざまな方法で学びます。可能かつ適切な場合は、視覚的な読者に対応するために、視覚的な補助またはオンラインビデオへのリンクをマニュアルに含めてください。