Aide Créer un guide de l’utilisateur

Les documents d’aide du guide de l’utilisateur sont regroupés dans les sections appropriées de la page et répertoriés dans un ordre configurable. Ajoutez vos sections à une page d’aide.

Avant de commencer

Créez tous vos documents d’aide à partir de l’enregistrement de section. Cela vous permet d’affiner leurs titres, d’ajuster leur emplacement et de décider s’ils sont appropriés pour la section.

Rôle requis : admin

Procédure

1. Créez une page.
   1. Accédez à la Guide de l'utilisateur système > Administration > Pages d'aide et cliquez sur Nouveau.
   2. Complétez le formulaire.

      Tableau 1. Définitions des champs de la page d’aide

      Champ	Description
      ID	Identification de page utilisée par le système pour créer une URL d’aide.
      Application	Périmètre de l’application pour cette page d’aide. Ce champ est en lecture seule et sa valeur par défaut est Global.
      Titre	Afficher le titre de cette page.

   3. Cliquez sur Envoyer.

      

2. Créez des sections de page d’aide et associez-les à la page.
   1. Accédez à la Guide de l'utilisateur système > Administration > Sections de page d'aide et cliquez sur Nouveau.

      

   2. Donnez à votre section un titre unique et concis, puis cliquez sur Soumettre.
      La vue revient à la liste des sections.
   3. Créez des sections supplémentaires pour votre page d’aide.
   4. Accédez à la Guide de l'utilisateur système > Administration > Pages d'aide et ouvrez votre nouvelle page.
   5. Dans la liste connexe Page aux sections , cliquez sur Nouveau.
   6. Complétez le formulaire.

      Tableau 2. Définitions des champs de la page à la section

      Champ	Description
      Colonne	Emplacement de colonne sur la page de cette section. La première colonne est désignée par 0 et la deuxième colonne est désignée par 1. Il doit y avoir au moins une entrée pour la colonne 0 pour que les sections s’affichent.
      Ordre	Ordre dans lequel les sections s’affichent dans les colonnes de la page. Si aucun numéro d’ordre n’est défini, le système répertorie les sections par ordre alphabétique.
      Application	Le périmètre de l'application pour cet enregistrement. Ce champ est en lecture seule et sa valeur par défaut est Global.
      Page	Page d’aide sur laquelle cette section s’affiche. Vous pouvez utiliser le champ de recherche pour modifier la page sur laquelle une section apparaît.
      Section	Nom de la section à afficher sur la page sélectionnée.

      

   7. Cliquez sur Envoyer.
   8. Facultatif : Ajoutez des sections à la page d’aide si nécessaire.
3. Créez un ou plusieurs documents.
   1. Accédez à la Guide de l'utilisateur système > Administration > Sections de page d'aide.
   2. Ouvrez un enregistrement de section que vous avez créé.
   3. Dans la liste connexe Aide , cliquez sur Nouveau pour créer un document d’aide pour cette section.
   4. Complétez le formulaire.

      Tableau 3. Définitions des champs du document d’aide

      Champ	Description
      Numéro	Numéro de document généré automatiquement par le système.
      Section	Section dans laquelle ce document apparaît.
      Ordre	Ordre de liste pour ce document dans la section sélectionnée.
      Publié	Date de création de ce document.
      Mis à jour	Date de la dernière mise à jour de ce document.
      Description brève	Brève description du contenu de ce document. Cette description est utilisée comme titre du document sur la page d’aide.
      Texte	Documentez le contenu, y compris les graphiques et les tableaux. Vous pouvez formater votre entrée, créer des listes à puces ou numérotées et joindre des images.

      

   5. Cliquez sur Envoyer.
   6. Répétez le processus pour créer les documents d’aide nécessaires pour cette section.