虎の巻のオーサリング・ガイドライン
虎の巻とコンポジット虎の巻を使用すると、ユーザーは一連のステップを実行することでゴールに到達することができます。このガイドラインでは、虎の巻を使用する時期、および虎の巻を作成する最善の方法について説明します。
虎の巻をいつ作成するか
虎の巻は、単純なアプリケーションの構築など明確なゴールにつながる複数のステップからなるタスクに最適です。ゴールは、虎の巻のステップをすべて終了したときユーザーが成功したと判断できるように定義する必要があります。チュートリアルは虎の巻の適切な候補になることがあります。チュートリアルにおけるゴールは、特定のタスクを実行する方法を学習することです。虎の巻は通常、多くても 10 ステップで、30 分以内で完了できます。タスクが大きい場合は、コンポジット虎の巻の使用を考慮してください。
コンポジット虎の巻をいつ作成するか
コンポジット虎の巻は、1 つの虎の巻で記述するには大きすぎるタスクや、ゴールが複数あるタスクをガイドするときに使用します。コンポジット虎の巻を使用すると、それぞれ先行するタスクを基に構築されている一連のタスクを記述できます。
虎の巻を使用するべきでない場合
虎の巻が最適に機能するのは、一連の単純ステップによって問題を解決できる場合です。虎の巻は、グラフィックスの豊富な HTML ページの作成や検索/ハイパーリンクによる情報のランダム・アクセスを可能にするヘルプ・システムの代わりにはなりません。虎の巻は、ユーザーが大量のテキストを入力しなければならないようなタスク向きではありません。
虎の巻作成のガイドライン
- 短くて分かりやすいタイトルを選択します。
- 虎の巻タスク内で、ヘルプ・システムへのリンクをできるだけ利用して、バックグラウンド情報または詳細情報を提供します。
- 10 ステップを超える場合、コンポジット虎の巻として書き直すよう考慮してください。
- パースペクティブのオープン、リソースのオープン、ウィザードの実行などの、できるだけ単純で退屈なタスクを実行するコマンドを使用します。コマンドを使わなくても同じ効果を実現する方法について必ず説明してください。
- ユーザーが手作業でステップを実行するように決定した場合にコマンドをスキップできるようにします。
- ダイアログを開くステップについて dialog="true" を指定します。これによって、ほとんどのダイアログの右側にある「トレイ」に虎の巻が開きます。
- ユーザーに頻繁に成功の兆しが見えるように、各ステップを編成します。
Java ソースに対してさまざまな変更を数多く行ってからアプリケーションを起動するような虎の巻は、それぞれのソース変更後にアプリケーションが起動されるように書き換えることができます。
- ユーザーが各ステップの実行の意味を理解できるようにします。
- ステップを実行する方法を複数、記述するのではなく、最小限の説明で済む最も単純な方法を採用します。
- 改行 (<br/>) タグを使用して読みやすくします。
- 下位項目を使用して、ステップをそれより小さいステップに分割することができます。
- すべての虎の巻に下位項目が必要なわけではありません。
- 下位項目のラベルは、"Input"、"Expand"、"Select" などのアクション・ワードで始めてください。
- 下位項目のラベルでは、引用符を用いて明確にインターフェース・テキストを識別し、それによって位置指定と相互処理に必要なインターフェース・テキストと、命令テキストをユーザーが区別できるようにします。
- 各下位項目は、1 つの値の入力など 1 つの最小単位のタスクを行う必要があります。
- 虎の巻の最終ステップには必ず <onCompletion> 要素を付加します。
- さまざまなサイズの虎の巻で、虎の巻の表示をテストします。
- エラー・ログ・ビューを開いて虎の巻をテストします。エラー・ログに警告が記録された場合に確認することができます。
コンポジット虎の巻作成のガイドライン
- コンポジット虎の巻には共通テーマに関連するタスクを含める必要があります。
- コンポジット虎の巻内の各タスクには、十分に定義されたゴールがなければなりません。
- 成功を認識できるように <onCompletion> 要素を使用します。
- タスク名は短く簡潔でなければなりません。
- 複雑な問題は、それぞれ先行するタスクを基に構築されたタスク群を使って解決できます。
- タスクがオプションの場合は、skip="true" を使用します。
- 整合性を保つため、シンプルな虎の巻の概要および名前が、コンポジット虎の巻に指定された概要および名前と一致するようにしてください。
- タスクの説明では、太字フォーマットを使用して、インターフェース・テキストを明確に識別してください。
- タスクを開始する順序の指定が重要な場合だけ、シーケンスを使用してください。
関連リンク
虎の巻の操作
コンポジット虎の巻の操作
簡単な虎の巻
コンポジット虎の巻