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

Documentación del producto … Puede que no sea la parte más sexy de un negocio, pero es un campo clave que no debe pasar por alto si desea que su negocio tenga éxito. La creación de documentación de alta calidad puede ayudarlo a hacer que sus clientes sean más exitosos, reducir su tarea de asistencia y, en general, crear un mejor negocio. Pero, ¿qué sucede en la creación de la documentación del producto? ¿Y cómo puede configurar su propia documentación en su sitio web? Estas son solo algunas de las preguntas que responderemos en nuestra guía final para la documentación del producto. Aquí está todo lo que cubriremos:
¿Por qué debería preocuparse por la estrategia de documentación del producto?
Algunos ejemplos reales de la documentación superior
Mejor software de documentación de productos
Ocho consejos para crear una mejor documentación
¿Está listo para mejorar la forma en que su negocio administra la documentación? ¡Penetamos! ¿Por qué debería preocuparse por la estrategia de documentación de su producto para comenzar las cosas con por qué no debe rayar con la estrategia de documentación del producto? Hace que sus clientes sean más exitosos el mayor beneficio de crear documentación del producto es que hace que sus clientes sean más exitosos. Tener clientes más 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 durante mucho tiempo. La documentación del producto es una forma útil de educar a los clientes para que obtengan el mayor valor posible. Cuando obtenga más valor de su producto, es más probable que continúen pagando, recomendar a sus amigos/colegas, etc. Reduce su tarea de soporte, la documentación del producto también puede ser una excelente manera de reducir la tarea de sus canales de asistencia humana. Si la documentación de su producto es de baja o no existente calidad, significa que sus clientes deben comunicarse con el equipo de asistencia humana cada vez que hay un problema. Esto significa que se dedica más tiempo a responder a las solicitudes de asistencia. Tendrá que tomar el tiempo de desarrollar el negocio para administrar estas respuestas solo, o tendrá que contratar a una persona de asistencia dedicada (costar dinero). Con documentación de alta calidad, los clientes podrán resolver muchos de sus propios problemas, lo que elimina la necesidad de solicitar asistencia. También puede estructurar sus procesos de asistencia para impulsar a las personas a verificar su documentación antes de hacer una solicitud. Puede ser una buena herramienta de marketing y ventas, mientras que muchas personas piensan en documentar el producto en el contexto de ayudar a las personas que ya han decidido hacer una compra, una buena documentación del producto también puede ayudarlo a atraer y convertir a muchos clientes primero.
Desde el punto de vista del marketing, la documentación del producto es una mina de oro SEO de larga cola para la cual puede clasificar su documentación. Es posible que se sorprenda por la cantidad de personas que llegan a la documentación del producto desde 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 en una cerca en la compra de su producto. La documentación del producto puede responder a las posibles preguntas de presentación que pueden tener, puede convencerlas de que su producto. Puede hacer lo que necesitan y puede Déles la confianza de que recibirán ayuda cuando la necesiten. Por ejemplo, Stripe se conoce porque tiene algunas de las mejores documentación del producto. Si accede a Twitter, puede ver a muchas personas que recomiendan Stripe debido a la calidad de la documentación de Stripe:
Hace que sus empleados la documentación de productos más eficiente no sea solo para los clientes, sino que también puede ser un recurso importante para que los miembros de su equipo se enteren de su producto y referencia cuando sea necesario. Esto es especialmente cierto para los nuevos empleados, que pueden no tener una amplia base de conocimiento sobre su producto. Cuatro excelentes ejemplos de documentación de productos de la vida real para brindarle más inspiración, para ver algunos ejemplos de documentación de productos en el mundo real desde Empresas exitosas.
1. Fuera

Mencioné Stripe anteriormente como uno de los mejores ejemplos de documentación de calidad como una herramienta de marketing/ventas, por lo que sabe que la documentación de Stripe tenía que ser la número uno en nuestra lista. 2. Adyenadyen es una plataforma para pagos para el comercio electrónico, pagos móviles y en el punto de venta. Al igual que Stripe, esto 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 un instrumento que ayuda a las empresas a construir 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 tendrán que integrar a Twilio en sus servicios existentes, lo que requiere la documentación superior. Puede navegar por los documentos de Twilio para ver un gran ejemplo.

4. Debilidad

Slack es otra herramienta que tiene una documentación muy bien escrita y útil. Puede explorar toda la documentación de Slack aquí. Para ver más ejemplos, vea nuestra publicación completa sobre los mejores ejemplos de examen para el usuario. El mejor software de documentación de productos ahora, pasemos a cómo puede comenzar a ofrecer una mejor documentación del producto en su sitio. Hablaremos sobre la escritura real 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.

Aunque solo puede agregar estos elementos directamente a su sitio, es una idea mucho mejor usar un software dedicado para documentar el producto. Más allá de organizar el contenido y hacer que sea accesible para los visitantes, un buen software de documentación de productos incluirá otras características útiles, como … AJAX Funciones de búsqueda para ayudar a los visitantes a navegar por la documentación.
Busque análisis para que pueda ver qué temas están buscando la gente.

Datos de utilidad para que pueda rastrear cuán útil es cada elemento y mejorar cuando sea necesario.
Aquí hay dos de las mejores soluciones …
Base de conocimiento heroico (Heroic KB)
Heroic Knowledge Base es un complemento gratis, WordPress Open Software, 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 propio centro de documentación. O, si no, puede crear una instalación dedicada de WordPress para su documentación en el último caso, también puede estar interesado en el tema de Knowall WordPress.
La base de conocimiento heroico le permite agregar toda la documentación utilizando el editor de contenido de WordPress, que facilita la inclusión del contenido multimedia si es necesario. También tendrá acceso a la versión construida de WordPress Content, que le permite seguir fácilmente los cambios y comparar las versiones anteriores de su documentación.
La base de conocimiento heroico también agrega una serie de características útiles que incluyen:
Búsqueda instantánea de AJAX.

Análisis de búsqueda. Valores de utilidad del artículo.

Archivos adjuntos al archivo de elemento.
La base de conocimiento heroico cuesta solo $ 129. Adobe robohelp
Si solo publica su documentación en la web, una solución como Heroic Knowledge Base es todo lo que necesita. Sin embargo, para obtener más necesidades de documentación a nivel empresarial, puede tener situaciones en las que debe publicar su documentación en múltiples plataformas, incluidas la web, el papel físico, las aplicaciones móviles, los PDF, etc. En este caso, es posible preferir un instrumento para crear múltiples plataformas, como Adobe RoboHelp. A partir de $ 29.99 por mes para uso individual, es más costoso que la base de conocimiento heroico. Sin embargo, si necesita la creación en varias plataformas, este precio adicional puede valer el dinero. Cómo optimizar la estructura y el contenido de la documentación del producto Ahora que tiene el software necesario para administrar su documentación, hable sobre cómo puede escribir artículos de alta calidad. Aquí hay ocho consejos clave para estructurar su documentación y escribir elementos de mejor ayuda.
. Para quien escriba, afectará la información que incluye y cómo estructura todo. Por ejemplo, si escribe para desarrolladores, su documentación debe ser radicalmente diferente de la escrita para usuarios ocasionales. No desea asumir que su audiencia es expertos y supera los detalles clave, pero podría involucrar algunos conocimientos básicos, dependiendo de quiénes son. 2. Comprenda los diferentes tipos de documentación del producto Hay diferentes tipos de documentación del producto y cada uno requiere un enfoque diferente. Algunos de los tipos comunes son: Presentación general: estos artículos ofrecen una visión general de cómo funciona un área de su producto, como una guía de “nociones introductorias”.
Tutorial paso a paso: estos artículos muestran a las personas cómo realizar una determinada tarea.
Referencia: estos artículos explican conceptos específicos en su producto.
Solución de problemas: estos artículos explican cómo solucionar problemas/solucionar los problemas comunes que los clientes podrían cumplir.

El tipo de documentación en la que está trabajando debe afectar la forma en que escribe y cómo estructura su documentación, por lo que es importante saber cuál es el propósito antes de concentrarse. 3. Sea consistente en su estilo y convenciones de nombres para facilitar el uso de la documentación del producto por parte de los clientes, es importante mantener las mismas convenciones de estilo y nombre en toda la documentación. Esto facilitará a los clientes seguir su documentación y evitar cualquier posible confusión. Para ayudarlo a hacer esto, puede ser útil crear una guía de estilo para el formato básico y la terminología. 4. Use un lenguaje simple y manténgase conciso todas las cosas iguales, lenguaje corto, 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 usar la jerga o los términos complejos siempre que sea posible. No todos sus clientes tendrán la misma base de conocimiento y algunos pueden no ser hablantes nativos de su lenguaje de documentación, por lo que mantener las cosas lo más simples posible, asegurarse de que todos puedan obtener valor de su documentación 5. Organice la documentación en artículos lógicos, “El” tamaño del problema “. Para que las personas naveguen más fácilmente su documentación y encuentre artículos para sus problemas específicos, debe dividir su documentación en segmentos lógicos. En general, cada artículo debe centrarse en resolver un problema específico.
Por supuesto, podría haber más subproblemas en ese problema principal, pero la idea es que no desea agrupar dos problemas completamente separados en el mismo artículo, porque será difícil para las personas buscar esos temas. podría confundirse al aterrizar en el artículo. Sus clientes no leerán su documentación de manera lineal, como se leería un libro. En cambio, saltarán de acuerdo con el problema que enfrentan en este momento. La división de los artículos en segmentos lógicos lo ayuda a considerar este comportamiento. 6. Incorporar elementos multimedia Aunque el texto escrito debe formar el producto de la documentación del producto, no debería ser lo único. También puede ser útil incluir contenido de imagen y video donde tiene sentido. Si incluye capturas de pantalla, también puede agregar anotaciones a las imágenes para aclarar los detalles clave. 7. Use títulos y agregue un contenido en los elementos de documentación de productos individuales, asegúrese de usar títulos para dividir sus elementos en segmentos lógicos, en lugar de escribir solo una pared de texto largo. Para ayudar a las personas a navegar en el artículo, también puede agregar un contenido que permita a los lectores saltar rápidamente a una determinada sección. Algunos software de documentación de productos pueden ayudarlo a agregar un contenido automáticamente. Por ejemplo, el arado de la base de conocimiento heroico viene con una función construida para generar automáticamente un contenido basado en los títulos de cada artículo. 8. Siempre mejore y actualice la documentación al final, es importante recordar que crear la documentación del producto no es un evento único; Es un proceso continuo. En un nivel básico, su producto
Probablemente se someterá a cambios, por lo que es importante actualizar 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 el software de documentación de productos, como Heroic Knowledge Base, tendrá acceso al análisis para ayudarlo a comprender cómo las personas usan su documentación. Puede usar estos análisis para: Siga lo que las personas buscan, lo que puede ser una señal de que debe crear documentación sobre estos temas, si aún no lo ha hecho.
Vea qué artículos no ayudan a los usuarios tanto como desee, lo que podría ser una señal de que debe hacer mejoras en esos artículos para mejorar su utilidad.
¡Empiece a crear una maravillosa documentación de productos hoy! Crear la documentación de alta calidad del producto es una inversión en el éxito a largo plazo de su negocio. Ayudarte …
Haga que sus clientes sean más exitosos.
Reduzca la tarea de su equipo de asistencia.
Atraer y convertir más clientes primero.
Mejorar el conocimiento de los empleados de su producto.
En esta publicación, compartí algunos excelentes ejemplos de documentación de productos de compañías exitosas, junto con algunos consejos sobre cómo escribir y estructurar la 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 autoguiada, alimentada por WordPress. Haga clic para obtener más información sobre la base de conocimiento heroico.