Instrucciones de paso a paso gratis 
Si tiene un producto que puede realizar muchas tareas o subtareas diferentes, debe ejecutar 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 las luces delanteras. Cree un análisis de trabajo para cada uno de estos, si es necesario. 
Para que el manual de usuario de un producto sea efectivo, debe estar escrito de acuerdo con las etiquetas adheridas directamente al producto. Antes de escribir el manual de usuario, asegúrese de que su dispositivo tenga licencias oficiales para la venta. 
Otra forma de simplificar su manual es usar dos columnas, una a la derecha con texto y la otra justo a la izquierda del texto, con viñetas, números o íconos pequeños, como señales de advertencia o signos de exclamación rojos. 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ñan. También puede utilizar un diagrama de flujo para guiar al usuario. Piensa en tu producto y en cómo cada método puede ayudarte a escribir tu manual. Sin embargo, evite mezclar diferentes diseños dentro de un manual. Elige uno y quédate con él. 
Por ejemplo, una advertencia general para un electrodoméstico podría ser no usarlo durante la lluvia. Una señal específica podría ser asegurarse de que tanto sus manos como el dispositivo estén secos antes de enchufarlo. Proporcione imágenes (como una calavera y tibias cruzadas) o texto en un color diferente (como texto rojo) para distinguir la advertencia del resto de las instrucciones del manual y atraer la atención de los usuarios hacia ella. 
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 de instalación 
Al final de este capítulo, se debe remitir a los usuarios al capítulo de solución de problemas, para resolver problemas que no se pueden explicar rápidamente. Publica imágenes donde sea necesario. Algunos pasos se explican mejor con imágenes y palabras. Piense en usar fotos o ilustraciones en su manual. En esta parte, como en cualquier parte, debe incluir las advertencias de seguridad pertinentes sobre el uso o la operación inadecuados. Por ejemplo, podría advertir a los usuarios de motosierras que no beban alcohol ni usen la motosierra mientras toman ciertos medicamentos. Si cree que beneficiaría a los usuarios, considere incluir enlaces a videos en línea que demuestren el uso y funcionamiento correcto del dispositivo. Puede incluir estos videos al principio de esta sección o (en el caso de videos que ilustran solo un paso) al final de cada paso. 
Si espera que el usuario retire la hoja de resumen o necesita consultarla con frecuencia, puede imprimirla en una tarjeta plastificada removible o cartón grueso para que sea más fácil para el usuario llevarla y consultarla. Alternativamente, puede colocar un resumen directamente en el producto para una referencia rápida y fácil para el usuario. 
Si hay ciertas tareas de mantenimiento que solo puede realizar un técnico certificado, divida la sección de mantenimiento del manual en dos partes. 
`Guardar el producto en un lugar fresco y seco. El almacenamiento inadecuado puede acortar la vida útil de su producto debido a la acumulación de humedad.` `No exponga el producto al calor y no lo almacene a temperaturas superiores a 50 grados centígrados. Si hace esto, puede conducir a la ignición.` 
Por ejemplo, si hay varios problemas con la computadora que muestra una pantalla azul, agrúpelos bajo un subtítulo, como "Problemas de pantalla comunes". También debe incluir un número de teléfono de atención al cliente y/o correo electrónico en esta sección. 
Por ejemplo, en lugar de usar "interruptor de encendido/apagado" y "botón de encendido/apagado" en su manual, elija uno de los dos términos y manténgalo. 
Pruebe la aplicación Hemingway (www.hemmingwayapp.com) para reconocer pasajes pasivos en su escritura. Estudie estas dos oraciones de muestra: la primera es activa y la segunda pasiva: Tienes que abrir el paquete despacio y con cuidado. El paquete debe abrirse lenta y cuidadosamente. 
Por ejemplo, si la pantalla se vuelve azul y comienza a parpadear, no inicie el paso con "La pantalla parpadeará y se volverá azul".` Pruebe: `Presione y mantenga presionada la tecla de inicio. La pantalla parpadeará y se volverá azul.` 
En general, trate de evitar la jerga y el lenguaje técnico. Para que sea efectivo para la base de usuarios más amplia posible, intente escribir a un nivel de sexto a séptimo grado. 
Si varios grupos de idiomas están 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 otras palabras en el idioma de destino para términos específicos que no son traducciones palabra por palabra. 
Si un paso comienza a ser demasiado largo, divídalo en pasos más pequeños. Esto no reducirá el número de palabras, pero los saltos de línea harán que sea más fácil de leer. 
Voz pasiva Lenguaje poco claro o confuso estructura de oración envuelta Párrafos excesivamente largos
Escribir una guía de usuario
Contenido
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 de usuario es un documento formal con una estructura específica y debe ser escrito por alguien que conozca el producto de principio a fin, como un redactor técnico o el diseñador del producto. Escribir un manual de usuario efectivo requiere que sepa quién usará el producto y que escriba el manual con estos usuarios en mente. Mantenga su escritura clara, precisa y simple para garantizar una experiencia de usuario sin problemas.
Pasos
Parte 1 de 4: Planificación de la guía del usuario
1. Haz un análisis de usuario. La guía del usuario debe estar escrita para los usuarios, aquellos que comprarán su producto o servicio y leerán la guía del usuario. Un análisis de usuario te dirá quién será tu público principal o objetivo y te guiará en la redacción del texto.
- Hable con las personas que usarán su dispositivo. Proporcionar a los usuarios de prueba prototipos del dispositivo y un borrador del manual del usuario en condiciones controladas. Solicite a estos usuarios de prueba comentarios sobre las cosas que no están claras o confusas en la guía del usuario y realice cambios en su guía del usuario en función de estos comentarios.
- Nunca puedes complacer a toda tu audiencia; escribir el manual adaptado a la audiencia objetivo o a la audiencia más grande.
- Piense en la edad, la salud (¿tienen alguna enfermedad, problemas de aprendizaje o discapacidades?) y el nivel de educación del público, para determinar el mejor enfoque para escribir el manual del usuario.
2. Coordinar el diseño del manual de usuario. Si usted fue parte del equipo que ayudó a diseñar y desarrollar el dispositivo o producto, puede ser difícil observar el producto de manera objetiva para explicar cómo funciona. Por lo tanto, debe buscar el consejo de un escritor (preferiblemente alguien con experiencia en escribir instrucciones) y un diseñador gráfico para que lo ayuden a preparar el manual del usuario. Puede elegir a estas personas a través de una consultoría externa o de su propia empresa u organización.
3. Haz un análisis de trabajo. Un análisis de trabajo es el proceso de identificar y organizar los pasos necesarios para usar el dispositivo. Un análisis exhaustivo del trabajo identifica los materiales y el equipo (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 solución de problemas que cada paso puede requerir.
4. Asegúrese de que su producto cumpla con los requisitos de autorización de etiquetado y comercialización. Estos requisitos garantizan que los productos se fabriquen pensando en 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 usar estos recursos al escribir su guía del usuario.
5. Decide el diseño de tu manual. Hay varias formas importantes en las que puede simplificar su manual. Debe poner un título en negrita al principio de cada sección con cada palabra en mayúsculas. Por ejemplo, "Configurar su dispositivo", "Controlar su dispositivo" y "Solucionar problemas" pueden ser encabezados de sección en negrita.
Parte 2 de 4: incrustación de información esencial
1. Organizar 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 guías más largas.
- Se necesita un glosario o índice si hay muchos términos para explicar que su audiencia puede no saber. Sin embargo, no se recomienda un glosario; la mejor opción es explicar los términos confusos en el propio texto del manual. Si elige incluir un glosario, colóquelo al principio del manual, justo después de la tabla de contenido.
- Solo se necesita una lista de tablas o figuras 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. Incluir las advertencias necesarias. Las advertencias generales o la información de precaución deben proporcionar información sobre los peligros potenciales que pueden derivarse del uso inadecuado del producto, incluida la muerte o lesiones graves. Estas advertencias deben colocarse al principio del manual, después de la primera página, para que el usuario las vea primero. También se deben incluir advertencias específicas en el texto del manual justo después o justo antes de que se sugiera un paso potencialmente peligroso.
3. Describa el dispositivo. Su descripción debe incluir tanto una explicación escrita del propósito del dispositivo como una pequeña representación gráfica de cómo se ve el dispositivo. La ilustración debe etiquetar y nombrar todos los interruptores, botones y piezas acoplables contenidas en el dispositivo.
4. Proporcionar 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 un usuario doméstico no puede construir o configurar el dispositivo, 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:
5. Proporcionar información de 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 usar el dispositivo. Comience con la preparación básica antes de usar el aparato, como enchufar el enchufe o lavarse las manos. Continúe con pasos lógicos y numerados que describen cómo usar el dispositivo, así como comentarios (por ejemplo, "Escucha un clic...`) que el usuario puede esperar al usar el dispositivo correctamente.
6. Añadir un resumen del producto al final. El resumen debe venir al final del manual, justo antes del índice, para dar los pasos básicos de operación. Esta debe ser una versión simplificada y simplificada de la información operativa y no debe exceder una página. Resumir cómo usar el dispositivo o producto. Incluya 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 indiquen a los usuarios que ayuden.
Parte 3 de 4: Describiendo el mantenimiento del producto
1. Explicar cómo limpiar el dispositivo. Si es necesario limpiar su dispositivo o producto, 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 limpiar.
- Si la limpieza requiere el desmontaje del producto o la eliminación de una o varias piezas, indique cómo desmontar el producto.
- Proporcionar 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 producto o dispositivo puede ser reparado por el usuario para corregir problemas de rendimiento, proporcione instrucciones numeradas sobre cómo hacerlo por parte del 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 usadas y cómo insertar las nuevas.
3. Discutir las opciones de almacenamiento. El manual debe explicar, si es necesario, 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 las consecuencias de un almacenamiento incorrecto. Por ejemplo, podrías escribir:
4. Proporcionar información de solución de problemas. Podría organizar esta sección como una lista de problemas comunes y sus soluciones. Agrupar problemas similares bajo un encabezado lógico. De esta manera, los usuarios pueden encontrar rápidamente problemas específicos.
Parte 4 de 4: escribir una guía legible
1. Leer otras guías de usuario. Antes de escribir un manual para su propio producto, consulte otros manuales de usuario efectivos. Preste atención a la estructura, elección de palabras y estructura de la oración. Las principales marcas como Apple, Google y Microsoft producen guías de usuario sólidas y efectivas que pueden ayudarlo a producir una guía de usuario cuidadosamente escrita.
- no solo leas todo manuales de usuario. Lee los manuales de productos similares que vendes. Por ejemplo: si vendes productos para bebés, lee manuales para bebés, no técnicos.
2. Seleccione sus estándares. Estandarizar la ortografía, la elección de palabras y la redacción hará que la guía 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 guías de estilo útiles al escribir el manual del propietario; verifique ambos para ver si uno es adecuado para su manual.
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.
4. Escribir 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 largo y detallado, o una serie de párrafos sin numerar, escriba su guía de 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 requerida 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.
6. Decide qué vocabulario usarás. Si escribe un manual de usuario para un yo-yo, su audiencia estará compuesta principalmente por niños pequeños. Usa palabras y vocabulario sencillos para explicar cómo funciona el yo-yo. Si está escribiendo un manual de microscopio electrónico de barrido, su audiencia estará compuesta por científicos altamente capacitados que pueden comprender información muy detallada, así que no dude en utilizar un vocabulario especializado o explicaciones matizadas.
7. Cuando envíe un producto al extranjero, asegúrese de que sus traducciones sean precisas. Contrate a un traductor para traducir su manual de usuario al idioma nativo del país al que envía su producto. También puede usar una herramienta de traducción en línea, pero pídale a un hablante nativo que lea la traducción y verifique si hay errores.
8. Escribe en oraciones cortas. En lugar de unos pocos párrafos largos, use muchos párrafos cortos. Busque saltos lógicos en cada sección y digiera información útil en fragmentos de una o dos oraciones. Lo mismo es cierto a nivel de oración. Mantén tus oraciones cortas y simples, en lugar de largas y detalladas.
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 escritor técnico que también edite y corrija el manual. Además de la ortografía y la gramática, un corrector debe prestar atención a lo siguiente:
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 acomodar a los lectores visualmente orientados.
Artículos sobre el tema. "Escribir una guía de usuario"
Оцените, пожалуйста статью
Popular
