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.

Trucos y Consejos

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. 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

Lee Mas →

Usar las funciones con scripts de HelpNDoc para restablecer automáticamente todos los números de Contexto de Ayuda

Usar las funciones con scripts de HelpNDoc para restablecer automáticamente todos los números de Contexto de Ayuda
Categorías: Artículos

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

Lee Mas →

Cómo compartir y hacer copias de seguridad de las plantillas de HelpNDoc

Cómo compartir y hacer copias de seguridad de las plantillas de HelpNDoc
Categorías: Artículos

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

Lee Mas →

Aprender a usar HelpNDoc: ¿por dónde deberías empezar?

Aprender a usar HelpNDoc: ¿por dónde deberías empezar?
Categorías: Artículos

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.

Lee Mas →

Actualizar fácilmente la ruta de los elementos audiovisuales externos al ser trasladados

Actualizar fácilmente la ruta de los elementos audiovisuales externos al ser trasladados
Categorías: Artículos

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

Lee Mas →

Cómo añadir un favicono multinavegador a tu documentación HTML generada

Cómo añadir un favicono multinavegador a tu documentación HTML generada
Categorías: Artículos

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

Lee Mas →

Cómo exportar ID de Ayuda y números de Contexto de Ayuda para tus desarrolladores

Cómo exportar ID de Ayuda y números de Contexto de Ayuda para tus desarrolladores
Categorías: Artículos

Cuando terminas de escribir un archivo de ayuda o una página web de documentación, normalmente te gustaría poder integrarlos con tus productos existentes: cuando los usuarios encuentren dificultades al realizar una acción, deberían poder abrir el archivo de ayuda y ver directamente el tema asociado correspondiente que explica esa acción específica. Con este propósito, las herramientas de creación de documentación de ayuda como HelpNDoc ofrecen dos identificadores únicos para cada tema: una ID de Ayuda alfanumérica y un número de Contexto de Ayuda. Con esto se puede llegar a un tema específico desde la aplicación de software o desde la página web. Pero como escritor técnico, es probable que no sea responsabilidad tuya "cablear" esa aplicación o página web con el archivo de ayuda, por lo que quizá prefieras enviar una lista de identificadores de temas a los desarrolladores encargados de ello. Gracias al potentísimo editor de scripts de HelpNDoc, ¡puedes hacerlo fácilmente!

Lee Mas →

Produce múltiples variaciones de una documentación maestra con facilidad

Produce múltiples variaciones de una documentación maestra con facilidad
Categorías: Artículos

Gracias a la potente función de generación condicional de HelpNDoc y su impresionante sistema de disposiciones, ahora es más fácil y rápido que nunca producir múltiples variaciones de una documentación maestra. Imagínate escribir un archivo de ayuda, manual, libro o documento y luego elegir qué partes incluir en cada producto diferente: empezarás a entender lo potente que puede ser esta función para producir diferentes variaciones de tu documentación maestra para diferentes clientes, usuarios, asociados… Sigue leyendo y descubre cómo usar con eficacia el sistema de generación condicional de HelpNDoc.

Lee Mas →