Contenido

• Al paso
• Parte 1 de 4: Planificación del manual del propietario
• Parte 2 de 4: Insertar información esencial
• Parte 3 de 4: descripción del mantenimiento del producto
• Parte 4 de 4: escriba un manual legible
• Consejos

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). Un manual de usuario es un documento formal con una estructura específica y debe ser escrito por alguien que conozca el producto de adentro hacia afuera, como un escritor técnico o el diseñador del producto. Escribir un manual de usuario eficaz requiere que sepa quién utilizará el producto y que escriba el manual teniendo en cuenta a estos usuarios. Mantenga su escritura clara, precisa y simple para garantizar una experiencia de usuario sin problemas.

Al paso

Parte 1 de 4: Planificación del manual del propietario

1. Haz un análisis de usuario. El manual del usuario debe estar escrito para los usuarios, aquellos que comprarán su producto o servicio y leerán el manual del usuario. Un análisis de usuario le dirá quién será su público principal o objetivo y lo guiará a través de la redacción del texto.
   • Habla con las personas que usarán tu dispositivo. Ofrezca a los usuarios de prueba prototipos del dispositivo y redacte el manual del usuario en condiciones controladas. Solicite a estos usuarios de prueba comentarios sobre cosas que no estén claras o sean confusas en la guía del usuario y realice cambios en su guía del usuario en función de estos comentarios.
   • Nunca podrá satisfacer a toda su audiencia; redacte el manual adaptado al público objetivo o al público más amplio.
   • Considere la edad, la salud (¿tienen alguna enfermedad, problemas de aprendizaje o discapacidades?) Y el nivel de educación de la audiencia para determinar el mejor enfoque para escribir el manual del usuario.
2. Coordinar el diseño del manual de usuario. Si fue parte del equipo que ayudó a diseñar y desarrollar el dispositivo o producto, puede ser difícil dar una mirada objetiva al producto para explicar cómo funciona. Por lo tanto, debe buscar el consejo de un escritor (preferiblemente alguien con experiencia en la redacción de instrucciones) y un diseñador gráfico para que lo ayude a preparar el manual del usuario. Podrías elegir a estas personas a través de una consultoría externa o de tu propia empresa u organización.
3. Haz un análisis de tareas. El análisis de trabajo es el proceso de identificar y organizar los pasos necesarios para utilizar el dispositivo. Un análisis exhaustivo del trabajo identifica los materiales y equipos (como baterías, medicamentos u otros productos suministrados por el usuario) necesarios para cada paso, así como las acciones, los errores y los consejos para la resolución de problemas que cada paso podría requerir.
   • Si tiene un producto que puede realizar muchas tareas o subtareas diferentes, debe realizar un análisis de tareas para cada tarea. Por ejemplo: en un automóvil puede tocar la bocina, abrocharse el cinturón y encender o apagar los faros. Haga un análisis de trabajo para cada uno de estos, si es necesario.
4. Asegúrese de que su producto cumpla con los requisitos de etiquetado y autorización de comercialización. Estos requisitos garantizan que los productos se fabriquen teniendo en cuenta la seguridad del usuario y que la exposición del usuario a condiciones peligrosas, como radiación y electrocución, sea limitada. Los anuncios deben indicar claramente el propósito y las pautas operativas básicas de un producto, y debe utilizar estos recursos al escribir el manual del propietario.
   • Para que el manual del usuario de un producto sea efectivo, debe estar escrito de acuerdo con las etiquetas adheridas directamente al producto.
   • Asegúrese de que su dispositivo tenga licencia oficial para la venta antes de escribir el manual del usuario.
5. Decide el diseño de tu manual. Hay varias formas importantes en las que puede optimizar su manual. Debe poner un encabezado en negrita al principio de cada sección con cada palabra en letras mayúsculas. Por ejemplo, "Configure su dispositivo", "Opere su dispositivo" y "Solucionar problemas" pueden ser títulos de sección en negrita.
   • Otra forma de simplificar su guía es usar dos columnas, una a la derecha con texto y la otra a la izquierda del texto, con viñetas, números o íconos pequeños, como signos de advertencia o signos de exclamación rojos.
   • El manual puede consistir principalmente en imágenes con algún texto debajo de cada imagen para explicar el dispositivo, o puede ser principalmente texto con solo unas pocas imágenes adjuntas. También puede utilizar un diagrama de flujo para guiar al usuario. Piense en su producto y en cómo cada método puede ayudarlo a escribir su manual. Sin embargo, evite mezclar diferentes diseños en un manual. Elige uno y quédate con él.

Parte 2 de 4: Insertar información esencial

1. Organiza el manual de forma lógica. El manual debe estar estructurado de tal manera que el usuario obtenga el mayor beneficio de él. Divida el manual en capítulos o secciones que tengan sentido para usar el producto e incluya una tabla de contenido al principio del manual para que cada sección se pueda encontrar rápidamente.
   • Una tabla de contenido es especialmente necesaria para manuales más extensos.
   • Es necesario un glosario o índice si hay muchos términos para explicar con los que su audiencia puede no estar familiarizada. Sin embargo, no se recomienda un glosario; la mejor opción es explicar términos confusos en el texto del propio manual. Si opta por incluir un glosario, colóquelo al principio del manual, justo después del índice.
   • Una lista de tablas o figuras solo es necesaria si hay más de unas pocas tablas o figuras en el manual.
   • Se necesita un apéndice para las cosas que deben explicarse pero que no se pueden explicar en otra parte del manual, ya que interrumpiría el flujo y el enfoque.
2. Incluya las advertencias necesarias. Las advertencias generales o la información de precaución deben proporcionar información sobre los peligros potenciales causados ​​por el uso inadecuado del producto, incluida la muerte o lesiones graves. Estas advertencias deben colocarse al principio del manual, después de la página principal, para que el usuario las vea primero. También deben incluirse advertencias específicas en el texto del manual justo después o justo antes de que se sugiera un paso potencialmente peligroso.
   • Por ejemplo, una advertencia general para un aparato eléctrico podría ser no usarlo cuando está lloviendo.
   • Una instrucción específica podría ser asegurarse de que tanto sus manos como el dispositivo estén secos antes de conectar el dispositivo a la toma de corriente.
   • Proporcione imágenes (como una calavera y tibias cruzadas) o texto de un color diferente (como texto rojo) para distinguir la advertencia del resto de las instrucciones en las instrucciones de uso y llamar la atención de los usuarios.
3. Describe el dispositivo. Su descripción debe incluir una explicación escrita del propósito del dispositivo y una pequeña representación gráfica de cómo se ve el dispositivo. La figura debe etiquetar y nombrar todos los interruptores, botones y piezas acoplables que contiene el dispositivo.
4. Proporcione instrucciones de instalación. La sección de instalación debe contener información básica sobre cómo prepararse para usar el producto o dispositivo. Si el electrodoméstico no puede ser construido o configurado por un usuario doméstico, indíquelo claramente en un encabezado en negrita en la parte superior de la sección de instalación. También debe incluir lo siguiente:
   • Una lista de piezas
   • Instrucciones de desembalaje
   • Advertencias de instalación
   • Consecuencias de una instalación incorrecta
   • A quién llamar en caso de dificultades durante la instalación
5. Brindar información sobre la operación. Esta sección es la parte más importante del manual del usuario y debe proporcionar información concreta y detallada sobre cómo utilizar el dispositivo. Comience con la preparación básica para usar la unidad, como enchufar el cable de alimentación o lavarse las manos. Continúe con los pasos lógicos numerados que describen cómo usar el dispositivo, así como cualquier comentario (por ejemplo, "Escuchará un clic ...") que el usuario puede esperar cuando usa el dispositivo correctamente.
   • Al final de este capítulo, los usuarios deben consultar el capítulo de solución de problemas para resolver problemas que no se pueden explicar rápidamente.
   • Coloque imágenes donde sea necesario. Algunos pasos se explican mejor con imágenes y palabras. Considere el uso de fotografías o ilustraciones en su manual.
   • En esta sección, como en cualquier sección, debe incluir advertencias de seguridad relevantes sobre el uso u operación inadecuados. Por ejemplo, puede advertir a los usuarios de motosierras que no beban alcohol ni utilicen la motosierra mientras estén tomando ciertos medicamentos.
   • Si cree que los usuarios se beneficiarán, considere incluir enlaces a videos en línea que demuestren el uso y funcionamiento adecuados del dispositivo. Puede grabar estos videos al principio de esta sección o (en el caso de videos que ilustran solo un paso) al final de cada paso.
6. Incluya un resumen del producto al final. El resumen debe aparecer al final del manual, justo antes del índice, para proporcionar los pasos operativos básicos. Esta debe ser una versión simplificada y reducida de la información operativa y no debe tener más de una página. Resuma cómo se utilizará el dispositivo o producto. Incluya alertas básicas, pasos numerados que expliquen cómo utilizar el producto y números de teléfono o direcciones de correo electrónico que dirijan a los usuarios a ayudar.
   • Si espera que el usuario retire o consulte la hoja de resumen con frecuencia, puede imprimirla en una tarjeta laminada extraíble o cartón grueso para que sea más fácil de llevar y consultar.
   • Como alternativa, puede aplicar un resumen directamente al producto para que el usuario pueda consultarlo de forma rápida y sencilla.

Parte 3 de 4: descripción del mantenimiento del producto

1. Explique cómo limpiar el dispositivo. Si su dispositivo o producto necesita limpieza, explique cómo hacerlo. Enumere los agentes de limpieza necesarios. Dígale al lector con qué frecuencia debe limpiar. Luego, como en cualquier otra parte del manual, incluya instrucciones numeradas paso a paso sobre cómo limpiarlo.
   • Si la limpieza requiere que se desarme el producto, o que se retire una parte o partes en particular, indique cómo se debe desarmar el producto.
   • Proporcione una advertencia sobre los resultados de no limpiar el dispositivo. Por ejemplo, podría decir: "Si el dispositivo no se limpia, el rendimiento no será óptimo".
2. Cuente al usuario cómo realizar el mantenimiento básico. Si el usuario puede reparar el producto o dispositivo para corregir problemas de rendimiento, proporcione instrucciones numeradas sobre cómo hacerlo para el usuario. Por ejemplo, si es necesario reemplazar las baterías después de cada 300 horas de uso, proporcione instrucciones sobre cómo verificar si es necesario reemplazar las baterías, cómo quitar las baterías agotadas y cómo instalar las nuevas.
   • Si hay ciertas tareas de mantenimiento que solo puede realizar un técnico certificado, divida la parte de mantenimiento del manual en dos partes.
3. Analice las opciones de almacenamiento. Si es necesario, el manual debe explicar cómo almacenar correctamente el producto o dispositivo. También debe incluir información sobre por qué es necesario el almacenamiento y las consecuencias de un almacenamiento inadecuado. Por ejemplo: podrías escribir:
   • Almacene el producto en un lugar fresco y seco. Un almacenamiento inadecuado puede acortar la vida útil de su producto debido a la acumulación de humedad ".
   • "No exponga el producto al calor ni lo almacene a temperaturas superiores a 50 grados Celsius.Si lo hace, puede provocar la combustión ".
4. Proporcione información sobre resolución de problemas. Puede organizar esta sección como una lista de problemas comunes y sus soluciones. Agrupe problemas similares bajo un encabezado lógico. De esta forma, los usuarios pueden encontrar rápidamente problemas específicos.
   • Por ejemplo, si hay varios problemas con la computadora que muestra una pantalla azul, agrúpelos bajo un subtítulo, como "Problemas comunes de pantalla".
   • También debe incluir un número de teléfono y / o correo electrónico de atención al cliente en esta sección.

Parte 4 de 4: escriba un manual legible

1. Lea otras guías de usuario. Antes de escribir un manual para su propio producto, consulte otras guías de usuario eficaces. Preste atención a la estructura, la elección de palabras y la estructura de la oración. Las principales marcas como Apple, Google y Microsoft producen guías de usuario sólidas y eficaces que pueden ayudarlo a producir una guía de usuario redactada con más cuidado.
   • No solo leas todas manuales de usuario. Lea los manuales de productos similares que vende. Por ejemplo, si vende productos para bebés, lea los manuales para bebés, no los técnicos.
2. Seleccione sus estándares. La estandarización de la ortografía, la elección de palabras y la redacción hará 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 propietario; compruebe ambos para ver si uno es el adecuado para su manual.
   • Por ejemplo, en lugar de utilizar "interruptor de encendido" y "botón de encendido" en su manual, elija uno de los dos términos y cúmplalo.
3. Usa la voz activa. La voz activa es una forma de escribir que explica las cosas desde la perspectiva del usuario. Es más fácil de entender que la alternativa, la voz pasiva, en la que el sujeto es indefinido.
   • Pruebe la aplicación Hemingway (www.hemmingwayapp.com) para identificar pasajes pasivos en su escritura.
   • Estudie estos dos ejemplos de oraciones: la primera es activa y la segunda es pasiva:
     • Tienes que abrir el paquete despacio y con cuidado.
     • El paquete debe abrirse lenta y cuidadosamente.
4. Escribe instrucciones numeradas. Las instrucciones ordenadas numéricamente ayudan al lector a concentrarse mejor en el proceso de uso, conexión o construcción del producto en cuestión. En lugar de escribir un párrafo extenso y detallado, o una serie de párrafos sin numerar, escriba su guía del usuario con pasos simples y explícitos, cada uno claramente numerado.
5. Comience cada paso con un imperativo. Un imperativo es un verbo orientado a la acción. Al comenzar cada paso con un verbo, le da al lector una pista sobre la acción necesaria para completar el paso. Por ejemplo, dependiendo del producto sobre el que esté escribiendo, puede comenzar sus pasos con un comando como "Conectar", "Confirmar" o "Deslizar". Sin embargo, no inicie sus pasos con una respuesta del sistema.
   • Por ejemplo, si la pantalla se vuelve azul y comienza a parpadear, no inicie el paso con: "La pantalla parpadeará y se pondrá azul". Pruebe: "Mantenga presionada la tecla de inicio. La pantalla parpadeará y se pondrá azul ".
6. Determina qué vocabulario utilizarás. Si está escribiendo un manual de yo-yo, su público será en su mayoría niños pequeños. Utilice palabras y vocabulario sencillos para explicar cómo funciona el yoyó. Cuando escribe un manual de microscopio electrónico de barrido, su audiencia está formada por científicos altamente capacitados que pueden comprender información muy detallada, así que no evite usar vocabulario especializado o explicaciones matizadas.
   • En general, intenta evitar la jerga y el lenguaje técnico.
   • Para ser eficaz para la base de usuarios más amplia posible, intente escribir en un nivel comprendido entre el sexto y el séptimo grado de la escuela primaria.
7. Cuando envíe un producto al extranjero, asegúrese de que sus traducciones sean precisas. Contrate un traductor para traducir su manual de usuario al idioma nativo del país al que envía su producto. También puede utilizar un programa de traducción en línea, pero pídale a un hablante nativo que lea la traducción y verifique si hay errores.
   • Si hay varios grupos de idiomas representados en su audiencia, incluya traducciones del manual del usuario en cada idioma relevante.
   • El traductor debe estar familiarizado con el producto, ya que puede haber diferentes palabras en el idioma de destino para términos específicos que no son traducciones palabra por palabra.
8. Escribe en oraciones cortas. En lugar de unos pocos párrafos largos, utiliza muchos párrafos cortos. Busque pausas lógicas en cada sección y asimile la información útil en fragmentos de una o dos oraciones. Lo mismo ocurre a nivel de la oración. Mantenga sus oraciones cortas y simples, en lugar de largas y detalladas.
   • Si un paso es demasiado largo, divídalo en pasos más pequeños. Esto no reducirá el recuento de palabras, pero los saltos de línea facilitarán la lectura.
9. Consulte el manual para ver si hay errores. Un manual puede perder credibilidad debido a errores gramaticales y ortográficos. Pídale a un colega o redactor técnico que también edite y revise el manual. Además de la ortografía y la gramática, un corrector de pruebas debe prestar atención a lo siguiente:
   • Voz pasiva
   • Lenguaje poco claro o confuso
   • Estructura de oración envuelta
   • Párrafos demasiado largos

Consejos

• Las personas aprenden de diferentes maneras; Si es posible y apropiado, incluya ayudas visuales o enlaces a videos en línea en el manual para adaptarse a los lectores con orientación visual.