Numerosas empresas tecnológicas de SaaS luchan con el proceso de desarrollar y distribuir documentación de productos (manuales de usuario, guías de usuario y/o tutoriales) a sus consumidores.
A menudo, esto ocurre como resultado de una falta de conocimiento o proceso sobre el manejo y la producción adecuados de manuales, o incluso sobre quién es responsable de ellos.
Mientras exista la necesidad de herramientas y programas informáticos en este mundo, necesitaremos una comunicación eficaz para transmitir efectivamente a los demás el uso, el desarrollo, el funcionamiento y la arquitectura de estos bienes. Si se pregunta a qué se debe esto, la respuesta es sencilla. Se debe al hecho de que las habilidades de comunicación técnica son cruciales para recopilar información y permitir que la audiencia comprenda el producto o la tecnología con mayor eficacia.
Mientras que en el mundo real la comunicación se realiza mediante el habla, el lenguaje corporal y las expresiones emocionales, en el mundo virtual la comunicación técnica tiene lugar a través de la documentación técnica de los productos.
El único objetivo de la documentación técnica del producto es facilitar al usuario la comprensión de la dinámica de funcionamiento y la arquitectura de un producto y una tecnología. Es más bien como un manual de "cómo usar" para los nuevos trabajadores, usuarios/clientes y cualquier otra persona que tenga que conocer los métodos de trabajo, una descripción exhaustiva de los entresijos de un producto.
Es deber de los jefes de producto asumir la responsabilidad de desarrollar un equipo para crear, gestionar, publicar y mantener una documentación de producto pulida.
Estoy seguro de que todos los jefes de producto han dicho o han oído lo siguiente en su departamento: "La documentación del producto es un componente de las obligaciones del Product Owner"; "Cada equipo de desarrollo debe documentar sus propias apps"; "se ha desplegado la característica, ¿se ha actualizado el manual?" o, mucho peor, "hay un error en la documentación técnica".
Está claro que la documentación técnica de un producto puede resultar un tanto desconcertante por sencilla que parezca. Mientras las personas intentan resolver o discutir sobre las líneas del párrafo anterior, los manuales y tutoriales se deterioran, lo que va en detrimento de la imagen de su "producto/empresa".
Para ayudar a cualquiera que experimente problemas similares, he aquí algunos procedimientos a aplicar para optimizar la documentación de su producto.
¿Para qué sirve la documentación de un producto?
Cuando se habla de documentación de un producto o servicio tecnológico, se hace referencia a la información que lo describe y a los datos que le conciernen.
La documentación técnica, o documentación de producto, trata de ayudar a su público y a sus clientes a utilizar, leer, comprender y utilizar su producto. La mayoría de las documentaciones de productos, por supuesto, se producen en diversas áreas, como la ingeniería, la medicina, la tecnología de la información y el marketing.
Una buena documentación técnica de producto ayuda a su público a navegar por su producto y les permite utilizarlo sin complicaciones.
Otra consideración es que la documentación técnica es fundamental para la asistencia al cliente y contribuye significativamente a la imagen de marca y la confianza de su empresa. Cuando más lo necesitan, los usuarios buscan documentación técnica. El público utiliza su producto para conocer los procesos y resolver problemas.
Esto significa que es muy importante disponer de una documentación de producto exhaustiva, dinámica y con capacidad de búsqueda.
¿Cuáles son las diferentes documentaciones de producto?
Esta sección le permite ver qué tipo de documentación de producto necesita para sus clientes.
Existen muchos tipos diferentes de documentación de producto que satisfacen las necesidades de distintos tipos de casos de uso y necesidades de los usuarios:
Documentación de usuario del producto: Consiste en manuales de usuario, guías prácticas, tutoriales, preguntas frecuentes, notas de la versión y manuales de formación, así como procedimientos operativos.
Documentación corporativa: Las encuestas muestran que más de 8 de cada 10 empresas, de las 1000 encuestadas, utilizan políticas formales y manuales de procedimiento.
Hay muchos otros documentos corporativos que comprenden la documentación relativa a las políticas y procedimientos de las empresas, como se indica en la investigación anterior, manuales de instrucciones, prácticas técnicas, documentación ética y de comportamiento. Así como documentación legal que puede estar protegida por contraseña. También estructuras empresariales, buenas prácticas y procedimientos, así como manuales de mantenimiento.
Documentación para desarrolladores: este tipo de documentación proporciona instrucciones para el desarrollo de productos de software, especificaciones funcionales, especificaciones técnicas, documentación y herramientas para ayudar al flujo de trabajo de los desarrolladores.
Ahora que entendemos mejor los diferentes tipos de documentación técnica y de producto, vamos a discutir cuáles son los primeros pasos de una sólida gestión del proceso de desarrollo de la documentación del producto.
Localizar un responsable del desarrollo de la documentación del producto.
Una cuestión muy típica es determinar quién debe encargarse de la documentación del producto, no como alguien que se limita a actualizarla, sino como alguien responsable de la calidad y el éxito del producto.
Mientras que algunas empresas creen que cada propietario de producto y/o gestor de producto es responsable de la documentación del producto, a otros departamentos, como los de desarrollo y soporte, también se les puede confiar la responsabilidad de mantener actualizados y eficaces los manuales de usuario, las guías de usuario y todas las facetas de la documentación del producto.
El desarrollo de la documentación del producto tiene muchas partes móviles, pero aquí señalaremos dos de ellas:
-
Quién entiende el funcionamiento del producto a todos los niveles (esto incluye también a los equipos de desarrollo y especificaciones del producto).
-
Aquellos que reciben aportaciones de los clientes que revisan la documentación del producto y escuchan sus dificultades, comentarios y preocupaciones sobre la comprensión de la documentación del producto en cuestión.
La primera parte nos ayuda a crear la documentación del producto asignada con los conocimientos de que disponemos, y ésta se envía al cliente, que a su vez da su opinión e inicia el segundo proceso, que ayuda a optimizar la documentación.
A veces, estos dos puntos no están perfectamente coordinados, lo que da lugar a situaciones en las que la documentación del producto nunca recibe la atención necesaria.
Un enfoque consiste en designar a una persona responsable del "rendimiento" de la documentación del producto, los manuales del producto y las guías del usuario. Consideremos una orden de compra que tiene como producto "Documentación del producto". Es responsable de recorrer todos los equipos de la empresa, esbozar cómo genera cada producto sus guías e identificar los retos asociados a ese proceso.
La intención no es que este propietario de producto y gestor de producto sea enteramente responsable de generar y modificar manuales, sino ayudar a los individuos dentro de cada equipo en la con la gestión de documentos.
Esta persona debe estudiar cómo interactúan los usuarios con los documentos, ofrecer formas de hacer que las actualizaciones sean más fluidas y recabar opiniones para determinar cómo mejorar la documentación y las explicaciones de cada producto con su público objetivo.
Tener a alguien a cargo de todas las facetas de la documentación del producto, la gestión del flujo de trabajo, y los diferentes departamentos que se requieren para completar esta documentación aumentará la productividad dentro de la empresa, establecer la conciencia y educar a los clientes con portales de conocimiento sobre el producto y sobre todo agilizar la comprensión del producto.
Considere la documentación de su producto como el producto mismo.
Los productos existen para ofrecer un grado de valor que satisfaga o supere las expectativas del cliente. Según estadísticas generadas por D2WorldWide el 73,7% de las personas consideran que la documentación es más útil que los vídeos, el embalaje o los vendedores cuando buscan información sobre productos que están pensando en comprar.
Considere los factores que contribuyen al atractivo de un producto. Hay varios factores que pueden influir en el atractivo de un producto, pero en este artículo nos centraremos en tres. Superan las expectativas en términos de valor; su uso genera satisfacción; y son competitivos.
Además, los mismos conceptos se aplican a una buena documentación de producto en línea. Los documentos de producto que van "más allá del valor previsto" ilustran no sólo cómo utilizar el artículo especificado, sino que también ofrecen soluciones que el cliente desconoce o no cree posibles. Siempre es necesario ver cómo otras empresas inician la documentación de sus productos para aprender de sus aciertos y errores.
No tiene sentido tener una empresa que desarrolla un software único y de alta calidad que está por delante de la competencia si los desarrolladores y clientes que integran sus documentos técnicos de producto no son capaces de comprenderlos.
Piense que la persona que lee la documentación del producto puede no estar familiarizada con la gama de posibles soluciones que ofrece el producto o con el mercado (como suele ocurrir con los productos técnicos SaaS), por lo que hay que "educarla" sobre esas soluciones y las distintas opciones relacionadas con el producto.
Los documentos de producto cuya "usabilidad genera satisfacción" siguen un patrón de lectura lógico adecuado a su público objetivo. De nada sirve tener el manual más completo del mundo si es un PDF de 500 páginas o no incluye un ejemplo de código y no está creado dinámicamente con capacidades de búsqueda y otras funciones. Recopile información de los usuarios del documento de su producto y de su personal de asistencia. Ellos determinarán las principales áreas de tensión relacionadas con los datos comunicados.
La documentación de producto competitiva es la que se actualiza continuamente utilizando las técnicas de intercambio de información más eficaces. Disponen de funciones sorprendentes, como capacidades de búsqueda integradas, traducciones, diferentes versiones, imágenes incrustadas, vídeos y mucho más.
Aunque su guía de integración sea la mejor redactada de todas las empresas tecnológicas, carecerá de atractivo sin un vídeo añadido e imágenes y códigos que puedan copiarse y pegarse para facilitar su uso a los clientes expertos en tecnología que adquieran sus productos técnicos SaaS.
Siempre es necesario ver cómo inician sus trabajos otras empresas para aprender de sus aciertos y errores.
No tiene sentido tener una empresa que desarrolla un software único y de alta calidad que está por delante de la competencia si los desarrolladores y clientes que integran sus documentos no son capaces de captarlos en su totalidad.
Valoración de la documentación del producto
Una documentación técnica de producto eficaz mejora la experiencia del usuario final al pulir el proceso para comprender los productos y diagnosticar cualquier problema con soluciones escritas fácilmente disponibles. Cuando los clientes confían en sus productos y comprenden cómo utilizarlos, pueden volver a recurrir a usted en el futuro cuando surja la necesidad.
Una nueva investigación realizada por SDL demuestra que el papel de la documentación en los mercados mundiales está aumentando. La investigación muestra que alrededor del 53% de los compradores realizan compras utilizando documentación técnica antes de probar el producto. Además, otra estadística recopilada de esta investigación muestra que el 94% de los compradores considera que disponer de información sobre el producto en un único lugar es útil y provechoso. Por ello, hoy en día todas las empresas dan la misma importancia a la documentación del producto que al desarrollo o las pruebas del mismo.
Incluso si la documentación tiene un propietario designado que gestiona el equipo de documentación, han creado una documentación del producto que ha sido revisada y evaluada para mejorar su usabilidad, y ha sido debidamente actualizada, usted sigue luchando para que sus usuarios y consumidores comprendan sus productos técnicos. Esto puede deberse a la incapacidad de los usuarios/lectores para comprender cómo se leen sus documentos o las preguntas que realmente formulan. Esto hace que uno de los aspectos más desafiantes de la composición de documentos sea ponerse en el lugar del lector. Al fin y al cabo, quien elabora la documentación del producto debe tener un sólido conocimiento del mismo.
Esta experiencia puede hacer que el redactor pase por alto cosas que no son tan obvias para el usuario medio. Esto suele ocurrir cuando algo que es evidente para quienes crean el producto no lo es tanto para quienes lo compran y utilizan.
Esto puede ocurrir de varias maneras:
Estructura o forma de redacción: Aunque pueda parecer una palabra subjetiva, incluso la forma en que está escrito un manual puede crear confusión. Es fundamental identificar el tipo de lector que lee la documentación; de lo contrario, pueden aparecer frases como "Los desarrolladores prefieren los ejemplos al texto descriptivo" o "Nuestra documentación no es clara a pesar de la presencia de ejemplos y elementos visuales".
Organización temática de los manuales: En ocasiones, las empresas que operan en un mismo mercado desarrollan un formato de documentación estandarizado. Si las guías de tu empresa no se ciñen a él, el lector puede tener una sensación de extrañeza.
Uso excesivo de términos implícitos: Cuando se aplican a un manual, las abreviaturas pueden tener poco sentido, aunque las frases no sean siglas. Es difícil de percibir, pero algunas palabras, como "estatus", "id", "credenciales", y contienen un significado implícito disfrazado de explícito. Utilice denominaciones particulares, como "UserID", en lugar de "UID".
Traducción válida: la traducción es una parte enorme del alcance global. Muchas veces las empresas crean manuales de usuario y documentación de productos mal traducidos que no se ajustan a la cultura de ciertas naciones o simplemente las palabras no se traducen de la misma manera que lo harían en inglés a ese país en particular. Comprender estos sutiles matices puede hacer que la documentación del producto pase de ser una información ilegible a ser una documentación del producto completa y traducida.
Para evitar estas situaciones, el objetivo es desarrollar una solución que recoja y analice los comentarios de los usuarios y sus patrones de navegación.
Las herramientas de feedback, como la función Vocally a Docsie, son una excelente forma de recibir y evaluar los patrones de navegación y sondear cómo ven sus clientes la documentación de su producto. Conozca aquí las 7 reglas de oro de la recopilación de opiniones
Esta información es fundamental para actualizar y optimizar sus guías de usuario, manuales de usuario y documentación del producto para crear una experiencia más fluida para que sus clientes aprendan acerca de sus productos. No hay nada más frustrante que introducir un nuevo producto y descubrir un aumento de las solicitudes de asistencia debido a unas instrucciones manuales deficientes.
Cómo redactar una documentación de producto completa
Una documentación de producto de calidad es cautivadora, útil y poderosa. Yo diría que una documentación hábil es un componente necesario de una buena gestión de productos. Por mucho que los gestores de productos desempeñen un papel importante en el desarrollo de los productos, una parte significativa del éxito consiste en crear una documentación de producto asombrosamente pulida que nuestros clientes puedan comprender y utilizar para ampliar sus conocimientos sobre nuestros productos.
¿Qué ocurre con la mayor parte de la documentación de los productos?
Muchos jefes de producto son reacios a redactar documentos de producto. Los documentos de producto con los que están familiarizados pueden no tener tracción entre sus clientes a menos que se ponga más cuidado en hacerlos atractivos, fáciles de leer y de relacionarse con ellos.
Sin embargo, muchas veces las empresas no ponen el cuidado necesario en crear y elaborar una documentación de producto asombrosa. Una documentación de producto pobre se escribe con el único propósito de ser escrita. Emplea frases extensas llenas de pensamientos vagamente aceptables y un diseño pobre para disuadir a los espectadores de interactuar con el material. Una documentación de producto pobre se crea para proteger al autor de las críticas y es una completa pérdida de tiempo para todos. Y a sus clientes también les disgusta leerla por este motivo.
¿Cómo podemos solucionar esto y escribir una mejor documentación del producto que nuestros clientes disfruten leyendo?
Una documentación de producto excelente se escribe con la intención de ser leída. Es sucinta. Una buena documentación de producto está bien formateada y puede ser leída y comprendida por todos los miembros de la empresa o los clientes en tres minutos. Evita la jerga y ofrece o hace referencia a un punto de vista a nivel empresarial. Una documentación de producto excelente dedica tiempo a describir casos de uso concretos que los clientes puedan entender y aplicar al uso mejorado del producto. Atrae al lector y llama la atención sobre los problemas subyacentes con soluciones bien elaboradas.
La potencia de una documentación de producto bien escrita
En pequeñas, medianas o grandes empresas, una documentación técnica de producto bien redactada puede ahorrar mucho tiempo y ayudar a los empleados a trabajar de forma más productiva. Esto suele ocurrir en la mayoría de las empresas basadas en productos, que dedican un gran porcentaje de su presupuesto a contratar redactores técnicos y a redactar la documentación técnica de los productos.
Si su empresa emplea a más de dos personas para crear la documentación del producto, establecer una cultura de buena documentación merece totalmente la pena. Hay muchas razones por las que querría que su equipo creara, gestionara y publicara una documentación de producto bien elaborada, pero en la sección siguiente abordaremos cómo una documentación de producto eficaz es un enfoque de bajo coste para mejorar la experiencia del cliente.
La documentación eficaz del producto es un enfoque de bajo coste para mejorar la experiencia del cliente
Una experiencia de cliente sólida es la clave para mantener y fidelizar a los clientes. La mayoría de los gestores de proyectos son optimistas: captan un concepto, se entusiasman y luego lo ejecutan. Aunque la pasión es admirable y la ejecución parece productiva, es vital contar con un plan de juego antes de ejecutar la documentación adecuada del producto.
Los primeros pasos después de una lluvia de ideas sobre un plan de juego es iniciar un ciclo de diseño y estructurar el contenido de la documentación del producto de tal manera que sea progresivamente fácil de leer para sus clientes.
Además, es fundamental obtener la opinión de los clientes sobre la documentación actual para reestructurarla y adaptarla a sus necesidades. De este modo, los gestores de proyectos pueden crear, gestionar, mantener, publicar y optimizar su documentación con percepción y automatización. No se trata de una tarea sencilla y minúscula, y contar con herramientas increíbles como Docsie que automatiza gran parte de los procesos para que la documentación del producto sea eficaz es bastante esencial para el éxito.
Una documentación técnica atractiva, atrayente y navegable ayuda a los consumidores a aprender el producto en menos tiempo, lo que aumenta la probabilidad de que lo configuren y utilicen correctamente.
Todas estas estrategias de creación de una documentación de producto bien pulida conducirán esencialmente a productos mejor valorados, críticas más favorables y más ventas; por lo tanto, no hace falta decir que el aumento de las ventas como resultado.
Cómo crear una documentación de producto bien elaborada
¿Cómo elaborar una documentación eficaz y fomentar una cultura en la que sea la norma? Redactar una documentación eficaz es todo un reto, pero Docsie ofrece muchas funciones útiles que pueden ayudar a sembrar este proceso de creación de portales de documentación de productos dinámicos y bien elaborados. A continuación se presenta un resumen de alto nivel de cómo enfocamos la cuestión.
Ahora vamos a empezar:
Las limitaciones de páginas garantizan la legibilidad. Escribir un documento decente no debería ser difícil de leer y procesar mentalmente. Las frases largas y sinuosas suelen indicar falta de claridad. Si la comunicación no puede resumirse adecuadamente en una sola página, es un indicio de que el gestor de producto probablemente debería volver atrás y desglosar más la situación.
El formato mejora la calidad. Una documentación de producto mal estructurada aumenta las probabilidades de que el redactor se la juegue. Crea una plantilla con secciones, tablas y encabezados de documento bien formateados. Es una inversión única con un alto potencial de dividendos.
Las plantillas le ayudan a ahorrar tiempo. Es mucho más fácil eliminar una sección de una plantilla que acordarse de añadir una. No es condescendencia, sino eficacia y ahorro de tiempo. Las secciones sencillas que recuerdan al redactor que debe empezar por los antecedentes generales y concretar las medidas o los supuestos peligrosos permiten una redacción más precisa y una mayor jerarquía en las decisiones.
Comentar y asignar tareas No hay forma más segura de desmotivar a su personal para que no produzca documentación de alta calidad que no comentarla. Los comentarios no tienen por qué ser muy inteligentes; más bien deben indicar implicación y servir de modelo. Aunque lo ideal es proporcionar comentarios de forma digital para que otros miembros de la empresa puedan beneficiarse de la conversación de forma asíncrona, una sencilla función de Docsie que te permite comentar y colaborar con tu equipo funciona de maravilla para el equipo de documentación de productos.
Echa un vistazo a este blog para obtener más información sobre cómo Docsie ayuda con la colaboración de documentación de productos
https://www.docsie.io/blog/articles/collaboration-to-create-well-polished-product-documentation/
**A medida que aumenta el número de partes interesadas en el proceso de desarrollo de productos, la comunicación debe dividirse en varios documentos (sobre todo si se quiere cumplir el criterio de "concisión" de una página). Docsie constituye una solución útil y sostenible para los equipos de documentación de productos en crecimiento.
Utiliza Docsie para acelerar la creación de documentación de productos increíbles
Docsie es una plataforma muy práctica que le ayuda en todos los aspectos de la documentación de productos y la creación de portales de conocimiento. Tiene muchas funciones integradas que hacen que crear, publicar, mantener y gestionar proyectos de creación de documentación de productos sea realmente sencillo y divertido. Éstas son sólo algunas de las muchas funciones de Docsie que pueden ayudarle a alcanzar estos objetivos:
Posibilidad de editar: Docsie permite a todos nuestros usuarios editar la documentación del producto después de publicarla creando una versión alternativa que no saldrá en directo hasta que esté activa. Esto es impresionante porque los equipos de gestión de productos pueden trabajar en la edición y alteración de la documentación del producto y luego hacerlo en vivo una vez que estén listos para hacerlo, sin saltar a través de HTML y CSS aros. La documentación del producto se mostrará automáticamente cuando esté lista.
Posibilidad de búsqueda: Si la documentación de su producto es abundante o tiene muchas características, el plugin de búsqueda Docsies es un extra útil que permite a sus clientes buscar a través de su documentación de forma rápida y sencilla para encontrar la información que necesitan para acelerar el proceso en el que están previsualizando y absorbiendo información de la documentación de su producto.
Posibilidad de enlazar: Docsie hace que la documentación de su producto sea SEO amigable. Puede enlazar a determinadas páginas del sitio web de su empresa o simplemente escribir palabras clave basadas en sus productos, que podrán buscarse en línea y atraer a nuevos clientes que busquen el mismo producto que usted.
Posibilidad de tener diferentes traducciones: El avanzado traductor fantasma de Docsie permite a nuestros usuarios traducir la documentación de sus productos a varios idiomas. Además, con las funciones de selección de idioma de Docsie, sus clientes pueden elegir el idioma que más les convenga. Esto es muy útil para tener un alcance global y ampliar la base de clientes de las empresas, a la vez que se crea confianza con sus clientes recién fundados y clientes en el extranjero.
Posibilidad de asignar tareas y comentarios para una colaboración fluida: Docsie tiene herramientas increíbles para colaborar con su equipo de documentación de productos. Puede asignar comentarios, establecer tareas y asignar roles para que pueda gestionar mejor qué tareas se llevan a cabo por cada usuario que está trabajando en su proyecto de documentación del producto con Docsie. Para obtener más información, consulte este blog aquí
Generación de feedback: Ser capaz de saber lo que sus clientes están pensando acerca de su documentación es la única manera de saber cómo optimizar su documentación del producto para que coincida con las necesidades de sus clientes para que puedan comprender mo9re agradablemente sus documentaciones de productos y portales de conocimiento Para obtener más información acerca de la importancia de la retroalimentación documentación del producto por favor visite mi blog aquí.
También hay muchas otras características y capacidades que Docsie le permite a usted y a su equipo de gestión de productos utilizar para crear una documentación de producto increíble. En este artículo me gustaría hablar de los plugins que cada portal de conocimiento Docsie y la documentación del producto pueden añadir a sus documentaciones para mejorarlas y mejorar su usabilidad general.
Docsie tiene un montón de plugins que puede utilizar para hacer su documentación más atractiva. En este blog lo dividiré en 3 partes.
En esta sección dividiremos la explicación de estos plugins del portal de conocimiento en tres partes.
PARTE 1: En la primera parte mostraremos los plugins 'Display Version Picker', 'Display Language Picker', 'Display Section Anchors', y 'Display Footer Navigation'.
PARTE 2: En esta parte mostraremos el plugin 'Code Highlighting', 'Search', y el plugin 'Share to Social Network
PARTE 3: En la tercera parte mostraremos la 'Vista previa de imágenes', 'Metadatos del documento', y el plugin 'Auto-destacar sección'.
Antes de entrar en los plugins vamos a hablar de cómo acceder a estos plugins dentro de la Plataforma Docsie.
En primer lugar, dentro del espacio de trabajo, tenemos que hacer clic en los tres puntos en la esquina superior derecha y abrir nuestra cuenta:
A continuación, dentro de los despliegues podemos acceder a los plugins una vez que creamos un nuevo despliegue a través de "Configurar un nuevo despliegue +".
A continuación, haga clic en "Más opciones", lo que le permitirá añadir estos plugins a su documentación desplegada a través de un script integrado o a través del portal Docsie.
La otra opción es acceder a los plugins de los portales de conocimiento de Docsie a través del botón "Actualizar configuración de despliegue" situado debajo de su documentación ya publicada.
Se abrirá este panel de control y, a continuación, puede agregar o quitar plugins como mejor le parezca y, a continuación, actualizar la implementación.
PARTE 1:
Ahora que sabemos cómo acceder al Pluggin Docsie vamos a saltar en PARTE 1.
Con el fin de ver parte 1 video tutorial por favor echa un vistazo a este video aquí:
Empecemos con el "Selector de versión de pantalla" y el "Selector de idioma de pantalla".
Una vez que estos dos estén activos, aparecerán en la parte inferior izquierda de su portal de conocimiento como pestañas flotantes. Permiten a tus clientes y a aquellos que lean la documentación de tu producto ver los documentos en diferentes idiomas y versiones.
Una vez que el usuario pulsa el idioma en el selector de idioma, toda la documentación que está leyendo cambiará al idioma asignado.
Una vez activada, el anclaje Mostrar sección permite a su cliente disponer de enlaces junto a cada encabezado que le proporcionarán enlaces a determinadas secciones de la documentación.
Cada vez que se pulsen estos enlaces, cambiará parte de la cabecera y cuando su cliente copie y pegue este html, dirigirá a la persona a la que se lo está enviando, a esta sección específica de la documentación.
Lo siguiente es 'Mostrar navegación a pie de página'.
Este plugin añade un botón de navegación en la parte inferior derecha de tu Libro de documentación. Su aspecto es el siguiente
De este modo, sus clientes podrán navegar más cómodamente por su documentación.
PARTE 2:
Con el fin de ver Parte 2 video tutorial por favor echa un vistazo a este video aquí:
En esta parte mostraremos el plugin 'Code Highlighting', 'Search', y el plugin 'Share to Social Network
Ahora vamos a empezar con el plugin 'Code Highlighting
Este plugin es ideal para productos técnicos que necesitan expresar varios códigos a sus clientes. Este plugin permite a sus clientes copiar y pegar el código asignado para que puedan utilizarlo en su editor para facilitar su uso mediante la adición de un botón "Copiar".
Ahora vamos a sumergirnos en el plugin de búsqueda.
Una vez activado en el portal de conocimiento de Docsie, sus clientes pueden buscar en su documentación a través de una navegación de búsqueda en la esquina superior derecha del portal de conocimiento.
Al hacer clic en buscar, aparecerá un sofisticado panel de control que permitirá a sus clientes saber exactamente dónde encontrar determinada información en sus estanterías y libros.
Esto acelera enormemente el proceso en el que sus clientes pueden encontrar y recuperar la información que necesitan sobre sus productos.
El siguiente es el plugin Share To Social Networks
Este plugin permite a sus clientes tomar secciones destacadas de la documentación escrita de su producto y compartirlas en sus redes sociales.
Esto es fantástico porque puede aumentar el tráfico, los clientes potenciales y la confianza en su marca.
PARTE 3:
Para ver parte 3 video tutorial por favor revisa este video aquí:
En la tercera parte mostraremos los plugins 'Vista previa de imagen', 'Metadatos del documento' y 'Sección de resaltado automático'.
Comencemos con el plugin de vista previa de imágenes
La previsualización de imágenes permite a sus clientes acercar o alejar una imagen de la documentación de su producto para visualizarla mejor.
A continuación, "Metadatos de la documentación
esto permite a nuestros clientes ver una marca de tiempo cuando se ha actualizado la documentación del producto o aspectos del portal del conocimiento. Estará situado en la parte superior e inferior de la documentación escrita.
Ahora veamos el plugin 'Auto-Highlight Section Plugin
Este sencillo complemento permite a sus clientes saber en qué punto de la documentación se encuentran dentro del portal de conocimiento.
Resaltará cada ubicación en la que se encuentren, dentro del portal Knowledge, para que los clientes de yo8ru puedan saber mejor en qué sección se encuentran y navegar más fácilmente a través de otras secciones.
Todas estas herramientas y muchas más te las proporciona la plataforma de Docsie. Si no la has probado, te sugerimos que lo hagas. Haga clic aquí
Además, si tienes alguna pregunta, no dudes en ponerte en contacto con nosotros en hello@docsie.io