Actualmente utilizamos un sistema llamado AsciiDoc que nos permite crear documentación en un simple marcado de texto. A partir de eso podemos generar múltiples formatos de salida. Solo utilizamos los formatos de salida pdf y chm.
Me preguntaba si había una alternativa a chm? Lo que estoy buscando es algo que se pueda usar fuera de línea (esto es importante porque algunos de nuestros usuarios están en lugares muy remotos) con nuestro software. Debe tener un índice (puede ser tan simple como una página html con términos con hipervínculos), debe poder buscarse y debe tener un mecanismo que permita que se invoquen entradas específicas desde el código (similar a la ayuda sensible al contexto).
Las dos cosas que están en contra de PDF en este caso son:
- La ayuda sensible al contexto no es una opción
- Generalmente el documento es bastante grande
- PDF es más adecuado para la documentación impresa que la ayuda contextual
Lo que me gustaría es usar html. El único problema con html es que parece que no puedo entender cómo proporcionar automáticamente una búsqueda de palabras clave (aparte de la funcionalidad ctrl + f de los navegadores, me gustaría algo más aparente). Tampoco puedo encontrar un método para generar automáticamente un índice hipervinculado de palabras clave. La ayuda sensible al contexto sería simple debido a las etiquetas de sección: simplemente podría pasar la URL de la página y la sección que me interesa al navegador predeterminado y esa página debería cargarse en la sección correcta.
Mis requisitos se parecen mucho a chm, lo hacen. Modelé mis requisitos fuera de chm. La única razón por la que no me gusta chm es por la forma en que el código interactúa con los mapids y demás. Preferiría usar almacenar una lista de texto sin formato (que se genera automáticamente para mí) que mi código puede usar para acceder a la parte sensible al contexto de la documentación.
Estoy imaginando un script que pasaría por los archivos de salida html y generaría una página de índice que simplemente contiene una lista de palabras clave que encontró. obviamente debería haber un mecanismo de exclusión de palabras para ignorar palabras como: the, it, is, etc. Esta parte sería relativamente fácil de escribir. La segunda parte necesitaría un script de algún tipo para reunir una base de datos de palabras clave y su ubicación dentro del texto html. Creo que esta sería la parte difícil junto con proporcionar el mecanismo de búsqueda dentro del navegador.
Cualquier idea sobre alternativas sería apreciada. Me encantaría usar un wiki o un conjunto de páginas html estáticas alojadas en un servidor web en algún lugar, pero tenemos un requisito crítico de uso fuera de línea. Simplemente colocar el html en el disco local no nos proporciona los requisitos de búsqueda que necesitamos.
EDITAR:
Diseño software que es usado por la industria minera. Muchas minas son muy remotas y no tienen acceso a Internet de ninguna manera significativa. No hay nada malo con pdf o html o chm (excepto que se está volviendo viejo). Si pudiera mostrar un archivo pdf en la ubicación correcta (es decir, ayuda sensible al contexto) lo usaría. Estoy casi tentado a escribir el mío, básicamente sería un wiki portátil. Hablando de eso, si sugiere una wiki portátil, debe pensar en el usuario final que puede no tener experiencia en el uso de tales herramientas. Tiene que ser muy simple. Esa fue la belleza de chm, es un trabajo difícil pero a los usuarios finales les gusta.