Al desarrollar una aplicación informática, uno de los elementos que se deben implementar son los ficheros de ayuda. Un fichero de ayuda nos permite conocer las características y forma de trabajo de una aplicación. Sirven de guía, de referencia, manual a los diferentes usuarios y usuarias de una aplicación.

El fichero de ayuda nos permite acceder a información sobre la instalación, configuración, utilización y administración de un programa informático. En la mayoría de los casos, los ficheros de ayuda sirven de asistencia al usuario o usuaria de la aplicación.

Los ficheros de ayuda se implementan en diferentes formatos, en función de la plataforma donde se distribuya el software, el lenguaje de programación utilizado o el entorno de desarrollo. En general, la mayoría de los ficheros de ayuda tienen un formato basado en HTML, aunque también se puede encontrar ficheros de ayuda creados en PDF.

En el caso de aplicaciones Java, para generar ficheros de ayuda se utiliza JavaHelp. Cuando activamos el sistema JavaHelp en nuestra aplicación, lo primero que se hace es leer el archivo de ayuda especificado para esa aplicación. El fichero de ayuda define la ayuda para esa aplicación. Generalmente, un fichero de ayuda incluye la siguiente información:

• Mapa del fichero. El mapa del fichero se utiliza para asociar los "Identificadores de tema" con el nombre de la URL o rute de tema HTML en el fichero de ayuda.
• Vista de Información. Presenta la información descrita en los navegadores de fichero de ayuda. El estándar que se utiliza es: tabla de contenidos, índice y búsqueda de texto completo. Algunos navegadores presentan un glosario y favoritos.
• Título del fichero de ayuda. Este título aparece en la barra de título de la ventana del fichero de ayuda y en las ventanas secundarias del fichero de ayuda.
• Identificar de inicio (Home ID). El nombre del identificador por defecto que se mostrará cuando el visor de ayuda sea invocado sin especificar un ID.
• Presentación. Son las ventanas en las que se muestran los temas de ayuda.
• Sub-Ficheros de ayuda. En este caso, los ficheros de ayuda pueden estar formados por ficheros más pequeños, que son fusionados para crear el fichero de ayuda de la aplicación.
• Implementación. Esta sección es opcional y crea un registro que proporciona datos clave para definir la asignación de la clase HelpBroker para usar el método HelpSet.createHelpBroker. El registro también determina el visor de contenido de usuario para un tipo MIME.

Cuando se implementa una aplicación que utiliza JavaHelp y es instalada en el sistema del usuario, el programa Java debe ser capaz de encontrar el archivo de ayuda. La aplicación especifica la ruta al archivo de ayuda cuando se inicia el sistema de JavaHelp.