El PHP(preprocesador de hipertexto) es un potente lenguaje de creación de scripts del lado del servidor que lleva décadas siendo una herramienta esencial para el desarrollo web. Con su capacidad para generar contenido dinámicamente, mejorar la experiencia de usuario, gestionar restricciones de seguridad, aumentar la interactividad o recopilar datos de usuario, se trata de una gran adición para la documentación de usuario online. Gracias al potente y versátil sistema de plantillas de HelpNDoc, ahora es fácil sacar partido a todas estas ventajas: exploremos cómo la incorporación de PHP a la documentación de usuario online puede ayudar a mejorar la experiencia de usuario y ofrecer más participación y mejor retroalimentación.
Los archivos de ayuda CHM se utilizan para crear documentación y archivos de ayuda en línea para aplicaciones de software, plugins y drivers, y suelen ser distribuidos con instaladores de Windows. Hay programas de terceros, como HelpNDoc, una herramienta de software de creación de documentación de ayuda especializada, que permiten crear archivos de ayuda CHM más rápida y fácilmente. Utilizar otros programas para crear archivos de ayuda CHM puede presentar una serie de ventajas por comparación con crearlos en el programa HTML Help Workshop integrado que ofrece Microsoft, ya que incluyen una interfaz gráfica intuitiva, potentes funciones, herramientas que permiten ahorrar tiempo y flexibilidad, lo que agiliza y optimiza la creación de archivos de ayuda CHM de aspecto profesional.
A la hora de crear archivos de ayuda, manuales de usuario, páginas web de documentación o eBooks, Microsoft Word no es la mejor herramienta para realizar el trabajo. De hecho, utilizarlo puede ser un verdadero martirio y rara vez produce resultados satisfactorios: gestionar múltiples documentos interconectados con Microsoft Word es bastante pesado, proclive a errores y requiere mucho tiempo. Una herramienta de creación de documentación de ayuda (HAT), como HelpNDoc, es mucho más fácil, rápida (y por tanto barata) de utilizar.
Administrar elementos audiovisuales como imágenes en todos los archivos de ayuda, proyectos de documentación o eBooks puede ser una tarea muy pesada, motivo por el que la herramienta de creación de ayuda HelpNDoc implementa una biblioteca centralizada: los elementos audiovisuales se gestionan desde la biblioteca del proyecto y los cambios se aplican automáticamente a todas las instancias en todo el proyecto.
Pero algunos ajustes (como las dimensiones, posiciones o textos alternativos) se pueden personalizar para cada instancia, lo que dificulta la actualización en el caso de los elementos usados con frecuencia.
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.
Aunque el formato RTF puede considerarse un formato de documento antiguo, es compatible con suficientes programas de software y sistemas operativos para ser considerado altamente portable y una gran opción para el intercambio de documentos entre plataformas. Gracias a la herramienta de creación de documentación de ayuda HelpNDoc, puedes producir tus proyectos de documentación no solo como documentos DocX de Microsoft Word, sino también como documentos RTF completamente válidos, lo que te da una gran elección de opciones de generación de formatos de documentos.
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.
Los escritores técnicos pasan gran cantidad de tiempo comprobando que el contenido que están redactando sea relevante, clara y concisa, para no tener que malgastar tiempo utilizando su software de creación de documentación de ayuda favorito cuando deban realizar tareas comunes, como por ejemplo crear hipervínculos. Por suerte, la herramienta de creación de documentación de ayuda HelpNDoc ofrece múltiples formas de acelerar la creación de hipervínculos, ayudando así a los escritores técnicos a dedicar su tiempo a lo que de verdad importa: redactar un contenido extraordinario.
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.
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.
