Skip to main content

5. LINEAMIENTOS PARA LA CREACIÓN DE MANUALES

5.1. Creación de Estantes (Shelves)

Criterio Especificación
Propósito Agrupar libros afines para mejorar la navegación.
Nombre Debe ser descriptivo y claro. Ejemplo: "Sistemas de Gestión Académica"
Descripción Breve texto que indique el contenido del estante.
Permisos Definir roles con acceso de visualización y edición según el equipo responsable.

 

5.2. Creación de Libros (Books)

Criterio Especificación
Nombre Debe coincidir con el nombre del sistema o proceso documentado. Ejemplo: "Manual de Usuario del SIR"
Descripción Indicar el propósito del manual y el público objetivo.
Portada Opcional, pero recomendable para identificación visual.
Etiquetas (Tags) Utilizar etiquetas estandarizadas para facilitar la búsqueda (ej: sistema:sirtipo:manual_usuario). 
Asignación a Estantes Un libro puede pertenecer a uno o varios estantes.

 

5.3. Creación de Capítulos (Chapters)

Criterio Especificación
Uso Crear capítulos cuando un libro tenga más de 5 páginas directas para mejorar la organización.
Nombre Debe ser temático. Ejemplo: "Módulo de Administración"
Descripción Breve resumen del contenido del capítulo.

 

5.4. Creación de Páginas (Pages)

Criterio Especificación
Título Claro y conciso. Debe reflejar el contenido específico.
Editor Utilizar el editor WYSIWYG para contenido general, o Markdown para documentación técnica que requiera código. 
Estructura Utilizar títulos jerárquicos (H2, H3, H4) para generar el índice automático lateral.
Contenido Incluir introducción, procedimientos paso a paso, imágenes y diagramas (usando diagrams.net integrado). 
Archivos adjuntos Subir archivos (PDF, Excel, etc.) como complemento, con un enlace visible dentro de la página. 
Versiones El sistema guarda el historial de revisiones automáticamente. Se debe indicar la fecha de actualización en el contenido.