¿Cómo redactar Manuales de usuario?
Redactar un manual ameno
Lee otros manuales de usuario. Selecciona tus estándares. Usa la voz activa. Escribe instrucciones numeradas. Comienza cada paso con un imperativo. Decide qué tipo de vocabulario usarás. Asegúrate de que las traducciones sean precisas si envías un producto al extranjero. Mantén la redacción breve. Revisa el manual.
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. 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. 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. 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. 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.  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. 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. 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. 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". 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. 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. 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. 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. 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:  voz pasiva lenguaje confuso o ambiguo oraciones con estructura complicada párrafos demasiado largos
Writing a Readable Manual