外部ヘルプ ページExternal help pages

アプリが、複雑なコンテンツを使った詳細なヘルプを必要とする場合は、それらの説明を Web ページでホストすることを検討します。If your app requires detailed help for complex content, consider hosting these instructions on a web page.

外部ヘルプ ページを使用する状況When to use external help pages

外部ヘルプ ページは、一般的な用途やクイック リファレンスとしては利便性が劣ります。External help pages are less convenient for general use or quick reference. これはアプリ自体に組み込むには大きすぎるヘルプ コンテンツに適しています。またチュートリアルや、一般のユーザーにはあまり使われないアプリの高度な機能の説明などにも適しています。They are suitable for help content that is too extensive to be incorporated into the app itself, as well as for tutorials and instructions for advanced functions of an app that won't be used by its general audience.

ヘルプ コンテンツが簡潔な場合、またアプリ内の特定の場合に表示するのが望ましい場合には、アプリ内のヘルプを使います。If your help content is brief or specific enough to be displayed in-app, you should do so. 必要のない限り、ヘルプのためにユーザーをアプリの外部に誘導しないようにします。Do not direct users outside of the app for help unless it is necessary.

ユーザーを外部ヘルプ ページに転送する場合は、次の 2 つのシナリオのいずれかを使用します。When a user is directed to an external help page, follow one of two scenarios:

  • 既知の問題に対応するページに直接リンクします。They are linked directly to the page that corresponds with their known issue. これはコンテキスト ヘルプであり、可能な場合には使用する必要があります。This is contextual help, and should be used when possible.
  • 選択するカテゴリとサブカテゴリが明確に表示されている、一般的なヘルプページにリンクします。They are linked to a general help page, with a clear display of categories and subcategories to choose from.

ユーザーがヘルプを検索できるようにすることは有用ですが、検索がヘルプ操作の唯一の方法とならないようにします。Providing users with a way to search your help can be useful, but do not make this search the only way of navigating your help. ユーザーが問題を記述しにくいこともあり、その場合には検索が困難になります。It can sometimes be difficult for users to describe their problems, which can make searching difficult. ユーザーが検索をしなくても、問題に関連のあるページをすぐに見つけられるようにします。Users should be able to quickly find pages relevant to their problems without needing to search.

チュートリアルと詳細なウォークスルーTutorials and detailed walkthroughs

外部ヘルプ ページは、ビデオやテキストを使って、ユーザーにチュートリアルや詳細なウォークスルーを提供するのに最適です。External help pages are the ideal place to provide users with tutorials and walkthroughs, whether video or textual.

  • チュートリアルでは、より複雑な用途や高度な機能に焦点を当てます。Tutorials should focus on more complicated ideas and advanced functions. ユーザーがアプリを使うためには、チュートリアルを必要としないようにします。Users shouldn't need a tutorial to use your app.
  • チュートリアルは標準のヘルプとは異なる方法で表示されるようにします。Make sure that these tutorials are displayed differently from standard help instructions. 高度な使い方を求めているユーザーは、問題に対する直接の解決策を求めるユーザーよりも、より進んで検索を行います。Users who are looking for advanced instructions are more eager to search for them than users who want straightforward solutions to their problems.
  • ディレクトリと各チュートリアルに対応する個々のヘルプ ページの両方から、チュートリアルへのリンクを行うことを検討します。Consider linking to tutorials from both a directory and from individual help pages that correspond to each tutorial.