Configurer le contenu d'aide pour les produits Web

Le système d'aide est livré sous forme de fichier WAR (archive Web) qui est déployé sur votre serveur d'applications. Il démarre ou s'arrête lorsque vous démarrez ou arrêtez votre produit. Le système d'aide contient un contenu d'aide qui peut être mis à jour manuellement. Vous pouvez aussi configurer le système d'aide afin qu'il serve le contenu d'aide récupéré du site Web ibm.com, de sorte que ce contenu soit toujours le plus récent. La troisième possibilité est d'obtenir le contenu d'aide auprès d'un serveur intranet.

Définitions

Les définitions suivantes sont utilisées pour décrire les différentes techniques de livraison du contenu d'aide :

Aide locale
Contenu d'aide siégeant sur un serveur local qui héberge le produit ou sur un serveur intranet. Vous pouvez aussi accéder à l'aide sur votre ordinateur.
Aide distante
Contenu d'aide dont la source est le site Web ibm.com ou un autre site de centre de documentation officiel tel que jazz.net.
Aide intranet
Contenu d'aide résidant sur un serveur intranet. Il est initialement téléchargé sur ce serveur à partir du site Web.
Programme de mise à jour de l'aide locale
Lorsque votre produit est configuré pour utiliser l'aide locale ou intranet, cet utilitaire facilite le téléchargement du contenu initial ou sa mise à jour ultérieure soit à partir du site de mise à jour de l'aide, soit à partir d'un fichier compressé (voir les définitions qui suivent).
Site de mise à jour de l'aide
Site ibm.com sur lequel est hébergé le centre de documentation de votre produit. Ce site est accessible à partir d'un navigateur ou du système d'aide du produit si celui-ci est configuré pour utiliser l'aide distante. Il peut aussi constituer la source de contenu du programme de mise à jour de l'aide locale.
Site de téléchargement de l'aide
Le site Web (http://download.boulder.ibm.com/ibmdl/pub/software/rationalsdp/documentation/updatesites/) contient le fichier compressé du contenu d'aide de chaque produit, que vous pouvez utiliser pour mettre à jour l'aide locale ou intranet. Le nom du fichier est de la forme code-produitn.n_updateSite.zip, où code-produit est le code du produit et n.n est le numéro de version.

Introduction

Ce produit propose une aide dont le contenu peut être mis à jour indépendamment du produit lui-même. Par défaut, votre produit est configuré pour accéder au contenu d'aide localement, ce qui signifie que le fichier WAR (archive Web) de l'aide contient l'intégralité des rubriques d'aide du produit et qu'il est installé en même temps que le produit. L'accès au contenu d'aide peut s'effectuer de trois manières différentes :
  • Vous pouvez accéder au contenu d'aide résidant sur le serveur qui héberge le produit.
  • Vous pouvez accéder au contenu d'aide disponible sur le Web.
  • Vous pouvez accéder au contenu d'aide situé sur un serveur intranet.

Les trois options d'accès au contenu d'aide.

Accéder au contenu d'aide sur le serveur du produit

Le contenu d'aide se trouve sur le serveur qui héberge votre produit si ce dernier est configuré à l'origine avec cette option ou si celle-ci a été configurée par votre administrateur.

Administrateur : installation et configuration : Installez le produit. Vous n'avez rien d'autre à faire si l'aide inclut l'intégralité du contenu localement ou si le système d'aide est configuré pour accéder au contenu distant.

Administrateur : mise à jour du contenu : Si l'aide distante n'est pas configurée, la mise à jour du contenu s'effectue manuellement à l'aide du Site de mise à jour de l'aide ou du Site de téléchargement de l'aide.

Utilisateur : accès à l'aide : Naviguez jusqu'au produit et commencez à l'utiliser. Lorsque vous avez besoin d'aide, cliquez sur Aide (?) pour ouvrir le système d'aide dans une fenêtre. Vous n'avez rien d'autre à faire.

Accéder au contenu d'aide sur le Web

Si votre administrateur a configuré cette option, ou si votre produit est ainsi configuré à l'origine, un lien est établi vers le centre de documentation du produit via un site Web ibm.com. Vous pouvez accéder à l'aide sur le Web du produit seulement si vous êtes connecté à Internet. Lorsque vous êtes déconnecté, vous n'avez accès qu'à un nombre limité de rubriques d'aide. Pour plus de détails, consultez la rubrique Contenu d'aide, sous la section Référence.

Remarque : Pour utiliser cette option, vous devez être connecté à Internet.
Administrateur : installation et configuration :
  1. Installez le produit.
  2. Démarrez le produit et l'aide.
  3. Supprimez le contenu d'aide existant dans le fichier WAR de l'aide en utilisant le programme de mise à jour de l'aide locale.
  4. Configurez l'aide distante de manière à la faire pointer sur le centre de documentation public du produit.

Administrateur : mise à jour du contenu : Vous n'avez rien à faire, le contenu étant toujours le plus récent qui soit disponible.

Utilisateur : accès à l'aide : Naviguez jusqu'au produit et commencez à l'utiliser. Lorsque vous avez besoin d'aide, cliquez sur Aide (?) pour ouvrir le système d'aide dans une fenêtre.

Accéder au contenu d'aide sur un serveur intranet (solution d'entreprise)

Votre organisation peut choisir de rendre le contenu d'aide accessible sur son intranet, le cas échéant. Cette méthode suppose que l'administrateur de l'intranet ait configuré un lien vers un serveur derrière votre pare-feu, où le contenu de l'aide du produit est installé. Si vous sélectionnez cette option, vous devez spécifier le lien vers votre serveur intranet. Les administrateurs doivent effectuer des mises à jour planifiées du contenu de l'aide.

Administrateur : installation et configuration :
  1. Installez le produit sur le serveur réservé à cet usage.
  2. Installez et configurez l'aide intranet conformément aux instructions de la procédure Distribution de contenu d'aide à partir d'un serveur intranet.
  3. Démarrez le produit.
  4. Supprimez le contenu existant de l'aide en utilisant le programme de mise à jour de l'aide locale.
  5. Configurez l'aide distante de manière à utiliser le serveur intranet comme source du contenu d'aide (reprenez les informations utilisées à l'étape 2).

Administrateur : mise à jour du contenu : La mise à jour du contenu s'effectue manuellement sur le serveur intranet à l'aide du Site de mise à jour de l'aide ou du Site de téléchargement de l'aide.

Utilisateur : accès à l'aide : Naviguez jusqu'au produit et commencez à l'utiliser. Lorsque vous avez besoin d'aide, cliquez sur Aide (?) pour ouvrir le système d'aide dans une fenêtre. Vous n'avez rien d'autre à faire.


Vos commentaires