Como elaborar un manual o guía de usuario en pocos pasos.

¿Qué es un manual de usuario?

          Como su nombre lo indica, un Manual de Usuario o guía están escritos para ayudar a las personas a comprender una aplicación de software, un sistema de TIC, aparato, etc.  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 los “manuales de usuario” como guías explicativas para programas de computación, los manuales de usuario pueden acompañar a computadoras y a otros dispositivos electrónicos, como televisores, radios, sistemas telefónicos y reproductores MP3, así como también a electrodomésticos y sistemas de computación, electrónica e informáticos. 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.

          Al escribir un Manual del usuario, se debe usar un lenguaje simple con oraciones cortas. Este estilo de escritura ayuda al usuario a comprender la aplicación. Las guías de usuario a menudo se escriben para personas no técnicas. El nivel de contenido y la terminología difieren considerablemente de, por ejemplo, una Guía de administración del sistema, que es más detallada y compleja.

 

   

A continuación, algunas pautas a considerar al escribir un Manual del usuario, como por ejemplo:

• Identificando tu audiencia

• Secciones de escritura

• Definición de guía de estilo y estándares

• Formatos de entrega

Identificando tu audiencia:

          Al igual que con todos los tipos de escritura, el primer paso es definir su PÚBLICO OBJETIVO. Su público objetivo son las personas que usarán su documento.

• Identificar el público objetivo

• Identificar su nivel de conocimiento técnico

• Identificar cómo usarán la guía 

Definiciones de la audiencia:

          En el proceso de planificación, desarrolle una definición de audiencia que identifique:

• El usuario

• El sistema

• Las tareas

          El Manual, es para enseñarle al usuario cómo el contenido les ayuda a hacer algo.

Dependiendo de la guía en cuestión, es posible que deba dirigirse a varias audiencias. Por ejemplo:

• Programadores que solucionarán el problema del programa

• Directores de TI que desean conocer los recursos que el programa requiere

• Estudiantes y profesores

          Si escribe para más de una audiencia, desarrolle una definición de audiencia para cada una. Examine las definiciones y vea si puede abordar todos los tipos de audiencia con un solo documento. Cuando planifique, use la definición de audiencia para enfocar sus decisiones.

          Al escribir, la definición de audiencia esta servirá como una guía para el equipo de documentación y como un punto de referencia para evaluar los resultados.

Aquí hay algunas preguntas que ayudarán a definir las necesidades de su audiencia:

¿Dónde usarán el documento, por ejemplo, en la oficina, en casa, en su móvil?

¿Cuánta experiencia tienen de usar su aplicación?

¿Es esta guía una actualización de una existente?

¿Cómo usará la guía el usuario?

¿Qué nivel de detalle se requiere?

¿Le ayudarán los gráficos a comprender cómo usar su producto?

Escribir la guía del usuario:

          Cada Manual de usuario se compone de portada, secciones del cuerpo y una página posterior. La siguiente sección describe lo que cada uno de estos debe contener.

Portada y página de título:

          Incluya una página de portada, tabla de contenido y un prefacio, si es necesario.

Si la guía del usuario está protegida por derechos de autor, incluya un aviso de copyright.

Ejemplo;

Copyright © 2003 El nombre de su empresa.

Coloque el aviso de copyright en la portada (y también en la contra portada).

 

Advertencias:

          Incluya un descargo de responsabilidad estándar dentro de la portada que describe los Términos y Condiciones para usar este manual.

Prefacio:

          Use esta sección para hacer referencia a otros documentos relacionados con el tema principal de la guía.  Asegúrese de consultar el número de versión correcto para los documentos a los que se refiere. Si es necesario, incluya una sección sobre "Cómo utilizar este manual " como introducción.

Contenido:

          Debe incluir una tabla de contenidos, la única excepción es si su guía tiene menos de diez páginas, en cuyo caso probablemente debería referirse a ella como una guía de Inicio o Guía de referencia.

          Si el Manual de usuario tiene más de veinte páginas, incluya un índice al final del documento.

 

Cuerpo de la guía:

          Este es el corazón del manual. En el cuerpo principal, separe los procedimientos (también llamados instrucciones) de los materiales de referencia. Esto ayudará al usuario a navegar a través del manual mucho más rápido.

          Los procedimientos ayudan al usuario a realizar tareas específicas. También se conocen como instrucciones o tareas. Ejemplos de estos pueden incluir:

• Cuando, por qué y cómo puede realizar una tarea, por ejemplo, imprimir un documento, recortar una imagen, cargar un archivo. 

• Qué mostrará la pantalla después de realizar una tarea, por ejemplo, una vista actualizada de su saldo bancario.

• Ejemplos de tareas y operación.

 

Procedimientos de escritura:

          Los procedimientos de escritura implican las siguientes tareas:

• Identificar las principales tareas

• Separar cada tarea principal en subtareas

• Escribir una serie de pasos que guíen al usuario a través de cada subtarea

• Usar un enfoque "si-entonces" al explicar las decisiones que los usuarios pueden tomar.

 

Texto fragmentado:

          Dividir grandes cantidades de información en una pieza más pequeña de información se llama "fragmentación".

Al escribir manual de usuario, puede separar la información por opciones de menú y sus respectivas consecuencias, por ejemplo, mostrando al usuario los resultados de cada acción.

          Las subtareas que deben realizarse pueden dividirse en fragmentos. Cada fragmento puede formar un nuevo capítulo o sección dentro de la guía.

 

Use un formato consistente para cada sección, por ejemplo:

• Presente cada sección con una descripción general de la tarea que se realizará

• Describe las entradas y salidas. En otras palabras, qué debe ingresar el usuario en el sistema y qué hará el sistema como resultado. 

• Describe los procedimientos para llevar a cabo estas tareas.

 

Numerar los pasos:

          Cuando escriba procedimientos, numere cada paso y use la forma imperativa de los verbos, por ejemplo:

Presione ENTER

o

Haga clic en "Sí" y presione ENTRAR para enviar sus detalles.

 

Usando el Enfoque si-entonces:

          Cuando a los usuarios se les permite tomar decisiones, use un enfoque If-Then para mostrar el resultado diferente para cada decisión que toman.

          Por ejemplo;

Si eliges "Sí", el programa convertirá a Firefox en tu navegador web predeterminado. Si elige "No", configurará Opera como su navegador predeterminado.

Usa diagramas para ilustrar procedimientos más complicados.

 

Materiales de referencia:

          El usuario recurre al material de referencia cuando necesita información detallada sobre un tema específico, por ejemplo, configuraciones o parámetros que deben ingresar.

 

Los materiales de referencia pueden incluir:

• Opciones de programa, por ejemplo, diferentes menús y botones que se presentan al usuario

• Las opciones de teclado, por ejemplo, mantienen AltGr y 4 para mostrar el símbolo del Euro

• Mensajes de error que puedan surgir

• Consejos para solucionar problemas

• Preguntas frecuentes que el usuario puede tener

 

Glosario:

         Agregue un Glosario de términos y un índice al final del documento. El glosario debe abarcar todos los acrónimos y términos de la industria utilizados en el documento. Esto ayudará al usuario a comprender el material. No los aliene usando jerga y suponiendo que conocen el significado de estas palabras.

• Un breve glosario puede aparecer en el frente antes de la tabla de contenido

• Un glosario más grande debería aparecer en la parte de atrás.

Resalte los términos del glosario (por cursivas, por ejemplo) la primera vez que aparecen en el texto.

 

Índice:

         Cualquier manual de más de 20 páginas se beneficia de un índice. Un índice ayuda a los usuarios a encontrar artículos específicos muy rápido sin tener que buscar manualmente todo el documento. Los documentos grandes sin un índice son imposibles de usar de manera eficiente.

 

Estableciendo Estándares:

Además de escribir él manual, también debe considerar cómo se entregará el documento, por ejemplo, como un libro, en línea o en PDF.

Las áreas que necesitan consideración incluyen:

• Formato (el diseño y el diseño de las páginas)

• Estilo (elementos que afectan la legibilidad, como la fuente, el tamaño, el color)

• Otros requisitos que son específicos para cada formato de entrega. Por ejemplo, los archivos PDF pueden necesitar configuraciones de seguridad aplicadas para que el material no pueda ser copiado; los logotipos de los socios pueden necesitar ser agregados; los términos y condiciones pueden necesitar ser actualizados.

 

Formato y estructura del documento:

          Al elaborar un manual de usuario, verifique si usa una guía de estilo específica, asegúrese de esto durante la fase de planificación.

Use un mapa del documento para organizar la guía. Para hacer esto:

• Use encabezados para organizar información.

• Incluya los números de página y los títulos de las secciones en cada página, ya sea en pies de página o encabezados.

• Considera usar columnas duales. Esto le permite colocar títulos en la columna de la izquierda y el texto en la columna de la derecha.

Estilo:

          Use un estilo apropiado. Decida el nivel técnico de su idioma, cómo se dirige al usuario y las convenciones que se requieren.

 

Lenguaje técnico

          Haga coincidir el nivel del lenguaje técnico con el nivel de competencia del público. Siempre subestime el conocimiento de sus lectores en lugar de sobreestimarlo. Limite los términos técnicos a los que el usuario encontrará. Si debe definir una gran cantidad de términos, use un glosario para complementar las definiciones en el texto.

 

Dirigiéndose al usuario:

          Al escribir procedimientos, use la voz activa (por ejemplo, haga clic aquí) y diríjase a los usuarios directamente (escriba "usted" en lugar de "el usuario").

          Al explicar una acción, use la forma "comando" del verbo:

Por ejemplo;

"Elija una opción del menú y presione [ENTER]".

 

Presentando su material:

          Puede mejorar la legibilidad de sus documentos usando formatos específicos para distinguir diferentes tipos de información.

          Por ejemplo, puede distinguir la entrada del usuario de la respuesta del sistema por:

• Sangría de texto

• Usar columnas para texto de diseño

• Proporcionar ilustraciones o fotografías que resaltan áreas clave

• Uso de diferentes fuentes y características de tipo (negrita, cursiva y subrayado)

          Los dispositivos no verbales, como iconos o diagramas, ayudan a complementar las instrucciones verbales.

 

Requisitos especiales:

          Si el manual no es virtual y se va a usar al aire libre, en un automóvil o en movimiento, asegúrese de que el tamaño de la fuente sea lo suficientemente grande como para poder leer con facilidad. Use la espiral para que el libro no se rompa fácilmente, y papel de alta calidad para que el texto no manche ni deje manchas en las manos del lector.

 

Información recopilada de: 

http://klariti.com/technical-writing/User-Guides-Tutorial.shtml

Traducido por Milagro Pérez F. 

Recibe en tu e-mail todas las novedades. Te enviare solo información relevante
¡Yo también odio el Spam!