¿Cómo redactar Manuales de usuario?
Incluir información esencial
Organiza el manual de forma lógica. Incluye advertencias necesarias. Describe el dispositivo. Incluye instrucciones de configuración. Proporciona información sobre la operación. Incluye un resumen del producto al final.
El manual del usuario debe proceder de una manera que el usuario encuentre más beneficiosa. Divide el manual en capítulos o secciones que tengan sentido para el uso del producto e incluye una tabla de contenido hacia el frente del manual para que cada sección se pueda encontrar rápidamente.  Una tabla de contenido es especialmente necesaria para los manuales más largos. Se necesita un glosario o índice cuando hay muchos términos para explicar con los que el público tal vez no esté familiarizado. Sin embargo, no se recomiendan glosarios. La mejor opción es explicar los términos confusos en el texto del manual. Si eliges incluir un glosario, colócalo delante del manual, justo después de la tabla de contenido. Una lista de tablas o figuras solo es necesaria si hay más de unas pocas de ellas en el manual. Se necesita un apéndice para las cosas que requieren explicación pero que no pueden explicarse en otro punto del manual porque interrumpiría el flujo y el enfoque. Las advertencias generales o la información de precaución deben proporcionar información sobre posibles amenazas que puede provocar el uso indebido del producto, incluida la muerte o lesiones graves. Estas advertencias deben colocarse en el frente del manual después de la portada para que el usuario las vea primero. También se deben incluir advertencias específicas en el texto del manual del usuario justo después o justo antes de sugerir un paso potencialmente peligroso.  Por ejemplo, una advertencia general para un dispositivo eléctrico puede ser evitar usarlo durante la lluvia. Una dirección específica puede ser para asegurarse de que tus manos y el dispositivo estén secos antes de conectarlo. Incluye gráficos (como una calavera y huesos cruzados) o texto de diferentes colores (como texto rojo) para diferenciar la advertencia del resto de las instrucciones en el manual del usuario y llamar la atención de los usuarios. La descripción debe incluir tanto una explicación escrita sobre el propósito del dispositivo como un pequeño gráfico que muestre cómo se ve el dispositivo. El gráfico debe etiquetar y nombrar adecuadamente todos los interruptores, perillas y partes conectables que incluye el dispositivo. La sección de configuración debe incluir información básica sobre cómo prepararse para usar el producto o dispositivo. Si un usuario en casa no puede armar o configurar el dispositivo, indica este hecho claramente en un encabezado en negrita en la parte superior de la sección de configuración. También debes incluir:   una lista de piezas instrucciones para desempacar advertencias relacionadas con la configuración consecuencias de una configuración incorrecta a quién llamar en caso de encontrar dificultadas para configurar Esta sección es la parte principal del manual del usuario y debe proporcionar información concreta y detallada sobre cómo usar el dispositivo. Comienza con una preparación básica para usar el dispositivo, tal como enchufarlo o lavarse las manos. Continúa con los pasos lógicos y numerados que describen cómo se debe usar el dispositivo, así como los comentarios (por ejemplo, "escucharás un clic...") que el usuario puede esperar al usar el dispositivo de manera adecuada.  Al final de esta sección, los usuarios deben ser referidos a la sección de solución de problemas para resolver problemas que no pueden explicarse rápidamente. Incluye gráficos cuando sea necesario. Algunos pasos se explican mejor con imágenes y palabras. Piensa en usar fotografías o ilustraciones en tu manual del usuario. En esta sección, como en cada una, asegúrate de incluir advertencias de seguridad relevantes sobre el uso u operación inadecuados. Por ejemplo, puedes advertir a los usuarios de una motosierra que no beban alcohol ni la usen mientras toman ciertos medicamentos. Si piensas que será de beneficio para los usuarios, considera incluir enlaces a videos que muestren el uso y operación adecuados del dispositivo. Puedes incluir estos videos ya sea al inicio de la sección, o (en caso de videos que ilustren solo un paso) al final de cada paso. El resumen debe ir al final del manual, justo antes del índice, para proporcionar pasos básicos de operación. Debe ser una versión simplificada y reducida de la sección de información operativa, y no debe tener más de una página. Resume cómo usar el dispositivo o producto. Incluye advertencias básicas, pasos numerados que expliquen cómo usar el producto y números de teléfono o direcciones de correo electrónico que dirijan a los usuarios a conseguir ayuda.   Si crees que el usuario quitará la hoja de resumen o necesitará consultarla con frecuencia, puedes imprimirla en una tarjeta plastificada extraíble o en una cartulina gruesa para que sea más fácil de llevar y consultar. De forma opcional, incluye una hoja de resumen directamente en el producto para que los usuarios puedan consultarla rápida y fácilmente.
Including Essential Information