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

Question

He añadido this question at 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 GUI con todo tipo de funcionalidades y características agradables. Funciona bien, las pruebas me dicen que es casi libre de errores y estoy a punto de implementarlo ...

¡ESPERE! ¡Necesita un archivo de ayuda para que los usuarios puedan recurrir a la ayuda contextual de la aplicación!

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

Esto es algo que me pregunto y esto es un poco subjetivo, entonces en su lugar voy a preguntar algo diferente, a todos ustedes que desarrollan aplicaciones de escritorio: ¿Ofrecen (todavía) archivos de ayuda contextuales?

Sí, o no, por favor. Siéntase libre de agregar algunos textos subjetivos, pero para mí, lo importante es saber si los desarrolladores modernos todavía están agregando ayuda contextual a sus aplicaciones GUI.

(Por cierto, yo mismo se han trasladado a los archivos PDF no de contexto que se pueden imprimir como manual. Es mucho más fácil de mantener.)

Answer 1

Sí, lo hago.

Motivo: No puedo esperar que el usuario sepa cómo funciona el programa. Ok, describir lo que debe incluirse en un campo de "Día de nacimiento" 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 se debe usar para el cálculo. No creo que ningún usuario sepa cómo configurar el sistema sin este archivo de ayuda.

Answer 2

actualmente no, pero no escribir mucho de aplicaciones de Windows La mayoría están basados ​​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 fines que los usuarios escriben la documentación durante el proceso de desarrollo, por lo que la documentación es algo que comprenderán.

Sin embargo, si estuviera escribiendo una aplicación grande para una gran cantidad de 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 tener una función de "ayuda necesaria" que es 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 compañía o interno.

Answer 3

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

En la última aplicación en la que participé cuando se tomó esta decisión, usamos globos de información sobre herramientas en la aplicación, que mostraban un globo de texto cuando el usuario se moví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 4

Le doy una opinión personal, no respaldada por ningún otro hecho que sea de 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 mediante exploración directa. La ayuda contextual en forma de información sobre herramientas es excelente y se recomienda encarecidamente: da pistas para este aprendizaje exploratorio.

¿Qué hay de la documentación de ayuda con muchos enlaces para hacer clic? bueno, aparentemente es genial, pero se usa muy pocas veces, supongo. 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 características que son muy esotéricas y especiales (diría que únicas) para su aplicación. En cualquier caso, tenderé hacia un tutorial en línea, en lugar de archivos de ayuda contextuales. 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 (al evaluar los resultados y las consultas de búsqueda de referencia a sus documentos en línea).

Answer 5

En una aplicación reciente, no proporcionamos ayuda contextual. Esto tenía más razones técnicas que otra cosa (el archivo de ayuda es, esencialmente, un archivo de docbook en varios idiomas, que en teoría admite ayuda contextual, 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 general bastante completa, que en su mayoría elimina la necesidad de ayuda adicional. Cada diálogo tiene un botón de ayuda para mostrar la página específica del diálogo. Históricamente, puede 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 están almacenados en recursos de todos modos.

Pero entonces, no es una aplicación para todos. Como el sistema de red que se puede administrar con la aplicación es un tema complejo en sí mismo, de todos modos existe 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 conozca la aplicación. En otras palabras, el modelo de la aplicación se alinea tan bien con el modelo de usuario 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 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 bastante similar: al presionar Ayuda, se abre la página de ayuda para el diálogo completo, 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 hacerlo más fácil), puede poner la explicación 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

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

Por ejemplo, actualmente estoy evaluando controles de terceros para incluirlos en un nuevo proyecto. Los controles que tienen una buena ayuda contextual (es decirpuede 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 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 conocimientos que actualizamos periódicamente. Esta es una recopilación de toda la ayuda brindada a los clientes por teléfono, correo electrónico, etc., sobre cualquier tema, adecuadamente categorizada y fácil de buscar. Esto finalmente termina siendo la mejor ayuda que contiene más o menos lo que los clientes buscan en lugar de lo que que inicialmente creemos que puedan necesitar.

Mientras unos pocos clientes invariablemente terminan contactándonos sin siquiera echarle un vistazo a la Base de conocimiento, todavía nos ayuda a reinventar la rueda una y otra vez.

Answer 8

Con la información sobre herramientas y una mayor capacidad de la computadora en los usuarios, algunas aplicaciones funcionan perfectamente 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 fotografía puede que desee explicar la compresión de JPEG y 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 contextual, para bien o para mal. En primer lugar, los sistemas de ayuda en Visual Studio son, para decirlo suavemente, difíciles de usar. En segundo lugar, la facilidad de uso del sistema de ayuda de Visual Studio se ha reducido significativamente. Voy a omitir el discurso, pero basta con decir que toma muchos más clics y se desplaza 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.

Answer 9

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

He trabajado con muchos desarrolladores que no tenían absolutamente ninguna pista sobre sus usuarios finales ni sobre cómo funcionan. 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, demasiados desarrolladores viven en una burbuja rodeados por otros desarrolladores.

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