Una guía de usuario es un manual en papel o formato electrónico (PDF o XPS) que proporciona instrucciones sobre un procedimiento o uso de algo. Aunque los “manuales de usuario” se asocian a menudo con guías de aplicaciones informáticas, las guías de usuario también se proporcionan con computadoras y otros dispositivos electrónicos como televisores, equipos de sonido, sistemas telefónicos, reproductores de MP3 y equipos domésticos y de jardín. Una buena guía del usuario educa a los usuarios sobre las características del producto mientras les enseña cómo usar esas características de manera efectiva. La guía del usuario está estructurada de tal manera que es fácil de leer y consultar. Estos son algunos pasos que debe considerar al desarrollar contenido efectivo y diseñar diseños de guías de usuario.
Paso
Parte 1 de 3: Creación de una guía de usuario adecuada
Paso 1. Decida quién utilizará la guía
Para escribir una buena guía de usuario, debe desarrollar un perfil de usuario, ya sea formalmente creando un perfil escrito o de manera informal tomándose el tiempo para hacer suposiciones razonables sobre las características del usuario. Dichos perfiles son útiles cuando forma parte de un equipo de redacción de guías de usuario y cuando trabaja en el producto previsto desde el concepto hasta la forma final. Tenga en cuenta los siguientes factores al crear un perfil de usuario:
- La ubicación del usuario utilizará la guía, por ejemplo, en casa, en la oficina, en un lugar de trabajo remoto o en el automóvil. Este factor determina no solo el contenido, sino también el estilo de redacción que adoptará la guía.
- Cómo utilizará el usuario la guía. Si rara vez lo usan o solo lo necesitan para encontrar información, es mejor si la guía está hecha en forma de documento de referencia. Por otro lado, si el usuario lo usará regularmente al principio, la sección de referencia debe ir acompañada de una sección de “Cómo comenzar” e instrucciones sobre las funciones más comunes que realizará el producto.
- Cuánta experiencia tiene el usuario con el producto o artículo similar. Si el producto es nuevo o muy diferente a productos similares, debe incluir una explicación de en qué se diferencia de otros e instrucciones sobre cómo usarlo. Si el producto se ocupa de algo que a los usuarios a menudo les resulta difícil, como una aplicación informática, debe proporcionar la información y los detalles adecuados de forma comprensible.
Paso 2. Cree una guía que se adapte a las necesidades del usuario de una manera que pueda comprender
Si los usuarios no son personas con conocimientos técnicos, probablemente sea mejor evitar el lenguaje altamente técnico y proporcionar explicaciones claras y simples. El texto también debe estar organizado de manera que se parezca a la forma en que piensa el usuario. Enumerar las características del producto agrupadas por función a menudo tiene más sentido que por las características más utilizadas.
A veces, el uso de términos técnicos es inevitable, por ejemplo, para aplicaciones de gráficos que incluyen gráficos de Fibonacci junto con gráficos circulares y los gráficos de barras más comunes. En un caso como este, sería mejor si define los términos y proporciona información, por ejemplo, una explicación de qué es el gráfico de Fibonacci y cómo se utiliza en el análisis financiero
Paso 3. Describa el problema que el usuario está tratando de resolver, luego proporcione una solución a ese problema
Ofrecer funciones como soluciones a problemas comunes está bien cuando se anuncia un producto, pero una vez que el cliente es propietario del producto, debe comprender cómo usarlo. Identifique el problema que encontrará el usuario, descríbalo en la guía del usuario, seguido de instrucciones para resolverlo.
Si el problema es complejo, divídalo en pedazos más pequeños. Escriba cada sección con instrucciones sobre cómo resolverlo o lidiar con él, luego siga uno a otro en orden. El desglose de información de esta manera se conoce como método de agrupamiento o división
Parte 2 de 3: Componentes de la guía del usuario
Paso 1. Cree una portada y una página de título adecuadas
Necesitará una portada para cualquier guía del usuario que sea más que una tarjeta de referencia y una página de título para una guía que incluya más de una hoja de papel doblada (4 páginas o más).
- Si la guía está protegida por derechos de autor, el aviso de derechos de autor debe incluirse en la portada y la contraportada, así como en la página del título.
- Si existen términos y condiciones para usar la guía y los productos asociados a ella, inclúyalos en el interior de la portada.
Paso 2. Ponga una referencia al documento relacionado en la introducción
Si hay más de una guía de usuario, haga referencia a otro documento, incluido el número de versión correcto, aquí. El prólogo también es un lugar para colocar la sección "Cómo usar esta guía", si existe.
Paso 3. Incluya una tabla de contenido si la guía tiene más de 10 páginas
Paso 4. Coloque las instrucciones / procedimientos y materiales de referencia en el cuerpo de la guía
En la mayoría de los casos, tanto el procedimiento como el material de referencia deben tener su propia sección. Sin embargo, puede decirles a los usuarios que se refieran a contenido específico en una sección y que lo diferencien de otras secciones. De esta forma, el usuario puede encontrar rápidamente la información que busca.
- Los procedimientos deben estar escritos en una estructura consistente a lo largo de las instrucciones del manual. Comience con una descripción general de la funcionalidad del producto, luego explique qué debe hacer el usuario y qué resultados obtendrá o verá. Los pasos deben estar numerados y comenzar con un verbo de acción, tal como están escritos en cada sección de este artículo.
- El material de referencia puede incluir listas de verificación, consejos para la resolución de problemas y preguntas frecuentes. Se puede agregar un glosario y un índice al final de la guía, aunque al principio se puede proporcionar un glosario de términos de uso frecuente. El índice se puede omitir si la guía tiene menos de 20 páginas.
Paso 5. Utilice imágenes gráficas según sea necesario para respaldar el texto
Las imágenes gráficas o capturas de pantalla pueden ilustrar mejor ciertos puntos en una guía que el texto, especialmente en procedimientos complejos donde los usuarios necesitan confirmación visual para asegurarse de que están siguiendo los pasos correctamente. Los dibujos gráficos se pueden crear utilizando aplicaciones de edición de gráficos o dibujo asistido por computadora (CAD), cámaras digitales y aplicaciones de procesamiento de fotografías, o si desea usar capturas de pantalla, use las funciones de captura de pantalla integradas en su computadora o un programa de gráficos con capacidades de captura de pantalla.
- Una vez que haya creado una imagen gráfica, guárdela en formato comprimido para que pueda usarla en una aplicación de procesamiento de texto o de autoedición. También debe reducir el tamaño de la imagen para que se ajuste mejor a la página, pero aún así proporcionar detalles completos para el usuario. (Si es necesario, puede recortar la imagen original en secciones y mostrar las secciones relevantes junto con el texto de apoyo).
- Si utiliza varias imágenes gráficas en el procedimiento, asegúrese de que las imágenes se creen en un tamaño constante, ya sea en las mismas dimensiones de largo y ancho o en proporción al tamaño de la imagen original. De esa forma, la imagen se verá más atractiva para los usuarios. Lo mismo ocurre cuando se toman capturas de pantalla desde una computadora; asegúrese de que la computadora muestre el esquema de color estándar al tomar fotografías; de lo contrario, el asistente mostrará una captura de pantalla en color.
- Si bien las aplicaciones de edición de imágenes como Photoshop y Paint Shop Pro tienen buenas capacidades de captura de imágenes, los programas dedicados a tomar capturas de pantalla como Snagit también ofrecen la capacidad de modificar, catalogar y anotar capturas de pantalla fácilmente.
Parte 3 de 3: Diseño de una guía de usuario fácil de usar
Paso 1. Elija algunas fuentes fáciles de leer
Aunque una computadora puede admitir varias fuentes, el propósito de crear una guía de usuario es fácil de leer. Seleccionar varias fuentes coincidentes es la mejor manera de lograr ese objetivo. Las fuentes se pueden agrupar en dos tipos: serif y sans serif.
- Las fuentes serif tienen pequeñas líneas decorativas en los extremos de las líneas principales que componen las letras. Las fuentes serif incluyen Times New Roman, Baskerville y Book Antiqua. Las fuentes serif son perfectas para la mayoría de los textos que se muestran en tamaños de 10 a 12 en el cuerpo principal para las guías de impresión.
- Las fuentes sans serif solo presentan las líneas que componen las letras, sin adornos. Las fuentes que pertenecen al grupo sans serif incluyen Arial, Calibri y Century Gothic. Las fuentes sans serif se pueden usar para la mayoría de los tamaños de texto de 8 a 10 en archivos PDF o guías en línea, aunque al no tener adornos, las oraciones que se muestran en fuentes de 12 o más grandes son más difíciles de leer. Sin embargo, las fuentes se pueden utilizar eficazmente en tamaños más grandes para mostrar títulos y títulos, y en tamaños más pequeños son perfectas para notas al pie y números en columnas y tablas.
- En general, es mejor elegir una fuente simple como Arial o Times New Roman para su guía, aunque puede usar una fuente decorativa para citas o títulos si está escribiendo una guía para un videojuego ambientado en un entorno de fantasía o ciencia ficción.. (En el caso de las citas, a menudo puede usar una fuente simple y mostrar la cita completa en cursiva).
- Después de decidir qué fuentes usar, cree páginas de muestra para verificar que se vean bien en papel. También debe mostrar esta página de muestra a la persona responsable de aprobar la visualización de la guía antes de continuar con el proceso de redacción.
Paso 2. Piense en el diseño
Una vez que haya seleccionado una fuente para la guía, deberá decidir cómo estructurar el contenido en la parte superior de la página.
- En general, probablemente debería colocar el título del documento o el título del capítulo en el encabezado o pie de página, quizás usando los títulos de la guía a la izquierda de la página y los títulos de los capítulos a la derecha de la página. Debe colocar el número de página en el encabezado o pie de página, ya sea afuera (encabezado o pie de página) o centrado (solo en pie de página). También es posible que deba distinguir la primera página de cada sección o capítulo de otras páginas colocando el número de página en el medio del pie de página y la página siguiente en la esquina exterior del encabezado.
- Es posible que deba insertar el texto dentro de un cuadro de color o un cuadro de bloque para diferenciarlo del resto del texto. Asegúrese de elegir un color o nivel de bloqueo para que el texto no sea difícil de leer.
- Deje un margen bastante amplio en todos los lados, con espacio adicional en los bordes para encuadernar.
Paso 3. Considere el tipo de volumen de la guía del usuario
Si la guía tiene más de 4 páginas, las páginas deben estar encuadernadas de cierta manera. Aunque los documentos internos se pueden grapar con una grapadora en la esquina de la página, la guía del usuario externa que se envía con el producto generalmente se grapa mediante uno de los siguientes 3 métodos:
- El método de grapado lateral (sujeto a los lados de la página con una grapadora) para guías impresas en papel doblado de 21 x 27,5 cm, 21 x 35 cm o 27,5 x 42,5 cm. La mayoría de las guías económicas de 48 páginas o menos están encuadernadas de esta manera.
- El método de encuadernado (cosido al costado de la página) se usa con más frecuencia para las guías de referencia de terceros que las guías incluidas con productos que no son automóviles, aunque algunas guías más largas están encuadernadas de esta manera. (La Paint Shop Pro Guide originalmente incluía una guía de encuadernado mientras aún era producida por JASC Software).
- La encuadernación en espiral es más adecuada para las guías que se utilizan en entornos más duros, como al aire libre (en cuyo caso los métodos de grapado lateral y encuadernado no son lo suficientemente fuertes como para hacer que las páginas se deslicen). Algunas guías encuadernadas en espiral también pueden tener páginas laminadas con plástico para evitar que se dañen cuando se mojan o se exponen al barro.
Paso 4. Cree un documento de plantilla como guía
Muchas aplicaciones de procesamiento de texto y autoedición ofrecen la opción de crear documentos de plantilla para guías de usuario. Entonces, a medida que escribe, el texto aparecerá automáticamente con la fuente que seleccionó para la parte del asistente en la que está trabajando. (En realidad, este artículo se escribió originalmente con una plantilla de Microsoft Word). La mayoría de estos programas también incluyen un conjunto estándar de plantillas que puede modificar según sea necesario para no tener que crear las suyas propias desde cero.
