Documentación del producto Guía definitiva: todo lo que necesita saber para crear excelentes documentos

Documentación del producto... Puede que no sea la parte más sexy de administrar un negocio, pero es un área clave que no debe pasar por alto si desea que su negocio tenga éxito.

La creación de documentación de productos de alta calidad puede ayudarlo a que sus clientes tengan más éxito, reducir su carga de soporte y, en general, construir un mejor negocio.

Pero, ¿qué implica crear la documentación del producto? ¿Y cómo puede configurar su propia documentación en su sitio web?

Esas son solo algunas de las preguntas que responderemos en nuestra guía definitiva para la documentación del producto. Aquí está todo lo que cubriremos:

• Por qué debería preocuparse por la estrategia de documentación de su producto
• Algunos ejemplos reales de documentación de primer nivel
• El mejor software de documentación de productos.
• Ocho consejos para crear una mejor documentación

¿Está listo para mejorar la forma en que su empresa maneja la documentación? ¡Vamos a profundizar en!

Por qué debería preocuparse por la estrategia de documentación de su producto

Comencemos con un vistazo a por qué no debe escatimar en su estrategia de documentación de productos.

Hace que sus clientes sean más exitosos

El mayor beneficio de crear documentación de productos es que hace que sus clientes tengan más éxito. Tener más clientes exitosos significa tasas de conversión más altas, tasas de abandono más bajas, etc.

Tiene sentido: si un cliente no puede descubrir cómo obtener valor de su producto, no seguirá siendo un cliente por mucho tiempo.

La documentación del producto es una forma útil de educar a los clientes para que puedan obtener el mayor valor posible. Cuando obtienen más valor de su producto, es más probable que continúen pagando, lo recomienden a sus amigos/colegas, etc.

Reduce su carga de apoyo

La documentación del producto también puede ser una excelente manera de reducir la carga en sus canales de soporte humano.

Si la documentación de su producto es de baja calidad o inexistente, eso significa que sus clientes deben comunicarse con su equipo de soporte humano cada vez que haya un problema. Eso significa más tiempo dedicado a responder a las solicitudes de soporte.

Necesitará tomarse un tiempo para hacer crecer su negocio para manejar estas respuestas usted mismo o deberá contratar a una persona de apoyo dedicada ( que cuesta dinero ).

Con documentación de alta calidad, los clientes podrán resolver muchos de sus propios problemas, lo que elimina la necesidad de que busquen soporte. También puede estructurar sus procesos de soporte para impulsar a las personas a verificar su documentación antes de realizar una solicitud.

Puede ser una buena herramienta de marketing y ventas

Si bien muchas personas piensan en la documentación del producto en el contexto de ayudar a las personas que ya han decidido realizar una compra, una buena documentación del producto también puede ayudarlo a atraer y convertir a más clientes en primer lugar.

Desde una perspectiva de marketing, la documentación del producto es una mina de oro de palabras clave de SEO de cola larga para las que puede clasificar su documentación. Es posible que se sorprenda de la cantidad de personas que acceden directamente a la documentación de su producto de Google. Si estructura bien su documentación, tendrá la oportunidad de convertir a estas personas en clientes.

Su documentación también puede ser una herramienta de ventas útil para las personas que están indecisas sobre la compra de su producto. La documentación del producto puede abordar posibles preguntas previas a la venta que puedan tener, convencerlos de que su producto puede hacer lo que necesitan y darles la confianza de que obtendrán ayuda cuando la necesiten.

Por ejemplo, Stripe es conocido por tener una de las mejores documentaciones de productos. Si vas a Twitter, puedes ver a mucha gente recomendando Stripe debido a la calidad de la documentación de Stripe:

Hace que sus empleados sean más efectivos

La documentación del producto no es solo para los clientes, también puede ser un recurso importante para que los miembros de su equipo aprendan sobre su producto y referencia cuando sea necesario. Esto es especialmente cierto para los nuevos empleados, que pueden no tener una amplia base de conocimientos sobre su producto.

Cuatro grandes ejemplos de documentación de productos de la vida real

Para brindarle más inspiración, veamos algunos ejemplos de documentación de productos del mundo real de compañías exitosas.

1. Raya

Anteriormente mencionamos a Stripe como uno de los mejores ejemplos de documentación de calidad como herramienta de marketing/ventas, por lo que sabe que la documentación de Stripe debe ser la número uno en nuestra lista.

2. Adyén

Adyen es una plataforma de pagos para pagos de comercio electrónico, dispositivos móviles y puntos de venta. Al igual que Stripe, eso significa que los desarrolladores deben integrarlo en sus propias plataformas, lo que requiere una excelente documentación. Adyen no decepciona: consulte la documentación completa de Adyen aquí.

3. Twilio

Si no está familiarizado con Twilio, es una herramienta que ayuda a las empresas a crear comunicación en sus plataformas, a través de mensajes de texto, correos electrónicos, llamadas telefónicas y más. Al igual que con Stripe y Adyen, esto significa que las empresas deberán integrar Twilio en sus servicios existentes, lo que requiere una documentación de primer nivel. Puede navegar por los documentos de Twilio para ver un excelente ejemplo.

4. Holgura

Slack es otra herramienta que tiene una documentación muy bien escrita y útil. Puede explorar la documentación completa de Slack aquí.

Para ver más ejemplos, consulte nuestra publicación completa sobre los mejores ejemplos de documentación de usuario.

El mejor software de documentación de productos

Ahora, analicemos cómo puede comenzar a ofrecer una mejor documentación del producto en su sitio.

Hablaremos sobre cómo escribir su documentación en la siguiente sección. Sin embargo, antes de que pueda escribir su documentación, necesita un lugar para almacenar esos artículos y hacerlos accesibles para sus usuarios.

Si bien puede agregar estos artículos directamente a su sitio, es una idea mucho mejor usar un software de documentación de productos dedicado. Más allá de organizar su contenido y hacerlo accesible para los visitantes, un buen software de documentación de productos incluirá otras características útiles como...

• Funciones de búsqueda Ajax para ayudar a los visitantes a navegar por la documentación.
• Análisis de búsqueda para que pueda ver qué temas está buscando la gente.
• Datos de utilidad para que pueda realizar un seguimiento de la utilidad de cada artículo individual y mejorar cuando sea necesario.

Aquí hay dos de las mejores soluciones...

Base de conocimiento heroica (KB heroica)

Heroic Knowledge Base es un complemento para el software gratuito de código abierto de WordPress que le permite crear fácilmente su propio centro de documentación de productos autohospedado.

Si ya usa WordPress para el sitio web de su empresa, puede agregar Heroic Knowledge Base a su sitio para crear su propio centro de documentación. O, si no lo hace, puede crear una instalación de WordPress dedicada para su documentación. En este último caso, también te puede interesar el tema de documentación de KnowAll WordPress .

Heroic Knowledge Base le permite agregar toda su documentación utilizando el editor de contenido de WordPress, lo que facilita la inclusión de contenido multimedia si es necesario. También obtendrá acceso al sistema de control de versiones de contenido integrado de WordPress, que le permite realizar un seguimiento de los cambios y comparar versiones anteriores de su documentación.

Heroic Knowledge Base también agrega una serie de características útiles que incluyen:

• Búsqueda instantánea de Ajax.
• Análisis de búsqueda.
• Calificaciones de utilidad del artículo.
• Archivos adjuntos del artículo.

Heroic Knowledge Base cuesta solo $ 129.

Adobe RoboAyuda

Si solo está publicando su documentación en la web, todo lo que necesita es una solución como Heroic Knowledge Base. Sin embargo, para más necesidades de documentación de nivel empresarial, es posible que tenga situaciones en las que necesite publicar su documentación en múltiples plataformas, incluida la web, papel físico, aplicaciones móviles, archivos PDF, etc.

En este caso, es posible que prefiera una herramienta de creación de documentación multiplataforma como Adobe RoboHelp. A partir de $ 29.99 por mes para uso individual, es más caro que Heroic Knowledge Base. Sin embargo, si necesita la autoría multiplataforma, ese precio adicional podría valer la pena.

Cómo optimizar la estructura y el contenido de la documentación de su producto

Ahora que tiene el software necesario para administrar su documentación, hablemos de cómo puede escribir artículos de alta calidad. Aquí hay ocho consejos clave para estructurar su documentación y escribir mejores artículos de ayuda...

1. Comprende a tu audiencia

Para escribir una excelente documentación de productos, debe comprender la audiencia para la que está escribiendo (es decir, sus clientes).

Para quién está escribiendo afectará qué información incluye y cómo estructura todo. Por ejemplo, si está escribiendo para desarrolladores, su documentación debería ser radicalmente diferente de la que se escribe para usuarios casuales.

No desea asumir que su audiencia es experta y pasar por alto los detalles clave, pero puede asumir algunos conocimientos básicos dependiendo de quiénes sean.

2. Comprender los diferentes tipos de documentación de productos

Hay diferentes tipos de documentación de productos y cada uno requiere un enfoque diferente. Algunos de los tipos comunes son:

• Descripciones generales : estos artículos brindan una descripción general de cómo funciona un área de su producto, como una guía de "Introducción".
• Tutoriales paso a paso : estos artículos muestran a las personas cómo realizar una tarea específica.
• Referencia : estos artículos explican conceptos específicos de su producto.
• Solución de problemas: estos artículos explican cómo depurar/solucionar problemas comunes que los clientes pueden encontrar.

El tipo de documentación en la que está trabajando debe afectar la forma en que escribe y estructura su documentación, por lo que es importante saber cuál es el objetivo antes de profundizar.

3. Sea consistente en su estilo y convenciones de nombres

Para que la documentación de su producto sea más fácil de usar para sus clientes, es importante que mantenga el mismo estilo y las mismas convenciones de nomenclatura en toda su documentación. Esto hará que sea más fácil para los clientes seguir la documentación y evitar cualquier posible confusión.

Para ayudarlo a hacer esto, podría ser útil crear una guía de estilo para el formato y la terminología básicos.

4. Utilice un lenguaje sencillo y sea conciso

En igualdad de condiciones, el lenguaje corto y simple siempre es mejor que la ensalada de palabras. Su objetivo debe ser comunicar toda la información necesaria en la menor cantidad de palabras posible.

También debe evitar el uso de jerga o términos complejos siempre que sea posible. No todos sus clientes tendrán la misma base de conocimientos y es posible que algunos ni siquiera sean hablantes nativos del idioma de su documentación, por lo que mantener las cosas lo más simples posible garantiza que todos puedan obtener valor de su documentación.

5. Organice la documentación en artículos lógicos del tamaño de un problema

Para facilitar que las personas exploren su documentación y encuentren artículos para sus problemas específicos, debe dividir su documentación en segmentos lógicos. En general, cada artículo debe estar enfocado a resolver un problema específico.

Por supuesto, puede haber múltiples subproblemas dentro de ese problema principal, pero la idea es que no desea agrupar dos problemas completamente separados en el mismo artículo porque dificultará que las personas busquen esos temas y pueden confundirse cuando aterrizan en el artículo.

Sus clientes no leerán su documentación de manera lineal como si estuvieran leyendo un libro. En cambio, saltarán según el problema que estén encontrando en este momento. Dividir sus artículos en segmentos lógicos lo ayuda a tener en cuenta este comportamiento.

6. Incorpora elementos multimedia

Si bien el texto escrito debe formar el núcleo de la documentación de su producto, no debe ser lo único. También puede ser útil incluir contenido de imágenes y videos donde tenga sentido.

Si incluye capturas de pantalla, también puede agregar anotaciones a las imágenes para aclarar detalles clave.

7. Use encabezados y agregue una tabla de contenido

Dentro de los artículos de documentación de productos individuales, asegúrese de usar encabezados para dividir sus artículos en segmentos lógicos en lugar de simplemente escribir una larga pared de texto.

Para ayudar a las personas a navegar por el artículo, también puede agregar una tabla de contenido que permita a los lectores saltar rápidamente a una sección específica.

Algunos software de documentación de productos pueden ayudarlo a agregar automáticamente una tabla de contenido. Por ejemplo, el complemento Heroic Knowledge Base viene con una función integrada para generar automáticamente una tabla de contenido basada en los títulos de cada artículo.

8. Mejora y actualiza siempre tu documentación

Finalmente, es importante recordar que la creación de la documentación del producto no es un evento de una sola vez; es un proceso continuo.

En un nivel básico, su producto probablemente sufrirá cambios, por lo que es importante que actualice su documentación para tener en cuenta esos cambios y cualquier característica nueva que haya agregado.

Pero más allá de eso, si elige un software de documentación de productos como Heroic Knowledge Base, obtendrá acceso a análisis para ayudarlo a comprender cómo las personas usan su documentación. Puede utilizar estos análisis para:

1. Realice un seguimiento de lo que buscan las personas, lo que puede ser una señal de que necesita crear documentación sobre esos temas si aún no lo ha hecho.
2. Vea qué artículos no están ayudando a los usuarios tanto como le gustaría, lo que podría ser una señal de que necesita realizar mejoras en esos artículos para mejorar su utilidad.

¡Empiece hoy mismo a crear una impresionante documentación de productos!

La creación de documentación de productos de alta calidad es una inversión en el éxito a largo plazo de su negocio. Esto te ayuda…

• Haga que sus clientes tengan más éxito.
• Reduzca la carga de su equipo de soporte.
• Atrae y convierte a más clientes en primer lugar.
• Mejora el conocimiento de tus empleados sobre tu producto.

En esta publicación, compartimos algunos excelentes ejemplos de documentación de productos de empresas exitosas junto con algunos consejos sobre cómo escribir y estructurar su documentación.

Si está listo para crear su propio centro de documentación de productos, puede usar el complemento Heroic Knowledge Base para crear su propia solución autohospedada con tecnología de WordPress. Haga clic para obtener más información sobre la base de conocimientos heroica.