2.7: Guías de usuario

Objetivos de aprendizaje

Al finalizar este capítulo, los lectores podrán hacer lo siguiente:

1. Explicar el propósito de una guía de usuario.
2. Definir los conceptos técnicos de escritura de este libro de texto que se aplican a las guías de usuario.
3. Explicar y aplicar el estilo, formato, componentes y proceso para crear guías de usuario.

Guías de usuario

Una guía del usuario es esencialmente un documento de longitud de libro que contiene instrucciones sobre la instalación, el uso o la solución de problemas de un producto de hardware o software. Una guía de usuario puede ser muy breve, por ejemplo, solo 10 o 20 páginas o puede ser un libro completo de 200 páginas o más. Si bien esta definición asume computadoras, una guía del usuario puede proporcionar instrucciones de operación en prácticamente cualquier cosa: cortadoras de césped, hornos microondas, lavavajillas, etc.

Cuanto más complejo sea el producto, mayor será el recuento de páginas. Cuando esto sucede, algunos elementos de la guía del usuario se dividen en sus propios volúmenes separados, especialmente los procedimientos de instalación, los procedimientos de solución de problemas y los comandos. Una guía del usuario puede incluso contener un breve tutorial, por ejemplo, hacer que los usuarios comiencen a usar el producto, pero si hay demasiado tutorial, también va a un libro separado.

Usuario de Filepad

Guía de usuario de Gimp

Guía Guía del usuario de Parallels

Estilo y Formato para Guías de Usuario

Una guía de usuario es una combinación de muchas cosas presentadas en este libro de texto en línea. En su esencia es la escritura de instrucciones; necesitas ser bueno en el estilo de escritura, encabezados, listas, avisos, resaltado, tablas y gráficos que se usan comúnmente en las instrucciones. Como conjunto de instrucciones, una guía de usuario debe usar el estilo y formato que se presenta en otra parte de este libro de texto en línea:

• Rúbricas. Use encabezados para marcar el contenido clave de la información para que los lectores puedan encontrarla rápidamente.
• Listas. Utilice listas numeradas y con viñetas para ayudar a los lectores a escanear la información rápidamente.
• Avisos especiales. Use avisos especiales como advertencias, advertencias y notas para alertar a los lectores sobre posibles problemas o enfatizar puntos especiales.
• Diseño instruccional. En general, use el diseño estándar de instrucciones; principalmente, esto significa encabezados y secciones orientadas a tareas y listas verticales numeradas para los pasos reales que los lectores deben realizar.

Componentes de las guías de usuario

Como libro, una guía del usuario debe tener alguna combinación de los componentes estándar de diseño de libro, como los siguientes:

• Cubiertas delantera y trasera
• Página de título
• Aviso de edición
• Marcas
• Renuncias
• Warrenties
• Acuerdos de licencia
• Avisos de seguridad
• Prefacio
• Apéndices
• Glosario
• Índice
• Formulario de comentarios del lector

No hay una combinación o secuencia estándar de estos elementos; cada empresa lo hace de manera diferente. Los detalles sobre el contenido, formato y diseño de estos elementos se pueden encontrar en el capítulo de diseño del libro.

Información incluida en las guías del usuario

Aquí hay una revisión de los contenidos comunes de las guías de usuario:

Instrucciones. Las más obvias son esas instrucciones paso a paso sobre cómo ensamblar, operar o solucionar problemas del producto. Las instrucciones en la guía del usuario generalmente deben estar orientadas a tareas, es decir, escritas para tareas específicas que los usuarios deben realizar. Las instrucciones generalmente deben usar listas numeradas verticales para acciones que deben realizarse en una secuencia requerida. Las instrucciones similares o estrechamente relacionadas en las guías de usuario deben agruparse en capítulos.

Información cautelar. Verás notas, advertencias, precaución e incluso avisos de peligro en las guías del usuario. Estos representan preocupaciones de responsabilidad para el fabricante del producto.

Información de referencia. Las guías de usuario suelen contener mucha información de referencia, pero solo hasta cierto punto. Por ejemplo, si hay numerosos comandos, es necesario un libro separado para los comandos. La información de referencia en las guías de usuario a menudo se presenta en tablas: listas columnales de configuraciones, descripciones, variables, parámetros, banderas, etc.

Información de inicio. Algunas guías de usuario en realidad incluirán breves tutoriales que ayudarán a los nuevos usuarios a familiarizarse con el uso del producto.

Acerca del producto. Las guías de usuario también proporcionan alguna descripción del producto, una revisión de sus características esenciales o sus nuevas características. En ocasiones esta información también se pone en un volumen separado, si es extenso. Por lo general, el volumen se llamará algo así como “Presentando Nuevo Producto...”

Antecedentes técnicos. En ocasiones, las guías de los usuarios incluirán explicaciones técnicas de cómo funciona el producto, qué principios físicos o químicos son esenciales para su funcionamiento, etc. Por ejemplo, verá un fondo considerable en las guías de usuario para programas gráficos o de audio; no puede operarlos sin comprender los conceptos de brillo, saturación y matiz; ley μ, ley A y otros similares.

Ejemplos descriptivos de guías de usuario

Considera estos ejemplos. Nota: No todos los siguientes estilos y formatos no son necesariamente recomendables. Pregúntale a tu instructor si tienes dudas.

Delarina WinFax LITE Guía del usuario

Este libro mide 5.5 × 8.5 pulgadas y menos de 150 páginas. Utiliza paginación por capítulo, con nuevos capítulos y secciones que comienzan en una página derecha.

Cubierta. En la portada, se ve el título completo del libro, un número de versión, el nombre de la empresa con su logotipo y la advertencia de que el libro no está para la venta al por menor. La contraportada contiene material publicitario, bastante atípico para las guías de usuario, sobre las mejores características del producto, ofertas especiales en la versión completa, un número 1-800 para llamar y el número del libro.

Página de título. La primera página dentro de esta guía de usuario es la página de título, que incluye el nombre del producto, el título del libro, el número de edición del libro, la fecha de la edición, el logotipo de la empresa (que incluye su nombre), varias direcciones de la empresa y la advertencia de no venta al por menor. El nombre de la empresa tiene un símbolo de marca registrada al lado; el nombre del producto tiene las letras de marca al lado. No se muestran símbolos de marca en la portada ni en la contraportada. Un enfoque más verde es omitir la portada, ya que es prácticamente un duplicado de la portada, y poner el aviso de edición en la parte posterior de la portada.

Aviso de edición: En la parte posterior de la portada está el aviso de edición. Este aviso de edición incluye el título del libro, un aviso de derechos de autor, declaraciones legales sobre la copia del libro, lista de nombres de productos de marca registrada que aparecen en el libro y el número del documento.

Acuerdo de licencia: En la siguiente página está el acuerdo de software, una cosa de dos páginas que describe los usos permitidos del software y las garantías relacionadas.

Tabla de contenido: El TOC comienza en una página derecha numerada con “i” y enumera hasta el nivel de encabezamientos dentro de los capítulos.

Encabezados y pies de página: El título del libro se utiliza tanto para el pie de página izquierdo como para el derecho: en la página izquierda, el título está alineado a la derecha; en la página derecha, el título está alineado a la izquierda. El número de página aparece opuesto a ambos pies de página, y una línea rayada sólida se coloca justo encima de ambos pies de página. El título del capítulo se usa para el encabezado interior de cada página; el encabezado actual se usa para el encabezado exterior de cada página. Una línea rayada sólida se coloca justo debajo de estos encabezados.

Prefacio: La visión general que se trata como capítulo 1. Contiene alguna promoción del producto, un diagrama de los múltiples usos del producto, requisitos de hardware y software sobre su uso, una descripción general del contenido del manual e instrucciones sobre cómo obtener ayuda.

Capítulos del cuerpo: Los capítulos utilizan las siguientes características de diseño:

• Título del capítulo: Letras Ariales grandes en negrita con el título del capítulo en el margen izquierdo y el número de capítulo a la derecha y una línea de doble regla debajo
• Encabezados: Los encabezados de primer nivel son aproximadamente 1 punto más pequeños que los títulos de los capítulos, alineados a la izquierda, con una línea rayada sólida justo debajo. Los encabezados de segundo nivel son aproximadamente 2 puntos más pequeños, alineados a la izquierda, sin línea reglada. Los encabezados de tercer nivel tienen el mismo tamaño que el texto principal, pero usan Arial en negrita y cursiva y se colocan en el margen izquierdo.
• Texto: El texto del cuerpo es una fuente serif de aproximadamente 10 puntos de tamaño. Este manual no utiliza el formato de cabeza colgada; el texto recortado se extiende hasta el mismo margen izquierdo que los encabezados.
• Gráficos: Se utilizan numerosas capturas de pantalla a través del libro; todas están centradas.
• Listas: Las listas numeradas se utilizan para los elementos en secuencia, como los pasos. Los cuadrados abiertos se utilizan para los artículos con viñetas que tienen un subtítulo. De lo contrario, los discos rellenos estándar se utilizan como balas.
• Destacando: El texto que los usuarios deben escribir utiliza un tipo sans serif (probablemente Arial) al igual que los botones de pantalla, las opciones, los nombres de campo y los mensajes del sistema. Negrito se utiliza para énfasis simple.
• Avisos: Solo se utilizan notas y sugerencias. La palabra “Nota” o “Sugerencia” usa negrita y cursiva. El texto del aviso es fuente de cuerpo regular con sangría de una pulgada.
• Apéndices: El libro termina con dos apéndices: El Apéndice A aborda problemas comunes con un formato de situación— solución; el Apéndice B aborda las fuentes. Estas páginas están numeradas A-1, A-2,... B—1, B—2, y así sucesivamente.
• Índice: El libro termina con un índice de 10 páginas con páginas numeradas con números romanos en minúscula comenzando en i. El índice usa el estándar pero hace algo inusual con las entradas. Utiliza un formato de tabla de contenidos para las entradas y sus referencias de página, conectándolas con el tipo de puntos de líder que verías en los TOC.

Guía de referencia de IBM Aptiva

Este libro también mide 8.5 × 5.5 pulgadas. Utiliza numeración de páginas consecutivas a lo largo del libro y tiene aproximadamente 120 páginas de largo.

Cubiertas. La portada tiene un diseño gráfico con números estilizados 1, 2 y 3 junto con un patrón de cuadrícula grande y varios tipos de sombreado. Los tres elementos del título del libro se colocan en la parte superior, tercera superior e inferior del área, respectivamente. También se ven las palabras “información”, “obtener ayuda” y “solución de problemas” que parece flotar entre los elementos del segundo y tercer título, dando a los lectores una idea más detallada del contenido del libro. La contraportada continúa con el patrón de cuadrícula e incluye el logotipo de IBM con el número de pieza del libro, su fecha de impresión, una declaración de que el libro se imprimió en “Estados Unidos” y un código de barras para el número del libro.

Página de título. Esta página contiene las palabras “Guía de referencia de Aptiva” en letra serif grande en la parte superior derecha de la página, ¡y eso es todo!

Aviso de edición. El aviso de edición aparece en la parte posterior de la página de título. Se empuja a la parte inferior de la página y utiliza un tamaño de tipo más pequeño, probablemente de 7 puntos, para su cuerpo de texto. El rubro para el aviso de edición es el número de edición seguido del mes y año de la edición. En los párrafos del aviso de edición se establece que el libro se proporciona “tal cual” sin ninguna garantía, que el libro es para múltiples modelos del producto y que partes del mismo pueden no referirse al modelo particular del lector. También se incluye una dirección donde se pueden enviar comentarios, un número 1-800 para solicitar copias adicionales y la línea estándar de derechos de autor.

Tabla de contenido. El TOC es un diseño inusual en el que todas las entradas se dejan alineadas en el centro de la página, con los números de página a la izquierda aproximadamente una pulgada. Las entradas de primer nivel usan negrita. El TOC comienza en la página iii.

Sección Avisos. La primera sección del cuerpo de este manual es para avisos, específicamente, marcas, destacando convenciones utilizadas en el libro, avisos de seguridad y avisos regulatorios (comunicaciones). La sección comienza con su propia página de título en la que se muestra la palabra “Avisos” en una fuente serif grande en la esquina superior derecha y con un diseño de cuadrícula y sombreado similar al de la portada. El texto de la sección de avisos comienza en una página derecha al igual que la página de título del capítulo.

Texto del cuerpo. Estas son las características clave de diseño del texto del cuerpo:

• Texto: El texto para este libro tiene sangría de casi 2 pulgadas. El texto del cuerpo es una fuente sans serif bastante pequeña, probablemente Helvética, probablemente 9 o 10 puntos. Se utiliza el formato de cabeza colgadora.
• Encabezados: Los encabezados de primer nivel se alinean con el margen izquierdo y usan una fuente blocky bold sans serif con una línea rayada sólida arriba. Los títulos de los capítulos utilizan una fuente grande con serif gris en la esquina superior derecha de la primera página del capítulo. Los encabezados de segundo nivel se alinean con el texto principal y usan mayúsculas de estilo oración (al igual que los encabezados de primer nivel) y usan la misma fuente que los encabezados de primer nivel pero aproximadamente 2 puntos más pequeños.
• Destacando: En instrucciones paso a paso, los siguientes elementos están en negrita: botones, pestañas, opciones de menú, nombres de menú, nombres de teclas de teclado, nombres de iconos, ajustes de parámetros. Los nombres de los discos suministrados con el producto están en cursiva. Los mensajes del sistema están entre comillas romanas y comillas dobles.
• Pasos: Las secuencias de instrucciones se introducen con un encabezado redactado en gerund-fraseado en negrita. Los subpasos o subtareas alternativas utilizan frases infinitivas con la misma fuente pero más pequeñas y están puntuadas con dos puntos. Los pasos reales usan un número en la misma fuente más pequeña sin un punto.

Encabezados y pies de página. Solo se utilizan pies de página. Los números de página en negrita (usando la misma fuente que el encabezado de primer nivel pero mucho más pequeños) están en el exterior; el encabezado actual, no el título del capítulo, está centrado y en una fuente serif cursiva usando mayúsculas de estilo oración.

Avisos especiales. Este libro utiliza una caja gris claro con una marca de verificación blanca en ella para llamar la atención sobre avisos especiales. El texto de los avisos especiales es el mismo que los pies de página: letra pequeña con serif cursiva. Por lo general, la casilla de verificación se encuentra en el margen izquierdo y el texto del aviso se alinea con el texto del cuerpo normal. En la medida de lo posible, la casilla de verificación y el texto del aviso se encuentran en el área abierta entre el margen izquierdo y el texto del cuerpo.

Sección de resolución de problemas. El cuerpo de esta sección comienza con un diagrama de flujo que debe estar destinado a orientar al usuario al proceso general de solución de problemas y a los diferentes recursos de solución de problemas disponibles. El siguiente apartado consta de preguntas comunes con acciones a tomar dependiendo de respuestas de sí o no. El texto de las acciones está numerado o con viñetas dependiendo del contenido y contiene referencias cruzadas a otras áreas de la información de solución de problemas. La siguiente sección está diseñada en dos columnas, la columna izquierda con el encabezado “Si el problema es...” y la columna derecha con el encabezado “Esto es lo que hay que hacer...” La sentencia problema en la columna izquierda está en negrita. la siguiente sección es similar excepto que enumera los códigos de error que se muestran en la computadora y las acciones a realizar.

Índice. El libro tiene un índice de 6 páginas formateado en 3 columnas. Se utilizan dos niveles de entradas de índice. Las referencias de las páginas se establecen aproximadamente a media pulgada de distancia de las entradas de texto.

Proceso y Documentos Internos para Guías de Usuario

Lorem ipsum

Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat. Ut wisi enim ad minim veniam, quis nostrud exerci tation ullam corper suscipit lobortis nisl ut aliquip ex ea commodo consecuat. Duis autem vel eum iriure dolor en hendrerit en vulputate velit esse molestie consecuat, vel illum dolore eu feugiat nulla facilisis en vero eros et accumsan.

Una parte importante de las guías de usuario, de hecho, de casi cualquier documento técnico, es el proceso que lo produce:

1. Planeación inicial. La planificación temprana de una guía del usuario implica la evaluación de las necesidades (¿se necesita alguna documentación?) , análisis de audiencia (¿quién va a utilizar la guía del usuario? ¿Cuáles son sus necesidades?) , análisis de tareas (¿para qué usarán los usuarios el producto? ¿Cuáles son sus tareas comunes?) , plan de biblioteca (¿qué libros y medios, además de una guía de usuario, se necesitan para dar soporte al producto?) , y así sucesivamente.
2. Propuesta de documentación. Si estás trabajando como freelance o como parte de una firma de documentación independiente, es posible que tengas que escribir una propuesta de documentación en un esfuerzo por ganar un contrato para hacer un determinado proyecto de documentación técnica.
3. Plan de documentación. Los guías de usuario necesitan planes de documentación, que son documentos de respaldo internos que especifican contenido, audiencia, diseño, formato, miembros del equipo de producción, horario y otra información similar sobre un proyecto de documentación y sus “entregables”. El plan de documentación se asemeja a la propuesta de documentación de ciertas maneras, pero el plan representa un plan establecido acordado por todos los involucrados en el proceso de producción (y eso significa tanto la guía del usuario como el producto que documenta).
4. Prototipo y especificaciones. Las herramientas importantes de planeación, que también sirven como herramientas de referencia útiles durante un proyecto de documentación, incluyen el prototipo de la guía del usuario y las especificaciones de la guía del usuario. El prototipo es una versión ficticio del libro con todos los componentes planeados del libro (ver la lista de componentes de diseño de libro) y todos los elementos planificados (ver la lista bajo formato y estilo). Sin embargo, el prototipo utiliza texto “greeked” (también conocido como Lorem ipsum) como el ejemplo mostrado.

Por lo general, el prototipo de la guía del usuario es muy breve: necesita incluir solo tantas páginas como sea necesario para ilustrar cada componente textual y elemento textual único que se utilizará en la guía del usuario. Las especificaciones son descripciones de un diseño de libro en forma de tabla. Las especificaciones describen cada componente o elemento único de un libro, de modo que puede ser recreado por alguien que podría no tener acceso a los archivos electrónicos, plantillas o estilos de ese libro.

• Catálogo de plantillas y estilos. Una guía de usuario bien diseñada y un proceso bien diseñado para producir esa guía de usuario deben incluir plantillas y catálogos de estilo. Una plantilla es un archivo electrónico que define aspectos de la guía del usuario como el tamaño de página, encabezados y pies de página, estilo de numeración de páginas, diseño de página regular y especial, y otros detalles similares. Un catálogo de estilos también es una cosa electrónica que define el formato y estilo de elementos textuales como encabezados, encabezados, pies de página, listas, párrafos, tablas, etc. Por ejemplo, un estilo para un “encabezado 1" podría especificar Arial negrita de 24 puntos con 24 picas arriba y 12 picas abajo. Los estilos te ayudan a crear una guía de usuario de manera más eficiente; los estilos también te ayudan a mantener la consistencia en el formato y estilo de esa guía del usuario.
• Múltiples borradores de revisión y cierre de sesión. Un buen proceso para la producción de una guía de usuario también incluye varios borradores que editores, expertos técnicos, probadores de usabilidad y miembros del equipo de documentación pueden revisar y proporcionar comentarios sobre ellos. Usted como escritor luego implementa esos comentarios y produce un nuevo borrador para que estas mismas personas lo revisen nuevamente. Cuando todos están satisfechos con el borrador de la guía del usuario (o desgastado o fuera de tiempo), firman la guía del usuario y luego puede entrar en “producción”, lo que significa producir las copias encuadernadas terminadas o el PDF que se pone a disposición de los usuarios.

Como puedes ver, una guía de usuario reúne muchos de los temas tratados en este libro de texto en línea. Si estás tomando un curso de redacción técnica, probablemente no puedas implementar todas estas características y fases de una guía de usuario. Ponte con tu instructor para ver cuáles son necesarios.