Descubra un tesoro de valiosas ideas y atajos para maximizar su dominio de la herramienta de creación de ayuda HelpNDoc. Desentierra joyas ocultas, agiliza tu flujo de trabajo y libera todo el potencial de la herramienta mientras profundizas en una colección de consejos y trucos de expertos. Desde el dominio de técnicas avanzadas de formato hasta el aprovechamiento de funciones que ahorran tiempo, esta etiqueta es su guía para convertirse en un virtuoso de HelpNDoc. Mejore su proceso de creación de documentación, aumente la eficiencia y elabore contenido de ayuda profesional con facilidad. Explora la sección Consejos y trucos y embárcate en un viaje para convertirte en un maestro de HelpNDoc.
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. ¡Pero eso no es todo! Hay otras cinco importantes funciones de HelpNDoc que harán aún más sencilla la redacción de tu próxima documentación técnica;
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
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. Afortunadamente, HelpNDoc incluye scripts para reordenar automáticamente los temas por título. Comprobemos lo rápido y fácil que puede hacerse esto
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. Por suerte, la herramienta de creación de documentación de ayuda HelpNDoc convierte este proceso es una tarea rápida y muy sencilla gracias a los marcadores de lugar de variables y al potente sistema de disposiciones
HelpNDoc incluye un editor de scripts muy potente con acceso a múltiples métodos API que ofrece un medio para automatizar prácticamente todas las partes del proceso de creación y mantenimiento de la documentación. Ya hemos visto cómo usar las funciones con scripts de HelpNDoc para automatizar la creación de documentos y archivos de ayuda, actualizar la ruta de los elementos audiovisuales externos cuando los mismos son trasladados y exportar códigos de ID de Ayuda y Contexto de Ayuda para tus desarrolladores. Veamos ahora cómo podemos crear un script muy conveniente para restablecer de manera automática los números de Contexto de Ayuda para todos los temas del proyecto de documentación
HelpNDoc es una potente herramienta de creación de documentación de ayuda capaz de generar múltiples formatos de documentación (entre ellos CHM, HTML, Word, PDF, ePub, Kindle o Qt Help) a partir de una sola fuente. Incluye un sistema muy potente de plantillas que ofrece una manera de personalizar prácticamente cualquier parte del aspecto y la dinámica de la documentación generada. Una vez creada una plantilla personalizada, puede compartirse entre compañeros de trabajo o hacer copias de seguridad con facilidad. Vamos a ver cómo hacerlo
A pesar de que la herramienta de creación de documentación de ayuda HelpNDoc ha sido diseñada para ser extremadamente fácil de usar, es posible que haga falta cierta ayuda para empezar a utilizarlo o para entender las funciones avanzadas. Por suerte, hay muchos recursos disponibles en diferentes formatos para entender rápida y fácilmente los conceptos y funciones disponibles en HelpNDoc. Vamos a repasarlos.
Ya hemos visto cómo se puede insertar un vídeo de YouTube en los archivos de ayuda CHM o HTML. Aunque YouTube es una plataforma fantástica para compartir vídeos, algunos prefieren a su principal competidor: Vimeo. Por suerte, con HelpNDoc es extremadamente sencillo integrar un vídeo de Vimeo en tus archivos CHM o HTML de ayuda
Puedes elegir cómo quieres que HelpNDoc procese tus ítems de biblioteca (imágenes, vídeos, documentos…): pueden incluirse dentro del proyecto, o ser incluidos dinámicamente en el momento de la generación, cuando decidas crear tus archivos finales de documentación. Con esta segunda opción, indicas una ruta a tus ítems audiovisuales, de manera que HelpNDoc pueda encontrarlos e incluirlos cuando sea necesario. Esto es muy útil para tener controlados los ítems desde fuera de HelpNDoc, compartirlos con un software de terceros… No obstante, puede producirse un problema si es necesario trasladar esos ítems en tu disco duro o en la ruta de red. Para garantizar que HelpNDoc pueda seguir encontrando tus elementos audiovisuales, tendrás que actualizarlos todos manualmente, uno a uno. Como esta puede ser una tarea bastante larga, aburrida y propensa a los errores, es la oportunidad perfecta para utilizar el potente editor de scripts de HelpNDoc. Veamos cómo podemos sacarle partido para actualizar con rapidez la biblioteca completa en sólo unos segundos
Nos preguntaron en FaceBook si era posible definir un favicono a una disposición HTML de ayuda generada con HelpNDoc. Es una pregunta fantástica y la respuesta corta es que desde luego que sí, gracias al potente sistema de plantillas de HelpNDoc. Veamos cómo podemos hacerlo creando primero nuestro favicono, y después nuestra propia plantilla personalizada para usarla con él
