更新可能なヘルプの作成: ステップバイステップ

このドキュメントでは、更新可能なヘルプを作成するプロセスの手順を示します。

更新可能なヘルプの作成: ステップ バイ ステップ

更新可能なヘルプはエンド ユーザー向けの設計ですが、モジュールの作成者やヘルプ ライターにも大きな利点があります。たとえば、モジュールが出荷された後も、コンテンツの追加、エラーの修正、複数の UI カルチャでの配信、ユーザーのコメントと要求への応答などの機能が含まれています。 このトピックでは 、Update-Help コマンドレットと Save-Help コマンドレットを使用してユーザーがダウンロードしてインストールできるよう、ヘルプ ファイルをパッケージ化してアップロードする方法について説明します。

次の手順では、更新可能なヘルプをサポートするプロセスの概要を示します。

手順 1: ヘルプ ファイルのインターネット サイトを検索する

更新可能なヘルプを作成する最初の手順は、モジュールのヘルプ ファイルのインターネットの場所を見つける方法です。 実際には、2 つの異なる場所を使用できます。 モジュールのヘルプ情報ファイル (HelpInfo XML - 後述) は、あるインターネットの場所に保持し、ヘルプ コンテンツ CAB ファイルを別のインターネットの場所に保持することができます。 モジュールのすべてのヘルプ コンテンツ CAB ファイルは、同じ場所に置く必要があります。 異なるモジュールのヘルプ コンテンツ CAB ファイルを同じ場所に配置できます。

手順 2: HelpInfoURI キーをモジュール マニフェストに追加する

HelpInfoURI キーを モジュール マニフェストに追加します。 キーの値は、モジュールUniform Resource Identifier HelpInfo XML 情報ファイルの場所の URI (URI) です。 セキュリティのために、アドレスは "http" または "https" で始まる必要があります。 URI はインターネットの場所を指定する必要がありますが、HelpInfo XML ファイル名を含め "ない" 必要があります。

例:

@{
RootModule = TestModule.psm1
ModuleVersion = '2.0'
HelpInfoURI = 'https://go.microsoft.com/fwlink/?LinkID=0123'
}

手順 3: HelpInfo XML ファイルを作成する

HelpInfo XML 情報ファイルには、ヘルプ ファイルのインターネットの場所の URI と、サポートされている各 UI カルチャのモジュールの最新のヘルプ ファイルのバージョン番号が含まれています。 すべてのモジュールWindows PowerShell HelpInfo XML ファイルが 1 つ用意されています。 ヘルプ ファイルを更新する場合は、HelpInfo XML ファイルを編集または置き換える必要があります。別の追加は行う必要があります。 詳細については 、「HelpInfo XML ファイルを作成する方法」を参照してください。

手順 4: CAB ファイルを作成する

などのキャビネット ( ) ファイルを作成するツールを使用して、モジュールのヘルプ ファイルを含む .cab MakeCab.exe CAB ファイルを作成します。 サポートされている各 UI カルチャのヘルプ ファイル用に個別の CAB ファイルを作成します。 詳細については、「更新可能な ヘルプ CAB ファイルを準備する方法」を参照してください。

手順 5: アップロードを作成する

新規または更新されたヘルプ ファイルを発行するには、HELPInfo XML ファイルの HelpContentUri 要素で指定されたインターネットの場所に CAB ファイルをアップロードします。 次に、HelpInfo XML ファイルを、モジュール マニフェストの HelpInfoUri キーの値で指定されたインターネットの場所にアップロードします。