Publicación de documentación de productos con Docsie

Avatar of Author
Tal F.
on June 30, 2021 · · filed under Product Documentation AI Product Management Documentation Portals Technical Writing

Hola a todos

En mi último vídeo hablé sobre cómo crear documentación de productos y editarla. También les mostré cómo incrustar vídeos, imágenes, medios de comunicación, así como el código para que pueda crear la documentación del producto para que pueda educar aún más a sus clientes acerca de sus plataformas técnicas y soluciones.

Ahora quería tomar una inmersión profunda en Docsie plataforma de documentación de producto y le mostrará cómo crear documentación de software simple y fácil.

Aquí está un tutorial rápido para explicar cómo publicar con Docsie.

Publicar con el portal de conocimiento de Docsie se puede hacer de varias maneras. En este vídeo explico cómo publicar con los portales de conocimiento de Docsie, libros, estanterías o artículos con una simple línea de código.

En este ejemplo quería publicar este libro específico llamado 'Writing your first Django app, part 2'.

Como se puede ver en mi actual documentación de software ya creado que he escrito una versión llamada "Marca nuevo portal que estoy trabajando" y si hace clic en la herramienta 'lápiz' cerca de él usted tiene la opción de hacer que su portal publicado 'activo' o 'principal' o desactivar estas características. que es impresionante porque eso significa que usted y su equipo puede escribir su o actualizar su documentación y no tenerlo visible para sus clientes o clientes hasta que esté listo para tenerlo publicó su documentación del producto creado en la producción en su sitio web:

Ahora que ya está listo para publicar, ¡es el momento de desplegar su documentación! Esto se hace fácilmente haciendo clic primero en los tres puntos en la esquina superior derecha de la plataforma Docsie, y luego haciendo clic en su cuenta:

Una vez que estés en tu página de Perfil y configuración, haz clic en la pestaña "Implementaciones". Esto te llevará a la página de implementación y te ayudará a crear el código de incrustación que se colocará en tu sitio web.

Ahora haga clic en "Configurar un nuevo despliegue +"

Perfecto. Ahora que tienes acceso al panel de control todo lo que necesitas hacer es desplegar un dominio personalizado, esto se hace fácilmente abriendo la pestaña "Desplegar un dominio" y haciendo clic en "Despliegue personalizado".

Los dos pasos siguientes son muy sencillos:

  1. El primer paso es escribir su dominio (y recuerde utilizar http:// o https:// antes de escribir su nombre de dominio)

  2. el segundo paso es elegir lo que quieres publicar, tienes la opción de publicar, un Libro o una Estantería entera. En este ejemplo estoy publicando un libro con el título: 'Writing your first Django app, part 2'.

¡Genial! Ahora el último paso es antes de obtener nuestro código es hacer clic en "+Más Opciones"

Ahora puede utilizar nuestros diversos plugins, funciones y otras opciones de documentación para dar vida a su portal de conocimiento y hacerlo más práctico para sus usuarios. Estas funciones, plugins y herramientas de documentación de productos son bastante ingeniosos y hacen que sus portales de conocimiento sean más robustos.

nota: puede cambiar estas características adicionales y plugins y otras herramientas de documentación del producto en cualquier momento.

Una vez hecho esto, haga clic en "Crear portal web".

Ahora desplázate hasta la parte inferior y haz clic en "+ Obtener script de despliegue".

Y copia tu script y pégalo en tu HTML:

Ahora que tiene acceso a su script, puede darle un toque especial con nuestra guía del usuario de CSS, que le ayudará a crear un portal de conocimiento Docsie con estilo que se adapte a la apariencia de su marca. Por favor, revise nuestra guía de usuario de estilo en este enlace aquí: Guía de estilo de Docsie

Espero que haya disfrutado de este tutorial. Esté atento a los próximos tutoriales de Docsie.

Si tiene alguna pregunta sobre cómo Docsie puede ayudarle y quiere que le mostremos una demostración de nuestras herramientas, no dude en Haga clic aquí para reservar una demostración con nosotros.


Subscribe to the newsletter

Stay up to date with our latest news and products