¿Cómo se puede programar la generación automatizada de documentación de usuario?

¿Cómo se puede programar la generación automatizada de documentación de usuario?
Categorías: artículos

Los escritores técnicos a menudo necesitan generar su documentación, manuales de usuario o páginas web de ayuda para compartirlos con los miembros de su equipo o entregárselos a sus usuarios finales. Este puede ser un proceso largo que requiere la máxima atención, para comprobar que se genere periódicamente la versión correcta. Por suerte, la herramienta de creación de archivos de ayuda HelpNDoc se puede automatizar para la generación programada de documentación.

Lee Mas →

Cómo localizar y reparar hipervínculos rotos en tus manuales de usuario, eBooks y archivos de ayuda

Cómo localizar y reparar hipervínculos rotos en tus manuales de usuario, eBooks y archivos de ayuda
Categorías: artículos

Los escritores técnicos confían en los hipervínculos para organizar y referenciar múltiples partes de sus manuales de usuario impresos, eBooks o archivos de ayuda. Asegurarse de que los hipervínculos estén actualizados es muy importante, ya que los hipervínculos rotos pueden interrumpir el transcurso del aprendizaje del usuario final, que puede abrumarse al no encontrar la información necesaria: esto puede conducir a un aumento de los costes de atención al cliente si se abren tickets de soporte.

Lee Mas →

Crea una nueva plantilla HTML para personalizar tus proyectos de documentación online

Crea una nueva plantilla HTML para personalizar tus proyectos de documentación online
Categorías: artículos

El reciente lanzamiento de HelpNDoc 6.4 incluye una plantilla mejorada HTML de una página que ofrece la opción de añadir una tabla de contenido a la documentación HTML de una página producida. Obviamente, hemos utilizado el potente editor de plantillas de HelpNDoc para modificar la plantilla de una página, y hemos pensado que sería buena idea documentar este proceso con efectos didácticos. Sigue los pasos descritos en este artículo para aprender a crear y a modificar plantillas de documentación basadas en HTML utilizando las herramientas integradas de HelpNDoc.

Lee Mas →

Edición en masa de estatus de todos los temas en tu proyecto de documentación

Edición en masa de estatus de todos los temas en tu proyecto de documentación
Categorías: artículos

HelpNDoc 6.0 contiene mayor soporte para estatus de temas, simplificando enormemente el mantenimiento de proyectos de documentación para los autores técnicos: se pueden etiquetar los temas como “Sin Actualizar”, “En Progreso”, “Por Revisar”, “Completo”, o cualquier estatus personalizado que definas. Es posible que te apetezca sacar partido a esta función para actualizar un antiguo proyecto y cambiar el estatus de todos tus temas a “Por Revisar” para empezar a revisarlos uno por uno.

Lee Mas →

Cómo migrar una plantilla personalizada cuando sale una nueva versión de HelpNDoc

Cómo migrar una plantilla personalizada cuando sale una nueva versión de HelpNDoc
Categorías: artículos

HelpNDoc incluye un procesador de plantillas muy potente que permite personalizar cualquier parte de la documentación generada. La mayoría de las veces utilizarás la plantilla predeterminada del formato de documentación que quieras personalizar como punto de partida. Pero cuando sale una nueva versión de HelpNDoc, es posible que la plantilla predeterminada haya evolucionado para incluir nuevas funciones y mejoras, y puede que quieras incluir dichos cambios en tus plantillas personalizadas. La solución consiste en comparar y combinar la plantilla predeterminada actualizada con la ya tienes.

Lee Mas →

Combina automáticamente varios temas de tu documentación en uno solo usando un script

Combina automáticamente varios temas de tu documentación en uno solo usando un script
Categorías: artículos

Una herramienta de creación de documentación de ayuda estándar como HelpNDoc es un programa de software en el que generalmente se escribe y organiza contenido para producir archivos de documentación para el usuario final. Según van haciendo falta revisiones, es imprescindible que el contenido permanezca organizado, algo que habitualmente implica gran cantidad de tareas pesadas y propensas a los errores, como pueda ser copiar y pegar contenido por todo el proyecto, eliminar contenido, desplazar o combinar temas… Por suerte, HelpNDoc incluye un poderoso procesador de creación de scripts que puede ayudar a automatizar la creación de documentación, el mantenimiento, la reorganización… Ahora veremos cómo sacar partido a las funciones de creación de scripts de HelpNDoc para combinar varios temas hijos en un tema padre.

Lee Mas →

5 funciones clave de HelpNDoc que simplifican la creación de documentación

5 funciones clave de HelpNDoc que simplifican la creación de documentación
Categorías: artículos

HelpNDoc es un popular software de creación de documentación de ayuda fácil de usar que fue diseñado para facilitar la escritura técnica. A lo largo de los años, el programa ha pasado por diferentes fases de desarrollo para hacerlo más fácil de usar y mejorar sus funciones, no sólo para los escritores técnicos, sino también para los autores de libros. En la actualidad, HelpNDoc es bien conocido por sus diferentes funciones de fácil manejo, en especial su capacidad para generar varios formatos diferentes de archivo a partir de un solo archivo de origen, entre ellos archivos Qt Help multiplataforma, documentación HTML5 basada en web, archivos CHM de ayuda estándar de Windows, documentos PDF y Word imprimibles, eBooks ePub y Kindle y páginas web específicas para iPhone.

Lee Mas →

Añade rápidamente un logo, código JavaScript y CSS personalizado a tus archivos HTML de documentación

Añade rápidamente un logo, código JavaScript y CSS personalizado a tus archivos HTML de documentación
Categorías: artículos

El impresionante proceso de generación de páginas web de HTML adaptable de HelpNDoc se puede personalizar para añadir un logo, CSS modificado y código JavaScript, strings traducidas y más… Comprobemos lo fácil y rápido que es producir páginas web de documentación HTML auténticamente personalizadas usando HelpNDoc. Añadir un logo personalizado a la biblioteca del proyecto La biblioteca incluye todos los elementos reutilizables audiovisuales (imágenes, vídeos, documentos…) disponibles en el proyecto.

Lee Mas →

Ordenar rápidamente contenido de ayuda, encabezados de documentación o temas de eBooks por título

Ordenar rápidamente contenido de ayuda, encabezados de documentación o temas de eBooks por título
Categorías: artículos

Escribir un archivo de ayuda online, un manual de usuario, un eBook o cualquier otro formato admitido por HelpNDoc suele ser un proceso prolongado, continuo y no lineal. Con frecuencia, a medida que evoluciona el contenido, la jerarquía de los temas en general puede degradarse, por lo que es necesaria una reorganización para hacer la documentación más fácil de leer y de navegar. Aunque HelpNDoc ofrece herramientas para reorganizar fácilmente la tabla de contenido, en algunas ocasiones este puede ser un proceso largo y susceptible a los errores, como cuando es necesaria una ordenación alfabética de los temas.

Lee Mas →

Usar marcadores de lugar de variables para producir documentación para diversas culturas

Usar marcadores de lugar de variables para producir documentación para diversas culturas
Categorías: artículos

Al producir un archivo de ayuda, un manual de usuario o un eBook, no sólo es importante ofrecer traducciones dirigidas al público objetivo, sino también utilizar los términos adecuados dependiendo del idioma del lector. Tomemos por ejemplo el término “ordenador”: en América Latina, el término preferido es “computador”, mientras que “ordenador” se utiliza habitualmente en España. Como escritor técnico, ofrecer múltiples variantes de idiomas puede hacer surgir complicaciones y aumentar la cantidad necesaria de trabajo para comprobar que no hay errores en la documentación.

Lee Mas →