Administrateurs
Guide d'utilisation et aides en ligne
Modifier, ajouter, ordonner et masquer les pages de ce guide, publier une version anglaise, insérer des images de la médiathèque, et régler le panneau d'aide de chaque écran de l'espace de travail.
Deux écrans de la console, rubrique Site public, tiennent la documentation de la plateforme à jour sans intervention technique :
- Guide d'utilisation (
/administration/guide-utilisation) : les rubriques et les pages du guide que vous lisez ; - Aides en ligne (
/administration/aides-en-ligne) : le texte du panneau Aide sur cet écran, affiché sous le titre des principaux écrans de l'espace de travail.
Qui peut faire quoi #
| Action | Permission requise | Rôles par défaut |
|---|---|---|
| Modifier le guide, ses rubriques et ses pages, les aides en ligne | Administrer le guide d'utilisation et les aides en ligne (guide.gerer) |
super-administrateur, administrateur national |
| Régler le message d'accueil de l'espace de travail | Administrer les paramètres de la plateforme (parametres.gerer) |
super-administrateur |
La permission s'accorde à d'autres rôles dans l'écran Rôles et permissions (voir Rôles et permissions).
Le guide d'utilisation #
Version d'origine et texte modifié #
Chaque page livrée avec la plateforme a une version d'origine. À la première ouverture de l'écran, toutes les pages sont reprises dans la console, sans rien changer à l'affichage du guide. Une page porte ensuite l'une de ces étiquettes :
| Étiquette | Signification |
|---|---|
| Version d'origine | Le texte affiché est celui de la version d'origine. Une mise à jour de la plateforme qui le corrige s'affiche aussitôt. |
| Modifiée | Le texte français a été réécrit dans la console. Il l'emporte sur la version d'origine, même après une mise à jour de la plateforme. |
| Créée en console | La page n'existe que dans la console. Elle peut être supprimée. |
| Masquée | La page n'apparaît ni sur le guide, ni dans sa recherche, ni dans le plan du site. |
| EN | La page a une version anglaise. |
Le bouton Rétablir la version d'origine d'une page modifiée remplace le texte français saisi par celui de la version d'origine. La version anglaise saisie est conservée.
Modifier une page #
- Ouvrez Guide d'utilisation, puis cliquez sur le titre de la page dans sa rubrique.
- Modifiez le titre, la description (une phrase reprise sous le titre et dans la recherche), le public visé et le contenu.
- Le bouton Aperçu au-dessus du contenu montre la page telle qu'elle s'affichera, avec ses encadrés, ses tableaux et ses images. Il signale aussi les termes refusés et les liens vers des pages inconnues.
- Cliquez sur Enregistrer. Le guide, sa recherche et le plan du site sont à jour dès la requête suivante.
Le contenu s'écrit en Markdown. La barre de mise en forme insère la syntaxe à l'emplacement du curseur : gras, italique, intertitre, sous-titre, listes, lien, tableau, encadrés Astuce et Attention. Un lien vers une autre page du guide s'écrit avec le chemin de la page, par exemple [Alertes](../validateurs/alertes).
Règles de rédaction #
Chaque enregistrement est contrôlé. Sont refusés : les tirets longs (remplacez-les par une virgule, des parenthèses ou deux-points), les emoji, le vocabulaire de commande publique et les mentions d'outils de génération de texte. Un lien vers une page du guide qui n'existe pas est également refusé. Le message nomme le terme ou le lien en cause.
Ajouter, ordonner et masquer #
- Nouvelle page : choisissez la rubrique et l'identifiant de la page (lettres minuscules, chiffres et tirets), qui forme son adresse
/guide/rubrique/identifiant. L'adresse d'une page d'origine ne change pas. - Nouvelle rubrique : identifiant, titre et description. Une rubrique n'apparaît sur le guide qu'une fois dotée d'une page publiée.
- Les flèches Monter et Descendre règlent l'ordre des rubriques sur l'accueil du guide et l'ordre des pages dans leur rubrique.
- Masquer retire une page ou une rubrique entière du guide sans la supprimer ; Publier la rétablit.
Version anglaise #
Le volet Anglais de chaque page porte un titre, une description et un contenu en anglais. Une page dotée d'un titre et d'un contenu anglais s'affiche en anglais aux visiteurs qui consultent la plateforme en anglais ; les autres pages restent en français. Le lien de langue de l'en-tête du guide passe d'une langue à l'autre. Les rubriques ont aussi un titre et une description en anglais.
Les aides en ligne #
L'écran Aides en ligne liste les écrans de l'espace de travail dotés d'un panneau Aide sur cet écran : vue exécutive, tableaux sectoriels, saisie, boîte d'envoi, validation, référentiel, analyse, alertes, exports, bulletins, présentations, bibliothèque interne. Pour chacun :
- le texte d'aide français, de deux à cinq phrases, avec une ligne vide entre deux paragraphes ;
- la version anglaise, facultative ;
- la case Afficher le panneau d'aide sur cet écran, qui masque le panneau sans perdre le texte ;
- la page du guide liée, ouverte par le lien Lire la page du guide du panneau.
Un écran modifié porte l'étiquette Modifié ; Rétablir le texte d'origine revient au texte livré avec la plateforme. Les mêmes règles de rédaction que le guide s'appliquent.
Le message d'accueil de l'espace de travail #
Le réglage Message d'accueil de l'espace de travail (écran Paramètres, rubrique Espace de travail) affiche un encadré en tête de la vue exécutive, première page des équipes après connexion : échéance de saisie, consigne du moment, réunion à venir. Il se saisit en français et en anglais. Vide, aucun encadré n'est affiché.
Journal #
Chaque modification, création, suppression, publication, masquage, changement d'ordre et retour à la version d'origine est inscrit au Journal d'audit, avec son auteur et la valeur avant et après (voir Journal et sécurité).