HTML (Hypertext Markup Language) es una piedra angular en la creación de contenido de ayuda digital a través de herramientas de autoría de ayuda (HAT) como HelpNDoc. Como lenguaje universal para la construcción de páginas web, proporciona la base estructural que organiza y presenta la información de una manera fácil de usar. HelpNDoc es una potente herramienta de autoría de ayuda (HAT) que puede producir eficazmente sitios web HTML totalmente adaptables, garantizando que su contenido de ayuda sea accesible, navegable y visualmente atractivo en todos los tipos de dispositivos y tamaños de pantalla.
Uno de los formatos de archivo de ayuda más importantes producido por la herramienta de creación de documentación de ayuda HelpNDoc es el formato de documentación HTML: las páginas de documentación totalmente funcionales pueden alojarse en cualquier servidor web para un rápido acceso a la documentación a voluntad, lo que simplifica la accesibilidad de los clientes y el trabajo del equipo de soporte. Los agentes de soporte a menudo necesitan compartir URL dependientes de contexto con los clientes para explicar tareas específicas, pero estas direcciones a menudo son demasiado largas o difíciles de recordar y escribir. Afortunadamente, todos los temas creados con HelpNDoc pueden tener un número ilimitado de aliases de URL: veamos cómo podemos definirlos en la interfaz de usuario de HelpNDoc.
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.
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
Paso 1: Definir ajuste HTML Haz clic en la mitad superior de Generar ayuda en la pestaña Inicio.
Esto mostrará la ventana “Generar documentación”.
Selecciona la disposición HTML que quieras modificar en la lista de disposiciones que hay a la izquierda.
Si la pestaña Ajustes de plantilla no está visible, haz clic en Personalizar para verla. Haz clic en la casilla “Ampliar el árbol de la tabla de contenido” para eliminar la marca de verificación.
Microsoft Word y otros programas similares de procesamiento de texto como LibreOffice son fantásticos para redactar y dar formato a documentos para impresión, pero no tanto para producir páginas web HTML a partir de dichos documentos: generan páginas HTML únicas o código CSS no optimizados para diferentes tamaños de pantalla y dispositivos como smartphones. Sacando partido a las capacidades de importación y exportación de una herramienta de creación de documentación de ayuda como HelpNDoc (que es gratuita para uso personal), es muy fácil convertir un documento de Word en una página web HTML5 con varias páginas y totalmente dinámica. Veamos cómo...
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
Compartir documentación de manera eficaz y segura es fundamental en el entorno laboral actual. Ya se trate de la distribución interna de manuales, documentación de proyectos o políticas de empresa, la herramienta de creación de documentación de ayuda HelpNDoc es una solución versátil perfecta para generar una variedad de formatos de documentación a partir de un solo proyecto de origen, como por ejemplo CHM, HTML, Word, PDF, ePub, Kindle, Qt Help o Markdown. Cada formato tiene sus propios puntos fuertes y débiles a la hora de su distribución interna y privada. En este artículo exploraremos las mejores prácticas para aprovechar estos diferentes formatos en tu organización, con el fin de asegurar que tu equipo cuente con el acceso que necesita sin renunciar a la seguridad ni a la facilidad de uso. La capacidad que tiene HelpNDoc para crear múltiples formatos de documentación hace que sea ideal para diversos supuestos y restricciones, ofreciendo una solución integral para cubrir todas tus necesidades de documentación.
