Diseñar un sistema de ayuda

Question

Estoy implementando un sistema de ayuda para una aplicación de escritorio (Win32) y estoy buscando cómo diseñarlo.

¿Qué tipo de estructura debe tener un sistema de ayuda? ¿Qué es realmente útil para el usuario? p.ej.¿Debería el sistema de ayuda ser una gran lista de preguntas frecuentes (la ayuda de Office 2010 parece ser así)?o debería ser una lista de características que documente y describa lo que hace todo (esto probablemente solo sea útil si el usuario no está seguro de cómo funciona una característica que ya conoce)

¿Qué tipo de conocimiento debo esperar que tenga el usuario final?Probablemente sea un poco degradante escribir en el archivo de ayuda que File -> Open Project Cierra el proyecto actual (si está presente) y abre un proyecto existente.

Lo que busco aquí es alguna guía, un conjunto de características que cualquier buen sistema de ayuda debería tener y un método para organizar los temas de manera que los usuarios puedan encontrarlos.

Answer 1

"Proyecto abierto" también puede ser un buen lugar para poner una referencia a la definición de un proyecto y otras descripciones y procedimientos más generales relacionados con la apertura de proyectos.

En general, se accede a la ayuda de CHM a través de la ayuda contextual (que es la típica para el archivo-> caso abierto) y a través de la tabla de contenido general, la búsqueda de texto completo y los índices. Las aplicaciones más recientes parecen crear solo una página de ayuda por contenedor (un diálogo o un menú desplegable), donde enumeran todos los elementos de esa pantalla (por ejemplo, mediante una captura de pantalla anotada) y no un lema para cada elemento (casilla de verificación, entrada de menú) en la GUI. Menos desorden y navegación, y muchos puntos solo necesitan una descripción bastante breve

Además de la ayuda contextual, también se puede explorar la ayuda a través del sistema de ayuda.

Un CHM es bastante parecido a un libro electrónico, con una tabla de contenido (TOC), índice y, opcionalmente, soporte para búsqueda de texto completo.

El índice y la búsqueda de texto completo son formas para que el usuario busque contenido. La principal diferencia es que el índice está más bajo su control y la búsqueda de texto completo es en gran medida automática cuando está habilitada.

La TOC es una vista de árbol de nodos que actúan como la TOC en un libro y debe fijar la estructura general del "ebook". Las preguntas frecuentes suelen ser un apéndice de este TOC.

Además de esto, hay una página de "entrada" predeterminada, que es como la página de inicio de un sitio web. Debería llevar a los usuarios a los temas más buscados.

Tenga cuidado al comparar con productos de Microsoft. A veces utilizan sistemas que aún no están disponibles para usuarios finales / desarrolladores.

La buena ayuda utiliza todos estos elementos.

Answer 2

En general, existen dos estilos de ayuda: basada en referencias (es decir, ¿qué significa esta casilla de verificación?) y basada en tareas (¿cómo logro XYZ?).

Probablemente sea mejor que primero cree un tutorial basado en tareas, respaldado por una sección de preguntas frecuentes si es necesario.