Cómo redactar manuales de usuario

El software, las computadoras, los juegos y los dispositivos requieren manuales de usuario, guías que explican cómo usar el producto (y cómo no hacerlo). Un manual del usuario es una pieza de escritura formal con una estructura específica, y debe ser redactado por alguien que esté íntimamente familiarizado con el producto, como un redactor técnico o el diseñador del producto. Redactar un manual del usuario efectivo requiere saber quién va a usar el producto y luego redactarlo teniendo en cuenta a estos usuarios. Mantén la redacción clara, precisa y simple para garantizar una experiencia de usuario sin problemas.

Parte 1

Parte 1 de 4:
Planear el manual del usuario

1
Haz un análisis del público. El manual del usuario debe estar escrito para el público: aquellos que comprarán el producto o servicio y leerán el manual del usuario. Un análisis de público te dirá quién será el público principal u objetivo y guiará la redacción.
- Habla con las personas que usarán el dispositivo. Ofrece a los usuarios de prueba prototipos del dispositivo y un borrador del manual del usuario en condiciones controladas. Solicita comentarios de estos usuarios de prueba sobre cosas que no son obvias o confusas en las instrucciones del usuario e incorpora cambios en el manual del usuario basados en esos comentarios.
- Nunca se puede complacer a todo el público. Escribe el manual para adaptarlo al público objetivo o al público más numeroso.
- Piensa en la edad, el estado de salud del público (¿tienen enfermedades, problemas de aprendizaje o discapacidades?) y el nivel educativo para determinar el mejor enfoque para redactar la guía del usuario.
2
Coordina el diseño del manual del usuario. Si fueras parte del equipo que ayudó a diseñar y desarrollar el dispositivo o producto, puede ser difícil mirar el producto de manera objetiva para explicar su funcionamiento. Por lo tanto, es posible que desees solicitar el asesoramiento de un redactor (preferiblemente uno con experiencia en redactar instrucciones) y un diseñador gráfico para ayudarte a redactar el manual del usuario. Puedes elegir a estas personas de una consultoría externa o de tu propia empresa u organización.
3
Haz un análisis de tareas. Un análisis de tareas es el proceso de identificar y organizar los pasos necesarios para usar el dispositivo. Un análisis completo de la tarea identificará los materiales y equipos (como baterías, medicamentos u otros productos suministrados por el usuario) necesarios para cada paso, así como las acciones, errores y consejos para la resolución de problemas que cada paso pueda requerir.
- Si tienes un producto que puede realizar diferentes tareas o subtareas, necesitarás realizar una tarea de análisis para cada una de ellas. Por ejemplo, en un automóvil, puedes tocar la bocina, sujetarte con el cinturón de seguridad y encender o apagar los faros. Crea un análisis de tareas para cada una de ellas según sea necesario.
4
Asegúrate de que el producto cumpla con los requisitos de etiquetado y autorización de comercialización. Estos requisitos aseguran que los productos se produzcan teniendo en cuenta la seguridad del usuario y limitarán la exposición del usuario a condiciones peligrosas como la radiación y la electrocución. La publicidad debe demostrar claramente cuál es el propósito y las pautas operativas básicas de un producto, y debes utilizar estas fuentes al redactar el manual del usuario.
- Para que el manual del usuario de un producto sea efectivo, debe estar redactado en coordinación con etiquetas pegadas directamente al producto.
- Asegúrate de que el dispositivo tenga licencia legal para la venta antes de redactar el manual de instrucciones.
5
Decide el diseño del manual. Hay varias formas importantes en que puedes simplificar el manual. Debes colocar un encabezado en negrita al comienzo de cada sección con cada palabra en mayúscula. Por ejemplo, "Configuración del dispositivo", "Operación del dispositivo" y "Solución de problemas" pueden ser encabezados de sección en negrita.
- Otra forma de simplificar el manual es usar dos columnas, una a la derecha con texto y la otra a la izquierda del texto con viñetas, números o pequeños iconos como señales de advertencia o signos de exclamación rojos.^{[1]
  X
  Fuente de investigación}
- El manual puede consistir principalmente en imágenes con algo de texto debajo de cada imagen para explicar el dispositivo, o puede ser principalmente texto con solo unas pocas imágenes que lo acompañen. También puedes usar un diagrama de flujo para proporcionar instrucciones al usuario. Piensa en el producto y en cómo cada método puede ser útil al redactar el manual del usuario. Sin embargo, evita mezclar diferentes diseños dentro de un manual. Elige uno y quédate con él.

Parte 2

Parte 2 de 4:
Incluir información esencial

1
Organiza el manual de forma lógica. 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.
2
Incluye advertencias necesarias. 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.
3
Describe el dispositivo. 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.
4
Incluye instrucciones de configuración. 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
5
Proporciona información sobre la operación. 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.
6
Incluye un resumen del producto al final. 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.

Parte 3

Parte 3 de 4:
Describir el cuidado del producto

1
Explica cómo limpiar el dispositivo. Si el dispositivo o producto requiere limpieza, explica cómo hacerlo. Asegúrate de enumerar los artículos de limpieza necesarios. Informa al lector con qué frecuencia debe limpiar. Luego, tal como lo harías en cualquier otra sección del manual del usuario, incluye instrucciones numeradas paso a paso sobre cómo debe proceder la limpieza.
- Si la limpieza requiere un desmontaje del producto o la extracción de una parte o partes determinadas, asegúrate de incluir detalles sobre cómo desmontarlas.
- Incluye una advertencia sobre las consecuencias de omitir la limpieza el dispositivo. Por ejemplo, puedes decir: "Si no se limpia, se conseguirá un rendimiento inferior al óptimo".
2
Dile al usuario cómo realizar el mantenimiento básico. Si el usuario puede reparar el producto o dispositivo para corregir problemas de rendimiento, incluye instrucciones numeradas sobre cómo puede hacerlo el usuario. Por ejemplo, si las baterías deben cambiarse después de cada 300 horas de uso, incluye instrucciones sobre cómo verificar si las baterías deben cambiarse, cómo quitar las baterías agotadas y cómo insertar las baterías nuevas.
- Si hay algunas tareas de mantenimiento que solo puede realizar un técnico certificado, divide la parte de mantenimiento del manual en dos secciones.
3
Habla sobre las opciones de almacenamiento. El manual del usuario debe, si es necesario, explicar cómo almacenar el producto o dispositivo correctamente. También debe incluir información sobre por qué es necesario el almacenamiento y cuáles son los resultados del almacenamiento inadecuado. Por ejemplo, puedes escribir:
- "Almacena el producto en un lugar fresco y seco. El almacenamiento inadecuado puede acortar la vida útil del producto debido a la acumulación de humedad".
- " No expongas el producto al calor ni lo almacenes a temperaturas superiores a (49 ° C) (120 ° F). Si lo haces, puede provocar una combustión."
4
Incluye información de solución de problemas. Puedes organizar esta sección como una lista de problemas comunes y sus soluciones. Agrupa problemas similares bajo un encabezado lógico. De esta forma, los usuarios pueden encontrar problemas específicos rápidamente.
- Por ejemplo, si hay varios problemas con la computadora que muestra una pantalla azul, enuméralos juntos bajo un subtítulo como "Problemas de pantalla comunes".
- También debes incluir un número de teléfono o correo electrónico para servicio al cliente en esta sección.

Parte 4

Parte 4 de 4:
Redactar un manual ameno

1
Lee otros manuales de usuario. Antes de redactar un manual para tu propio producto, consulta otros manuales de usuario efectivos. Presta atención a la estructura, la elección de palabras y el estilo de las oraciones. Las principales marcas como Apple, Google y Microsoft producen manuales de usuario sólidos y efectivos que pueden ayudarte a producir un manual del usuario más cuidadosamente redactado.^{[2]
X
Fuente de investigación}
- No solo leas los manuales de usuario. Lee los manuales de productos similares que vendas. Por ejemplo, si vendes productos para bebés, lee los manuales para bebés, no de tecnología.
2
Selecciona tus estándares. La estandarización de la ortografía, la elección de palabras y la redacción harán que el manual del usuario sea más fácil de usar. El Manual de Estilo de Chicago y el Manual de Estilo de Microsoft también pueden ser útiles guías de estilo al escribir el manual del usuario. Consulta ambos para ver si uno funcionará para tu manual.^{[3]
X
Fuente de investigación}
- Por ejemplo, en lugar de usar a la vez "el interruptor de encendido y apagado" y "el interruptor de encendido" en el manual del usuario, elige uno u otro término y mantenlo.
3
Usa la voz activa. La voz activa es una perspectiva escrita que explica las cosas desde la perspectiva del usuario. Es más fácil de entender que la voz alternativa y pasiva, en la que el tema no está definido.^{[4]
X
Fuente de investigación}
- Prueba la aplicación Hemingway (www.hemmingwayapp.com) para identificar pasajes pasivos en la redacción.
- Examina estas dos oraciones, la primera activa y la otra pasiva, para ver ejemplos de cada una:
  - Debes abrir el paquete lenta y cuidadosamente.
  - El paquete debe ser abierto lenta y cuidadosamente.
4
Escribe instrucciones numeradas. Las instrucciones ordenadas numéricamente ayudarán al lector a mantenerse más enfocado en el proceso de uso, conexión o armado del producto en cuestión. En lugar de escribir un párrafo largo y confuso, o una serie de párrafos sin numerar, escribe el manual del usuario con pasos simples y explícitos, cada uno claramente numerado.^{[5]
X
Fuente de investigación}
5
Comienza cada paso con un imperativo. Un imperativo es un verbo orientado a la acción. Al comenzar cada paso con un verbo, le dará una pista al lector sobre la acción requerida para completar el paso. Por ejemplo, dependiendo del producto sobre el que escribes, puede comenzar los pasos con imperativos como "Conectar", "Adjuntar" o "Deslizar". Sin embargo, no comiences los pasos con una respuesta del sistema.^{[6]
X
Fuente de investigación}
- Por ejemplo, si la pantalla se volverá azul y parpadeará, no comiences el paso con: "La pantalla parpadeará y se volverá azul". Prueba con: "Mantén presionada la tecla de inicio. La pantalla se oscurecerá y se volverá azul".
6
Decide qué tipo de vocabulario usarás. Si redactas un manual del usuario sobre un yoyo, tu público será principalmente niños pequeños. Usa palabras y vocabulario simples para explicar cómo funciona el yoyo. Si escribes un manual del usuario de un microscopio electrónico de barrido, el público será científicos altamente capacitados que puedan comprender información muy detallada, por lo que no debes evitar usar vocabulario especializado o explicaciones matizadas.
- En general trata de evitar los modismos y el lenguaje técnico.
- Para que sea efectivo para la gama más amplia de usuarios, intenta escribir en un nivel de lectura de sexto a séptimo grado.
7
Asegúrate de que las traducciones sean precisas si envías un producto al extranjero. Contrata un traductor para traducir el manual del usuario al idioma nativo del país al que envías el producto. De forma opcional, usa una aplicación de traducción en línea, pero pídele a un hablante nativo que lea y edite la traducción en busca de errores.
- Si hay varios grupos de idiomas representados en el público, incluye traducciones del manual del usuario en cada idioma relevante.
- El traductor debe estar familiarizado con el producto, ya que puede haber diferentes palabras para términos específicos en el idioma de destino que no sean traducciones palabra por palabra.
8
Mantén la redacción breve. En lugar de unos pocos párrafos largos, usa muchos párrafos cortos. Busca saltos lógicos en cada sección y coloca información útil en fragmentos de una o dos oraciones. Lo mismo se aplica a nivel de oración. Mantén las oraciones cortas y simples, en lugar de largas e incoherentes.^{[7]
X
Fuente de investigación}
- Si un paso es demasiado largo, divídelo en pasos más pequeños. Esto no hará que disminuya el conteo de palabras, pero los saltos de línea harán que sea más fácil de leer.
9
Revisa el manual. Un manual puede perder credibilidad debido a errores gramaticales y ortográficos. Haz que un compañero de trabajo o redactor técnico edite y revise el manual también. Además de la ortografía y la gramática, un corrector debe buscar:^{[8]
X
Fuente de investigación}
- voz pasiva
- lenguaje confuso o ambiguo
- oraciones con estructura complicada
- párrafos demasiado largos

Consejos

La gente aprende de diferentes maneras. Si es posible y apropiado, incluye recursos visuales o enlaces a videos en línea en el manual para ayudar a los lectores.