Creación de manuales en línea
La creación de manuales en línea es uno de los formatos de documentación más populares en la actualidad. Con la herramienta profesional de autoría de ayuda, puede convertir su proyecto en un conjunto de archivos HTML listos para cargar en su servidor, sin necesidad de programación.
Publique su guía de usuario en línea y los clientes potenciales podrán explorar las funciones de su software incluso antes de descargarlo. Una guía en línea bien elaborada genera confianza entre los prospectos y puede mejorar el posicionamiento de su sitio en los motores de búsqueda.
¿Cómo crear una guía en línea con Dr.Explain?
No necesita conocer HTML o CSS para publicar ayuda en línea. Simplemente cree un proyecto desde el menú principal y describa los temas de su futura guía en línea. Si prefiere no diseñar la estructura usted mismo, puede utilizar una de las plantillas predefinidas de guías de usuario.
Añada su contenido — texto e imágenes que describan las funciones de su software — utilizando el editor de Dr.Explain y sus herramientas de anotación automática. Personalice el estilo de su guía sin salir de la aplicación. Elija entre temas predefinidos o cree el suyo propio usando CSS. También puede ajustar el aspecto de su guía en línea directamente en el modo de vista previa.
Una guía basada en web debe incluir una tabla de contenidos para una navegación rápida, donde cada página se centre en un tema específico y enlace a temas relacionados. También incluye funciones de navegación integradas, como enlaces "Siguiente", "Anterior" e índice. Cuando su guía esté lista, simplemente expórtela y cárguela en su servidor. Dr.Explain gestiona estos pasos finales sin esfuerzo.
Ejemplos de manuales en línea creados en Dr.Explain
Esta página proporciona ejemplos reales de manuales de usuario. También puede ver ejemplos de guías de ayuda basadas en web creadas con la aplicación.
¿Cuáles son las ventajas de usar Dr.Explain?
Los ejemplos anteriores muestran solo algunos de los posibles estilos de diseño. Sin escribir una sola línea de código, puede implementar una amplia variedad de soluciones de diseño para su guía en línea. Dr.Explain también ofrece:
Diseño responsivo. Cree ayuda en línea que se adapte automáticamente a dispositivos móviles, sin necesidad de programación.
Integración de analíticas web. Agregue código de análisis para recopilar estadísticas que lo ayuden a identificar las fortalezas y debilidades de su documentación personalizada para una mayor optimización.
Soporte para código externo. Incruste widgets y otros elementos para hacer sus guías de usuario más visuales e interactivas.
Servicio en la nube vs. Dr.Explain: una comparación
Muchos equipos utilizan plataformas basadas en la nube (SaaS) para escribir documentación. Estos servicios ofrecen beneficios claros, como la accesibilidad desde cualquier lugar, el control de versiones integrado y el soporte multiplataforma. Sin embargo, las aplicaciones de escritorio como Dr.Explain siguen siendo muy relevantes. A continuación, se muestra una comparación al crear guías de ayuda en línea:
| Plataforma SaaS | Aplicación de escritorio Dr.Explain | |
|---|---|---|
| Funcionalidad sin conexión | — | + |
| Seguridad de los datos | Puede escapar al control del usuario. Depende del proveedor, del navegador, de la política de seguridad y de la protección de datos del servicio en la nube. | Está bajo el control del usuario. |
| Rendimiento | Depende de la conexión a Internet. | Depende del rendimiento del PC. |
| Anotación automática de capturas de pantalla | Depende del servicio; puede ser limitada. | + |
| Formatos de salida | Manuales en línea, a veces PDF. | HTML, CHM, DOCX, PDF. |
En ciertas situaciones, las características de las plataformas en la nube pueden considerarse ventajas. La elección entre una solución SaaS y una aplicación de escritorio para PC depende, en última instancia, de sus requisitos específicos de seguridad, accesibilidad y control de datos.
¿Para qué tipo de usuarios es adecuado Dr.Explain?
Dr.Explain es una herramienta versátil, adecuada para crear manual de usuario en cualquier campo. Definitivamente vale la pena probarla si necesita:
- un rendimiento potente que maneja documentos de cualquier tamaño sin problemas;
- navegación sencilla a través de su proyecto;
- búsqueda con todas las funciones;
- herramientas de diseño flexibles para personalizar el aspecto de su documentación;
- exportación multifomato directa;
- funciones de colaboración para proyectos en equipo;
- una solución local confiable (software de escritorio).
Lo que dicen los usuarios sobre la creación de guías en línea en Dr.Explain
"Dr.Explain funciona de manera excelente, y ya hemos convertido nuestro gran proyecto de ayuda en línea a su formato".
Jim, CNCSimulator Company
"Considero que Dr.Explain funciona mejor para nuestro sector industrial y proporciona la "sensación de libro" en un formato en línea, lo que parece funcionar bien para nuestros clientes que no son técnicos".
Darryl Winder, director gerente y copropietario del proyecto SmartFees
"La opción de publicar fácilmente nuestra documentación en línea también nos es muy útil. Construimos tanto una versión estática de la documentación que se incluye con la instalación del software como una versión en línea que siempre está actualizada con los últimos cambios".
Are Tømmerås, Geólogo Senior en Migris
Preguntas frecuentes
¿La guía en línea estará optimizada para dispositivos móviles?
Sí. La guía de usuario se genera automáticamente con un diseño responsivo y se mostrará correctamente en teléfonos y tabletas desde el principio.
¿Necesito conocimientos técnicos para crear una guía web?
No. Simplemente escriba su contenido como cualquier otro documento: Dr.Explain lo convierte automáticamente en una guía de usuario HTML lista para la web, preparada para publicar en línea.
¿Qué es el formato HTML?
HTML es el formato estándar para crear páginas web. Cuando exporte su manual de usuario a HTML, obtendrá una guía de usuario en línea completa lista para publicar.
¿Qué es CSS?
CSS es el lenguaje que controla la apariencia de las páginas HTML. Por ejemplo, puede usarlo para cambiar los fondos de página, fuentes, espaciado y mucho más.