Esta página describe cómo importar, en las bases de conocimientos de Portail ZAPP, la documentación de usuario entregada con la aplicación.
Cuándo usarla
Tras una actualización de la aplicación, los administradores ven un recordatorio: la documentación importada ya no está al día con la versión 0.1.0. El botón Actualizar la documentación (menú Base de conocimiento, solo administradores) lanza la importación.
Qué hace la importación
- Crea los artículos que faltan, publicados directamente.
- Actualiza un artículo cuyo texto ha cambiado, con una nueva revisión.
- No toca los artículos sin cambios: ninguna revisión inútil.
- Nunca elimina nada: un artículo cuya fuente ha desaparecido se señala como huérfano.
La importación se ejecuta en segundo plano: la pantalla muestra el paso en curso (lectura, artículos, enlaces de ayuda, indexación semántica), el número de páginas procesadas y la página en curso. Puedes salir de la página, la importación continúa; al volver, ves de nuevo su avance. Solo se ejecuta una importación a la vez: si la lanzas de nuevo durante una importación, se muestra la que está en curso.
Los artículos y los enlaces de Ayuda se guardan primero; la indexación para la búsqueda semántica, el paso más largo, viene después. Si no hay ninguna IA configurada, este paso se omite y el informe lo indica: los artículos siguen encontrándose con la búsqueda de texto completo.
El informe indica los artículos creados, actualizados, sin cambios y huérfanos.
Quién puede leer las páginas entregadas
Las páginas destinadas a todos los usuarios conectados están en la base Ayuda. Las páginas destinadas a los equipos (agentes del Service Desk, gestores de existencias, de activos…) están en la base Documentación: cada categoría indica los grupos que la leen, y la importación les concede la lectura de esa categoría. Así, cada uno lee la ayuda de sus pantallas, y el enlace Ayuda lo lleva a ella.
Un permiso que concedes en la pantalla de permisos de una base nunca es modificado por la importación. Los permisos establecidos por la importación llevan allí la insignia Documentación entregada: si retiras uno, la próxima importación lo vuelve a establecer mientras la documentación lo declare. Un grupo indicado por la documentación que no existe en tu instancia se señala en el informe.
Variables en las páginas
Las páginas pueden usar {{ProductName}} (el nombre de la aplicación de la instancia), {{ProductVersion}} y {{AppVersion}}, sustituidas al importar.
Capturas de pantalla
Una página puede mostrar capturas de pantalla: se importan con ella, se almacenan como archivos del artículo y solo se muestran a las personas que pueden leer el artículo. Una captura modificada sustituye a la anterior, sin duplicados.
Publicar la documentación en otro sitio
El botón Exportar la documentación genera un paquete (archivo .zip) con la documentación de Portail ZAPP: páginas, capturas de pantalla e índice, con el nombre y la versión del producto.
En otra instancia, por ejemplo un portal de documentación, un administrador lo importa con Importar un paquete de documentación. Las reglas son las mismas que para la actualización: no se elimina nada, un artículo sin cambios no recibe revisión y un artículo escrito en la aplicación nunca se sobrescribe. Un paquete nunca modifica los enlaces de Ayuda de la instancia que lo importa y se rechaza si una de sus bases ya pertenece a otra fuente.
Ver también
- «Administrar una base de conocimientos»: la pantalla de permisos de una base.