Bienvenido a “HelpNDoc Ideas y Artículos”, tu centro dedicado a todo lo relacionado con HelpNDoc, presentado en artículos reflexivos y en profundidad. Aquí, exploramos la amplitud y profundidad del software, arrojando luz sobre sus características, ofreciendo consejos y trucos, y proporcionando ideas sobre la mejor manera de aprovechar HelpNDoc para crear documentación convincente y completa. Nuestros artículos abarcan desde guías para principiantes hasta consejos de expertos y profundizaciones en funciones avanzadas. Para aquellos que prefieren una experiencia de aprendizaje más práctica, tenemos una serie de guías paso a paso disponibles tanto en forma de texto fácil de seguir como de atractivo contenido en vídeo. Tanto si es la primera vez que utiliza HelpNDoc como si es un especialista en documentación con experiencia, nuestro objetivo es empoderarle con conocimientos e inspirarle para que saque el máximo partido de HelpNDoc. Sumérgete para descubrir, aprender y mejorar tu comprensión de esta potente herramienta.
Los escritores técnicos pueden usar un archivo especial robots.txt or define robots meta tags en su documentación HTML para especificar cómo deben los motores de búsquedas populares, como Google o Bing, indexar y servir páginas individuales en los resultados de búsqueda. En este artículo, veremos cómo podemos actualizar la plantilla HTML predeterminada incluida en la herramienta de creación de archivos de ayuda HelpNDoc para generar un archivo robots.txt, especificar un valor predeterminado en todo el proyecto para la etiqueta meta robots y anular su contenido en páginas específicas de documentación. Está inspirado en el código suministrado por Keith Phillips, un usuario de HelpNDoc al que nos gustaría agradecer su contribución.
La impresionante interfaz de usuario de HelpNDoc ha sido cuidadosamente diseñada para ser lo más intuitiva y fácil de usar posible. Ofrece lo mínimo necesario para ser rápido y eficaz al máximo al redactar y producir archivos de ayuda, manuales de usuario y eBooks; y, sin embargo, proporciona funciones avanzadas para usuarios expertos, tales como la capacidad para desplazar, redimensionar y anclar paneles donde se quiera. En este artículo veremos cómo conseguirlo.
Crear la documentación más completa, exhaustiva y actualizada es la prioridad número uno de cualquier escritor técnico. Pero los lectores esperan un diseño limpio y moderno y las compañías a veces necesitan integrar páginas web de documentación con su material existente, por lo que se imita un aspecto y una dinámica predefinidos. Por suerte, la herramienta de creación de documentación de ayuda HelpNDoc te permite añadir con rapidez un logotipo o un código CSS personalizado para una rápida personalización, o incluso crear una plantilla completamente nueva para personalizar por completo los entregables de tus proyectos. En este artículo veremos cómo puedes usar iconos personalizados en la tabla de contenidos de la documentación HTML generada.
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. Veamos cómo podemos hacerlo.
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. Afortunadamente, la herramienta de creación de archivos de ayuda HelpNDoc incluye un sencillo analizador de hipervínculos, para ayudar a los escritores técnicos a detectar con y reparar con rapidez hipervínculos problemáticos.
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.
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. Pero actualizar individualmente cada tema es un gran proyecto que llevará tiempo. Por suerte, las funciones de scripts de HelpNDoc permiten actualizar los estatus de todo el proyecto de documentación en un instante. Vamos a ver cómo podemos hacerlo.
Siempre nos alegra compartir recursos valiosos de nuestros posts con autores y escritores técnicos. Si te has perdido alguno de nuestros posts, en esta recapitulación encontrarás una selección de posts recientes con trucos y consejos para ayudar a autores y escritores técnicos a permanecer un paso por delante. Para recibir notificaciones sobre futuros posts, síguenos en los medios sociales: Facebook, Twitter, LinkedIn, YouTube y Google+.
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. Veamos ahora una manera fácil y fiable de realizar esta tarea
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 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
