Créer une aide pour le guide de l’utilisateur

  • Rversion finale: Australia
  • Mis à jour 12 mars 2026
  • 2 minutes de lecture

    • 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 de champs de pages 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 de cette page d’aide. Ce champ est en lecture seule et défini par défaut sur le champ d’application Global .
        Titre Titre d’affichage 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 ouvrir votre nouvelle page.
      5. Dans la liste connexe Page aux sections , cliquez sur Nouveau.
      6. Complétez le formulaire.
        Tableau 2. Définitions de champs de page à section
        Champ Description
        Colonne Emplacement de colonne sur la page pour cette section. La première colonne est désignée comme 0 et la deuxième colonne est désignée comme 1. Il doit y avoir au moins une entrée dans 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 de commande n’est défini, le système répertorie les sections par ordre alphabétique.
        Application Périmètre de l’application pour cet enregistrement. Ce champ est en lecture seule et défini par défaut sur le champ d’application Global .
        Page Page d’aide sur laquelle cette section apparaît. 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 selon vos besoins.
    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 de champs de documents 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 d’affichage de ce document dans la section sélectionnée.
        Publié Date de création de ce document.
        Mis à jour Date de dernière mise à jour de ce document.
        Description courte Brève description du contenu de ce document. Cette description est utilisée comme titre pour le document sur la page d’aide.
        Texte Contenu du document, y compris les graphiques et les tableaux. Vous pouvez mettre en forme 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.