¿Cuál es el trato con los archivos de ayuda en estos días?

Question

Agregué esta pregunta en SuperUser para la perspectiva del usuario.

Así que creo una aplicación en Delphi o .NET que se ejecutará en un sistema de escritorio. Una buena interfaz gráfica de usuario con todo tipo de funcionalidades y características agradables. Funciona bien, las pruebas me dicen que está casi libre de errores y estoy a punto de implementarlo ...

¡ESPERA! ¡Necesita un archivo de ayuda, por lo que los usuarios pueden recurrir a la ayuda contextual de la aplicación!

¿O no? ¿Los archivos de ayuda son realmente un requisito para las aplicaciones de escritorio en estos días? ¿Y realmente necesitan ser sensibles al contexto, tomar las manos del usuario para decirles que tienen que completar su día de nacimiento en este campo etiquetado como "Día de nacimiento"? ¿O los archivos de ayuda se están volviendo un poco anticuados?

Esto es algo de lo que me pregunto y esto es un poco subjetivo, así que en cambio voy a preguntar algo diferente a todos los que desarrollen aplicaciones de escritorio: ¿Ofrecen (todavía) archivos de ayuda sensibles al contexto?

Sí o no, por favor. Siéntase libre de agregar algunos textos subjetivos, pero para mí, lo importante es saber si los desarrolladores modernos aún agregan ayuda sensible al contexto a sus aplicaciones GUI.

(Por cierto, yo mismo me mudé a archivos PDF sin contexto que pueden imprimirse como manuales. Es mucho más fácil de mantener).

Answer 1

Sí, lo hago.

Motivo: Simplemente no puedo esperar que el usuario sepa cómo funciona el programa. Ok, describiendo lo que tiene que ser ingresado en un " Día de nacimiento " El campo es un poco extremo, pero normalmente hay cosas más complejas en un sistema de software. Tuve que escribir un archivo de ayuda para nuestro sistema de contabilidad de costos hoy mismo, describiendo cómo funciona el sistema para determinar el precio que debe usarse para el cálculo. No creo que ningún usuario sepa cómo configurar el sistema sin este archivo de ayuda.

Answer 2

Hablando como usuario, no como desarrollador, sí, quiero un archivo de ayuda sensible al contexto.

Por ejemplo, actualmente estoy evaluando controles de terceros para su inclusión en un nuevo proyecto. Los controles que tienen una buena ayuda contextual (es decir, puede seleccionar una propiedad en la ventana de propiedades o una palabra clave en el código y presionar F1 para ir directamente al tema de ayuda) son mucho, mucho más fáciles de aprender y usar.

Answer 3

Actualmente no lo hacemos, pero no escribimos muchas aplicaciones de Windows. La mayoría están basadas en la web. La mayoría de nuestras aplicaciones de Windows son bastante pequeñas y están bien documentadas fuera de un archivo de Ayuda.

Además, tenemos los usuarios finales que escriben la documentación durante el proceso de desarrollo, por lo que la documentación es algo que entenderán.

Sin embargo, si escribiera una aplicación grande para muchos usuarios (no una aplicación interna) incluiría un archivo de ayuda sensible al contexto. Lo he hecho en el pasado para algunas de nuestras aplicaciones más grandes, y en una situación no interna, es muy útil.

En realidad, ahora estamos diseñando nuestro sitio web para que "necesite ayuda" característica sensible al contexto, y la característica ha sido bien recibida. Lo estamos incorporando en todo nuestro desarrollo web ahora, ya sea para el sitio web de nuestra empresa o interno.

Answer 4

¿Sin ayuda? Eso está bien para las personas que tienen una inclinación técnica y les gusta jugar con un nuevo software. Pero si su software va a ser utilizado por personas que no son expertos en tecnología, la ayuda es esencial. Tome su ejemplo de fechas. Si tiene un mercado internacional, es mejor que explique lo que necesita el programa. Los estadounidenses usan un formato MM / DD / AAAA, pero la mayoría de los usuarios internacionales usan DD / MM / AAAA; necesita explicar lo que necesita el programa.

He trabajado con muchos desarrolladores que no tenían absolutamente ninguna idea sobre sus usuarios finales y cómo operan. Por ejemplo, un CTO que insistió en que su nueva compañía debería eliminar la documentación imprimible sin saber que sus clientes imprimían todos los PDF y la mayoría de los temas de ayuda cada vez que había una actualización. Debe conocer a su usuario final y su mercado. Desafortunadamente, muchos desarrolladores viven en una burbuja, rodeados de otros desarrolladores.

¿Deberían los desarrolladores escribir ayuda? Probablemente no. A menos que realmente pueda pensar como un usuario final típico, redacte notas pero permita que un escritor técnico desglose la información técnica al nivel que el usuario final necesita.

Answer 5

En una aplicación reciente, no proporcionamos ayuda contextual. Esto tenía razones técnicas en lugar de cualquier otra cosa (el archivo de ayuda es, esencialmente, un archivo de docbook en varios idiomas, que en teoría admite ayuda sensible al contexto, pero no funcionó bien). Tiene una página para cada ventana / diálogo en la aplicación, con todos los controles explicados. Sin embargo, cada control también tiene una información sobre herramientas bastante completa, que elimina la necesidad de ayuda adicional. Cada cuadro de diálogo tiene un botón de ayuda para abrir la página específica del cuadro de diálogo. Históricamente, podría almacenar el texto de información sobre herramientas en el archivo de ayuda, pero eso no parece funcionar con los sistemas de ayuda recientes. Y de todos modos se almacenan en recursos.

Pero entonces, no es una aplicación para todos. Dado que el sistema de red que se puede administrar con la aplicación es un tema complejo en sí mismo, de todos modos hay una capacitación especial para los usuarios, y la aplicación se ha diseñado de modo que si conoce el sistema de red, también conoce la aplicación. En otras palabras, el modelo de aplicación se alinea con el modelo de usuario tan bien que no se necesitan funciones de ayuda integrales. Este debería ser el objetivo de cualquier desarrollo de aplicaciones.

La mayoría de la información en los archivos de ayuda sobre los controles no es realmente más de lo que ya está en la información sobre herramientas, porque nadie necesita más.

Office y Visual Studio resolvieron el problema de manera bastante similar: al presionar la ayuda se abre la página de ayuda para todo el diálogo, no para el control único.

Si tiene una parte de un diálogo que es tan complicado que necesita una explicación adicional (y dado que no puede rediseñarlo para que sea más fácil), puede poner la explicación justo al lado del control. Esto se usa en muchas aplicaciones para casos especiales, de modo que el flujo de trabajo no se interrumpe porque el usuario tiene que buscar, p. cómo se debe escribir un texto específico.

Answer 6

Nunca he proporcionado ayuda sensible al contexto en una aplicación, ni la he visto implementada lo suficientemente bien en ninguna otra aplicación como para usarla yo mismo. En mi opinión, el esfuerzo requerido para hacerlo supera el beneficio.

En la última aplicación en la que estuve involucrado para tomar esta decisión, utilizamos globos de información sobre herramientas en la aplicación, que mostraban un globo de texto cuando el usuario se cernía sobre cada control. También proporcionamos un manual convencional que consistía principalmente en tutoriales con muchas capturas de pantalla paso a paso.

Después de un tiempo, los usuarios se cansaron de los globos y los apagaron con una casilla de verificación que proporcionamos, pero pareció ayudar a los principiantes a comenzar.

Answer 7

Todas nuestras aplicaciones tienen ayuda contextual en forma de información sobre herramientas (similar a las sugerencias de Office 2007) para todas las características críticas de la aplicación.

Si bien no ofrecemos el archivo de ayuda tradicional y completo, definitivamente tenemos una Base de conocimiento que actualizamos regularmente. Esta es una recopilación de toda la ayuda brindada a los clientes por teléfono, correo electrónico, etc., en todos y cada uno de los temas, debidamente categorizados y fáciles de buscar. Esto finalmente termina siendo la mejor ayuda que contiene más o menos lo que buscan los clientes en lugar de lo que nosotros inicialmente pensamos que pueden necesitar.

Si bien algunos clientes terminan invariablemente en contacto con nosotros sin siquiera echar un vistazo a la Base de conocimiento, todavía nos ayuda a reinventar la rueda una y otra vez.

Answer 8

Te doy una opinión personal, no respaldada por ningún otro hecho que mi gusto personal.

Escribir archivos de ayuda fue útil en el pasado, donde todo era nuevo y los recursos en línea eran escasos. Hoy, la mayoría de los usuarios de computadoras aprenden por exploración directa. La ayuda contextual en forma de información sobre herramientas es excelente y altamente recomendable: da pistas para este aprendizaje exploratorio.

¿Qué pasa con la documentación de ayuda con muchos enlaces para hacer clic? bueno, aparentemente es genial, pero supongo que se usa muy raramente. En la mayoría de los casos, el usuario puede obtener respuestas con una búsqueda adecuada en Google. Además, este tipo de documentación es costoso . No puede ser escrito por un desarrollador. Debe contratar o asignar personas específicas para esto, con redacción técnica y claridad como habilidades relevantes.

Si tuviera que gestionar esta decisión, proporcionaría documentos completos solo para aquellas funciones que son muy esotéricas y especiales (diría que únicas) para su aplicación. En cualquier caso, preferiría un tutorial en línea, en lugar de archivos de ayuda contextual. Esto tiene la ventaja adicional de proporcionar información sobre lo difícil que es usar su aplicación y cuáles son los puntos de acceso más solicitados (evaluando los resultados y las consultas de búsqueda de referencias a sus documentos en línea).

Answer 9

Con la información sobre herramientas y una mayor capacidad informática de los usuarios, algunas aplicaciones funcionan sin archivos de ayuda. Sin embargo, algunas aplicaciones necesitan archivos de ayuda, tanto para la información general del tema como para el uso de la aplicación. Por ejemplo, en una aplicación de fotos, es posible que desee explicar la compresión JPEG e incluir algunas muestras en el archivo de ayuda, incluso si la operación del usuario es evidente.

Me parece que Microsoft contribuye a la disminución de la ayuda sensible al contexto, para bien o para mal. Primero, los sistemas de ayuda en Visual Studio son, por decirlo suavemente, un dolor de usar. En segundo lugar, la facilidad de uso del sistema de ayuda de Visual Studio se ha reducido significativamente. Omitiré la queja, pero basta con decir que se necesitan muchos más clics y desplazamientos para obtener información relevante en la ayuda de VS2008. Esto tiende a establecer un estándar más bajo para los sistemas de ayuda en las aplicaciones.