オンラインヘルプ制作のポイント

Windows HelpやHTML Help、あるいはその他のオンラインヘルプを制作する時のポイントを簡単にまとめてみました。

動作環境

ユーザの環境の確認

オンラインヘルプを表示するには、何らかのハード/ソフトが必要です。ヘルプを提供するユーザの元に必ずその環境があるかどうかを確認してください。企業ユーザなどでは、その会社全体の環境の統一のために、ソフトのバージョンアップやプラグインのインストールが制限されている場合があります。ユーザに過大な環境を要求すると、文字通り「使い物にならない」ヘルプになってしまいます。

画面サイズ

今のところ、パソコンなどで一度に画面に表示できる情報量は、紙のマニュアルよりも少なくなります。また、ヘルプを画面いっぱいに広げて表示することはめったになく、現在の操作に対する説明として、アプリケーションウインドウと並べて表示するのが一般的です。したがって、ヘルプウインドウに表示できる情報量は、より少なくなります。

このため、ヘルプウインドウに大量の文字を詰め込むと、ユーザが何度も縦スクロールしなければ目的の情報にたどりつけなくなります。1トピックは、多くて数スクロールぐらいまでが限度でしょう。ただし1画面にこだわり過ぎて情報を細分化しすぎると、ジャンプ、ジャンプの繰り返しで、内容を把握しづらくなります。

また、縦スクロールに横スクロールが加わると操作性がさらに落ちるので、横スクロールしなければ表示できないようなサイズの画像は極力使わない方がよいでしょう。

(一覧に戻る)

ヘルプの構成

全体構成

ヘルプでは、目次を順にたどって探すよりも、キーワードを入力して検索されたトピックにジャンプする、ダイアログの[ヘルプ]ボタンを押してヘルプを呼び出すというような操作の方が一般的です。

このため、前後の脈絡なしにトピックを表示しても、そのトピックが何の説明であるか分かり、必要な情報が過不足なく含まれているように情報を切り分けることが、マニュアルの場合よりもさらに大事になります。

目次構成

目次を順にたどる人が少ないとは言え、目次がヘルプの全体構成を知らせる大きな手がかりであることは確かです。数十の目次をずらりと縦に並べるよりも、WinHelpやHTML Helpのブック(見出し)→ページのように、目次を階層化する方が、必要な項目を探しやすくなります。

一番上の目立つ階層には、困ったときにすぐに必要になるサポートの問合せ先や、トラブルシューティング、ヘルプ自体の使い方なども入れる方が良いでしょう。

(一覧に戻る)

トピックの内容

文章は簡潔に

紙のマニュアルでもだらだら長い文章は読みづらいものですが、画面上で読むのはさらに大変です。読み飛ばしや読み落としも増えます。長文には大抵複数の事柄の説明が含まれますので、これを短い文章に分け、1つの文章では1つの事柄のみを説明すると、内容が頭に入りやすくなります。

また、箇条書きを使う、手順の番号を入れる、 小見出しを入れるなどして、情報のまとまりがはっきり区別できるようにすると、読みやすくなります。

トピック間のリンク

複数のトピックで同じ情報が必要になった場合など、その情報量が少なければ、各トピックに重複して掲載する方が親切でしょう。トピック間のリンクを増やす方が制作側のメンテナンスは楽ですが、あちこちのトピックを渡り歩くとユーザが混乱します。特にWinHelpの場合は目次とトピックを同時に表示して同期をとることができないので、自分がヘルプ全体のどのあたりを見ているのか、すぐに分からなくってしまいます。

参照する情報量が多かったり、著作権情報など、重要だけれどユーザが参照する機会の少ない情報は、別トピックにしてリンクする方がよいでしょう。

用語説明や、あるトピックと同時に参照するべき内容は、ポップアップや二次ウインドウなどに表示します。

画像の取り扱い

マニュアル感覚で画像を入れない

マニュアルの場合、画面やイラストを入れて読者の理解を助けることができますが、オンラインヘルプでは、画像がかえって邪魔になる場合があります。
たとえば、アプリケーションのダイアログの[ヘルプ]ボタンをクリックしてヘルプを呼び出す場合、現にダイアログを表示している訳ですから、呼び出すトピック自体にはダイアログの画像は不要です。さらにバージョンアップなどで、実際に表示されているダイアログとトピック中の画像の内容が食い違うようになると、ユーザが混乱します。

また、マニュアルでは画像を縮小して貼り込んでいる場合がよくありますが、オンラインヘルプの場合、へたに画像を縮小すると、画面上で文字がつぶれて読めなくなることがあります。

画像のファイルサイズを考える

フルカラーの画像をふんだんに貼り込んだヘルプを作成すると、ファイルサイズが数十MB以上になることも考えられます。ファイルサイズがあまりに大きいと、アプリケーションと同時に起動したときにメモリ不足になったり、Webサイトで配布することが困難になったりします。

関連情報

「実用的なWebサイトのデザイン」
(ホームページの作り方というのも、オンラインヘルプの作り方と似た部分が結構あります。)

(一覧に戻る)