Cette page décrit comment importer, dans les bases de connaissances de Portail ZAPP, la documentation utilisateur livrée avec l'application.
Quand l'utiliser
Après une mise à jour de l'application, un rappel s'affiche aux administrateurs : la documentation importée n'est plus à jour de la version 0.1.0. Le bouton Mettre à jour la documentation (menu Base de connaissances, administrateurs seulement) lance l'import.
Ce que fait l'import
- Il crée les articles manquants, publiés directement.
- Il met à jour un article dont le texte a changé, avec une nouvelle révision.
- Il ne touche pas aux articles inchangés : aucune révision inutile.
- Il ne supprime jamais rien : un article dont la source a disparu est signalé comme orphelin.
L'import tourne en tâche de fond : l'écran affiche l'étape en cours (lecture, articles, liens d'aide, indexation sémantique), le nombre de pages traitées et la page en cours. Vous pouvez quitter la page, l'import continue ; en y revenant, vous retrouvez son avancement. Un seul import tourne à la fois : relancer pendant un import affiche celui en cours.
Les articles et les liens Aide sont enregistrés en premier ; l'indexation pour la recherche sémantique, l'étape la plus longue, vient ensuite. Si aucune IA n'est configurée, cette étape est sautée et le compte rendu le signale : les articles restent trouvables par la recherche en texte intégral.
Le compte rendu indique les articles créés, mis à jour, inchangés et orphelins.
Qui peut lire les pages livrées
Les pages destinées à tous les utilisateurs connectés sont dans la base Aide. Les pages destinées aux équipes (agents du Service Desk, gestionnaires de stock, d'actifs…) sont dans la base Documentation : chaque catégorie y désigne les groupes qui la lisent, et l'import leur accorde la lecture de cette catégorie. Chacun lit ainsi l'aide de ses écrans, et le lien Aide l'y conduit.
Un droit que vous accordez vous-même dans l'écran des permissions d'une base n'est jamais modifié par l'import. Les droits posés par l'import y portent le badge Documentation livrée : si vous en retirez un, le prochain import le repose tant que la documentation le déclare. Un groupe que la documentation désigne mais qui n'existe pas sur votre instance est signalé dans le compte rendu.
Variables dans les pages
Les pages peuvent utiliser {{ProductName}} (nom de l'application de l'instance), {{ProductVersion}} et {{AppVersion}}, remplacées à l'import.
Captures d'écran
Une page peut montrer des captures d'écran : elles sont importées avec elle, stockées comme fichiers de l'article et affichées aux seules personnes qui peuvent lire l'article. Une capture modifiée remplace l'ancienne, sans doublon.
Publier la documentation sur un autre site
Le bouton Exporter la documentation produit un paquet (fichier .zip) qui contient la documentation de Portail ZAPP : pages, captures d'écran et sommaire, au nom et à la version du produit.
Sur une autre instance, par exemple un portail de documentation, un administrateur l'importe avec Importer un paquet de documentation. Les règles sont les mêmes que pour la mise à jour : rien n'est supprimé, un article inchangé ne reçoit pas de révision, un article écrit dans l'application n'est jamais écrasé. Un paquet ne modifie jamais les liens Aide de l'instance qui l'importe, et il est refusé si l'une de ses bases appartient déjà à une autre source.
Voir aussi
- « Administrer une base de connaissances » : l'écran des permissions d'une base.