JP6529501B2 - 動的にカスタマイズされた文脈依存型ヘルプを生成する方法 - Google Patents

Description

本発明は、一般にコンピュータ・ソフトウェア・ヘルプ・システムの分野に関し、より具体的には、文脈依存型ヘルプ画面をカスタマイズすることに関する。

コンピュータ・システムがますます複雑になってきた時点で、大部分のソフトウェア製品に関して旧式の紙に書かれたマニュアルは姿を消した。その代わりが内蔵ヘルプ・システムであり、これは全てのユーザに対してオンデマンドでヘルプ・コンテンツを迅速且つ効率的に提供することができる。今日のコンピュータ・ソフトウェア製品及びアプリケーションの内蔵ヘルプ・システムは、標準ヘルプ画面及び文脈依存型ヘルプ画面を含む。標準ヘルプ画面は、コンテンツ又はインデックスの目次を有し、トピックによる検索が可能であるので、特定のトピックに関する情報をいつでも見いだすことができる。文脈依存型ヘルプ画面は、ヘルプに対する要求がなされた時点で、ソフトウェア製品内で現在実行されている動作に基づいて、ユーザに情報を提供する。ヘルプに対する要求は、ユーザが開始することができ、又は、コンピュータ・ソフトウェア製品若しくはコンピュータ・システム内の現在の問題によってトリガすることができる。

文脈依存型ヘルプ画面は、時として、コンピュータ・ソフトウェア製品が動作している環境の何らかの理解を要求するコマンドに対する指示を与えることがある。サーバ名、又はハードディスク・パスといった環境情報に関する総称変数は、ソフトウェア環境からの実際値のプレースホルダとして機能する。このときユーザは、使用前に、これらの変数をソフトウェア環境からの実際値で置換えなければならない。ユーザが変数を理解すること又は挿入する実際値を見いだすことに困難を覚える場合、ユーザは典型的にはシステム休止時間という代償を払って技術サポートを呼ばなければならない。多くの場合、技術サポート人員がこれらの実際値のいずれをも有していないので、ユーザは情報を見いだすためにウォークスルーさせられる。

本発明の目的は、文脈依存型ヘルプ画面をカスタマイズすることである。

本発明の実施形態は、ヘルプ画面をカスタマイズするための方法、コンピュータ・プログラム製品、及びシステムを開示する。コンピュータは、ヘルプ・コンテンツに対する要求を受け取る。コンピュータは、ヘルプ・コンテンツに対する要求に対応する注釈付きヘルプ・ファイルを識別する。コンピュータは、識別された注釈付きヘルプ・ファイル内の１つ又は複数の変数を識別する。コンピュータは、１つ又は複数の変数の各々の値をソフトウェア製品から検索する。コンピュータは、識別された注釈付きヘルプ・ファイル内の１つ又は複数の変数の各々を検索された値で置換えて、カスタマイズされたヘルプ・コンテンツを生成する。

本発明の実施形態による、分散データ処理環境を示す機能ブロック図である。 本発明の実施形態による、カスタマイズされた文脈依存型ヘルプ・システムの動作ステップを示すフローチャートである。 本発明の実施形態による、カスタマイズされた文脈依存型ヘルプ出力の一例のブロック図である。 本発明の実施形態による、カスタマイズされた文脈依存型ヘルプ出力の一例のブロック図である。 本発明の実施形態を実装するための例示的なコンピュータ・システムの構成要素のブロック図を示す。

コンピュータ・ソフトウェア製品及びアプリケーションがますます複雑になるにつれて、関連したヘルプ・システムを作成することは、ますます重要になり、競合製品を凌駕する競争力をもたらすことができる。本発明の実施形態は、総称的に記述されたソフトウェア製品のためのヘルプ・システム内の利用可能なコンテンツを認識するので、システムのハードウェア又はソフトウェア環境に関わらずソフトウェア・システムをカバーする。さらに、ある種のヘルプ・コンテンツは、総称値を使用して、ハードディスク・パス、サーバ名、及びポート構成などの環境固有値を参照する。従って、ユーザはこれらの環境固有値を知るか、又はそれらをどのようにして見いだすかを知る必要がある。ユーザは次に、それらを、ヘルプ・コンテンツ内で詳述されたいずれかのコマンドにどのようにして挿入するかを知る必要がある。本発明の実施形態は、製品開発中に、ヘルプ・ファイル内でこれらの環境固有フィールドにマーク付けする又は注釈付けすることを可能にする。後日、ヘルプ・コンテンツに対する要求を受け取ったときに、実際の環境値がソフトウェア製品から検索され、カスタマイズされた文脈依存型画面内に、ヘルプ・コンテンツが、注釈付きフィールドを実際の環境値で置換えて動的に記述される。ヘルプ文書はいまや、現在のインストールの文脈で表現される。コマンドは、それ以上編集することなく、文書から単にコピー及びペーストすることができ、管理者の作業がより効率的になる。本発明の実施形態は顧客環境内のアプリケーション及びそれらの相互作用の数の増加から生じる構成の問題に関する技術サポートへの要求を減らすことができる。本発明の実施形態の実装は、さまざまな形態をとることができ、例示的な実装の詳細は、後で図面を参照しながら説明する。

当業者であれば理解するように、本発明の態様は、システム、方法又はコンピュータ・プログラム製品として具体化することができる。従って、本発明の態様は、完全にハードウェアの実施形態、完全にソフトウェアの実施形態（ファームウェア、常駐ソフトウェア、マイクロコード等を含む）、又はソフトウェアの態様とハードウェアの態様とを組み合わせた実施形態の形を取ることができ、本明細書においてはこれらの全てを一般に「回路」、「モジュール」又は「システム」と呼ぶことができる。さらに、本発明の態様は、コンピュータ可読プログラム・コード／命令が組み入れられた１つ又は複数のコンピュータ可読媒体内として具体化されたコンピュータ・プログラム製品の形を取ることができる。

コンピュータ可読媒体の任意の組合せを用いることができる。コンピュータ可読媒体は、コンピュータ可読信号媒体又はコンピュータ可読ストレージ媒体とすることができる。コンピュータ可読ストレージ媒体は、例えば、電子、磁気、光学、電磁気、赤外線若しくは半導体のシステム、装置、若しくはデバイス、又は上記のもののいずれかの適切な組合せとすることができる。コンピュータ可読ストレージ媒体のより具体的な例（非網羅的なリスト）として、以下のもの：即ち、１つ又は複数の配線を有する電気的接続、ポータブル・コンピュータ・ディスケット、ハード・ディスク、ランダム・アクセス・メモリ（ＲＡＭ）、読み出し専用メモリ（ＲＯＭ）、消去可能なプログラム可能読み出し専用メモリ（ＥＰＲＯＭ又はフラッシュ・メモリ）、光ファイバ、ポータブル・コンパクト・ディスク読み出し専用メモリ（ＣＤ−ＲＯＭ）、光記憶装置、磁気記憶装置、又は上記のもののいずれかの適切な組合せが挙げられる。本明細書の文脈においては、コンピュータ可読ストレージ媒体は、命令実行システム、装置若しくはデバイスによって、又はこれらと関連して用いるためのプログラムを収容又は格納することができる任意の有形媒体とすることができる。

コンピュータ可読信号媒体は、例えばベースバンド内に又は搬送波の一部として、具体化されたコンピュータ可読プログラム・コードをその中に有する、伝搬されるデータ信号を含むことができる。このような伝搬信号は、これらに限定されるものではないが、電磁気、光又はそれらのいずれかの適切な組合せを含む、種々の形態のいずれかを取ることができる。コンピュータ可読信号媒体は、コンピュータ可読ストレージ媒体ではなく、かつ、命令実行システム、装置若しくはデバイスによって、又はこれらと関連して用いるためのプログラムを伝達し、伝搬し、又は搬送することができる任意のコンピュータ可読媒体とすることができる。

コンピュータ可読媒体上に具体化されたプログラム・コードは、これらに限定されるものではないが、無線、有線、光ファイバ・ケーブル、ＲＦ等、又は上記のもののいずれかの適切な組合せを含む、任意の適切な媒体を用いて伝送することができる。

本発明の態様の操作を実行するためのコンピュータ・プログラム・コードは、Ｊａｖａ（商標）、ＳｍａｌｌＴａｌｋ、Ｃ＋＋等のようなオブジェクト指向型プログラミング言語、及び「Ｃ」プログラミング言語又は同様のプログラミング言語のような従来の手続き型プログラミング言語を含む、１つ又は複数のプログラミング言語のいずれかの組合せで記述することができる。プログラム・コードは、完全にユーザのコンピュータ上で実行される場合もあり、一部がユーザのコンピュータ上で、独立型ソフトウェア・パッケージとして実行される場合もあり、一部がユーザのコンピュータ上で実行され、一部が遠隔コンピュータ上で実行される場合もあり、又は完全に遠隔コンピュータ若しくはサーバ上で実行される場合もある。一番最後のシナリオにおいては、遠隔コンピュータは、ローカル・エリア・ネットワーク（ＬＡＮ）若しくは広域ネットワーク（ＷＡＮ）を含むいずれかのタイプのネットワークを通じてユーザのコンピュータに接続される場合もあり、又は外部コンピュータへの接続が為される場合もある（例えば、インターネット・サービス・プロバイダを用いたインターネットを通じて）。

本発明の態様は、以下、本発明の実施形態による方法、装置（システム）及びコンピュータ・プログラム製品のフローチャート図及び／又はブロック図を参照して説明される。フローチャート図及び／又はブロック図の各ブロック、並びにフローチャート図及び／又はブロック図内のブロックの組合せは、コンピュータ・プログラム命令によって実装することができることが理解されよう。これらのコンピュータ・プログラム命令を、汎用コンピュータ、専用コンピュータ、又は他のプログラム可能データ処理装置のプロセッサに与えてマシンを製造し、それにより、コンピュータ又は他のプログラム可能データ処理装置のプロセッサによって実行される命令が、フローチャート及び／又はブロック図の１つ又は複数のブロック内で指定された機能／動作を実装するための手段を作り出すようにすることができる。

これらのコンピュータ・プログラム命令を、コンピュータ、他のプログラム可能データ処理装置、又は他のデバイスを特定の方式で機能させるように指示することができるコンピュータ可読媒体内に格納し、それにより、そのコンピュータ可読媒体内に格納された命令が、フローチャート及び／又はブロック図の１つ又は複数のブロックにおいて指定された機能／動作を実装する命令を含む製品を製造するようにすることもできる。

コンピュータ・プログラム命令を、コンピュータ、他のプログラム可能データ処理装置、又は他のデバイス上にロードして、一連の動作ステップをコンピュータ、他のプログラム可能データ処理装置、又は他のデバイス上で行わせてコンピュータ実施のプロセスを生成し、それにより、コンピュータ又は他のプログラム可能装置上で実行される命令が、フローチャート及び／又はブロック図の１つ又は複数のブロックにおいて指定された機能／動作を実行するためのプロセスを提供するようにすることもできる。

本発明の実施形態の実装は、種々の形態を取ることができ、例示的な実装の詳細を、この後で図面を参照しながら論じる。図面に示された実施形態は、ソフトウェア製品ヘルプ・システムと注釈付きヘルプ・ファイルとの相互作用を説明する。本明細書で開示される特定の詳細は、限定と解釈されるべきものではなく、単に、当業者に本開示の方法及び構造を様々に使用することを教示するための代表的な基礎として解釈すべきものである。本発明の実施形態は、コンピュータ・ソフトウェア製品内のヘルプスクリーン、ウェブ・サーバ上にホストされるオンラインヘルプ、コマンドライン・インタフェース又は他のＧＵＩスクリーンからのヘルプスクリーンを含む、全てのヘルプ・システム型式に適用することができる。

次に、本発明を、図面を参照しながら詳しく説明する。図１は、本発明の一実施形態による、全般的に１００で示される分散データ処理環境を示す機能ブロック図である。分散データ処理環境１００は、ネットワーク１０４上で相互接続されたサーバ・コンピュータ１０２、並びにクライアント・コンピュータ１０６、１０８、及び１１０を含む。

サーバ・コンピュータ１０２は、専用サーバ・コンピュータ、ラップトップ・コンピュータ、タブレット・コンピュータ、ネットブック・コンピュータ、パーソナル・コンピュータ（ＰＣ）、デスクトップ・コンピュータ、パーソナル・デジタル・アシスタント（ＰＤＡ）、スマートフォン、又は、ネットワーク１０４を介してクライアント・コンピュータ１０６、１０８、及び１１０と通信することができる任意のプログラム可能電子装置とすることができる。特定の実施形態において、サーバ・コンピュータ１０２は、データ・センタ及びクラウド・コンピューティング・アプリケーションで一般的であるような、ネットワーク１０４を通してアクセスされたときにシームレス・リソースの単一プールとして機能する、クラスタ化されたコンピュータ及び構成要素を利用するコンピュータ・システムを表す。一般に、サーバ・コンピュータ１０２は、機械可読プログラム命令を実行し、ネットワークを介して他のコンピューティング装置と通信することができる、任意のプログラム可能電子装置又はプログラム可能電子装置の組合せを代表するものである。サーバ・コンピュータ１０２の例示的な構成要素は、図５に関してより詳細に説明される。

本発明の様々な実施形態において、クライアント・コンピュータ１０６、１０８、及び１１０は各々、それぞれ、ラップトップ・コンピュータ、タブレット・コンピュータ、アプリケーション・サーバ、ノートブック・コンピュータ、パーソナル・コンピュータ（ＰＣ）、デスクトップ・コンピュータ、パーソナル・デジタル・アシスタント（ＰＤＡ）、スマートフォン、又は、ネットワーク１０４を介してサーバ・コンピュータ１０２と通信することができる任意のプログラム可能電子装置とすることができる。

ネットワーク１０４は、例えば、ローカル・エリア・ネットワーク（ＬＡＮ）、インターネットなどの広域ネットワーク（ＷＡＮ）、又はこれら２つの組合せとすることができ、有線、無線、又は光ファイバ接続を含むことができる。一般に、ネットワーク１０４は、サーバ・コンピュータ１０２とクライアント・コンピュータ１０６、１０８、及び１１０との間の通信をサポートすることができる接続及びプロトコルの任意の組合せとすることができる。

この実施形態において、クライアント・コンピュータ１０６、１０８、及び１１０は各々、それぞれクライアント・アプリケーション・プログラム２００のインスタンスを含み、これは、それぞれのクライアント・コンピュータ上でローカルに実行され、サーバ・コンピュータ１０２上のソフトウェア製品１１２に接続する機能を有する。図示した環境において、クライアント・アプリケーション・プログラム２００は、ユーザ・インタフェース１１８を用いてユーザ入力を受け取り、ユーザへの応答を出力する。ユーザ・インタフェース１１８は、ウェブ・ページ・アプリケーション、コマンド・ライン・プロセッサ・アプリケーション、又は任意の他のグラフィカル・ユーザ・インタフェース（ＧＵＩ）を利用することができる。クライアント・アプリケーション・プログラム２００は、ネットワーク１０４上でサーバ・コンピュータ１０２に情報を送り、サーバ・コンピュータ１０２から情報を受け取る。クライアント・アプリケーション・プログラム２００は、分散データ処理環境１００の内部で何らかの機能又はタスクを実行するために、ソフトウェア製品１１２に接続する。クライアント・アプリケーション・プログラム２００は、ソフトウェア製品１１２に接続することができ、何らかのタスクを実行するようにソフトウェア製品１１２に要求することができる、任意のプログラムとすることができる。クライアント・アプリケーション・プログラム２００は、ソフトウェア製品１１２の供給者又は開発者によって作成された、サーバ−クライアント環境内で使用するように関連付けられたクライアント・アプリケーションとすることができる。

サーバ・コンピュータ１０２は、ユーザ・インタフェース１２０、ソフトウェア製品１１２、ヘルプ・システム１１４、及び注釈付きヘルプ・ファイル１１６を含む。ユーザ・インタフェース１２０は、ウェブ・ページ、コマンド・ライン・プロセッサ、又は任意の他のＧＵＩを利用してソフトウェア製品１１２に接続することができる。図示した環境において、ソフトウェア製品１１２は、ユーザ・インタフェース１２０を使用して、ユーザ入力を受け取り、システム管理者などのユーザに応答を出力する。ネットワーク１０４上で、サーバ・コンピュータ１０２は、クライアント・コンピュータ、即ち、クライアント・コンピュータ１０６、１０８、又は１１０上で実行されているクライアント・アプリケーション・プログラム２００からヘルプ・コンテンツに対する要求を受け取ることができる。さらに、ヘルプ・コンテンツに対する要求は、サーバ・コンピュータ１０２上で実行されているソフトウェア製品１１２からくることもある。ソフトウェア製品１１２は、ヘルプ・コンテンツに対する要求をヘルプ・システム１１４に渡す。ヘルプ・システム１１４は、注釈付きヘルプ・ファイル１１６内に存在する対応するヘルプ文書を識別し、識別された注釈付きヘルプ・ファイル１１６を、ソフトウェア製品１１２又は環境構成ファイルからの情報を用いてカスタマイズし、要求に関連付けられたカスタマイズされたヘルプ・コンテンツを当初の要求側、即ち、クライアント・アプリケーション・プログラム２００又はソフトウェア製品１１２に返すことによって、要求を処理する。

図１の例証的な実施形態において、ヘルプ・システム１１４及び注釈付きヘルプ・ファイル１１６は、ソフトウェア製品１１２と共にサーバ・コンピュータ１０２上に存在する。本発明の別の実施形態において、ヘルプ・システム１１４、注釈付きヘルプ・ファイル１１６、及びソフトウェア製品１１２は、１つより多くのコンピュータ上に存在することができ、各々の項目自体が複数の部分に分割されて１つより多くのコンピュータにわたって散在することができる。いずれの構成においても以下のことが維持される。即ち、ヘルプ・システム１１４は、注釈付きヘルプ・ファイル１１６に接続され、さらにソフトウェア製品１１２に接続される。ヘルプ・システム１１４は、ソフトウェア製品１１２及びクライアント・アプリケーション・プログラム２００に完全に組み込まれ、部分的に組み込まれ、又はそれらから完全に分離したものとすることができる。ヘルプ・システム１１４は、それらに限定されないが、Ｅｃｌｉｐｓｅ Ｐｌａｔｆｏｒｍヘルプ・システム、Ｅｃｌｉｐｓｅ Ｉｎｆｏｒｍａｔｉｏｎ Ｃｅｎｔｅｒ（インフォセンタ）、又はＵＮＩＸ（商標）ｍａｎ（マニュアル）ページなどのヘルプ・システム技術を含むことができる。本発明の別の実施形態において、ヘルプ・システム１１４は、インストレーション内の１つより多くのソフトウェア製品を扱うことができ、ここで各ソフトウェア製品はそれぞれの注釈付きヘルプ・ファイルのセットを有する。本発明の別の実施形態において、ヘルプ・システム１１４は、ソフトウェア製品１１２のインストール環境の外部で遠隔にホストされ、ウェブ・サーバ上又はインストール環境の内部のいずれかに存在し得る注釈付ヘルプ・ファイル１１６を利用する、オンライン・ウェブ・アプリケーションとすることができことができる。ヘルプ・システム１１４は、図２でさらに説明される。

図２は、本発明の実施形態による、カスタマイズされた文脈依存型ヘルプ・システムであるヘルプ・システム１１４の動作ステップを示すフローチャートである。好ましい実施形態において、ヘルプ・システム１１４は、注釈付きヘルプ・ファイル１１６内の選択フィールドを環境固有値で置き換えることを指定する機能を含む。

ヘルプ・システム１１４は、ヘルプ・コンテンツに対する要求を受け取る（ステップ２０２）。サーバ・コンピュータ１０２上で実行されているヘルプ・システム１１４が、ユーザからヘルプ・コンテンツに対する要求を受け取る。一実施形態において、ヘルプ・システム１１４は、クライアント・コンピュータ、即ち、クライアント・コンピュータ１０６、１０８、又は１１０上で実行されているクライアント・アプリケーション・プログラム２００から、ヘルプ・コンテンツに対する要求をネットワーク１０４上で受け取る。クライアント・アプリケーション・プログラム２００は、ユーザから、ユーザ・インタフェース１１８を通してヘルプ・コンテンツに対する要求を受け取る。別の実施形態において、ヘルプ・システム１１４は、サーバ・コンピュータ１０２上で実行されているソフトウェア製品１１２からヘルプ・コンテンツに対する要求を受け取る。ソフトウェア製品１１２は、ユーザから、ユーザ・インタフェース１２０を通してヘルプ・コンテンツに対する要求を受け取る。どちらの場合も、ユーザは、ユーザ・インタフェースを通してヘルプ・コンテンツに対する要求を入力する。ユーザは、初めにヘルプ・ボタンをクリックするか又はヘルプ・メニュー項目を選択して、ヘルプ・システム１１４から初期ヘルプ画面を得ることができる。初期標準画面から、ユーザは、インデックス・リスト若しくは目次（ｔａｂｌｅ ｏｆ ｃｏｎｔｅｎｔｓ）からトピックを選択することができ、又は、検索機能を使用してトピックを検索することができる。関心のあるトピックを識別するまでに、幾つかの選択を行ってトピックのレベルを掘り下げることができる。ユーザがトピックに対するリンクをクリックするたびに、ヘルプ・コンテンツに対する要求が作成され、ヘルプ・システム１１４に送られる。例えば、あるユーザが、新しいソフトウェア製品をＤＢ２データベースに接続するように構成することを望むとする。ユーザは、ヘルプ・システムを開始し、目次の内部で以下の選択を行うことになる。即ち、ソフトウェア製品名をクリックし、そのトピック内でトピック「構成（Ｃｏｎｆｉｇｕｒｉｎｇ）」をクリックし、そのトピック内でトピック「データベース接続の構成（Ｃｏｎｆｉｇｕｒｉｎｇ ｄａｔａｂａｓｅ ｃｏｎｎｅｃｔｉｏｎ）」をクリックし、そしてそのトピック内でトピック「ＤＢ２データベースへの接続（Ｃｏｎｎｅｃｔｉｎｇ ｔｏ ａ ＤＢ２ ｄａｔａｂａｓｅ）」をクリックする。この時点で、ユーザは関心のあるトピックを見いだしている。各クリックにより、コンテンツ・リストの右にウェブ・ページを表示することができ、該ウェブ・ページは、実際値で置換えられた注釈付き変数を含む場合も又は含まない場合もある。全てのヘルプ・ページがこれらの変数を含むとは限らないが、変数を含むものは、ユーザに対して表示される前に実際値で変数を置換えることを要求することになる。

別の実施形態において、ソフトウェア製品１１２は、何らかのタスクの実行中にエラーに応答してヘルプ・コンテンツに対する要求を作成し、次いで、このヘルプ・コンテンツに対する要求をヘルプ・システム１１４に送る。例えば、ビジネス環境においてラップトップ・コンピュータを使用する人物は、そのラップトップ上のクライアント・アプリケーション・プログラム２００を用いて、データ・ストレージのタスクを要求するために、ソフトウェア製品１１２などのサーバ・アプリケーションに接続することができる。ソフトウェア製品１１２は、データ・ストレージのタスクを実行しているときにハードウェア装置への書込み中にエラーを生じることがある。エラーに続いて、ソフトウェア製品１１２は、エラーに基づいて、関心のあるトピック、例えば、クライアント・コンピュータからのデータ・ストレージに伴う問題、を識別するヘルプ・コンテンツに対する要求を作成することができる。幾つかのエラー・コードに応答して、特定のエラー・ログの位置を詳述するヘルプ文書を提示することができるので、顧客はログを外部の技術サポートに送ることができる。エラー・ログの位置が、実際の環境値が記入される注釈である。当業者であれば、ヘルプ・コンテンツに対する要求を受け取ることができる他の方法があることを認識するであろう。

ステップ２０４において、ヘルプ・システム１１４は、要求されたヘルプ・コンテンツを注釈付きヘルプ・ファイル１１６から識別する。ヘルプ・システム１１４は、関心のあるトピックを含むヘルプ・コンテンツに対する要求を受け取る。ヘルプ・システム１１４は、要求されたヘルプ文書を、注釈付きヘルプ・ファイル１１６の中から、識別された注釈付きヘルプ・ファイルがヘルプ・コンテンツに対する要求の中の関心のあるトピックと一致するように識別する。「識別された注釈付きヘルプ・ファイル」は、本明細書で使用する場合、単数形で示されるが、実際には、出力画面を形成するファイルの集合とすることができる。ソフトウェア製品１１２及びヘルプ・システム１１４の両方の製品開発者が、注釈付きヘルプ・ファイル１１６を準備する。製品開発者は、ヘルプ・コンテンツ内の変数を示す特別の注釈を有する複数のヘルプ文書ファイルを注釈付きヘルプ・ファイル１１６内に作成する。これらの文脈固有変数は、構成及び環境固有値に関係し、例えば、サーバ名及びプロファイル・ルート・ディレクトなどであり、開発時の製品チームには既知である。

ステップ２０６において、ヘルプ・システム１１４は、識別された注釈付きヘルプ・ファイル内の１つ又は複数の変数を識別する。ステップ２０４による識別された注釈付きヘルプ・ファイルが変数に関して走査される。各々の識別された注釈付きヘルプ・ファイルは、１つ又は複数の変数を保持することができ、単一変数の複数のインスタンスを含むことができる。変数は、ハードディスク・パス、サーバ名、又はポート構成を含むがそれらに限定されない環境固有値に対応する。これらの変数の値は、ソフトウェア製品１１２のインストール中に定義される。

ステップ２０８において、ヘルプ・システム１１４は、識別された注釈付きヘルプ・ファイルからの１つ又は複数の変数の各々の値を検索する。ヘルプ・システム１１４は、ソフトウェア製品１１２とインタフェースして、ステップ２０６で識別された１つ又は複数の変数の実際値を検索する。このインタフェースは、ヘルプ・システム１１４とソフトウェア製品１１２との間の双方向通信を提供する。ヘルプ・システム１１４は、ソフトウェア製品１１２に、変数の値に対する要求を送る。ソフトウェア製品１１２は、レジストリ又は他の構成ファイルに問い合わせて、ヘルプ・コンテンツ内の全ての変数に関する値を検索する。ソフトウェア製品１１２は、これらの変数の値をヘルプ・システム１１４に送る。ヘルプ・システム１１４は、これらの変数の値を受け取る。インタフェースは、ソフトウェア製品１１２及びヘルプ・システム１１４の両方の開発者によって書かれたアプリケーション・プログラミング・インタフェース（ＡＰＩ）である。本発明の別の実施形態において、インタフェースは、リプリゼンテーショナル・ステート・トランスファ（ＲＥＳＴ）インタフェース、又は当技術分野で知られた任意の他のインタフェース・アーキテクチャとすることができる。

ステップ２１０において、ヘルプ・システム１１４は、識別された注釈付きヘルプ・ファイル内の１つ又は複数の変数の各々を、検索された値で置換える。識別された注釈付きヘルプ・ファイル内の識別された１つ又は複数の変数の各々に関して、変数が、ステップ２０８で検索された実際値で置換えられる。識別された注釈付きヘルプ・ファイルのこの一時バージョンが、動的に生成されたカスタマイズされた文脈依存型ヘルプ文書となる。これはヘルプ文書の格納されたリポジトリを変更しない。環境構成が変化した場合、動的に生成されるカスタマイズされた文脈依存型ヘルプ文書は、それに応じて順応し、有効性を持続する。本発明の一実施形態において、動的に生成されたカスタマイズされた文脈依存型ヘルプ文書内に挿入された値に、強調表示するか、下線を付すか、又は何らかの仕方でマーク付けして、ユーザにそのテキストが変数であったことを知らせることができる。本発明の別の実施形態において、注釈付きヘルプ・ファイル１１６を全体として実際値でカスタマイズして、ソフトウェア製品１１２による使用のために保存することができる。この場合、インストール環境が変化した場合、変数に関する新たな値を用いて、注釈付きヘルプ・ファイル１１６の新たなカスタマイズされたバージョンを再作成しなければならない。

ステップ２１２において、ヘルプ・システム１１４は、カスタマイズされたヘルプ・コンテンツをユーザ・インタフェース（ＵＩ）に送る。本発明の好ましい実施形態において、ヘルプ・システム１１４は、動的に生成されたカスタマイズされたヘルプ・コンテンツを要求側に送る。クライアント・アプリケーション・プログラム２００は、受け取ったカスタマイズされたヘルプ・コンテンツを、ユーザ・インタフェース１１８を通してユーザに送る。ソフトウェア製品１１２は、受け取ったカスタマイズされたヘルプ・コンテンツを、ユーザ・インタフェース１２０を通してユーザに送る。ソフトウェア製品１１２がエラーに応答して要求を生成した場合、カスタマイズされたヘルプ・コンテンツは、適切なユーザに送られることになる。カスタマイズされたヘルプ・コンテンツは、ｈｔｍｌページ、ＰＤＦファイル、インフォメーション・センタ・ウェブ・ページ、又は当業者が利用できる他の型式のウェブ・ページの形態にすることができる。カスタマイズされたヘルプ・コンテンツはまた、ポップアップ・ウィンドウ又はコマンド・ライン・ウィンドウ内に送出することができる。当業者であれば、応答を書式設定する又はユーザに伝達することができる他の方式があることを認識するであろう。

ヘルプ・システム１１４は、ステップ２０２から２１２までを、ユーザが要求する限り繰返すことができる。

図３は、本発明の実施形態による、カスタマイズされた文脈依存型ヘルプ出力の一例のブロック図である。ヘルプ・コンテンツの例３００は、環境固有パス値から引き出された変数に関する値の一例である。

ブロック３０２は、変数を含む注釈付きヘルプ・コンテンツの一例を示す。ブロック３０２において、囲み項目「＄ ｛ＡＰＰ＿ＩＮＳＴＡＬＬ＿ＲＯＯＴ｝」及び「ｐｒｏｆｉｌｅ＿ｒｏｏｔ」は、ヘルプ・コンテンツ内の注釈付き変数である。

ブロック３０４は、２つの変数及び関連する実際値の一例である。ブロック３０４内で、変数「ｐｒｏｆｉｌｅ＿ｒｏｏｔ」＝「Ｃ：／Ｐｒｏｇｒａｍ Ｆｉｌｅｓ／ＩＢＭ／ＷＳ／ＡｐｐＳｅｒｖｅｒ／ｐｒｏｆｉｌｅｓ／ＡｐｐＳｒｖ０１／」であり、変数「＄ ｛ＡＰＰ＿ＩＮＳＴＡＬＬ＿ＲＯＯＴ｝」＝「ｐｒｏｆｉｌｅ＿ｒｏｏｔ／ｉｎｓｔａｌｌｅｄＡｐｐｓ」である。この場合、１つの変数がその内部に別の変数を含む。

ブロック３０６は、変数が実際値で置換えられた後のカスタマイズされたヘルプ・コンテンツを示す。このヘルプ・コンテンツは、囲み項目で示す環境固有情報を用いてカスタマイズされており、ユーザに送る準備ができている。これは例証的な一例であり、限定を意図したものではない。

図４は、本発明の実施形態による、カスタマイズされた文脈依存型ヘルプ出力の一例のブロック図である。ヘルプ・コンテンツの例３５０は、レジストリ構成ファイルから、及び環境固有パス値から引き出された変数の値の一例である。

ブロック３０８は、変数を含む注釈付きヘルプ・コンテンツの一例を示す。ブロック３０８において、囲み項目「ａｐｐ＿ｈｏｍｅ」、「＄ａｐｐｓｅｒｖｅｒ．ｕｓｅｒ」、「＄ａｐｐｓｅｒｖｅｒ．ｐａｓｓｗｏｒｄ」、「＄ａｐｐｓｅｒｖｅｒ．ｗａｓ．ｓｅｒｖｅｒ」及び「＄ａｐｐｓｅｒｖｅｒ．ｌｏｇ．ｌｅｖｅｌ」は、ヘルプ・コンテンツ内の注釈付き変数である。

ブロック３１０は、５つの変数及び関連付けられた実際値の一例である。ブロック３１０内で、変数「ａｐｐ＿ｈｏｍｅ」＝「Ｃ：／Ｐｒｏｇｒａｍ Ｆｉｌｅｓ／ＩＢＭ／ＪａｚｚＳＭ／ｐｒｏｆｉｌｅ」は環境パス情報からくるものである。残りの変数は、「ＣＬＩ．ｐｒｏｐｅｒｔｉｅｓ」と名付けられたレジストリ構成ファイルの内部の定義された変数に由来するものである。変数「＄ａｐｐｓｅｒｖｅｒ．ｕｓｅｒ」＝「ｆｒｓａｄｍｉｎ」である。変数「＄ａｐｐｓｅｒｖｅｒ．ｐａｓｓｗｏｒｄ」＝「＄２ｗｓ！ｋａ／／ｐａ＄％＠３」である。変数「＄ａｐｐｓｅｒｖｅｒ．ｗａｓ．ｓｅｒｖｅｒ」＝「ｓｅｒｖｅｒ１」である。変数「＄ａｐｐｓｅｒｖｅｒ．ｌｏｇ．ｌｅｖｅｌ」＝「Ｓｅｖｅｒｅ」である。この場合、変数の値は、ヘルプ・システム１１４及びソフトウェア製品１１２によって２つの場所から引き出されたものである。ヘルプ・システム１１４は、インタフェースを通してソフトウェア製品１１２からの変数の値を要求する。ソフトウェア１１２製品は次に、レジストリ又は他の構成ファイルに問い合わせて、ヘルプ・コンテンツ内の全ての変数の値を検索する。

ブロック３１４は、変数が実際値で置換えられた後のカスタマイズされたヘルプ・コンテンツを示す。このヘルプ・コンテンツは、囲み項目で示す実際値でカスタマイズされており、ユーザに送る準備ができている。これは例証的な一例であり、限定を意図したものではない。注釈付きヘルプ・ファイル内には、もっと多くの変数及び種々の型式の変数が存在し得る。

製品環境から引き出される変数及び環境構成項目の例示的なリストは以下の通りである。（１）製品環境変数リスト（即ち、ＩＴＭ＿ＨＯＭＥ＝／ｏｐｔ／ＩＢＭ／ＩＴＭ）から検索されるパス及び環境変数、例えば、％ＩＴＭ＿ＨＯＭＥ％、％ＣＡＮＤＬＥ＿ＨＯＭＥ％、％ＯＭＮＩ＿ＨＯＭＥ％、％ＨＯＳＴ＿ＮＡＭＥ％等− ％ＩＴＭ＿ＨＯＭＥ％、（２）製品構成ファイルから検索されるサーバ・レベルのパラメータ値、例えば、％ＳＥＲＶＥＲ＿ＮＡＭＥ％、％ＯＳ＿ＡＲＣＨ％、％ＣＥＬＬ＿ＮＡＭＥ％、％ＮＯＤＥ＿ＮＡＭＥ％、％ＡＰＰＳＥＲＶＥＲ＿ＨＯＭＥ％、（３）製品構成ファイルから検索されるアプリケーション・ユーザ・レベルのパラメータ、例えば、％ＰＯＲＴ％、％ＬＯＧ＿ＬＥＶＥＬ％、％ＴＲＡＣＥ＿ＬＥＶＥＬ％、％ＵＳＥＲ＿ＮＡＭＥ％、並びに（４）サービス・ファイル及びデータベース構成ファイルから検索されるデータベース・レベルのパラメータ値、例えば、％ＴＨＲＥＡＤ＿ＰＯＯＬＳ％、％ＤＡＴＡＢＡＳＥ＿ＵＳＥＲ％、％ＤＡＴＡＢＡＳＥ＿ＩＮＳＴＡＮＣＥ＿ＮＡＭＥ％、％ＤＡＴＡＢＡＳＥ＿ＰＯＲＴ％、％ＪＤＢＣ＿ＣＯＮＮＥＣＴＩＯＮ＿ＴＩＭＥＯＵＴ％。本発明の好ましい実施形態は、上記の変数及び変数型のうちの少なくとも１つを、カスタマイズされたヘルプ・コンテンツ内で使用する。

図５は、本発明の例証的な実施形態による、サーバ・コンピュータ１０２の構成要素のブロック図を示す。図５は、１つの実装の単なる例証を与えるものであり、種々異なる実施形態を実装することができる環境に関する何らかの限定を意味するものではないことを認識することができるであろう。図示した環境に多くの修正を加えることができる。

サーバ・コンピュータ１０２は、コンピュータ・プロセッサ４０４、メモリ４０６、永続的記憶装置４０８、通信ユニット４１０、及び入力／出力（Ｉ／Ｏ）インタフェース４１２の間の通信を提供する通信ファブリック４０２を含む。通信ファブリック４０２は、プロセッサ（例えば、マイクロプロセッサ、通信及びネットワーク・プロセッサなど）、システム・メモリ、周辺装置、及びシステム内の任意の他のハードウェア構成要素の間でデータ及び／又は制御情報を送るように設計された任意のアーキテクチャを用いて実装することができる。例えば、通信ファブリック４０２は、１つ又は複数のバスを用いて実装することができる。

メモリ４０６及び永続的記憶装置４０８は、コンピュータ可読記憶媒体である。この実施形態において、メモリ４０６は、ランダム・アクセス・メモリ（ＲＡＭ）４１４及びキャッシュ・メモリ４１６を含む。一般に、メモリ４０６は、任意の適切な揮発性又は不揮発性のコンピュータ可読記憶媒体を含むことができる。

ヘルプ・システム１１４、ソフトウェア製品１１２、及び注釈付きヘルプ・ファイル１１６は、１つ又は複数のメモリ４０６を介した、１つ又は複数のそれぞれのコンピュータ・プロセッサ４０４による実行及び／又はアクセスのために、永続的記憶装置４０８内に格納される。ヘルプ・システム１１４は、ソフトウェア製品１１２及び注釈付きヘルプ・ファイル１１６の両方へのアクセスを有する。この実施形態において、永続的記憶装置４０８は、磁気ハードディスク・ドライブを含む。代替的に、又は磁気ハードディスク・ドライブに加えて、永続的記憶装置４０８は、ソリッド・ステート・ハード・ドライブ、半導体記憶デバイス、読み出し専用メモリ（ＲＯＭ）、消去可能プログラム可能読み出し専用メモリ（ＥＰＲＯＭ）、フラッシュ・メモリ、又は、プログラム命令若しくはデジタル情報を格納することができる任意の他のコンピュータ可読記憶媒体を含むことができる。

永続的記憶装置４０８に使用される媒体は取外し可能とすることもできる。例えば、取外し可能ハード・ドライブを永続的記憶装置４０８に利用することができる。他の例としては、光及び磁気ディスク、サム・ドライブ、及び、スマート・カードが挙げられ、これらが、やはり永続的記憶装置４０８の一部分である別のコンピュータ可読記憶媒体への転送のためにドライブ内に挿入される。

これらの例において、通信ユニット４１０は、サーバ・コンピュータ１０２並びにクライアント・コンピュータ１０６、１０８、及び１１０のリソースを含む他のデータ処理システム又は装置との通信を提供する。これらの例において、通信ユニット４１０は、１つ又は複数のネットワーク・インタフェース・カードを含む。通信ユニット４１０は、物理通信リンク及び無線通信リンクのいずれか又は両方の使用による通信を提供することができる。ヘルプ・システム１１４、ソフトウェア製品１１２、及び注釈付きヘルプ・ファイル１１６は、通信ユニット４１０を通して永続的記憶装置４０８にダウンロードすることができる。

Ｉ／Ｏインタフェース４１２は、サーバ・コンピュータ１０２に接続することができる他の装置とのデータの入力及び出力を可能にする。例えば、Ｉ／Ｏインタフェース４１２は、キーボード、キーパッド、タッチ・スクリーン、及び／又は他の何らかの適切な入力装置などの外部装置４１８への接続を提供することができる。外部装置４１８はまた、携帯可能なコンピュータ可読記憶媒体、例えば、サム・ドライブ、携帯可能な光又は磁気ディスク、及びメモリ・カードなどを含むことができる。本発明の実施形態を実施するために使用されるソフトウェア及びデータ、例えば、ヘルプ・システム１１４、ソフトウェア製品１１２、及び注釈付きヘルプ・ファイル１１６は、それらの携帯可能なコンピュータ可読記憶媒体上に格納することができ、Ｉ／Ｏインタフェース４１２を介して永続的記憶装置４０８にロードすることができる。Ｉ／Ｏインタフェース４１２は、ディスプレイ４２０にも接続される。

ディスプレイ４２０は、ユーザにデータを表示するための機構を提供し、例えば、コンピュータ・モニタとすることができる。

本明細書で説明したプログラムは、本発明の特定の実施形態において実装されるアプリケーションに基づいて識別される。しかし、本明細書におけるいずれの特定のプログラム用語も、単に便宜上用いたものであり、従って、本発明は、そのような用語によって識別され及び／又は暗示されるいずれかの特定のアプリケーションにのみ使用するように限定されるべきではないことを認識されたい。

図面内のフローチャート及びブロック図は、本発明の種々の実施形態による、システム、方法、及びコンピュータ・プログラム製品の可能な実装の、アーキテクチャ、機能及び動作を示す。この点に関して、フローチャート又はブロック図内の各ブロックは、指定された論理機能を実装するための１つ又は複数の実行可能命令を含むモジュール、セグメント、又はコードの一部を表すことができる。幾つかの代替的な実装において、ブロック内に記された機能は、図中に記された順序とは異なる順序で生じることがあることにも留意されたい。例えば、連続して示された２つのブロックは、関与する機能に応じて、実際には実質的に同時に実行されることもあり、又はこれらのブロックはときとして逆順で実行されることもある。ブロック図及び／又はフローチャート図の各ブロック、及びブロック図及び／又はフローチャート図中のブロックの組合せは、指定された機能又は動作を実行する専用ハードウェア・ベースのシステム、又は専用のハードウェアとコンピュータ命令との組合せによって実装することができることにも留意されたい。

１００：分散データ処理環境
１０２：サーバ・コンピュータ
１０６、１０８、１１０：クライアント・コンピュータ
１１８、１２０：ユーザ・インタフェース
３００、３５０：ヘルプ・コンテンツの例

Claims (17)

1. ヘルプ・コンテンツをカスタマイズする方法であって、
   コンピュータが、ヘルプ・コンテンツに対する要求を受け取ることと、
   前記コンピュータが、前記ヘルプ・コンテンツに対する要求に対応する注釈付きヘルプ・ファイルを識別することと、
   前記コンピュータが、前記識別された注釈付きヘルプ・ファイル内の１つ又は複数の変数を識別することと、
   前記コンピュータが、前記１つ又は複数の変数の各々の値をソフトウェア製品から検索することと、
   前記コンピュータが、前記識別された注釈付きヘルプ・ファイル内の前記１つ又は複数の変数の各々を前記検索された値で置換えて、カスタマイズされたヘルプ・コンテンツを生成することと、
   を含み、
   前記１つ又は複数の変数の各々の値をソフトウェア製品から検索することは、
   前記コンピュータが、前記ソフトウェア製品からの前記１つ又は複数の変数の各々の値を要求することであって、前記ソフトウェア製品が、前記１つ又は複数の変数の各々の前記要求された値に関してリソースに問い合わせる、ことと、
   前記コンピュータが、前記１つ又は複数の変数の各々の前記要求された値を受け取ることと、
   を含む、方法。
2. 前記注釈付きヘルプ・ファイルが、環境及び構成値に関する変数で注釈付けされる、請求項１に記載の方法。
3. 前記コンピュータが、前記ソフトウェア製品とヘルプ・システムとの間のインタフェースを作成して、前記ソフトウェア製品と前記ヘルプ・システムとの間に双方向通信を提供することをさらに含む、請求項１に記載の方法。
4. 前記ソフトウェア製品に接続される前記ヘルプ・システムが、複数の注釈付きヘルプ・ファイルにさらに接続される、請求項３に記載の方法。
5. 前記ヘルプ・システムが、前記ソフトウェア製品のインストール環境の外部で遠隔にホストされるオンライン・アプリケーションとして存在する、請求項４に記載の方法。
6. 前記１つ又は複数の変数が、製品環境変数リストから検索されるパス及び環境変数、製品構成ファイルから検索されるサーバ・レベルのパラメータ値、製品構成ファイルから検索されるアプリケーション・ユーザ・レベルのパラメータ、並びに、サービス・ファイル及びデータベース構成ファイルから検索されるデータベース・レベルのパラメータ値、のうちの少なくとも１つを含む、請求項１に記載の方法。
7. ヘルプ・コンテンツをカスタマイズするためのコンピュータ・プログラムであって、
   ヘルプ・コンテンツに対する要求を受け取るためのプログラム命令と、
   前記ヘルプ・コンテンツに対する要求に対応する注釈付きヘルプ・ファイルを識別するためのプログラム命令と、
   前記識別された注釈付きヘルプ・ファイル内の１つ又は複数の変数を識別するためのプログラム命令と、
   前記１つ又は複数の変数の各々の値をソフトウェア製品から検索するためのプログラム命令と、
   前記識別された注釈付きヘルプ・ファイル内の前記１つ又は複数の変数の各々を前記検索された値で置換えて、カスタマイズされたヘルプ・コンテンツを生成するためのプログラム命令と、
   を含み、
   前記１つ又は複数の変数の各々の値をソフトウェア製品から検索するために、
   前記ソフトウェア製品からの前記１つ又は複数の変数の各々の値を要求するためのプログラム命令であって、前記ソフトウェア製品が、前記１つ又は複数の変数の各々の前記要求された値に関してリソースに問い合わせる、プログラム命令と、
   前記１つ又は複数の変数の各々の前記要求された値を受け取るためのプログラム命令と、
   を含む、
   コンピュータ・プログラム。
8. 前記注釈付きヘルプ・ファイルが、環境及び構成値に関する変数で注釈付けされる、請求項７に記載のコンピュータ・プログラム。
9. 前記コンピュータ・プログラムが、
   前記ソフトウェア製品とヘルプ・システムとの間にインタフェースを作成して、前記ソフトウェア製品と前記ヘルプ・システムとの間に双方向通信を提供するためのプログラム命令をさらに含む、請求項７に記載のコンピュータ・プログラム。
10. 前記ソフトウェア製品に接続される前記ヘルプ・システムが、複数の注釈付きヘルプ・ファイルにさらに接続される、請求項９に記載のコンピュータ・プログラム。
11. 前記ヘルプ・システムが、前記ソフトウェア製品のインストール環境の外部で遠隔にホストされるオンライン・アプリケーションとして存在する、請求項１０に記載のコンピュータ・プログラム。
12. 前記１つ又は複数の変数が、製品環境変数リストから検索されるパス及び環境変数、製品構成ファイルから検索されるサーバ・レベルのパラメータ値、製品構成ファイルから検索されるアプリケーション・ユーザ・レベルのパラメータ、並びに、サービス・ファイル及びデータベース構成ファイルから検索されるデータベース・レベルのパラメータ値、のうちの少なくとも１つを含む、請求項７に記載のコンピュータ・プログラム。
13. ヘルプ・コンテンツをカスタマイズするためのコンピュータ・システムであって、
    １つ又は複数のコンピュータ・プロセッサと、
    １つ又は複数のコンピュータ可読記憶媒体と、
    前記１つ又は複数のコンピュータ・プロセッサのうちの少なくとも１つによる実行のための、前記コンピュータ可読記憶媒体上に格納されたプログラム命令と、
    を含み、
    前記プログラム命令は、
    ヘルプ・コンテンツに対する要求を受け取るためのプログラム命令と、
    前記ヘルプ・コンテンツに対する要求に対応する注釈付きヘルプ・ファイルを識別するためのプログラム命令と、
    前記識別された注釈付きヘルプ・ファイル内の１つ又は複数の変数を識別するためのプログラム命令と、
    前記１つ又は複数の変数の各々の値をソフトウェア製品から検索するためのプログラム命令と、
    前記識別された注釈付きヘルプ・ファイル内の前記１つ又は複数の変数の各々を前記検索された値で置換えて、カスタマイズされたヘルプ・コンテンツを生成するためのプログラム命令と、
    を含み、
    前記１つ又は複数の変数の各々の値をソフトウェア製品から検索するために、
    前記ソフトウェア製品からの前記１つ又は複数の変数の各々の値を要求するためのプログラム命令であって、前記ソフトウェア製品が、前記１つ又は複数の変数の各々の前記要求された値に関してリソースに問い合わせる、プログラム命令と、
    前記１つ又は複数の変数の各々の前記要求された値を受け取るためのプログラム命令と、
    を含む、
    コンピュータ・システム。
14. 前記注釈付きヘルプ・ファイルが、環境及び構成値に関する変数で注釈付けされる、請求項１３に記載のコンピュータ・システム。
15. 前記コンピュータ・システムが、
    前記ソフトウェア製品とヘルプ・システムとの間にインタフェースを作成して、前記ソフトウェア製品と前記ヘルプ・システムとの間の双方向通信を提供するためのプログラム命令をさらに含む、請求項１３に記載のコンピュータ・システム。
16. 前記ソフトウェア製品に接続される前記ヘルプ・システムが、複数の注釈付きヘルプ・ファイルにさらに接続される、請求項１５に記載のコンピュータ・システム。
17. 前記ヘルプ・システムが、前記ソフトウェア製品のインストール環境の外部で遠隔にホストされるオンライン・アプリケーションとして存在する、請求項１６に記載のコンピュータ・システム。

Images