Administración > Creación de documentación interna > Conceptos > Descripción general de la documentación interna

Descripción general de la documentación interna

La función Documentación interna permite añadir su propia documentación personalizada (un texto o una URL) a la ayuda en línea existente.

Los usuarios acceden a esta documentación pulsando el botón Ayuda del área relevante del producto. En la Ayuda del producto bajo la cabecera Documentación interna aparece un enlace a una página donde se muestra su documentación.

Puede crear documentación interna en el panel Documentación interna del módulo Administrador. Para obtener más información, consulte Panel Documentación interna.

Ejemplo:

Juan es un administrador de Release Control de la compañía ABC. Susana, la administradora Web le comenta a Juan que se encargará de realizar tareas de mantenimiento del sitio Web cada lunes y le pide a Juan que cree una categoría de período de tiempo en Release Control que prohíba que se realicen cambios en el sitio Web de la compañía los lunes.

Juan crea una categoría de período de tiempo llamada Desactivación_Web. Cuando los usuarios de Release Control van al módulo Análisis, seleccionan Evaluar > pestaña Conflictos en período de tiempo, puede que descubran que su cambio programado está en conflicto con este período de tiempo Desactivación_Web. Juan quiere buscar una manera de explicar a los usuarios por qué existe esta categoría de período de tiempo y decide escribir una documentación interna.

Desde el panel Documentación interna (Módulo > Administrador > pestaña Configuración > Documentación interna), seleccione Conflictos en período de tiempo del panel Área del producto y envíe la documentación rellenando los campos obligatorios y guardando los cambios:

Cuando los usuarios vayan al módulo Análisis, Evaluar > pestaña Conflictos en período de tiempo y pulsen el botón Ayuda , en la Ayuda del producto aparecerá un enlace a la documentación de Juan donde se explica el nuevo período de tiempo.

Cuando los usuarios pulsen el enlace, se abrirá en otra página con el contenido que Juan envió. Juan también hubiera podido decidir documentar el período de tiempo en el sitio Web interno de la compañía y en vez de enviar un texto al panel Documentación interna, podría haber insertado una URL. En este caso, el enlace abriría la URL directamente.