Administration > Création de documentation interne > Concepts > Principes de la documentation interne

Principes de la documentation interne

La fonctionnalité Documentation interne vous permet d'ajouter votre propre documentation personnalisée (un texte ou une URL) à l'aide en ligne existante.

Les utilisateurs auront accès à cette documentation en cliquant sur le bouton d'aide dans le domaine du produit. Un lien à la page de la documentation s'affiche dans l'aide sous l'en-tête Documentation interne.

Vous créez votre documentation interne dans le volet Documentation interne du module Administrateur. Pour plus d'informations, reportez-vous à la section Volet Documentation interne.

Exemple :

John est administrateur Release Control pour l'organisation ABC. Sue, l'administratrice Web, indique à John qu'elle effectuera une maintenance du site Web toutes les lundi et lui demande de créer une catégorie de période dans Release Control destinée à empêcher les utilisateurs de modifier le site Web de l'entreprise le lundi.

John crée une catégorie de période intitulée Web_blackout. Lorsque les utilisateurs Release Control accèdent à l'onglet Évaluer > Conflits de périodes du module Analyse, ils constatent que leur changement planifié est en conflit avec la période Web_blackout. John souhaite informer les utilisateurs des raisons de cette catégorie de période et décide donc de créer une documentation interne.

Il ouvre le volet Documentation interne, (Module > Administrateur > onglet Configuration > Documentation interne), sélectionne Conflits de périodes dans le volet Domaine, puis envoie la documentation en remplissant les champs requis et en enregistrant ses modifications :

Lorsque les utilisateurs accèdent à l'onglet Évaluer > Conflits de périodes au module Analyse et cliquent sur le bouton d'aide , un lien qui mène vers la documentation de John décrivant la nouvelle période apparaît dans l'aide du produit.

Lorsque les utilisateurs cliquent sur le lien, ce dernier s'ouvre dans une page distincte affichant le contenu envoyé par John. John aurait également pu documenter la période sur le site Web interne de l'entreprise et insérer une URL au lieu d'afficher un texte dans le volet Documentation interne. Dans ce cas, le lien ouvre directement l'URL.