Cómo crear un manual de usuario

https://www.wikihow.it/Creare-un-Manuale-d%27Uso

07-08-2024 |
italia |
fai da te |
Programma di scrittura o pubblicazione |
Programma di grafica o registrazione visiva |

Los manuales de usuario son guías escritas físicamente (en papel) o documentos electrónicos (PDF o XPS) que brindan instrucciones sobre cómo hacer o usar algo.Aunque comúnmente se piensa que las “guías de usuario” están relacionadas con software de computadora, los manuales de usuario también se adjuntan a computadoras u otros dispositivos electrónicos como televisores, estéreos, teléfonos y reproductores de MP3, así como a electrodomésticos y equipos de jardín.Un buen manual de usuario informa a los usuarios sobre las características del producto, enseñando además sus respectivas operaciones de forma eficaz y fácilmente accesible.A continuación se detallan los elementos a considerar al crear contenido y diseño efectivos de un manual de usuario.

Parte 1

Parte 1 de 3:

Crear documentación fácil de usar

Descargar PDF

1
Definir el usuario de referencia. Para escribir un manual exitoso, necesita perfilar a su usuario, ya sea formal, creando un perfil escrito, o informal, tomándose el tiempo para hacer suposiciones razonables sobre las características de su usuario.Un perfil como este es útil cuando eres parte de un equipo que escribe documentación de usuario y también puede ser útil en el proceso de llevar el producto desde la idea hasta la forma final.Al escribir un perfil de usuario, los elementos a considerar incluyen:
- Dónde los usuarios utilizarán el manual, en casa, en la oficina, en un lugar de trabajo remoto o en el coche.Esto podría afectar no sólo al contenido, sino también al estilo del manual.
- Cómo utilizarán la guía los usuarios.Si sólo es necesario consultar el manual en raras ocasiones o buscar información, debería adoptar principalmente la forma de un documento de referencia.Si es algo que inicialmente los usuarios consultarán con frecuencia, la sección de referencia debe ir acompañada de una sección de “Primeros pasos” e instrucciones sobre los usos más comunes del producto.
- Cuánta experiencia tienen ya los usuarios con el producto u otros de la misma categoría.Si su producto es nuevo o tiene diferencias sustanciales con productos similares, deberá incluir una explicación de estas diferencias, así como instrucciones sobre cómo comenzar a usarlo.Si el producto aborda algo con lo que los usuarios suelen tener problemas, como muchas aplicaciones informáticas, deberá proporcionar información y detalles adecuados en un estilo comprensible.
2
Aborde las necesidades de sus usuarios de una manera que puedan entender. A menos que el usuario tenga experiencia técnica, probablemente será mejor evitar terminologías específicas y preferir explicaciones claras y sencillas.El texto también debería organizarse para dar cabida al razonamiento de los usuarios;Enumerar las características de los productos agrupándolos por sus funciones a menudo tiene más sentido que los pedidos más utilizados en las listas.
- A veces no hay forma de evitar los términos técnicos, como en el caso del software de gráficos que incluye gráficos de Fibonacci junto con gráficos circulares y de barras más comunes.En casos similares, resulta útil definir el término y ofrecer una explicación, por ejemplo profundizando en la definición y utilidad de las tablas de Fibonacci en el análisis financiero.
3
Explique el problema que el usuario está intentando resolver y luego presente la solución. Proporcionar sólo la solución a un problema genérico funciona en la fase de venta del producto, pero una vez que el usuario lo ha comprado debe entender cómo utilizarlo de la mejor manera.Identifique los problemas específicos que encontrará el usuario, indíquelos en la guía del usuario y luego pase a las instrucciones para resolverlos.
- Si el problema es complejo, divídalo en partes más pequeñas.Enumere cada parte con instrucciones sobre cómo resolverla o abordarla y luego organícelas en sucesión.Este proceso se conoce como "fragmentación".
Publicidad

Parte 2

Parte 2 de 3:

Elementos de un manual de usuario

Descargar PDF

1
Incluya la portada y las páginas de título apropiadas. Necesitará una portada para cada guía del usuario, que consta de algo más que una simple tarjeta de referencia, y portadas para manuales más largas que una hoja de papel doblada (4 o más páginas).
- Si el manual está protegido por derechos de autor, se deberá especificar tanto en la portada como en la portada.
- Si necesita informar los términos y condiciones de uso del manual y del producto relacionado, deberá incluirlos en el interior de la portada.
Si la documentación del usuario cubre más de un volumen, proporcione referencias a los otros documentos aquí, con las versiones correctas.La introducción es también la parte donde puedes insertar la sección “Cómo utilizar esta guía”, si es necesario.
4
Coloque las instrucciones/métodos y materiales de referencia en el cuerpo principal del manual. En muchos casos, los métodos y materiales de referencia deben tener cada uno su propia sección, aunque siempre se puede indicar al usuario que haga referencia a contenidos específicos de una sección a otra.De esta forma, el usuario puede encontrar más rápido la información que busca.
- Los métodos deben escribirse de forma coherente en toda la sección de instrucciones del manual.Comience con una descripción general de la tarea, luego describa lo que el usuario debe hacer y qué resultados debe lograr.Los pasos deben estar numerados y comenzar con verbos de acción, al igual que los pasos de cada sección de este artículo.
- Los materiales de referencia pueden incluir una lista de opciones, consejos y preguntas frecuentes.Se pueden agregar glosarios y apéndices hacia el final del manual, aunque al principio puede aparecer una lista de términos de uso común.El índice se puede omitir si el manual tiene menos de 20 páginas.
5
Utilice gráficos cuando sea necesario para respaldar el texto. Los gráficos o capturas de pantalla pueden ilustrar ciertos puntos del manual mejor que el texto, especialmente dentro de procedimientos complejos donde los usuarios necesitan confirmación visual de la ejecución correcta.Los gráficos se pueden producir usando programas CAD o software de gráficos, edición digital y cámaras digitales, o en el caso de capturas de pantalla, a través de la función incorporada de la computadora (“sello”/cmd+shift+3) o un programa de gráficos que proporcione la opción de grabación de pantalla.
- Una vez creados los gráficos, guárdelos en un formato comprimido para permitir su uso en programas de escritura o publicación.También querrás reducir el tamaño del archivo para que sea más fácil incluirlo en la página sin reducir los detalles para el usuario (si es necesario, es posible que tengas que desglosar la imagen original y mostrar las partes relevantes a medida que avanzas en el texto). .
- Si utiliza numerosos gráficos en sus métodos, mantenga la coherencia en las dimensiones, ya sea que todos tengan el mismo largo y ancho o que siempre estén reducidos a la misma proporción de su tamaño original.Esto hará que las imágenes sean más atractivas para el usuario.Del mismo modo, al guardar capturas de pantalla en una computadora, asegúrese de que la computadora esté configurada en un color estándar durante este paso, en caso de que el manual requiera que conserve estos colores.
- Si bien los programas gráficos como Photoshop y Paint Shop Pro ofrecen buenas capacidades de guardado de pantalla, programas especializados como SnagIt también le permiten editar, catalogar y anclar pantallas fácilmente.
Publicidad

Parte 3

Parte 3 de 3:

Diseñar un manual legible

Descargar PDF

1
Elija un par de fuentes legibles. Aunque las computadoras pueden admitir muchas fuentes diferentes, el objetivo de un manual de usuario es que sea fácil de leer.Elegir algunas fuentes que combinen bien es la mejor manera de lograr este objetivo.Hay 2 categorías de fuentes:“serif” y “sans serif” (con o sin serif).
- Las fuentes serif tienen pequeñas terminaciones al final de los trazos principales de las letras.Las fuentes serif incluyen Times New Roman, Baskerville y Book Antiqua.Las serifas funcionan mejor en bloques de texto grandes de tamaño 10 a 12 en el cuerpo principal de un manual de usuario impreso.
- Las fuentes sans serif exhiben sólo los trazos que forman las letras sin terminaciones.Las sans serif incluyen Arial, Calibri y Century Gothic.Estas fuentes se pueden utilizar para bloques grandes de texto de tamaño 8-10 en un manual en línea o PDF, aunque la falta de terminaciones hace que las oraciones de tamaño 12+ sean más difíciles de leer.Sin embargo, se pueden utilizar eficazmente en tamaños más grandes para mostrar titulares y encabezados, y son igualmente adecuados en tamaños más pequeños para pies de página y números en columnas o tablas.
- Generalmente debes elegir fuentes neutras como Arial o Times New Roman para tu manual de usuario, aunque es mejor optar por una fuente decorativa en el caso de citas o títulos, si estás escribiendo por ejemplo para un videojuego de fantasía o ciencia. entornos de ficción (en el caso de extractos del mismo texto, a menudo se puede utilizar la misma fuente, en formato “cursiva”).
- Una vez que haya elegido las fuentes que utilizará, cree una página de prueba para comprobar que las fuentes se ven bien juntas en papel.También es posible que desee mostrar esta prueba a cualquier persona que necesite aprobar el aspecto del manual antes de continuar.
2
Piensa en el diseño. Una vez que haya elegido las fuentes para su manual de usuario, deberá decidir la ubicación de los distintos elementos de las páginas.
- Por lo general, querrás colocar el título del manual o del capítulo en el encabezado o en la parte inferior de la página, idealmente usando el título del manual en la página izquierda y el título del capítulo en la derecha.Los números de página deben estar arriba o abajo, hacia afuera (encabezado o pie de página) o en el centro (solo pie de página).Es posible que desees distinguir la primera página de cada sección o capítulo de las demás colocando su número de página en el centro y las siguientes en la esquina exterior del encabezado.
- Es posible que desees dibujar partes del texto en cuadros coloreados o sombreados para separarlas del resto del texto.Asegúrese de elegir un color o grado de sombreado que no se superponga al texto.
- Deje márgenes razonablemente amplios en todos los lados, con suficiente espacio en los bordes que se unirán.
3
Considere el tipo de encuadernación del manual de usuario. Si su manual tiene más de 4 páginas, será necesario encuadernarlas de alguna manera.Si bien los documentos internos se pueden grapar en una esquina, los manuales externos que se entregan con el producto generalmente se encuadernan de tres maneras:
- Las grapas laterales son adecuadas para manuales formados por hojas de papel plegadas de 21x27,5cm, 21x35cm o 27,5x42,5cm.La mayoría de los manuales económicos de menos de 48 páginas están encuadernados de esta manera.
- La costura lateral se usa más comúnmente para guías de referencia externas en lugar de manuales del propietario incluidos con productos que no son automotrices, aunque algunas guías más largas están encuadernadas de esta manera (Paint Shop Pro inicialmente se envió con una guía encuadernada, cuando fue producida por JASC Software ).
- La encuadernación en espiral es adecuada para guías de usuario diseñadas para ser más robustas, como por ejemplo para entornos exteriores, donde los manuales engrapados o engrapados no resistirían.Algunos manuales encuadernados en espiral también pueden contener páginas laminadas para evitar que se dañen por el contacto con el agua o el barro.
4
Cree una plantilla para su manual. Muchos programas de redacción y publicación ofrecen la posibilidad de crear un documento de plantilla para tu manual de usuario, de modo que cuando escribas, el texto aparezca automáticamente en la fuente deseada dentro de la parte del manual en la que estás trabajando (este artículo, de hecho, fue escrito inicialmente usando una plantilla de MS Word).Muchos de estos programas también incluyen un conjunto de plantillas prediseñadas que puedes modificar para adaptarlas a tus necesidades, en lugar de crear una plantilla desde cero.
- Los programas de redacción y publicación también le permiten crear "estilos", fuentes y tamaños preestablecidos para encabezados, pies de página, títulos y cuerpos de texto.Puede elegir uno de los estilos predefinidos (como "Encabezado1", "Normal", "Cita") o crear su propio estilo personalizado con su propio nombre.En la medida de lo posible, siga las convenciones de nomenclatura de estilos institucionales si tiene varios estilos para el mismo fragmento de texto (por ejemplo, MS Word etiqueta los estilos de encabezado como "Encabezado1", "Encabezado2", etc.por títulos, desde el principal hasta los distintos niveles de subtítulos).Intente crear todos los estilos que necesitará con anticipación, para no tener que dejar de crearlos durante el proceso de escritura real.
Publicidad

Consejo

Haga un buen uso del código y las variables de texto siempre que sea posible.Puedes asignarle valores, como el nombre de un producto, el título de un manual o un capítulo, y colocarlos en el documento en lugar de escribir el texto real.Cuando obtiene una vista previa o imprime un documento, el texto reemplazará la variable.Si cambia el nombre del producto, o si cambia el nombre del manual o de un capítulo, será más fácil cambiar la información reemplazando el valor de la variable de texto en lugar de buscarlo y reemplazarlo dentro del documento.

Cosas que necesitarás

Programa de redacción o publicación.
Programa de grabación gráfica o visual.

Licenciado bajo: CC-BY-SA