Herramientas de creación de ayuda para usuarios finales multiplataforma

Question

¿Cuáles son algunas buenas herramientas de creación para crear archivos de ayuda multiplataforma para usuarios finales? (Nuestra aplicación utiliza el marco de Qt, si eso hace alguna diferencia.)

Nota: No estoy interesado en la documentación interna de la API, estamos usando doxygen para eso.

Idealmente, una solución sería:

• nos permiten gestionar todos los contenidos de ayuda (texto, tabla de contenidos, imágenes, etc.) en un solo lugar.
• Salida a formatos de ayuda nativos. (CHM para Windows, o al menos algo que podríamos incluir directamente en la API de Ayuda HTML; no estamos seguros de cuáles son los formatos de ayuda "estándar" de otras plataformas).
• Compatible con WYSIWYG decente: maneja la entrada de texto común, imágenes, referencias, etc. fácilmente, pero podemos editar el HTML cuando lo necesitemos.
• Formato de archivo basado en texto para el proyecto de ayuda (XML, etc.) para que pueda ser versionado en Subversion.
• Cualquier gancho que lo mantenga sincronizado con la base de código real sería genial. (Tal vez de alguna manera un tema de ayuda está asociado con un archivo de código, y puede verificar Subversion para ver si se han realizado cambios y marcar un tema como "posiblemente desactualizado" ... ¿estoy soñando?)
• Contenido de ayuda puede ser localizado
• No se opone a un producto comercial, pero una opción gratuita sería agradable.

Voy a seguir adelante y hacer esto una wiki y comenzar con algunos ejemplos. Vótelos arriba o abajo si tienes experiencia con ellos, y deja algunos comentarios. Agrega herramientas adicionales también.

Answer 1

acabo de descubrir Sphinx; Creo que estoy enamorado.

• Mejor que WYSIWYG sobre HTML: reStructuredText
• salidas a QtHelp (entre otras cosas), por lo que será fácil de distribuir (e integrar) en nuestra aplicación.
• Aún no estoy seguro acerca de la localización, pero cruzaremos ese puente cuando lo necesitemos.
• Fue fácil de configurar y "simplemente funciona"; parece profesional.

Answer 2

Robohelp

Answer 3

Help & Manual

Answer 4

El único que conozco es Latex, uno de los convertidores latex2html, y luego algunas adaptaciones para que el html resultante esté listo para el archivador CHM.

• texto, html, chm, pdf, ps ningún problema.
• Convertir a Word a través de RTF solía ser un desastre, no sé el estado actual.
• convertidores de latex 2 html, mientras que varios, todos tienen sus propios problemas.
• Los pdfs se ven absolutamente geniales.
• WYSIWYM (via lyx) posible.

Este archivo tiene un montón de CHM de esa manera (en especial las partes progresivas, árbitro y de los usuarios, el resto (RTL, FCL, LCL) son generados por nuestro propio doxygen equivalente, fpdoc)

http://www.stack.nl/~marcov/doc-chm.zip

Tenga en cuenta que los CHM anteriores están hechos con nuestro propio compilador CHM (portátil). Sí, no más taller.

documento A Lyx como PDF y HTML:

pdf: http://www.stack.nl/~marcov/buildfaq.pdf

html: http://www.stack.nl/~marcov/buildfaq/

Answer 5

he utilizado robohelp durante años.

Está bien, pero la tecnología básica es muy antigua ahora. También la forma en que bloquean las versiones de Word es un PITA total (y me ha obligado a evitar las actualizaciones de MS Office varias veces).

Nos estamos moviendo a Madcap estallar http://www.madcapsoftware.com/products/flare/robohelp.aspx

Answer 6

creo DocBook direcciones de todo lo que los requisitos excepto posiblemente los ganchos de sincronización, que voy a pensar un poco más adelante. Es esencialmente un subconjunto de XML diseñado para crear documentación, y es de código abierto y gratuito. Es solo un formato más un conjunto de transformaciones de salida XSL que convierten el Docbook en formatos más útiles (HTML y por lo tanto CHM, JavaHelp, PDF a través de XML-FO o Tex).

Esto significa que usted todavía necesita elegir una herramienta de creación de XML para editarla, por lo que cosas como WYSIWYG dependerán de las características de su software de creación de XML. Usamos Syntext Serna ya que tiene un buen soporte para WYSIWYG y edición en línea de #includes XML (nadie más parece apoyar este último). Puede encontrar otras herramientas de creación XML que se adapten mejor a sus necesidades: Serna es una oferta comercial razonablemente costosa.

Docbook proporciona una gran flexibilidad a través del perfilado, que le permite incluir/excluir elementos xml en función de sus atributos. Ejemplos de casos de uso serían tener una salida de ayuda ligeramente diferente para OS = Windows que OS = Linux. La localización también se admite mediante perfiles y otros mecanismos.

Una bastante buena introduction to Docbook se puede encontrar here.

Usamos Docbook para nuestro formato de ayuda y lo compilamos a archivos CHM que contienen ayuda solo para las características relevantes para un producto específico (es decir, Enterprise Edition tiene características que no están en las versiones Estándar o Demo). Los pasos relevantes son:

1. Ejecute las plantillas XSL de generación de perfiles en la fuente XML (utilizando, por ejemplo, XSLTproc).
2. Ejecute las plantillas HTML-Help XSL en la salida de 1.
3. Recopile los archivos HTML de salida utilizando el Compilador de Ayuda HTML (HHC) de Microsoft.