Ayuda

Nota

Esta guía de diseño se creó para Windows 7 y no se ha actualizado para las versiones más recientes de Windows. Gran parte de las instrucciones todavía se aplican en principio, pero la presentación y los ejemplos no reflejan nuestra guía de diseño actual.

Use la Ayuda como mecanismo secundario para ayudar a los usuarios a completar y comprender mejor las tareas que el mecanismo principal es la propia interfaz de usuario. Aplique estas directrices para que el contenido sea realmente útil y fácil de encontrar.

Un sistema de Ayuda se compone de varios tipos de contenido diseñados para ayudar a los usuarios cuando no pueden completar una tarea, quieren comprender un concepto con más detalle o necesitan más detalles técnicos de los que están disponibles en la interfaz de usuario.

En este artículo, nos referimos a la Ayuda como secundaria a la interfaz de usuario. La interfaz de usuario es principal porque es donde los usuarios intentan resolver primero sus problemas. Consultan el sistema de ayuda solo si no pueden realizar su tarea con la interfaz de usuario.

La página principal ayuda y soporte técnico de Windows, disponible en el menú Inicio.

Nota: Las directrices relacionadas con el estilo y el tono se presentan en un artículo independiente.

¿Es esta la interfaz de usuario adecuada?

Para decidirte, intenta responder a estas preguntas:

• ¿Cómo están motivados los usuarios de destino? Cuantos más motivados son descubrir la funcionalidad de su programa y convertirse en usuarios intermedios o incluso avanzados de él, más dispuestos a investigar respuestas a sus preguntas consultando temas de Ayuda.
• ¿Usa ayuda para corregir una interfaz de usuario incorrecta? Cuanto mejor sea la interfaz de usuario, menos usuarios buscarán ayuda adicional. Si el programa tiene una interfaz de usuario principal muy clara y útil (como mensajes de error sin jerga, asistentes bien escritos y cuadros de diálogo no ambiguos), es posible que no necesite un sistema de ayuda secundario en absoluto.
• ¿El programa es relativamente sencillo? Si es así, considere la posibilidad de incorporar todo el contenido de ayuda necesario en las superficies de la interfaz de usuario principal. Es más probable que los usuarios busquen ayuda adicional en programas que realizan tareas complejas.
• ¿Su aplicación está pensada para desarrolladores, profesionales de TI u otros expertos en software? Estos usuarios tienden a esperar ayuda de referencia para convenciones del lenguaje de programación y ayuda conceptual detallada para el dominio de las características.

Conceptos de diseño

Si decide incluir ayuda en el programa, intégrela en su diseño general. La interfaz de Ayuda debe ser sencilla, eficaz y relevante; debe permitir a los usuarios obtener ayuda fácilmente y, a continuación, volver a su tarea. Piense en el sistema de ayuda en términos de tiempo de los usuarios: minimice primero la interrupción anticipando dónde se encontrarán con problemas en el programa, luego solucionando esos problemas incorporando asistencia fundamental directamente en la interfaz de usuario y creando puntos de entrada claros y coherentes en su Ayuda más detallada.

La asistencia de Windows se diseñó según estos principios. Estos son algunos de los cambios de diseño en la experiencia del usuario de la Ayuda de Windows:

• Puntos de entrada más reconocibles para ayuda de la interfaz de usuario principal (especialmente nuevos vínculos de Ayuda desde superficies de interfaz de usuario, como cuadros de diálogo, mensajes de error y asistentes). Los vínculos de ayuda le llevan directamente al tema pertinente de la Ayuda.
• Un icono del botón Ayuda está disponible en la esquina superior derecha de la mayoría de las páginas centrales de Panel de control, así como en las carpetas de shell.
• Los usuarios pueden elegir obtener el contenido de Ayuda más actualizado de la Ayuda en línea de Windows y soporte técnico cuando estén en línea.
• Los temas de ayuda ahora se basan en tareas en lugar de centrarse en características, para que los usuarios puedan realizar sus tareas de forma rápida y eficaz.
• Los temas de ayuda ahora se basan en gran medida en escenarios conocidos de usuarios principales.
• Los temas de ayuda tienen un tono más relajado e informal, con lenguaje real.
• Los temas de ayuda están diseñados para un examen eficaz, ya que los usuarios rara vez leen la palabra de contenido.

Una analogía para ayuda

Para pensar en mayor profundidad sobre el diseño de su sistema de Ayuda, considere una analogía de la vida cotidiana. Te pierdes en una ciudad desconocida. ¿Qué puede hacer? Muchos reaccionarían así:

• Obtener orientación; busque puntos de referencia, signos de calle (nombres y punteros a lugares).
• Busque mapas.
• Por último, como último recurso, pida indicaciones o llame a un amigo.

El diseño de la "interfaz" de la ciudad afecta a su necesidad de ayuda. Calles bien etiquetadas, indicaciones explícitas (punteros a hospitales, aeropuertos, museos y la oficina de correos) y lugares de interés claros como características geográficas destacadas o edificios le ayudan a encontrar su camino.

Pide ayuda como último recurso. Es una indicación de que la "interfaz" de la ciudad ha fallado por ser mal diseñado y confuso. Es más probable que pida ayuda en un lugar que tenga una etiqueta específica que sugiere utilidad. Por ejemplo, es más probable que pidas ayuda en un lugar con la etiqueta "Directions" o "Information" que un lugar general como el Ayuntamiento aunque casi cualquier persona del Ayuntamiento pueda darte indicaciones.

Cuando solicita ayuda, es probable que se sienta frustrado y solo quiera llegar a su destino previsto. Probablemente no estés de humor para pasar tiempo haciendo un recorrido por la ciudad o aprendiendo sobre su historia. Además, la motivación depende de la importancia de la tarea. Si está intentando encontrar su habitación de hotel, hará lo que sea necesario. Sin embargo, si su objetivo es encontrar un lugar de importancia menor, lo más probable es que simplemente se descuénte después de un esfuerzo modesto.

Todos estos aspectos de encontrar tu forma en espacio real corresponden a cómo los usuarios suelen encontrar su camino en el espacio virtual de tu programa. Buscar ayuda más allá de la interfaz de usuario principal es por su propia naturaleza desorientación; haga lo mejor para mitigar esta experiencia mediante una interfaz de usuario bien diseñada y señales inteligentes de "calle" para dirigir a los usuarios a las respuestas que necesitan.

Diseño de la interfaz de usuario para que la Ayuda no sea necesaria

Intente hacer que la Ayuda sea innecesaria en primer lugar, por:

• Hacer que las tareas comunes sean fáciles de detectar y realizar.
• Proporcionar instrucciones principales claras.
• Proporcionar etiquetas de control claras y concisas orientadas a objetivos y tareas.
• Proporcionar instrucciones y explicaciones complementarias cuando sea necesario.
• Anticipando problemas evitables mediante el uso de controles restringidos a opciones válidas, proporcionando valores predeterminados adecuados, controlando todos los formatos de entrada y evitando errores.
• Escribir mensajes de error que proporcionan una solución o acción claras para que el usuario realice.
• Evitar diseños confusos de la interfaz de usuario, como tareas con un flujo deficiente o el uso de controles deshabilitados por ningún motivo aparente.
• Trabajar con escritores y editores al principio del ciclo de desarrollo para crear texto de interfaz de usuario coherente y de alta calidad en todo el programa.

Los usuarios no deben tener que ir a otro lugar para averiguar cómo usar la interfaz de usuario. Agregue información esencial directamente a la interfaz de usuario principal, en lugar de forzar a los usuarios fuera de su contexto inmediato y al panel Ayuda. Si la información importante solo existe en un tema de Ayuda, hay una buena posibilidad de que los usuarios no lo vean. Para obtener información opcional y más explicativa, use vínculos de Ayuda de la interfaz de usuario principal al tema de Ayuda correspondiente para obtener ayuda complementaria.

Consideración de la motivación del usuario

Para la mayoría de los usuarios, la velocidad y la eficiencia están entre las virtudes primordiales de los buenos programas. Los usuarios quieren hacer su trabajo. Por lo general, no están interesados en aprender sobre el programa y la tecnología por su propio bien; su paciencia se extiende sólo en la medida en que ese programa sirve sus propios intereses y resuelve problemas a mano.

Diseñe el sistema de ayuda para que coincida con la motivación de los usuarios. Por ejemplo, considere un usuario que ha caminado hasta un quiosco en un museo. Si no puede averiguar cómo realizar la tarea rápidamente, es probable que se desenlace y salga. Es poco probable que pase tiempo usando la Ayuda. Como alternativa, un usuario altamente motivado tiene una mayor tolerancia para el tiempo dedicado a investigar el sistema de ayuda para obtener respuestas. Un usuario empresarial que debe equilibrar los libros, por ejemplo, probablemente está dispuesto a consultar el contenido de ayuda para sacar el máximo partido de esa nueva aplicación de contabilidad.

Escritura de contenido para el examen

Escriba temas de Ayuda sabiendo que se analizarán para obtener información específica, no leer palabras para palabras. Escribir concisamente, llegar al punto rápidamente y proporcionar información sobre la que los usuarios pueden actuar.

• Escriba temas de "procedimientos" mediante pasos numerados en un formato coherente para que los usuarios reconozcan que reciben ayuda de procedimientos.
• Escriba temas de referencia con facilidad de examen en mente, usando tablas, por ejemplo, para presentar opciones de interfaz de usuario o sintaxis de lenguaje.
• Escriba temas conceptuales organizados lógicamente por subpartidos, de modo que el usuario pueda omitir secciones enteras de menor interés.

En todo el contenido de la Ayuda, es más fácil examinar listas con viñetas que bloques de párrafo estándar de texto; use listas de viñetas con criterio, sin embargo, no como una muleta para material no organizado.

Creación de contenido que importa

Dado que ningún sistema de Ayuda puede anticipar todas las preguntas que pueda tener cada usuario, centre la mayoría del contenido en responder a las preguntas principales en los escenarios principales para los usuarios de destino. Por ejemplo, la búsqueda eficaz y cómo establecer la conectividad de red (entre otras tareas) puede ser temas muy buscados. Además, céntrese en las tareas dentro de los escenarios de usuario principales, en lugar de documentar exhaustivamente una característica o tecnología por su cuenta.

Propina: El soporte técnico es una buena fuente de contenido de Ayuda. Los servicios de soporte técnico a menudo mantienen registros de preguntas frecuentes sobre programas o tareas concretos que los usuarios están intentando (y fallan) para realizar.

No es necesario proporcionar ayuda para cada característica de la interfaz de usuario. A menudo, la Ayuda no útil resulta de intentar crear ayuda para todo. Si la interfaz de usuario está bien diseñada, la mayoría de estos temas de Ayuda no serán muy útiles; simplemente restarán lo obvio.

Si hay más de una manera de realizar una tarea, en la mayoría de los casos puede simplemente documentar la forma más común que usan los usuarios inexpertos. Entre las excepciones a esto se incluyen consideraciones de accesibilidad (documentar equivalentes de teclado de acciones del mouse, por ejemplo) y consideraciones de plataforma (documentación para el factor de forma de tableta, por ejemplo, o para entornos de servidor en los que la línea de comandos puede sustituir por la interfaz gráfica de usuario).

Recuerde que los usuarios a menudo no piensan en los problemas que encuentran exactamente en los mismos términos que usted. Por ejemplo, los usuarios pueden encontrarlo extraño pensar en sí mismos como una "cuenta". Asegúrese de diseñar la funcionalidad de búsqueda e indexación y, a continuación, para tener en cuenta las variaciones y sinónimos de terminología probables.

Sin embargo, entre la interfaz de usuario principal y el sistema de ayuda, los términos deben ser muy similares si no son idénticos. Los usuarios pueden confundirse cuando el idioma del sistema de ayuda no se correlaciona muy estrechamente con lo que ven en la pantalla.

Escribir texto de vínculo de Ayuda atractivo

Cuando vincule a un tema de Ayuda desde la interfaz de usuario principal, asegúrese de escribir texto de vínculo de Ayuda atractivo. Un lenguaje claro y específico inspira confianza. Los usuarios tienden a creer que los vínculos genéricos de Ayuda (un botón con la palabra "Ayuda" o "Más información" en él) no darán lugar a la información correcta sin una inversión significativa del tiempo.

Si haces solo cinco cosas...

1. Diseñe la interfaz de usuario para que los usuarios no necesiten ayuda.
2. Haga que la Ayuda sea útil al centrar el contenido en las principales preguntas de los escenarios principales para los usuarios de destino.
3. Presentar el contenido de la Ayuda para que sea fácil examinarlo.
4. Comprenda que no tiene que proporcionar ayuda para cada característica de la interfaz de usuario.
5. Haga que los puntos de entrada de ayuda sean reconocibles y atractivos.

Patrones de uso

Los diferentes tipos de contenido sirven para diferentes propósitos.

Tipo de contenido	Ejemplo
Ayuda de procedimientos proporciona los pasos para llevar a cabo una tarea.	La ayuda de procedimientos debe centrarse en la información de "cómo" en lugar de "qué" o "por qué". En este ejemplo, en el tema ayuda se describe cómo usar una característica de la utilidad Limpieza de disco, lo que proporciona los pasos que se deben seguir en secuencia.
Ayuda conceptual proporciona información general, información general sobre características o procesos.	La ayuda conceptual debe proporcionar información "qué" o "por qué" más allá de lo necesario para completar una tarea. En este ejemplo, el tema ayuda define qué es el escritorio y proporciona detalles adicionales sobre lo que contiene y por qué los usuarios interactúan con él.
Ayuda de referencia sirve como libro de referencia en línea.	Puede usar ayuda de referencia para documentar un lenguaje de programación o interfaces de programación. En este ejemplo, en el tema de Ayuda se enumeran las convenciones tipográficas que se usan para este idioma o aplicación concretos, lo que proporciona la información en una tabla fácil de examinar.

Instrucciones

Puntos de entrada

• Vínculo a temas de Ayuda específicos y relevantes. No vincule a la página principal de la Ayuda, la tabla de contenido, una lista de resultados de búsqueda o una página que simplemente vincule a otras páginas. Evite vincular a páginas estructuradas como una lista grande de preguntas más frecuentes, ya que obliga a los usuarios a buscar la que coincida con el vínculo en el que hicieron clic. No vincule a temas de Ayuda específicos que no sean relevantes y útiles para la tarea en cuestión. Nunca vincule a páginas vacías.

• No coloque vínculos de Ayuda en todas las ventanas o páginas por motivos de coherencia. Proporcionar un vínculo de Ayuda en un solo lugar no significa que tenga que proporcionarlos en todas partes.

• Use vínculos de Ayuda para cuadros de diálogo, mensajes de error, asistentes y hojas de propiedades. Si el vínculo Ayuda se aplica a controles específicos, colóquelo bajo ellos, alineado a la izquierda. Si el vínculo Ayuda se aplica a toda la ventana, colóquelo en la esquina inferior izquierda del área de contenido de la ventana.

  

  En este ejemplo, el segundo vínculo ayuda se aplica a un grupo de controles.

  

  En este ejemplo, el vínculo Ayuda se aplica a toda la ventana.

• Use vínculos de Ayuda en lugar de referencias textuales genéricas a ayuda siempre que sea técnicamente posible.

  Correcto:

  ¿Cómo puedo reparar errores de disco?

  Incorrecto:

  Para obtener más información sobre cómo reparar errores de disco, consulte Ayuda y soporte técnico.

• Use un botón Ayuda con el icono ayuda de las páginas centrales de los elementos del panel de control. Colóquelo en la esquina superior derecha. Estos botones no tienen una etiqueta, pero tienen información sobre herramientas que lee ayuda.

  

  Elemento del panel de control con un botón Ayuda.

• La Ayuda F1 es opcional. Los usuarios han crecido acostumbrados a encontrar información de Ayuda relacionada con el contexto inmediato de la interfaz de usuario en la pantalla presionando la tecla F1, que está etiquetada como Ayuda en teclados estándar. Puede incluir ayuda F1 si, por ejemplo, los estudios de facilidad de uso muestran que los usuarios esperan encontrarlo, o la interfaz de usuario del programa es lo suficientemente compleja como para beneficiarse de la asistencia contextual.

• Los programas con barras de menú pueden tener una categoría de menú Ayuda. Para obtener instrucciones del menú Ayuda, consulta Menús.

  

  En este ejemplo, el accesorio De pintura de Windows tiene una categoría de menú Ayuda.

• Para la accesibilidad del teclado, proporcione tabulaciones para los botones y vínculos de Ayuda.

• El botón de ayuda y el comportamiento del vínculo deben ser los siguientes: se abre el panel de ayuda y se muestra un tema de Ayuda dedicado; La interfaz de usuario que invocó el panel ayuda debe permanecer abierta para conservar la experiencia contextual.

• No use los siguientes estilos de punto de entrada de ayuda obsoletos: "Más información" o "Más información sobre..." vínculos, botones genéricos de Ayuda y botones de Ayuda contextuales en la barra de título. Aunque se han usado en el pasado, los estudios de facilidad de uso han determinado que los usuarios tienden a ignorarlos. En su lugar, use vínculos a temas de Ayuda específicos. Para obtener instrucciones sobre cómo escribir buenos vínculos de Ayuda, consulte Vínculos de Ayuda.

  Incorrecto:

  

  No use "Más información" o "Más información sobre..." Enlaces.

  Incorrecto:

  

  No use botones genéricos de Ayuda.

  Incorrecto:

  

  No use botones de Ayuda contextuales en la barra de título.

Contenido

• No cree contenido obvio. Los temas de ayuda que repiten lo que está en la interfaz de usuario principal no agregan valor.
• No cree contenido en el que el usuario no pueda actuar de alguna manera.
  • Excepción: Algunos contenidos conceptuales ofrecen información general importante sin llevar necesariamente a la acción del usuario.
• Evite soluciones vagas a los problemas. Por ejemplo, "póngase en contacto con el administrador del sistema" o "reinstale la aplicación" tiende a frustrar a los usuarios.
  • Excepción: Se recomienda ponerse en contacto con el administrador del sistema si es la única solución práctica y los administradores del sistema esperan ponerse en contacto con el problema.
• Evite el contenido que aborde escenarios de usuario muy improbables. Desarrolle el contenido principal de la Ayuda para lo que prevé que será el uso normal; tenga en cuenta las excepciones importantes al uso esperado, pero trate este contenido como una prioridad más baja.
• Recopile comentarios de los usuarios sobre lo útil que son los temas de Ayuda. Permitir a los usuarios calificar temas individuales. Realice estudios de facilidad de uso en su documentación para determinar los problemas relacionados con la calidad y la detectabilidad del contenido.
  • Propina: Los comentarios de los usuarios también son una excelente manera de generar contenido más basado en tareas, centrados en lo que los usuarios están haciendo realmente con el programa, en lugar de contenido basado en características, centrado simplemente en una descripción de la tecnología.
• Proporcione varias formas de acceder al contenido. Una tabla de contenido, un índice y un mecanismo de búsqueda son tres de los métodos más comunes para mejorar la detectabilidad.
• Si hay más de una manera de realizar una tarea, en la mayoría de los casos puede simplemente documentar la forma más común que usan los usuarios inexpertos.

Iconos

• Use el icono de Ayuda solo para las ventanas del Explorador y las páginas centrales de los elementos del panel de control. No use el icono de Ayuda con vínculos de Ayuda.

Correcto:

En este ejemplo, una ventana del Explorador de Windows usa un icono de Ayuda para proporcionar acceso a la Ayuda.

Incorrecto:

En este ejemplo, el icono de Ayuda de la parte inferior izquierda se usa incorrectamente con un vínculo de Ayuda.

Texto

Vínculos a la Ayuda

• Proporcione información específica sobre el contenido del tema de Ayuda, utilizando tanto texto conciso como sea necesario. A menudo, los usuarios omiten los vínculos genéricos de ayuda. Asegúrese de que los resultados del vínculo son predecibles, los usuarios no deben sorprenderlos.

  • Excepción: Puede usar "Más información" para complementar las instrucciones que se encuentran directamente en la interfaz de usuario, especialmente si proporcionar información específica en el vínculo ayuda conduce a repeticiones innecesarias o hace que el vínculo sea menos atractivo.

  Incorrecto:

  Una contraseña segura tiene al menos seis letras, números y símbolos de mayúsculas y minúsculas mixtas. ¿Qué es una contraseña segura?

  Correcto:

  Una contraseña segura tiene al menos seis letras, números y símbolos de mayúsculas y minúsculas mixtas. Más información

  En el ejemplo incorrecto, el vínculo ayuda es repetitivo. Hace una pregunta que ya está respondida.

• Siempre que sea posible, la ayuda de frases vincula el texto en términos de la pregunta principal respondida por el contenido de la Ayuda. No use la expresión "Más información sobre", "Cuéntame más sobre" o "Obtener ayuda con esto".

  Incorrecto:

  Más información sobre cómo agregar excepciones

  Correcto:

  ¿Cuáles son los riesgos de permitir excepciones?

  Cómo agregar excepciones?

  En los ejemplos correctos, el vínculo se frasea en términos de la pregunta principal respondida por el tema de Ayuda.

• Si la información más relevante se puede resumir concisamente, coloque el resumen directamente en la interfaz de usuario en lugar de usar un vínculo de Ayuda. Sin embargo, puede usar un vínculo de Ayuda para proporcionar información complementaria.

  Incorrecto:

  

  Correcto:

  

  Mejor:

  

  En el ejemplo correcto se resume la información de ayuda concisamente, lo que mejora considerablemente la probabilidad de que los usuarios la lean. En el ejemplo mejor se proporciona un vínculo de Ayuda para obtener más información sobre este tema complejo.

• Los vínculos de ayuda de frases indican claramente la asistencia. Los vínculos de ayuda nunca deben leerse como vínculos de acción.

• Use el vínculo de Ayuda completo para el texto del vínculo, no solo las palabras clave.

  Correcto:

  ¿Cuáles son los riesgos de permitir excepciones?

  Incorrecto:

  ¿Cuáles son los riesgos de permitir excepciones?

  En el ejemplo correcto, se usa toda la oración del vínculo ayuda para el texto del vínculo.

  • Excepción: Los vínculos de ayuda a sitios web externos simplemente deben usar el nombre del sitio o la página como vínculo. No es necesario incluir ningún texto que introduzca el nombre del sitio en el propio vínculo.

• Los vínculos de ayuda no tienen que coincidir exactamente con los encabezados del tema de Ayuda, pero debe haber una conexión fuerte y obvia entre los dos. Diseñe vínculos y encabezados en pares por este motivo.

  Correcto:

  ¿Cómo puedo mejorar el rendimiento de esta característica? (texto del vínculo)

  Configuración de esta característica para un rendimiento óptimo (encabezado de tema)

  Incorrecto:

  ¿Cómo puedo mejorar el rendimiento de esta característica? (texto del vínculo)

  Información general completa de esta característica (encabezado de tema)

  En el ejemplo incorrecto, el encabezado del tema de Ayuda difiere sustancialmente en el ámbito del texto del vínculo de ayuda y podría estar desorientando.

• Si el contenido de la Ayuda está en línea, desactive el texto del vínculo. Esto ayuda a hacer que el resultado de los vínculos sea predecible.

  Correcto:

  Para obtener formatos y herramientas adicionales, vaya al sitio web de Microsoft.

  Incorrecto:

  ¿Dónde puedo encontrar formatos y herramientas adicionales?

• Use oraciones completas.

• No use signos de puntuación finales, excepto los signos de interrogación.

• No use puntos suspensivos para vínculos o comandos de Ayuda.

Contenido de ayuda

• Dar formato a los elementos de la interfaz de usuario con negrita para facilitar su identificación. Esto es especialmente útil para los temas de ayuda de procedimientos, lo que permite a los usuarios examinar los procedimientos y ver rápidamente los elementos pertinentes de la interfaz de usuario.
• Dar formato a los títulos mediante cursiva. Esto se aplica a tablas, arte, capturas de pantalla y otros elementos gráficos que se benefician de una breve explicación textual.
• Consulte Ayuda simplemente como Ayuda. Por lo general, no use la frase ayuda en línea a menos que esté haciendo referencia de hecho al contenido en su sitio web.