Technical Communication Suite とスタンドアロン製品を使用した HTML 公開ワークフロー

Adobe Technical Communications Suite は、コンテンツを一度オーサリングすればそれを複数のマルチメディア形式で配布できる能率的なワークフローをテクニカルコミュニケーターに提供します。FrameMaker でオーサリングを行い、FrameMaker 文書を RoboHelp に取り込み、ヘルプを Adobe AIR ヘルプや WebHelp など複数の形式で公開できます。

Adobe Technical Communications Suite には、個別のスイートアプリケーションをスタンドアロン製品として使用した場合よりも、多彩な機能が提供されています。本スイートを使用したときとスタンドアロン製品を使用したときの、FrameMaker 文書を取り込むためのワークフローの違いを以下の表に示します。

ワークフローのタスク

Technical Communication Suite

FrameMaker および RoboHelp をスタンドアロンアプリケーションとして使用した場合

RoboHelp プロジェクトへの FrameMaker 文書の取り込み

FrameMaker ソース文書を RoboHelp プロジェクトにリンクまたは取り込みます。

FrameMaker 文書を取り込みます。

FrameMaker ソースファイルと RoboHelp トピックの同期

RoboHelp のプロジェクトマネージャーポッドには、リンク先文書が同期されているかどうかが表示されます。リンク先文書を更新すると、その変更が RoboHelp プロジェクトに反映できます。生成されたトピック内でその変更を保持するように選択できます。

FrameMaker 文書を再取り込みし、以前に生成されたトピックを上書きします。

ページ割り付け設定が変更されたときのトピック構造の更新

RoboHelp 内で FrameMaker 文書を更新します。

FrameMaker 文書を再取り込みし、以前に生成されたトピックを上書きします。

混在したソースの文書

一般的に、本スイートのワークフローを使用して既存の FrameMaker ブックをオンラインヘルプ形式に変換します。すなわち、ブック全体を RoboHelp 内にリンクします。よく整備された FrameMaker 文書の場合は、FrameMaker ソースまたは RoboHelp 内で生成されたトピックに少しだけ変更を加えるだけでワークフローを最適化できます。主として FrameMaker でオーサリングを行い、RoboHelp を公開ツールとして使用するときに、この方法を使用します。

ただし、RoboHelp プロジェクト内で種々のソースからのコンテンツを再利用する必要がある場合があります。たとえば、リファレンスガイドから概念情報を取り込み、メンテナンスガイドからトラブルシューティング情報を取り込んで、小さなオンラインヘルププロジェクトを更新する場合などです。これらの文書は、異なるツールやテンプレートでオーサリングされ、異なる執筆ガイドラインに従って書かれている可能性があります。

文書は次のようなソースを持つことができます。

  • 旧バージョンの FrameMaker でオーサリングされた文書

  • 構造化 FrameMaker および非構造化 FrameMaker の両方で作成された文書

  • FrameMaker および Microsoft Word でオーサリングされた文書

プロジェクト全体の変換設定

RoboHelp では、各ソースタイプごとにプロジェクト全体の設定を定義できます。すべての FrameMaker 文書の場合、変換設定を定義するのは 1 回のみです。これは文書が RoboHelp にリンクされているか取り込まれているかには関係しません。同様に、Microsoft Word 文書の変換設定も、文書がリンクされている場合や取り込まれている場合でも、同じです。

プロジェクト全体の変換設定を使用すると、1 つのプロジェクト内だけではなく、複数のプロジェクトに渡って一貫性を確保できます。段落、表、画像などに対して個別の変換設定を定義することなく、RoboHelp プロジェクトを迅速に設定できます。

プロジェクト全体の変換設定は、文書全体を FrameMaker または Word のいずれかでオーサリングし、RoboHelp を公開ツールとして使用する場合に最も良く機能します。この場合、オンラインヘルプ形式に公開するためにソースコンテンツを最適化し、RoboHelp 内ではコンテンツの変更をほとんどまたはまったく行いません。ただし、オーサリング環境が混在している場合や、複数のソースからのコンテンツを使用している場合は、状況が複雑になります。次の違いにより複雑になります。

FrameMaker テンプレート
RoboHelp では、リンクまたは取り込む FrameMaker 文書に適用するテンプレートを選択できます。文書の種類が異なるとテンプレートも異なり、異なる段落やその他の書式が設定されている場合があります。

トピック命名パターン
トピック名を段落テキストに基づいている場合は、この複雑な問題が発生します。見出しをどのように書いたかにより、RoboHelp のトピックは一貫性のない名前を持つことになる場合があります。FrameMaker 文書の場合、カスタムマーカーに基づいてトピック名の付け方を定義できます。Word では、カスタムマーカーに基づいてトピック名の付け方を定義することはできません。

状況依存ヘルプマーカーテキスト
ソース文書内で状況依存ヘルプを定義すると、オンラインヘルプの作成を完全に制御できます。ただし、ソースで状況依存性を定義すると、深刻な複雑性を持ち込んでしまいかねません。複数の種類のソース文書を使用する場合は、通常、書式が異なる複数のタイプのマーカーが使用されます。

状況依存ヘルプを作成するときのヒント

複雑な問題を回避するために、プロジェクトを計画するときは次のヒントに留意してください。

ワークフローを決定する
ネイティブに作成された大きな RoboHelp プロジェクトを処理する場合、もしコンテンツの入力が少ない場合は、引き続き RoboHelp でオーサリングするほうが賢明です。特に RoboHelp 内で目次、索引、用語集、および状況依存ヘルプの設定を定義した場合には、文書をリンクまたは取り込むとプロジェクトが複雑になります。ただし、最初からプロジェクトを作成する場合または既存のプロジェクトを大幅に改定する場合は、RoboHelp 内で手動によりコンテンツを更新する手間を回避するために、外部文書をリンクまたは取り込みます。

ソース文書を特定する
RoboHelp でプロジェクト設定を定義する前に、プロジェクトで使用するコンテンツのソースを特定します。すべてのソース文書がよく整備された FrameMaker 文書である場合は、文書をリンクします。ソース文書が複数の種類からなる場合は、文書を取り込みます。

リンクオプションや取り込みオプションを検討する
ソース文書から目次、索引、用語集を変換するように選択できますが、オプションを注意深く検討してください。たとえば、ソース文書内の目次構造を保持したいときは、目次を取り込むことが最良です。同様に、異なるバージョンの FrameMaker 文書や Word 文書を取り込む場合は、状況依存ヘルプマーカーや索引マーカーを使用する前に、十分に検討してください。これらを使用する利点が得られるのは、大幅な改版を行う場合のみです。更新が非常に小さい場合は、コンテンツを取り込み、RoboHelp 内でネイティブにマップ ID または索引エントリを追加する方法が最良です。

プロジェクト作成のシナリオ

ソース文書

使用方法

使用できるオプション

単一の非構造化または構造化 FrameMaker ブック

FrameMaker ブックをリンクする

RoboHelp を公開ツールとして使用し、RoboHelp 内ではほとんどまたはまったくコンテンツをオーサリングしない
  • FrameMaker 段落書式またはカスタムマーカーに基づいてページ割り付けを定義する

  • FrameMaker でカスタムマーカーを使用して状況依存ヘルプを作成する

  • 目次、索引、用語集を変換する

複数の非構造化または構造化 FrameMaker ブック

FrameMaker ブックをリンクする

RoboHelp を公開ツールとして使用し、RoboHelp 内ではほとんどまたはまったくコンテンツをオーサリングしない
  • FrameMaker 段落書式またはカスタムマーカーに基づいてページ割り付けを定義する

  • FrameMaker でカスタムマーカーを使用して状況依存ヘルプを作成する

  • 目次、索引、用語集を変換する

バージョン 7 より前の単一または複数の FrameMaker ブック

FrameMaker ブックを取り込む

  • FrameMaker 段落書式またはカスタムマーカーに基づいてページ割り付けを定義する

  • FrameMaker でカスタムマーカーを使用して状況依存ヘルプを作成する

  • 目次、索引、用語集を変換する

独立した FrameMaker 文書

FrameMaker 文書を取り込む

  • FrameMaker 段落書式またはカスタムマーカーに基づいてページ割り付けを定義する

  • 目次、索引、用語集を変換する

単一の Word 文書でよく整備された目次と索引を持つもの

Word 文書をリンクする

  • Word の段落スタイルに基づいてページ割り付けを定義する

  • Word でカスタム脚注オプションを使用して状況依存ヘルプマーカーを定義し、状況依存ヘルプのためにマーカーテキストを使用する

  • 目次、索引、用語集を変換する

  • RoboHelp を公開ツールとして使用し、RoboHelp 内ではほとんどまたはまったくコンテンツをオーサリングしない

複数の Word 文書

文書を取り込む

  • Word の段落スタイルに基づいてページ割り付けを定義する

  • Word でカスタム脚注オプションを使用して状況依存ヘルプマーカーを定義し、状況依存ヘルプのためにマーカーテキストを使用する

FrameMaker 文書と Word 文書の混在

FrameMaker 文書と Word 文書をリンクする

  • FrameMaker と Word の段落スタイルに基づいて、別々にページ割り付けを定義する

  • ソース文書で状況依存ヘルプマーカーを使用する

独立した FrameMaker 文書と Word 文書の混在

文書を取り込む

  • FrameMaker と Word の段落スタイルに基づいて、別々にページ割り付けを定義する

  • ソース文書で状況依存ヘルプマーカーを使用する

RoboHelp プロジェクト更新のシナリオ

ソース文書

使用方法

使用できるオプション

単一の非構造化または構造化 FrameMaker ブック

FrameMaker ブックをリンクする

  • FrameMaker 段落書式またはカスタムマーカーに基づいてページ割り付けを定義する

  • FrameMaker でカスタムマーカーを使用して状況依存ヘルプを作成する

複数の非構造化または構造化 FrameMaker ブック

FrameMaker ブックをリンクする

  • FrameMaker 段落書式またはカスタムマーカーに基づいてページ割り付けを定義する

複数の FrameMaker ブックまたは独立した FrameMaker 文書

FrameMaker ブックと文書を取り込む

  • FrameMaker 段落書式またはカスタムマーカーに基づいてページ割り付けを定義する

単一の Word 文書でよく整備された目次と索引を持つもの

Word 文書をリンクする

  • Word の段落スタイルに基づいてページ割り付けを定義する

複数の Word 文書

文書を取り込む

  • Word の段落スタイルに基づいてページ割り付けを定義する

独立した FrameMaker 文書と Word 文書の混在

文書を取り込む

  • FrameMaker と Word の段落スタイルに基づいて、別々にページ割り付けを定義する