Cómo hacer un manual de usuario

Información del autor

Los manuales de usuario son guías escritas en formatos impresos (en papel) o en documentos electrónicos (PDF o XPS) que proporcionan instrucciones de cómo hacer o utilizar algo. Si bien se considera generalmente a las “guías de usuario” como manuales para programas de computación, las guías de usuario pueden acompañar a computadoras y a otros dispositivos electrónicos, como televisores, radios estéreo, sistemas telefónicos y reproductores MP3, así como también a electrodomésticos y equipos de jardinería. Los buenos manuales de usuario educan al usuario acerca de las funciones del producto mientras le enseñan a utilizarlas de manera efectiva y están dispuestos de tal forma que puedan leerse y consultarse fácilmente. A continuación, este artículo presentará algunas cosas para tener en cuenta a la hora de crear un contenido efectivo y diseñar la disposición para un manual de usuario.

Parte 1

Parte 1 de 3:
Crear la documentación de usuario apropiada

1
Define quién es el usuario de la guía. Para escribir un manual de usuario exitoso, debes desarrollar un perfil de tu usuario, ya sea de manera formal, creando un perfil escrito, o de manera informal, tomándote el tiempo de realizar suposiciones razonables acerca de las características del usuario. Un perfil así es útil cuando formas parte de un equipo que está escribiendo la documentación de usuario y también puede ayudar a llevar al producto en sí desde un concepto hasta su forma final. Las cosas a tener en mente cuando formas un perfil de usuario son:
- El lugar donde los usuarios utilizarán la guía de usuario, como por ejemplo en casa, en la oficina, en un lugar de trabajo remoto o en el auto. Esto puede determinar, no solo el contenido, sino también el estilo que tome el manual de usuario.
- La manera en que los usuarios utilizarán la guía de usuario. Si los usuarios consultarán el manual pocas veces o solo para buscar información, esta debe tener un formato como el de un documento de consulta. Si al principio los usuarios consultarán el manual con frecuencia, la sección de consulta debe estar acompañada de una sección titulada “Cómo empezar” y de instrucciones de las tareas más simples para las que se utilizará el producto.
- La experiencia que tienen los usuarios con el producto o con otros productos similares. Si tu producto es nuevo o significativamente diferente de otros productos similares, deberás incluir una explicación de cómo es distinto comparado con otros productos y también instrucciones de cómo comenzar a utilizarlo. Si el producto está relacionado con algo que frecuentemente resulta problemático para los usuarios, como sucede con muchos programas de computación, deberás proporcionar una información adecuada y detallada de una forma comprensible.
2
Escribe y dale un formato a la guía de modo tal que sea comprensible para todos los usuarios. A menos que el usuario tenga antecedentes técnicos, es posible que sea mejor evitar el lenguaje muy técnico para lograr explicaciones más claras y simples. El texto debe estar organizado de manera similar a como piensa el usuario; a menudo, tiene más sentido enumerar las características del producto agrupándolas por sus funciones que señalar solo aquellas que se utilizan más seguido.
- A veces es inevitable utilizar términos técnicos, como para un programa de computación destinado a crear gráficos que incluye gráficas de Fibonacci además de los gráficos de barras y circulares, que son más comunes. En ese caso, es útil definir el término y proporcionar algo de información básica al respecto, como explicar qué es un gráfico de Fibonacci y para qué se usa en el análisis financiero.
3
Explica a detalle el problema que el usuario intenta resolver y luego presenta una solución para dicho problema. Ofrecer una característica del producto como una solución a un problema común funciona bien cuando se promociona el producto, pero una vez que el usuario lo tenga, debe saber cómo utilizar dicha característica. Identifica los problemas específicos que el usuario enfrentará, menciónalos en la guía de usuario y luego añade las instrucciones para resolverlos.
- Si el problema es complejo, sepáralo en partes más pequeñas. Enumera cada una de las partes con las instrucciones para resolverlo o lidiar con él y luego agrega sucesivamente cada parte siguiente. Dividir la información de esta manera se denomina “fragmentar”.

Parte 2

Parte 2 de 3:
Organizar los componentes del manual de usuario

1
Incluye la portada y las carátulas adecuadas. Deberás incluir una portada para cualquier guía de usuario mayor a una hoja de referencia así como una carátula para cualquier manual que cubra más que la superficie de una hoja de papel doblada (4 o más páginas de largo).
- Si el manual tiene la protección de los derechos de autor, se debe incluir un aviso de derechos de autor en la portada y en la carátula.
- Si existen términos y condiciones para usar el manual y el producto asociado a este, colócalos en la portada interior.
2
Pon referencias a las documentaciones relacionadas en el prefacio. Si la documentación de usuario es más que un solo manual, coloca aquí las referencias a los demás documentos, con sus números de versiones correspondientes. El prefacio también es el lugar en donde deberás colocar (si la hubiera) una sección denominada “Cómo utilizar esta guía”.
3
Si el manual excede las 10 páginas, incluye un índice de contenidos.
4
Pon las instrucciones o los procedimientos y los materiales de consulta en el cuerpo del manual. En la mayoría de los casos, los procedimientos y los materiales de consulta tienen sus propias secciones, aunque dentro de una sección puedes indicarle al usuario que consulte un contenido específico de la otra. De este modo, el usuario puede encontrar más rápidamente la información que esté buscando.
- Los procedimientos deben escribirse con una estructura consistente a lo largo de la sección de instrucciones del manual. Comienza con un resumen de la tarea, luego describe qué debe hacer el usuario y qué resultados debe observar. Los pasos deben ser numerados y comenzar con acciones verbales del mismo modo que están escritos los pasos en cada sección de este artículo.
- Los materiales de consulta pueden incluir una lista de opciones, consejos para la resolución de problemas y las preguntas más frecuentes. Los glosarios y los índices pueden añadirse cerca del final del manual, aunque se puede colocar una lista de términos utilizados frecuentemente al principio. Puede omitirse el índice si el manual tiene menos de 20 páginas.
5
Usa imágenes gráficas para respaldar al texto cuando sea necesario. Las imágenes gráficas o las capturas de pantalla pueden ilustrar algunos puntos en el manual mejor que un texto, en especial si se trata de procedimientos complejos en los cuales el usuario necesite una confirmación visual de que esté llevando a cabo los pasos correctamente. Las imágenes gráficas pueden crearse utilizando programas de diseño asistido por computadora (CAD, por sus siglas en inglés) o programas de diseño gráfico, cámaras digitales y programas de edición de fotografías o, en el caso de las capturas de pantalla, puedes utilizar la función de captura que viene instalada en la computadora, o un programa de manejo de gráficos con una función de captura de pantallas.
- Una vez que hayas creado una imagen gráfica, guárdala en un formato tan comprimido como tu procesador de textos o tu programa de autoedición te permita utilizar. También debes reducir el tamaño físico de la imagen hasta alcanzar uno que pueda encajar más fácilmente en la página proveyendo simultáneamente el detalle necesario para el usuario (de ser necesario, quizás debas separar la imagen en partes para mostrar las partes relevantes junto al texto que respaldan).
- Si utilizas muchas imágenes gráficas en los procedimientos, hazlas de un tamaño consistente, ya sea en las mismas medidas de ancho y alto o en la misma proporción de reducción con respecto al tamaño original. Esto hará que las imágenes luzcan más atractivas para el usuario. Del mismo modo, cuando tomes capturas de pantalla en una computadora, asegúrate de que la computadora muestre la misma combinación de colores cuando captures imágenes en caso de que el manual de usuario vaya a mostrarlas en colores.
- Aunque los programas de diseño gráfico como Photoshop o Paint Shop Pro ofrecen funciones de captura de pantalla decentes, los programas de captura especializados como el Snagit también permiten modificar, catalogar y comentar fácilmente las capturas de pantalla.

Parte 3

Parte 3 de 3:
Diseñar un manual de usuario legible

1
Elige algunas fuentes legibles. Aunque las computadoras permiten utilizar muchas fuentes diferentes, el objetivo de un manual de usuario es ser fácilmente legible. Para lograrlo, lo mejor es elegir un número reducido de fuentes que se vean bien juntas. Las fuentes pueden dividirse en dos grupos: las fuentes serif y las fuentes sans serif
- Las fuentes serif tienen pequeñas líneas de adorno al final de los trazos principales que forman la letra. Algunas fuentes serif son Times New Roman, Baskerville, y Book Antiqua. Las fuentes serif funcionan mejor en grandes fragmentos de texto impresos en el cuerpo principal del manual de usuario en un tamaño de 10 o 12 puntos.
- Las fuentes sans serif solo tienen trazos que forman las letras, sin adornos. Algunas fuentes sans serif son Arial, Calibri y Century Gothic. Las fuentes sans serif se pueden utilizar en grandes fragmentos de texto en tamaños de 8 a 10 puntos en un PDF o en un manual en Internet, aunque la falta de serifs hace que las oraciones escritas en tamaños de 12 puntos o más sean difíciles de leer. Sin embargo, se pueden utilizar de manera efectiva en tamaños más grandes para los títulos y encabezados, y además son muy buenas en tamaños más pequeños para pies de página y números en columnas y tablas.
- Por lo general, debes elegir fuentes simples como Arial o Times New Roman para tu manual de usuario, aunque puedes elegir una fuente decorativa para las citas apartadas o los títulos si escribes un manual de usuario para un videojuego con una temática fantástica o de ciencia ficción (en el caso de las citas al margen, a menudo puedes utilizar alguna de las fuentes sencillas y mostrar la cita apartada en cursiva).
- Una vez que hayas elegido las fuentes que vayas a utilizar, crea una página de muestra para verificar que las fuentes se vean bien juntas en el papel. También deberías mostrarle esta muestra a la persona que deba aprobar la apariencia del manual antes de continuar escribiéndolo.
2
Piensa bien la distribución. Una vez que hayas elegido las fuentes del manual de usuario, deberás decidir dónde colocas cada cosa en las páginas.
- Por lo general, es conveniente poner el título del manual o del capítulo en el encabezado o en el pie de página colocando el título del manual en la página izquierda y el título del capítulo en la página derecha. También es conveniente colocar el número de página en el encabezado o en el pie de página, ya sea en el lado externo (del encabezado o del pie de página) o en el centro (únicamente en el pie de página). Es conveniente diferenciar la primera página de cada sección o capítulo de las otras páginas colocando su número de página en el centro del pie de página y en las páginas siguientes, ponerlo en la esquina exterior del encabezado.
- Es conveniente colocar el texto de las referencias de las imágenes en colores o en recuadros sombreados para separarlo del resto del texto. Asegúrate de elegir un color o un nivel de sombreado que permita leer el texto con facilidad.
- Deja unos márgenes razonablemente amplios a los lados, con un espacio extra en los bordes en los cuales vayas a unir todas las páginas.
3
Elige el tipo de encuadernación para el manual de usuario. Si el manual de usuario tiene más de 4 páginas, será necesario unir las páginas de algún modo. Aunque los documentos de uso interno pueden engraparse en las esquinas, los manuales de usuario de uso externo que se entregan con un producto pueden encuadernarse en una de estas 3 formas:
- Engrapar a los lados resulta apropiado para los manuales compuestos por hojas de papel dobladas de 21 x 27,5 cm (8,5 x 11 pulgadas), 21 x 35 cm (8,5 x 14 pulgadas) o 27,5 x 42,5 cm (11 x 17 pulgadas). La mayoría de los manuales baratos de 48 páginas o menos se encuadernan de este modo.
- Es más común utilizar el cosido a caballo para las guías de consulta para terceros que para los manuales de usuario que se entregan con los productos que no sean automóviles, aunque algunas guías de usuario más largas se encuadernan de este modo (inicialmente, cuando JASC software producía el Paint Shop Pro, entregaban manuales de usuario encuadernados mediante el cosido a caballo).
- La encuadernación con espirales es más adecuada para las guías de usuario que estén diseñadas para entornos más hostiles como en exteriores, en donde los manuales encuadernados con grapas o cosidos a caballo se desarmarían. Algunos manuales encuadernados con espirales también pueden tener páginas laminadas para evitar que se arruine el manual si se moja o se ensucia.
4
Diseña una plantilla de documento para tu manual de usuario. Muchos procesadores de texto y programas de autoedición ofrecen la posibilidad de crear plantillas de documentos para los manuales de usuario, así que a medida que escribas, el texto se mostrará automáticamente en la fuente que hayas elegido para la parte del manual en la que estés trabajando (de hecho, este artículo fue escrito inicialmente utilizando una plantilla de Microsoft Word). La mayoría de estos programas también incluyen un conjunto de plantillas predefinidas que puedes modificar según lo necesites, en vez de crear la plantilla desde el comienzo.
- Los procesadores de texto y los programas de autoedición también ofrecen la posibilidad de crear “estilos”, que son tipos y tamaños de fuente predefinidos para los títulos, los pies de páginas, los encabezados y el cuerpo del texto. Puedes elegir uno de los nombres de estilo predefinidos (por ejemplo, “Encabezado1”, “Normal”, “Cita”) o crea tu propio estilo con su propio nombre. Si tienes muchos estilos para la misma clase de texto, sigue las convenciones para los nombres de estilo tanto como sea posible (por ejemplo, Microsoft Word llama a los estilos de texto para los títulos como “Título1”, “Título2”, etc., para todos los títulos desde el principal hasta varios niveles de subtítulos). Intenta crear anticipadamente todos los estilos que puedas necesitar, así no tendrás que detenerte para crearlos mientras estés escribiendo realmente el manual.

Consejos

Utiliza códigos de campo o variables de texto cuando sea posible. Puedes asignarles valores, como el nombre del producto, del manual o el título del capítulo, y utilizarlos en el documento en lugar de escribir el texto real. Cuando hagas una vista previa o imprimas el manual, el texto aparecerá en lugar de la variable. Si el nombre del producto cambia, o si cambias el nombre del manual o de un capítulo, será más fácil modificar la información cambiando el valor de la variable de texto que buscando y reemplazando las palabras en el documento.