設計者が行う作業

オンライン・ヘルプの記述は印刷マニュアルを記述するのとは違うので、対象ユーザ、情報へのアクセスの方法、アプリケーションと情報との合致という点に留意することが重要です。

オンライン・ヘルプの目的

良質のオンライン・ヘルプの設計には、次の 2 つの重要な目的があります。

• ユーザができるだけ早く確実に作業をこなせるようにすること。

• ユーザがいずれヘルプなしでも作業できるように教育すること。

これらに目標を置けば、最適なヘルプは何か、必要な情報は何かを判断するのに役立ちます。

対象となるユーザ

何を書く場合でも、対象となるユーザとそのユーザが必要としている情報を理解することが大切です。特にオンライン・ヘルプでは、ユーザが行おうとしている作業と、起こりうる問題について認識しておくことが重要です。

ヘルプへのアクセス方法

ユーザを正しく認識するのと同時に、ユーザがどのようにヘルプにアクセスするのかを理解することが重要です。

アプリケーションのヘルプ

アプリケーションのヘルプを記述する場合は、ブラウズできるトピックと、コンテキスト・ヘルプとしてアプリケーションから使用できるトピックをそれぞれ決めることが必要です。トピックをナビゲートできる場合は、トピック・ツリーまたはハイパーリンクを使用してトピックをブラウズできます。排他的なコンテキスト・ヘルプに指定されているトピックは、アプリケーションの特定のコンテキストからしかトピックを表示できないため、ブラウズできません。

アプリケーションのヘルプボリュームを登録するかどうかも決める必要があります。登録されたヘルプ・ボリュームは他のアプリケーション (ヘルプ・ビューアなど) によっても表示でき、より広範囲な情報へのアクセスが可能になります。ヘルプ・ボリュームにあるトピックへの別のヘルプ・ボリュームからのハイパーリンクが含まれている場合は、そのヘルプ・ボリュームを登録してください。

アプリケーションのインストールと登録の詳細は、「アプリケーションとそのヘルプの登録」を参照してください。

スタンドアロン・ヘルプ・ボリューム

スタンドアロン・ヘルプ・ボリューム (アプリケーションに対応付けられていないヘルプ・ボリューム) を記述する場合は、別の方法で実行できます。

まず、記述したすべてのトピックをユーザが使用できるようパスを設定しなければなりません。つまり、すべてのトピックが、少なくとも 1 つのハイパーリンクによってブラウズできなければなりません。また、ヘルプに対応付けられているアプリケーションがないため、ヘルプ・ボリュームの表示はヘルプ・ビューアに依存しなければなりません。

ヘルプの表示方法の評価

アプリケーションは種類が異なるヘルプを取り入れることができます。この場合、アプリケーションに最適なヘルプの種類がどれかを判断することが重要になります。たとえば同じヘルプ情報でも様々な方法で表示されることがあります。その選択には、主要な機能、チュートリアル、例、作業指示、ショートカット、トラブルシューティング、リファレンス情報、用語集、ハード・コピーまたはその他のオンライン・マニュアルがあります。ヘルプ・ボリュームは異なる表示を組み合わせることもあります。

アプリケーション・プログラマとの協力

アプリケーションのヘルプを記述する場合は、アプリケーション・プログラマと密に連絡をとるようにしてください。ヘルプ・システムをどの程度アプリケーションに統合するかは設計仕様によります。

アプリケーションとそのヘルプの結び付きが弱い場合には、アプリケーションが直接表示できるトピックはほんの一握りです。しかし簡単に実装できます。

反対に、アプリケーションのあらゆる状況に対応する特定のヘルプを提供できるアプリケーションもあります。これには多くの作業を必要としますが、それさえできれば、ユーザにとっては非常に便利です。

ヘルプの統合レベルを決定するのは、あなた自身とそのプロジェクト・チームです。