Caso práctico

Imagen de una mujer joven, de pie, con camisa azul y mirando de frente. — Ministerio de Educación y Formación Profesional (Elaboración propia)

—¿Qué documentación elaboramos en primer lugar? —pregunta Ana.

—Elaboramos el manual de usuario —responde Juan.

—¿Es importante? —pregunta Ana.

—El manual de usuario es fundamental, para que cualquier persona que quiera utilizar la aplicación, sepa cómo funciona y conozca todas las funciones —responde Juan.

—Pues manos a la obra.

Imagen en donde se muestra pantalla de un ordenador con un libro abierto en primer plano. — INTEF (CC BY-NC-SA)

Un manual de usuario es un documento de comunicación técnica, que proporciona asistencia para usuarios o usuarias que utilizan un terminado sistema. Normalmente, un manual de usuario suele estar elaborado por un escritor o escritora técnica, aunque también suelen escribirlo los programadores o programadoras, ingenieros o ingenieras o los gestores o gestoras del proyecto, o cualquier otro componente del equipo de desarrollo, especialmente en compañías pequeñas.

Los manuales de usuario elaborados para aplicaciones software, ofrecen una explicación detallada de la instalación, configuración y uso, de la aplicación. Es usual que incorporen imágenes, con captura de pantalla de la ejecución del programa.

Las secciones de una manual de usuario suelen incluir los siguientes contenidos:

Portada.
Página de título y página de copyright.
Prólogo, que muestra detalles de los documentos relacionados e información sobre cómo navegar por la el manual de usuario.
Páginas de contenidos, donde se muestra un índice con los contenidos de manual.
Una guía de cómo usar, al menos, las funciones básicas de la aplicación.
Una sección de solución de problemas, donde se detallan problemas y posibles soluciones que pueden surgir, junto con la forma de solucionarlos.
Una sección FAQ (Frequently Asked Questions, se refiere a una lista de preguntas y respuestas que surgen frecuentemente dentro de un determinado contexto y para un tema en particular).
Donde encontrar más ayuda para uso de la aplicación.
Un glosario y un índice.

Aunque en un principio, los manuales de usuario eran documentos en papel, en la actualidad, la mayoría de los manuales de usuario, se distribuyen con la aplicación en formato electrónico. También se pueden encontrar los manuales en los sitios web de las empresas que los elaboran.