Configurando o conteúdo de ajuda para produtos baseados na Web

O sistema de ajuda é empacotado como um arquivo WAR (Web archive) implementado no seu servidor de aplicativos. Ele inicia ou para quando seu produto é iniciado ou finalizado. O sistema de ajuda contém o conteúdo de ajuda que pode ser atualizado manualmente. Também é possível configurar o sistema de ajuda para fornecer o conteúdo de ajuda no Web site do ibm.com, para que o conteúdo esteja sempre atualizado. A terceira opção é ter o conteúdo de ajuda fornecido pelo servidor de intranet.

Definições

As seguintes definições são usadas no fornecimento do conteúdo de ajuda:

Ajuda Local
Conteúdo de ajuda acessado de um servidor local que hospeda o produto ou um servidor de intranet. Também é possível acessar a ajuda de seu computador.
Ajuda Remota
Conteúdo de ajuda acessado ou transferido por download do Web site do ibm.com.
Ajuda da Intranet
Conteúdo de ajuda acessado de um servidor de intranet. O conteúdo é transferido por download inicialmente para o servidor de intranet da Web.
Atualizador da ajuda local
Quando você utiliza a ajuda local ou da intranet, esse utilitário o ajuda a transferir por download o conteúdo inicial ou o conteúdo atualizado a partir da Web.
Site do atualizador da ajuda
O site ibm.com no qual o centro de informações para o seu produto está hospedado. Esse site pode ser acessado com um navegador ou a partir do sistema de ajuda do produto. Esse site também é a origem para o atualizador da ajuda local.
Site de download da ajuda
O Web site (http://download.boulder.ibm.com/ibmdl/pub/software/rationalsdp/documentation/updatesites/) contém arquivos compactados do conteúdo de ajuda do seu produto para preencher a ajuda local ou da intranet. O arquivo tem este formato: prod_coden.n_updateSite.zip, onde prod_code é o código do produto e n.n é o número da versão.

Introdução

Este produto oferece conteúdo de ajuda que pode ser atualizado independentemente das atualizações do produto. Por padrão, seu produto é configurado para acessar o conteúdo de ajuda localmente, o que significa que o arquivo WAR (Web archive) da ajuda contém todo o conteúdo de ajuda e é instalado quando o seu produto é instalado. Existem três opções para acesso do conteúdo de ajuda, incluindo o acesso local:
  • Você pode acessar o conteúdo do servidor que hospeda o produto.
  • Você pode acessar conteúdo de ajuda na Web.
  • Você pode acessar conteúdo de ajuda a partir do servidor de intranet.

As três opções do conteúdo da ajuda.

Acessando o Conteúdo de ajuda no Servidor do Produto

A opção padrão instala o conteúdo de ajuda no servidor que hospeda o seu produto.

Administrador: instalando e configurando: Instalar o produto. Nada mais é necessário.

Administrador: atualizando o conteúdo: O conteúdo é atualizado manualmente usando o Site do atualizador da ajuda ou o Site de download da ajuda.

Usuário: acessando a ajuda: Navegue ao produto e comece a usá-lo. Quando precisar de ajuda, clique em Ajuda (?) para abrir a Ajuda em uma janela. Nada mais é necessário.

Acessando Conteúdo da Ajuda a partir da Web

Se seu administrador configurou esta opção, você será vinculado ao centro de informações do seu produto pelo Web site do ibm.com. A ajuda baseada na Web do produto só poderá ser acessada quando você estiver conectado à Internet. Quando estiver desconectado, você poderá acessar um número limitado de tópicos de ajuda. Para obter detalhes adicionais, consulte o tópico de Conteúdo de ajuda sob Referência.

Nota: Você deve ter uma conexão com a Internet para utilizar essa opção de ajuda.
Administrador: instalando e configurando:
  1. Instale o produto.
  2. Inicie o produto e a ajuda.
  3. Exclua o conteúdo de ajuda existente do arquivo WAR de ajuda.
  4. Configure a ajuda remota para apontar ao centro de informações público do produto.

Administrador: atualizando o conteúdo: O conteúdo é sempre a informação mais recente que está disponível.

Usuário: acessando a ajuda: Navegue ao produto e comece a usá-lo. Quando precisar de ajuda, clique em Ajuda (?) para abrir a Ajuda em uma janela.

Acessando Conteúdo da Ajuda a partir de um Servidor de Intranet (solução Corporativa)

Dependendo do suporte de sua empresa, talvez seja possível acessar conteúdo da ajuda a partir de servidores de intranet. Este método pressupõe que os administradores de intranet tenham configurado um link para um servidor protegido por firewall, em que o conteúdo de ajuda do produto esteja instalado. Ao selecionar essa opção, você precisa especificar o link para o servidor de intranet. Os administradores devem fazer atualizações planejadas para o conteúdo de ajuda.

Administrador: instalando e configurando:
  1. Instale o produto no servidor do produto.
  2. Instale e configure a ajuda da intranet.
  3. Inicie o produto.
  4. Exclua o conteúdo existente da ajuda.
  5. Configure a ajuda remota para usar o servidor de intranet, utilizando as informações usadas na etapa 2.

Administrador: atualizando o conteúdo: O conteúdo é atualizado manualmente no servidor de intranet usando o Site do atualizador da ajuda ou o Site de download da ajuda.

Usuário: acessando a ajuda: Navegue ao produto e comece a usá-lo. Quando precisar de ajuda, clique em Ajuda (?) para abrir a Ajuda em uma janela. Nada mais é necessário.


Feedback