Skip to main content

5. LINEAMIENTOS PARA LA CREACIÓN DE MANUALES

5.1. CreacióCreación de Estantes (Shelves)

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

 

5.2. CreacióCreación de Libros (Books)

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

 

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

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

 

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

Criterio EspecificacióEspecificación
TíTítulo Claro y conciso. Debe reflejar el contenido especíespecífico.
Editor Utilizar el editor WYSIWYG para contenido general, o Markdown para documentaciódocumentación tétécnica que requiera cócódigo. 
Estructura Utilizar títítulos jerájerárquicos (H2, H3, H4) para generar el ííndice automáautomático lateral.
Contenido Incluir introduccióintroducción, procedimientos paso a paso, imá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ápágina. 
Versiones El sistema guarda el historial de revisiones automáautomáticamente. Se debe indicar la fecha de actualizacióactualización en el contenido.
Back to top