ヘルプ

ユーザーがタスクを完了し、主要なメカニズムが UI 自体であることを理解するのに役立つセカンダリ メカニズムとしてヘルプを使用します。 これらのガイドラインを適用して、コンテンツを本当に役立ち、見つけやすくします。

ヘルプ システムは、ユーザーがタスクを完了できない場合、概念をより詳細に理解したい場合、または UI で使用できるよりも技術的な詳細が必要な場合に役立つさまざまな種類のコンテンツで構成されています。

この記事では、UI のセカンダリとしてヘルプを参照します。 UI は、ユーザーが最初に問題を解決しようとする場所であるため、プライマリです。 UI でタスクを実行できない場合にのみ、ヘルプ システムに問い合わせてください。

[スタート] メニューから使用できる Windows のヘルプとサポートのホーム ページ。

手記：スタイルとトーンに関連するガイドラインは、別の記事で示されています。

これは適切なユーザー インターフェイスですか?

決定するには、次の質問を検討してください。

• ターゲット ユーザーの動機はどのくらいですか? プログラムの機能を発見し、その中級者や上級ユーザーになる意欲が高いほど、ヘルプ トピックに相談して質問に対する回答を調査する意欲が高くなります。
• ヘルプを使用して不適切な UI を修正していますか? UI が優れていれば、ユーザーが追加のヘルプを求める必要性が減少します。 プログラムに非常に明確で便利なプライマリ UI (専門用語のないエラー メッセージ、適切に記述されたウィザード、明確なダイアログ ボックスなど) がある場合は、セカンダリ ヘルプ システムがまったく必要ない可能性があります。
• プログラムは比較的単純ですか? その場合は、必要なすべての支援コンテンツをプライマリ UI サーフェイスに組み込むことを検討してください。 ユーザーは、複雑なタスクを実行するプログラムで追加のヘルプを探す可能性が高くなります。
• アプリケーションは、開発者、IT プロフェッショナル、またはその他のソフトウェア専門家を対象としていますか? これらのユーザーは、プログラミング言語規則のリファレンス ヘルプと、機能を習得するための詳細な概念ヘルプを期待する傾向があります。

設計の概念

プログラムにヘルプを含める場合は、全体的な設計に統合します。 ヘルプ インターフェイスは、シンプルで効率的で関連性の高いインターフェイスである必要があります。ユーザーが簡単にヘルプを取得し、タスクに戻ることを可能にする必要があります。 ユーザーの時間の観点からヘルプ システムを考えてみましょう。まず、プログラムで問題が発生する場所を予測して中断を最小限に抑え、その後、基本的な支援を UI に直接組み込み、より詳細なヘルプに明確で一貫性のあるエントリ ポイントを作成することで、それらの問題を解決します。

Windows の支援は、これらの原則に従って設計されました。 Windows ヘルプ ユーザー エクスペリエンスの設計変更の一部を次に示します。

• プライマリ UI からのヘルプへのより検出可能なエントリ ポイント (特に、ダイアログ ボックス、エラー メッセージ、ウィザードなどの UI サーフェスからの新しいヘルプ リンク)。 ヘルプ リンクを使用すると、ヘルプの関連トピックに直接アクセスできます。
• ヘルプ ボタン アイコンは、ほとんどのコントロール パネル ハブ ページの右上隅とシェル フォルダーで使用できます。
• ユーザーは、オンラインのときに、Windows Online のヘルプとサポートから最も up-to最新のヘルプ コンテンツを取得することを選択できます。
• ユーザーがタスクを迅速かつ効率的に実行できるように、ヘルプ トピックは機能に焦点を当てたものではなく、タスクベースになりました。
• ヘルプ トピックは、主に既知の上位ユーザー シナリオに基づいています。
• ヘルプ トピックは、現実の言葉を使って、よりリラックスしたカジュアルなトーンに設定されています。
• ヘルプ トピックは、ユーザーが単語単位でコンテンツを読み取ることはほとんどないので、効果的なスキャン用に設計されています。

ヘルプの例

ヘルプ システムの設計についてさらに深く考えるために、日常生活の例えを考えてみましょう。 あなたは未知の都市で迷子になります。 そのためにはどうすればよいですか。 多くは次のように反応します。

• 指向を取得します。ランドマーク、道路標識 (名前と場所へのポインター) を探します。
• マップを探します。
• 最後に、最後の手段として、道順を尋ねるか、友人を呼び出します。

都市の「インターフェイス」の設計は、支援の必要性に影響を与えます。 よくラベル付けされた通り、明示的な道順(病院、空港、博物館、郵便局へのポインター)、目立つ地理的特徴や建物などの明確なランドマークが、あなたの道を見つけるのに役立ちます。

あなたは最後の手段として助けを求めます。 これは、都市の「インターフェイス」が十分に設計されておらず、混乱して失敗したことを示しています。 有用性を示す特定のラベルがある場所でヘルプを求める可能性が高くなります。 たとえば、市庁にいるほとんど誰でも道順を教えることができますが、一般的な場所より、「案内」または「情報」とラベル付けされた場所で助けを求める可能性が高くなります。

あなたが助けを求めるとき、あなたは不満を感じ、あなたの意図した目的地に到達したいだけである可能性があります。 あなたはおそらく、街のツアーをしたり、その歴史について学んだりするのに時間を費やす気分ではありません。 さらに、動機はタスクの重要性によって異なります。 ホテルの部屋を見つけようとしている場合は、必要な操作を行います。 しかし、あまり重要でない場所を見つけることが目標である場合は、控えめな努力をした後にあきらめてしまう可能性が高いです。

実際の空間で自分の方法を見つけるこれらすべての側面は、ユーザーが通常、プログラムの仮想空間で自分の方法を見つける方法に対応します。 主要なUIを超えて助けを求めることは、混乱を招きやすい性質があります。適切に設計されたUIとインテリジェントな「道路標識」を活用して、ユーザーが必要な回答へと導けるように最善を尽くしましょう。

ヘルプが不要になるように UI を設計する

まず、次の方法でヘルプを不要にしてみてください。

• 一般的なタスクを簡単に検出して実行できるようにします。
• 明確な 主な指示を提供します。
• 目標とタスク指向の明確で簡潔なコントロール ラベルを提供します。
• 必要に応じて補足の指示と説明を提供します。
• 有効な選択肢に制約されたコントロールを使用し、適切な既定値を指定し、すべての入力形式を処理し、エラーを防ぐことで、回避可能な問題を予測します。
• ユーザーが実行する明確な解決策またはアクションを提供するエラー メッセージを記述する。
• フローの悪いタスクや、明らかな理由で無効になっているコントロールの使用など、混乱を招く UI デザインを回避します。
• 開発サイクルの早い段階でライターやエディターと連携して、プログラム全体で高品質で一貫性のある UI テキスト を作成します。

ユーザーは、UI の使用方法を理解するために他の場所に移動する必要はありません。 重要な情報をプライマリ UI に直接追加して、ユーザーが即座に利用できるようにし、ヘルプ ウィンドウに強制的に移動させるのを避けます。 重要な情報がヘルプ トピックにのみ存在する場合は、ユーザーに表示されない可能性が高いです。 任意の情報や詳細な説明については、プライマリUIから関連するヘルプトピックへのヘルプリンクを使用してください。

ユーザーの動機を考慮する

ほとんどのユーザーにとって、速度と効率は良いプログラムの最も重要な美徳の一つです。 ユーザーは作業を完了したいと考えています。 一般的に、彼らはプログラムと技術について学ぶことに興味がありません。彼らの忍耐は、そのプログラムが自分の利益に役立ち、目の前の問題を解決する限りにのみ拡張されます。

ユーザーの動機に合わせてヘルプ システムを設計します。 たとえば、博物館のキオスクに歩いて行ったユーザーを考えてみましょう。 タスクを迅速に実行する方法を理解できない場合、彼女は単にあきらめて立ち去る可能性があります。 彼女はヘルプを使って時間を費やす可能性は低いです。 または、高い動機を持つユーザーは、ヘルプ システムの調査に費やされた時間に対して、回答に対する許容度が高くなります。 たとえば、書籍のバランスを取る必要があるビジネス ユーザーは、その新しい会計アプリケーションを最大限に活用するためにヘルプ コンテンツを参照する必要がある可能性があります。

スキャン用のコンテンツの書き込み

特定の情報がスキャンされることを意識して、逐語的に読まれないヘルプトピックを記述します。 簡潔に記述し、すぐにポイントにアクセスし、ユーザーが操作できる情報を提供します。

• ユーザーが手続き型の支援を受けていると認識できるように、一貫した形式で番号付き手順を使用して"ハウツー" トピックを記述します。
• たとえば、UI オプションや言語構文を示すために、テーブルを使用して、スキャンの容易さを念頭に置いて参照トピックを記述します。
• ユーザーがより関心の少ないセクション全体をスキップできるように、小見出しによって論理的に整理された概念的なトピックを記述します。

すべてのヘルプ コンテンツでは、テキストの標準の段落ブロックよりも箇条書きをスキャンする方が簡単です。ただし、箇条書きリストは、整理されていない素材の松葉杖としてではなく、慎重に使用してください。

重要なコンテンツの作成

すべてのユーザーが持つ可能性のあるすべての質問を予測できるヘルプ システムが存在しない場合は、ターゲット ユーザーの上位シナリオで上位の質問に回答することにほとんどのコンテンツに焦点を当てます。 たとえば、効果的な検索やネットワーク接続を確立する方法 (他のタスクの中でも) は、非常に必要なトピックである可能性があります。 また、機能やテクノロジを独自の目的で完全に文書化するのではなく、上位のユーザー シナリオ内のタスクに重点を置きます。

ヒント： 技術サポートは、ヘルプコンテンツの優れたソースです。 ヘルプ デスクは、ユーザーが実行しようとしている (失敗した) 特定のプログラムやタスクについてよく寄せられる質問の記録を保持することがよくあります。

UI 内のすべての機能に対してヘルプを提供する必要はありません。 非常に頻繁に、役に立たないヘルプは、すべてに対してヘルプを作成しようとしたときに生じます。 UI が適切に設計されている場合、これらのヘルプ トピックのほとんどは役に立ちません。彼らはただ明白に言い続けるでしょう。

タスクを実行する方法が複数ある場合は、ほとんどの場合、経験の浅いユーザーが使用する最も一般的な方法を文書化できます。 これに対する例外としては、アクセシビリティに関する考慮事項 (マウス 操作に相当するキーボードのドキュメント化) やプラットフォームの考慮事項 (タブレット フォーム ファクターのドキュメント化など)、またはコマンド ラインがグラフィカル ユーザー インターフェイスに代わるサーバー環境の場合などがあります。

多くの場合、ユーザーは発生している問題を自分とまったく同じ用語で考えていないことに注意してください。 たとえば、ユーザーは自分自身を "アカウント" と考えるのが不思議な場合があります。用語のバリエーションとシノニムの可能性を考慮して、検索とインデックス作成の機能を設計してください。

ただし、プライマリ UI とヘルプ システムの間では、用語が同じでない場合は非常によく似ています。 ヘルプ システム言語が画面に表示されているものとあまり密接に関連していない場合、ユーザーは混乱する可能性があります。

説得力のあるヘルプ リンク テキストの作成

プライマリ UI からヘルプ トピックにリンクする場合は、説得力のあるヘルプ リンク テキストを必ず記述してください。 明確で具体的な言語は自信を刺激します。 ユーザーは、一般的なヘルプ リンク ("ヘルプ" または "詳細情報" という単語を含むボタン) は、時間を大幅に投資しないと適切な情報に結び付かないと考える傾向があります。

5 つの操作のみを行う場合...

1. ユーザーがヘルプを必要としないように UI を設計します。
2. ターゲット ユーザー向けの上位のシナリオの上位の質問にコンテンツを絞り込むことで、ヘルプを役立てるようにします。
3. 簡単にスキャンできるように、ヘルプ コンテンツを表示します。
4. UI のすべての機能に対してヘルプを提供する必要がないことを理解します。
5. ヘルプ エントリ ポイントを見つけやすく説得力のあるものにします。

使用パターン

コンテンツの種類が異なると、目的が異なります。

コンテンツ タイプ	例
手続き型ヘルプ には、タスクを実行するための手順が用意されています。	手続き型ヘルプでは、"what" や "why" ではなく"how" 情報に焦点を当てる必要があります。 この例では、ヘルプ トピックでディスク クリーンアップ ユーティリティの機能を使用する方法について説明します。手順を順番に説明します。
概念に関するヘルプ は、背景情報、機能の概要、またはプロセスを提供します。	概念的なヘルプでは、タスクを完了するために必要な情報以外の "what" または "why" の情報を提供する必要があります。 この例では、ヘルプ トピックでデスクトップの内容を定義し、デスクトップに含まれる内容とユーザーがデスクトップを操作する理由についてさらに詳しく説明します。
リファレンス ヘルプ は、オンラインリファレンスブックとして機能します。	リファレンス ヘルプを使用して、プログラミング言語またはプログラミング インターフェイスを文書化できます。 この例のヘルプ トピックでは、この特定の言語またはアプリケーションで使用されている文字体裁規則を示し、スキャンしやすいテーブルに情報を提供します。

ガイドライン

入口点

• 特定の関連するヘルプ トピックへのリンク。 ヘルプ ホーム ページ、目次、検索結果の一覧、または他のページにリンクするページにはリンクしないでください。 ユーザーはクリックしたリンクと一致するものを強制的に検索するため、よく寄せられる質問の大きなリストとして構成されたページへのリンクは避けてください。 手元にあるタスクに関連がなく役に立たない特定のヘルプ トピックにはリンクしないでください。 空のページにはリンクしないでください。

• 一貫性を保つため、すべてのウィンドウまたはページにヘルプ リンクを配置しないでください。 ヘルプ リンクを 1 か所に用意しても、どこでも提供する必要があるわけではありません。

• ダイアログ ボックス、エラー メッセージ、ウィザード、プロパティ シートにはヘルプ リンクを使用します。 ヘルプ リンクが特定のコントロールに適用される場合は、その下に左揃えで配置します。 ヘルプ リンクがウィンドウ全体に適用される場合は、ウィンドウのコンテンツ領域の左下隅に配置します。

  

  この例では、2 番目のヘルプ リンクがコントロールのグループに適用されます。

  

  この例では、[ヘルプ] リンクがウィンドウ全体に適用されます。

• 技術的に可能な限り、ヘルプへの一般的なテキスト参照の代わりにヘルプ リンクを使用します。

  正解:

  ディスク エラーを修復するにはどうすればよいですか?

  間違い:

  ディスク エラーの修復の詳細については、「ヘルプとサポート」を参照してください。

• コントロール パネル項目のハブ ページの [ヘルプ] アイコンと共に [ヘルプ] ボタンを使用します。 右上隅に配置します。 これらのボタンにはラベルはありませんが、ヘルプと表示されるヒントがあります。

  

  ヘルプ ボタンを含むコントロール パネル項目。

• F1 ヘルプは省略可能です。 ユーザーは、標準キーボードで「ヘルプ」とラベル付けされたF1キーを押すことで、画面に表示されたUIの直感的なコンテキストに関連するヘルプ情報を見つけることに慣れています。 たとえば、ユーザビリティ調査でユーザーがそれを見つけることを期待している場合や、プログラム UI がコンテキスト 支援の恩恵を受けるのに十分な複雑さが示されている場合は、F1 ヘルプを含めることができます。

• メニュー バーを含むプログラムには、ヘルプ メニュー カテゴリを含めることができます。 ヘルプ メニューのガイドラインについては、「 メニュー」を参照してください。

  

  この例では、Windows Paint アクセサリに [ヘルプ] メニュー カテゴリがあります。

• キーボードのアクセシビリティのために、ヘルプ ボタンとリンクのタブ位置を指定します。

• ヘルプ ボタンとリンクの動作は次のようになります。ヘルプ ウィンドウが開き、専用のヘルプ トピックが表示されます。コンテキスト エクスペリエンスを維持するために、ヘルプ ウィンドウを呼び出した UI は開いたままにする必要があります。

• 古いヘルプ エントリ ポイント スタイルを使用しないでください。具体的には、"詳細情報" または "詳細情報について..." のリンク、汎用ヘルプボタン、タイトルバーにある状況依存のヘルプボタンなどが含まれます。 これらは過去に使用されてきましたが、使いやすさの研究では、ユーザーが無視する傾向があると判断されました。 代わりに、特定のヘルプ トピックへのリンクを使用してください。 適切なヘルプ リンクの作成に関するガイドラインについては、 ヘルプ リンクを参照してください。

  不正解:

  

  「もっと詳しく見る」や「について詳しく知る…」などのリンクを使用しないでください。

  不正解:

  

  一般的なヘルプ ボタンは使用しないでください。

  不正解:

  

  タイトル バーで状況依存のヘルプ ボタンを使用しないでください。

コンテンツ

• 明確なコンテンツを作成しないでください。 プライマリ UI の内容を繰り返すヘルプ トピックでは、値は追加されません。
• ユーザーが何らかの方法で操作できないコンテンツを作成しないでください。
  • 例外： 一部の概念コンテンツでは、重要な背景情報が提供され、必ずしもユーザーの操作に結び付く必要はありません。
• 問題に対するあいまいな解決を避ける。 たとえば、"システム管理者に問い合わせる" や "アプリケーションを再インストール" すると、ユーザーが不満を感じる傾向があります。
  • 例外： これが唯一の実用的な解決策であり、システム管理者が問題に関する連絡を受ける予定の場合は、システム管理者に連絡することをお勧めします。
• 非常に可能性の低いユーザー シナリオに対処するコンテンツは避けてください。 通常の使用になると予想される内容に合わせて、主なヘルプ コンテンツを開発します。は、予想される使用に対する重要な例外に注意してください。ただし、このコンテンツは優先順位の低いものとして扱います。
• ヘルプ トピックがどれほど役に立つかについて、ユーザーからのフィードバックを収集します。 ユーザーが個々のトピックを評価できるようにします。 ドキュメントに関する ユーザビリティ調査 を実施して、コンテンツの品質と検出可能性に関する問題を確認します。
  • ヒント： ユーザーフィードバックは、単に技術の説明に焦点を当てた機能ベースのコンテンツではなく、ユーザーが実際にプログラムで何をしているかに焦点を当てたタスクベースのコンテンツをより多く生成するための優れた方法でもあります。
• コンテンツにアクセスする複数の方法を提供します。 目次、インデックス、 および検索 メカニズムは、検出可能性を向上させる最も一般的な 3 つの方法です。
• タスクを実行する方法が複数ある場合は、ほとんどの場合、経験の浅いユーザーが使用する最も一般的な方法を文書化できます。

アイコン

• [ヘルプ] アイコンは、エクスプローラー ウィンドウとコントロール パネル項目のハブ ページにのみ使用します。 ヘルプ リンクに [ヘルプ] アイコンを使用しないでください。

正解:

この例では、Windows エクスプローラー ウィンドウでヘルプ アイコンを使用してヘルプへのアクセスを提供します。

不正解:

この例では、左下のヘルプ アイコンがヘルプ リンクと共に正しく使用されていません。

テキスト

[ヘルプ] リンク

• 必要に応じて、関連性の高い簡潔なテキストを使用して、ヘルプ トピックの内容に関する具体的な情報を提供します。 多くの場合、ユーザーは一般的なヘルプ リンクを無視します。 リンクの結果が予測可能なユーザーであることを確認し、結果に驚かないようにします。

  • 例外： "詳細情報" を使用すると、UI に直接含まれる指示を補足できます。特に、ヘルプ リンクに特定の情報を指定すると、不要な繰り返しが発生したり、リンクの説得力が低下したりする場合があります。

  不正解:

  強力なパスワードには、大文字と小文字が混在する文字、数字、記号が少なくとも 6 つ含まれています。 強力なパスワードとは何ですか。

  正解:

  強力なパスワードには、大文字と小文字が混在する文字、数字、記号が少なくとも 6 つ含まれています。 詳細情報

  正しくない例では、[ヘルプ] リンクが繰り返し表示されています。 それは、本当に既に答えが出ている質問を尋ねます。

• 可能な限り、ヘルプ コンテンツが回答した主な質問に関して、ヘルプ リンク テキストを語句として入力します。 "詳細情報を知る"、"詳細を教えて"、"この問題のサポートを得る"言い回しは使わないでください。

  不正解:

  例外の追加の詳細

  正解:

  例外を許可するリスクは何ですか?

  例外を追加する方法

  正しい例では、リンクはヘルプ トピックによって回答された主要な質問の観点から表現されています。

• 最も関連性の高い情報を簡潔に要約できる場合は、ヘルプ リンクを使用する代わりに、概要を UI に直接配置します。 ただし、ヘルプ リンクを使用して補足情報を提供できます。

  不正解:

  

  正解:

  

  より良い:

  

  正しい例では、ヘルプ情報を簡潔にまとめ、ユーザーが読む可能性が大幅に向上します。 より良い例では、この複雑な主題の詳細については、ヘルプ リンクを提供します。

• ヘルプ リンクはサポートを明確に示すためのものです。 ヘルプ リンクは、アクション リンクのように読み上げられることはありません。

• キーワードだけでなく、リンク テキストのヘルプ リンク全体を使用します。

  正解:

  例外を許可するリスクは何ですか?

  不正解:

  例外を許可するリスクは何ですか?

  正しい例では、ヘルプ リンク文全体がリンク テキストに使用されています。

  • 例外： 外部 Web サイトへのヘルプ リンクでは、サイトまたはページの名前をリンクとして使用する必要があります。 サイトの名前を紹介するテキストは、リンク自体に含める必要はありません。

• ヘルプ リンクはヘルプ トピックの見出しと正確に一致する必要はありませんが、2 つの間には強力で明確な接続が必要です。 このため、リンクと見出しをペアでデザインします。

  正解:

  この機能のパフォーマンスを向上させるにはどうすればよいですか? (リンクテキスト)

  最適なパフォーマンスを得るためのこの機能の構成 (トピックの見出し)

  不正解:

  この機能のパフォーマンスを向上させるにはどうすればよいですか? (リンクテキスト)

  この機能の完全な概要 (トピックの見出し)

  不適切な例では、ヘルプ トピックの見出しの範囲がヘルプ リンクテキストと大きく異なり、見当違いになる可能性があります。

• ヘルプ コンテンツがオンラインの場合は、リンク テキストでその内容を明確にします。 これにより、リンクの結果が予測可能になります。

  正解:

  その他の形式とツールについては、Microsoft Web サイトにアクセスしてください。

  不正解:

  その他の形式とツールはどこで入手できますか?

• 完全な文を使用します。

• 疑問符を除き、終了句読点は使用しないでください。

• ヘルプ リンクやコマンドには省略記号を使用しないでください。

ヘルプ コンテンツ

• 太字を使用して UI 要素を書式設定し、識別しやすくします。 これは、プロシージャのヘルプ トピックで特に便利です。これにより、ユーザーはプロシージャをスキャンして、関連する UI 要素をすばやく確認できます。
• 斜体を使用してキャプションを書式設定します。 これは、簡単なテキスト説明の恩恵を受けるテーブル、アート、スクリーンショット、およびその他のグラフィック要素に適用されます。
• ヘルプは単に "ヘルプ" と表記してください。 通常、Web サイトのコンテンツを実際に参照している場合を除き、オンライン ヘルプという語句は使用しないでください。