Manual

Es un documento de comunicación técnica destinado a dar asistencia a las personas que utilizan un sistema en particular. Por lo general, este documento está redactado por un escritor técnico, como por ejemplo los programadores del sistema o los directores de proyectos implicados en su desarrollo, o el personal técnico, especialmente en las empresas más pequeñas.

Los Guías del usuario son más comúnmente asociados con los productos electrónicos, como computadoras y programas.

La mayoría de las guías de usuario contienen tanto una guía escrita como imágenes asociadas. En el caso de las aplicaciones informáticas, es habitual incluir capturas de pantalla de cómo el programa debería ser, y manuales que a menudo incluyen diagramas claramente detallados y sencillos que detallan los pasos a realizar por el usuario para llevar a cabo las distintas opciones disponibles. El lenguaje utilizado deberá ser sencillo, dirigido a una audiencia que podrá no entender un lenguaje demasiado técnico.

 Secciones básicas del manual de usuario

Las secciones de un manual de usuario a menudo incluyen:

• Una página de portada.

• Una página de título.

• Una página de derechos de autor.

• Un prefacio, que contiene detalles de los documentos relacionados y la información sobre cómo navegar por la guía del usuario.

• Una página de contenido.

• Una guía sobre cómo utilizar al menos las principales funciones del sistema, es decir, sus funciones básicas.

• Una sección de solución de problemas que detalla los posibles errores o problemas que pueden surgir, junto con la forma de solucionarlos.

• Una sección de preguntas frecuentes.

• Donde encontrar más ayuda, y datos de contacto.

• Un Glosario y, para documentos más grandes, un Índice.

 Manuales y guías de programas informáticos

Los Manuales de usuario y Guías de usuario para la mayor parte de las aplicaciones de software contienen comúnmente todos los contenidos detallados en el apartado anterior. El Starta User Manual es un buen ejemplo de este tipo de documento. Sin embargo, algunos documentos tienen una estructura más fluida con muchos enlaces internos. El Google Earth User Guide es un ejemplo de este tipo de manuales.

El término guía se suele aplicar a un documento que aborda un aspecto específico de un producto de software. Algunos ejemplos son: Guía de Instalación o Guía de Introducción. Un ejemplo de este tipo es la guía de introducción a Picaza.

En algunos sistemas software de negocios, donde los grupos de usuarios tienen acceso sólo a una de la funcionalidad total de la aplicación, es bastante aconsejable preparar una guía de usuario para cada grupo. Un ejemplo de este enfoque puede observarse en la guía Autodesk Topobase 2010 Help, que contiene por separado una Guía del Administrador y las distintas Guías de Usuario, además de una Guía para desarrolladores. Estos manuales son una herramienta valiosa para el entrenamiento en el trabajo.