RoboHelp プロジェクトの計画

すぐにプロジェクトの作成に取り掛かるのではなく、必ず最初に十分な時間をかけてプロジェクトの計画を立てることをお勧めします。 その際、ビジネスの目標と、対象となるユーザーを想定する必要があります。 また、プロジェクトを計画する場合は、コンテンツの作成と配信で使用するリソースの影響も考慮する必要があります 1 つのプロジェクトで複数の作成者が共同作業を行う場合は、プロジェクトの品質を保ち、リソースの使用効率を最適化する上で、プロジェクトを適切に計画することが特に重要な要素になります。

オーサリングチームの規模は、プロジェクトを構成するプロセスとツールの種類を決定する上での重要な考慮事項になります。  例えば、複数の作成者が協力してコンテンツの作成と配信を行う必要がある場合は、必ずバージョンコントロールシステムを使用することをお勧めします。 同様に、用語集と共通アセットの作成と管理を行い、ガイドラインを作成して公開すると、複数の作成者が共同作業を行う環境で、プロジェクトの品質を確保することができます。

複数役割の設定

公開に関する要件の数が多くて複雑な場合は、チームメンバーをいくつかのグループに分割して、オーサリングと出力の生成を行う必要があります。 こうしたケースでは、各チームメンバーが RoboHelp の組み込み機能を使用できるような方法で各種プロセスとプロトコルを計画し、効率的でスムーズなコンテンツ配信を実現する必要があります。  

出力のタイプと配信

必要な出力タイプを定義する必要があります。 その際、後で別の出力タイプを追加しなければならないかどうかを検討します。 追加する必要がある場合、その出力タイプを簡単に追加できるような方法を検討する必要があります。 サーバー上で出力をホストする場合は、IT 部門の管理者と協力する必要があるかどうかを判断します。 モバイルアプリの出力を生成する場合は、バイト単位のトピックを作成するためのガイドラインを公開する必要があるかどうかを検討します。 また、製品の複数のバージョンのコンテンツを管理する必要があるかどうか、1 つの機能で共存する 2 つのエクスペリエンスに対してコンテンツを配信する必要があるかどうかについても検討します。 各種の出力に条件付きコンテンツを含める場合は、コンディションタグと条件式を定義する必要があるかどうかを検討します。 その際、各種の出力について、変数セットの計画を立てる必要があります。

出力の外観

対象ユーザーのニーズを満たすコンテンツを作成するには、十分な時間をかけて、出力の外観を視覚化する必要があります。 RoboHelp に付属しているスキンをチェックアウトして、既存のスキンをカスタマイズする必要があるかどうか、新しいスキンを作成する必要があるかどうかを検討します。 エンドユーザーに対して高品質なコンテンツエクスペリエンスを提供するには、計画段階でコストをかけて、優れたスタイルシートを作成する必要があります。

外部コンテンツの活用

RoboHelp とは異なる形式の外部コンテンツを使用する場合があります。 例えば、Microsoft Word に詳しい専門家が作成した質の高いコンテンツ（FAQ、ソリューション、ケーススタディなど）を使用する場合があります。 こうしたコンテンツは、RoboHelp に簡単に読み込むことができます。 ただし、Word の各種読み込み設計を確認し、スタイルや書式設定など、読み込むコンテンツのさまざまな要素について定義する必要があります。 配信コンテンツに関する Adobe Captivate のビデオがある場合は、コンテンツ内にそれらのビデオを組み込むことにより、没入型のコンテンツエクスペリエンスが実現します。

ナビゲーションの設計

各種のコンテンツを作成する前に、出力内のコンテンツをエンドユーザーがどのようにナビゲートするかについて設計する必要があります。その際、次の点を検討する必要があります。 トピックの全体的な構成と、各トピック内のコンテンツの構成。 各フォルダーで許可されるレベルの数。 トピック内のコンテンツを構成するための見出しレベルの数。 タイプが異なる出力や変数に対して異なる目次を使用するかどうか。 例えば、PDF 出力とレスポンシブ HTML 出力に対して出力変数を生成する場合や、内部ユーザーと外部ユーザー用の異なるヘルプシステムに対して出力変数を生成する場合は、それぞれ異なる目次を使用することをお勧めします。 同様に、初級ユーザーと上級ユーザーに対して、同じプロジェクトで個別のヘルプシステムを作成する場合は、それぞれ異なる目次を使用する必要があります。

コンテンツの再利用

RoboHelp のメリットの 1 つとして、コンテンツを再利用できるという点が挙げられます。 最初に、プロジェクト全体で共通して使用する必要があるコンテンツのタイプを特定します。 それらのコンテンツが頻繁に変わる場合や、プロジェクトサイクルの後半になって変わるような場合は、変数とスニペットを使用して、コンテンツの作成と更新を 1 箇所で行います。この方法により、プロジェクト内でコンテンツを繰り返して使用することができます。

コンテンツの書式設定とスタイル

スタイルを使用すると、コンテンツの各種要素について、一貫性のある洗練された外観を設計することができます。 RoboHelp の優れた機能として、プロジェクトレベルでのインライン書式設定を禁止することができます。 そのため、オーサリングを開始する前に、インラインでの書式設定を許可するか禁止するかを決定する必要があります。 インライン書式設定を許可する場合は、コンテンツの書式設定を統一するため、いくつかの規則を定義してそれに従う必要があります。 例えば、コンテンツ内で表示されるすべての UI 用語を太字にする場合は、太字に関する規則をプロジェクトの計画段階で定義し、オーサリングを行う場合は常にこの規則に従う必要があります。

用語集

用語集を作成する場合は、コストをかけて作成することをお勧めします。 各用語に対して明確な定義を追加することにより、エンドユーザーは、その用語の概念を把握し、必要な手順を理解できるようになります。 また作成者は、各用語について、プロジェクト全体で一環した用法を適用することにより、シームレスで高品質なユーザーエクスペリエンスを実現することができます。 RoboHelp では、プロジェクト内で複数の用語集を作成して管理することができます。 そのため、プロジェクトの出力には表示されない、作成者専用の用語集を使用することもできます。 また、複数の用語集をユーザー用として作成し、そのうちのいずれかの用語集を特定の出力タイプに含めたり除外したりすることもできます。

コンテンツの管理

RoboHelp の組み込み機能を使用して、コンテンツ用の管理フレームワークを定義することができます。 作成者は、定義されたトピックステータスのリストを常に使用することをお勧めします。 各種の RoboHelp レポートを効率的に使用することにより、エラーを特定したり、各種コンポーネント間の不整合を検出したり、プロジェクト全体で一括して更新を行ったりすることができます。 使用していないアセットとプロジェクトコンポーネントを削除することにより、プロジェクトをクリーンな状態に保つことができます。 また、プロジェクトのトピック内で、ガイドラインと作成者による注釈を管理し、プロジェクトの出力からは、これらのガイドラインと注釈を除外することもできます。