Criação de ajuda atualizável: passo a passo

Este documento lista as etapas no processo de adoção da Ajuda Atualizável.

Autorizando ajuda atualizável: passo a passo

A Ajuda Atualizável foi projetada para usuários finais, mas também oferece benefícios significativos para autores de módulo e autores de ajuda, incluindo a capacidade de adicionar conteúdo, corrigir erros, entregar em várias culturas de interface do usuário e responder a comentários e solicitações do usuário, muito depois que o módulo for enviado. Este tópico explica como você empacota e carrega arquivos de ajuda para que os usuários possam baixá-los e instalá-los usando os cmdlets Update-Help e Save-Help.

As etapas a seguir fornecem uma visão geral do processo de suporte à Ajuda Atualizável.

Etapa 1: Encontrar um site da Internet para seus arquivos de ajuda

A primeira etapa na criação de ajuda atualizável é encontrar um local da Internet para os arquivos de ajuda do módulo. Na verdade, você pode usar dois locais diferentes. Você pode manter o arquivo de informações de ajuda do módulo (XML HelpInfo – descrito abaixo) em um local da Internet e os arquivos CAB de conteúdo de ajuda em outro local da Internet. Todos os arquivos CAB de conteúdo de ajuda para um módulo devem estar no mesmo local. Você pode colocar arquivos CAB de conteúdo de ajuda para módulos diferentes no mesmo local.

Etapa 2: Adicionar uma chave HelpInfoURI ao manifesto do módulo

Adicione uma chave HelpInfoURI ao manifesto do módulo. O valor da chave é o Uniform Resource Identifier (URI) do local do arquivo de informações XML HelpInfo para seu módulo. Para segurança, o endereço deve começar com "http" ou "https". O URI deve especificar um local da Internet, mas não deve incluir o nome de arquivo XML HelpInfo.

Por exemplo:

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

Etapa 3: Criar um arquivo XML HelpInfo

O arquivo de informações XML HelpInfo contém o URI do local da Internet dos arquivos de ajuda e os números de versão dos arquivos de ajuda mais novos para seu módulo em cada cultura de interface do usuário com suporte. Cada Windows PowerShell módulo tem um arquivo XML HelpInfo. Quando você atualiza os arquivos de ajuda, edita ou substitui o arquivo XML HelpInfo; você não adiciona outro. Para obter mais informações, consulte How to Create a HelpInfo XML File.

Etapa 4: Criar arquivos CAB

Use uma ferramenta que cria arquivos de gabinete ( ), como , para criar um arquivo CAB que contém os arquivos .cab de ajuda para seu MakeCab.exe módulo. Crie um arquivo CAB separado para os arquivos de ajuda em cada cultura de interface do usuário com suporte. Para obter mais informações, consulte How to Prepare Updatable Help CAB Files.

Etapa 5: Carregar seus arquivos

Para publicar arquivos de ajuda novos ou atualizados, carregue os arquivos CAB no local da Internet especificado pelo elemento HelpContentUri no arquivo XML HelpInfo. Em seguida, carregue o arquivo XML HelpInfo no local da Internet especificado pelo valor da chave HelpInfoUri no manifesto do módulo.