EST-BDT-010 Estándar para la creación de manuales de usuario

v 1.1

Propósito

Mantener la consistencia entre proyectos al momento de crear manuales de usuario.

Notas introductorias

Este estándar establece pautas para la creación de manuales de usuario consistentes en diferentes proyectos. Su propósito es garantizar que los manuales sean claros y fáciles de entender para los usuarios finales. Al seguir este estándar, esperamos mejorar la experiencia del usuario y la eficiencia en el desarrollo de los sistemas.

Estándares

Estilos

1. Seguir preferentemente el estándar definido en el apartado de “Estilos” de EST-BDT-001 Redacción para Documentos. En caso de no seguirlo, la tipografía y el tamaño de la fuente debe ser legible para personas con dislexia y con un mínimo de número de fuente de 10.
2. El diseño del manual (colores, distribución de texto, imágenes, etc.) son de elección libre para cada proyecto, de acuerdo a la visión del mismo.
3. Cada imagen debe estar centrada al texto y con su respectivo pie de imagen, que consta de la numeración de la imagen así como la descripción de esta. La numeración deberá tomar el número o letra correspondiente al título de su sección (por ejemplo, si la sección es 1. Evaluación, el pie de imagen debe ser Imagen 1.1, por otro lado, si la sección es a. Introducción, el pie de imagen debe ser Imagen a.1. El número de lado de la derecha del punto decimal debe empezar en 1 y aumenta de una unidad en una unidad). El pie de imagen debe ir centrado a la imagen y debajo de esta, con la misma tipografía del cuerpo del documento y en itálicas.

Estructura del manual

1. El manual deberá seguir una estructura clara y coherente.
2. Deben incluir al menos estas secciones:
   1. Introducción: Esta sección proporciona una visión general del proyecto desarrollado cubierto por el manual. Incluye información sobre el propósito del sistema, su contexto de uso y una breve descripción de las funciones principales.
   2. Funcionalidades: Esta sección debe proporcionar instrucciones detalladas sobre las funciones del sistema. Se cubren operaciones fundamentales, navegación por la interfaz de usuario y cualquier otra información adicional para el uso del sistema de manera efectiva.
   3. Solución de Problemas: En esta sección se presentan posibles problemas o errores que los usuarios pueden encontrar al utilizar el sistema, junto con soluciones recomendadas. Se pueden incluir consejos para la resolución de problemas comunes, mensajes de error, códigos de error y procedimientos de diagnóstico.
   4. Referencias: Recopilación de recursos adicionales que pueden ser útiles para el usuario, como enlaces a documentación técnica, manuales de referencia, páginas de soporte en línea, tutoriales, comunidad de práctica, y cualquier otra información relevante para el sistema. Esta sección es opcional, dependiendo del valor que esta genere.
3. Cada sección debe estar identificada con título y numeración consecutiva, ya sea con números o letras (por ejemplo, 1. Introducción, 2. Funciones).
4. En caso de requerir subtítulos, estos deben estar de igual manera numerados de manera consecutiva, ya sea con números o letras.

Lenguaje

1. Utilizar un lenguaje sencillo y claro, evitando lenguaje técnico o términos complejos que puedan confundir a los usuarios.
2. Mantener un tono amigable y orientado al usuario, brindando instrucciones paso a paso y ejemplos cuando sea necesario.

Pruebas de validación

1. Antes de presentar el manual de usuario a los usuarios finales, se debe validar la efectividad de las instrucciones del manual, es decir, hacer pruebas con usuarios reales para identificar posibles áreas de mejora en el manual.

Actualización del manual

1. Designar responsable(s) al momento de actualizar el manual de usuario a medida que se introduzcan cambios en el sistema o surjan nuevas funcionalidades.

Formato de entrega

1. El formato de entrega de los manuales de usuario al cliente deberá ser en PDF preferentemente.

Control de cambios

Versión	Cambio realizado	Análisis	Autor	Revisor(es)	Fecha de cambio
v 1.0	Creación del documento	N/A	Mafer Moreno, Uri Gopar	Ricardo Rosales	25/04/2024
v 1.1	Cambio a link relativo	Los links relativos avisan si se rompen	Ricardo Fernández		1/05/2024