Crear documentación de producto SaaS para sus clientes

La documentación es el más rollo de rock de una compañía SaaS, ¿verdad? Probablemente no.

La documentación para su producto SaaS es crucial, aunque puede que no haya sido alta en su lista en el torbellino que es una puesta en marcha de SaaS.

Es algo más que un ahorro de costes para el servicio de atención al cliente. Puede que ya haya hecho algunos puñaladas al publicar alguna documentación, pero es hora de llevar sus documentos al siguiente nivel.

Dado que las empresas SaaS operan según un modelo de suscripción, usted interactúa regularmente con sus clientes. Esto significa que usted tiene una posición única para beneficiarse de la documentación.

Tener una sólida documentación de productos SaaS contribuye directamente a construir una relación sólida y continua con sus clientes y por lo tanto reduce la frustración.

Churn es una de las mayores barreras para su crecimiento, así que las empresas de SaaS no pueden ignorar la necesidad de tener buena documentación.

Por qué necesitas la documentación del producto SaaS excepcional

En este momento, usted podría estar sentado en una oportunidad para hacer que sus clientes sean más felices. Usted puede reducir las solicitudes de asistencia al cliente con documentación reactiva: documentos creados en respuesta a problemas que sus clientes están teniendo.

Para las empresas SaaS que necesitan escalar, documentación de producto es esencial para mantener su número de tickets por cliente como baja como sea posible. Puede hacer que su producto sea más fácil de usar con documentación para reducir la molestia.

Los documentos de productos SaaS también tienen el potencial de ayudar a su puesta en marcha a mejorar la integración. Esto es posible con documentación proactiva.

¿Sabía que la documentación también puede ayudarle a aumentar su visibilidad en línea? ¡Sí! La ventaja de tener documentación excepcional es que puede ser parte de su estrategia de marketing de contenido, especialmente si su producto SaaS está relacionado con una industria popular.

En última instancia, puede y debe incluirse en sus esfuerzos por optimizar su base de conocimiento usando SEO.

Por ejemplo, la base de conocimiento de MailChimp coincide con consultas relacionadas con la comercialización por correo electrónico. Si busca “analizar a los suscriptores de correo electrónico”, su documentación aparece en los resultados de búsqueda. Esta es una gran manera para que los clientes potenciales descubran sus productos.

Este enfoque funciona mejor si su base de conocimiento es un subdominio de su sitio web principal, y cuenta para la clasificación de su sitio.

Echa un vistazo a Cómo crear documentación de producto SaaS:

9 Áreas para concentrarse en la documentación de producto SaaS

Para crear la documentación adecuada para sus usuarios de SaaS, debe centrarse en nueve áreas clave.

1. Definir la audiencia para su documentación
2. Conozca el tipo de documentación que está creando
3. Utilizar Arquete de Información en su Base de Conocimiento SaaS
4. Chunk tu contenido de la base de conocimiento para descubrimiento no lineal
5. Reconocer la documentación del producto de calidad
6. Distinguir entre la documentación del código y la documentación del producto
7. Utilice la solución de software adecuada para alojar su base de conocimiento
8. Usar múltiples formatos para el contenido
9. iterar continuamente en su documentación

Vamos a entrar en detalles sobre cómo puede crear documentación de producto SaaS para sus usuarios ahora.

1. Definir la audiencia para su documentación

No puedes crear documentación efectiva si no sabes exactamente para quién la estás escribiendo.

Su documentación puede estar dirigida a usuarios finales, personal interno, desarrolladores de API, o una combinación de estos audiencias.

Es de vital importancia definir claramente el público objetivo para su base de conocimiento. Si es necesario, debería dividir el contenido en bases de conocimiento separadas. Es tan importante como ser específico como sea posible.

Antes de invertir tiempo y recursos en una base de conocimiento para su SaaS, lleve a cabo entrevistas y encuestas en profundidad. Averigua exactamente quiénes son tus clientes.

Incluso unos pocos correos electrónicos que piden comentarios de aquellas personas que se ponen en contacto con su equipo de soporte es mejor que nada.

Wave sabe exactamente quién es su audiencia de la base de conocimientos: los propietarios de pequeñas empresas

2. Conozca el tipo de documentación que está creando

¿Sabía usted que hay diferentes tipos de documentación técnica? Necesitarás tener claro cuál es la que estás creando.

Los tipos de la documentación del producto SaaS pueden incluir:

• Tutoriales
• Cómo hacerlo
• Explicaciones
• Referencia

Ser claro sobre el tipo de documentación significa que puede ser formateado y presentado de forma óptima a sus usuarios. Debe mantener distintos tipos de contenido aparte para evitar confusión.

Tutoriales

Los tutoriales son para el aprendizaje práctico y contienen poco o nada de material de referencia. Son guías rápidas y sucias para que los usuarios principiantes se familiaricen con las características básicas de su software.

Cómo hacerlo

Estos son más avanzados que los tutoriales. Cómo guiar a los usuarios a través del proceso de completar una tarea específica, y una que los principiantes probablemente no podrían formular. Esto podría incluir cómo solucionar problemas si su programa falla.

Explicaciones

Las explicaciones son discusiones sobre conceptos. Son teóricos más que prácticos. El objetivo es conseguir que el usuario entienda algo abstracto, como el contexto que rodea su software.

Referencia

Los documentos de referencia son descripciones técnicas de su software. Estos pueden ser más comunes en los documentos de desarrollo que para los usuarios finales de su software. Es posible que sigan siendo útiles para los usuarios finales en caso de que clientes potenciales muestren tu documentación a sus desarrolladores internos.

También lectura: Documento: Pasos y Mejores Prácticas

3. Utiliza Arquitectura de la Información en el Software de Documentación de tu Producto SaaS

La documentación del producto SaaS no es sólo una cuestión de crear un montón de contenido y arrojarlo a sus clientes.

El diseño y Arqueo de Información de su base de conocimiento tiene que ser cuidadosamente diseñado . Esto ayudará en el proceso de aprendizaje.

La Arquitectura de Información (IA) proporciona mensajes de señalización a sus usuarios, mostrándoles el camino alrededor de su base de conocimientos. Se ve afectado por cosas como la consistencia en nombrar convenciones, jerarquías y categorías. Muestra los casos de uso potenciales de su usuario para su software y mejora el ROI de su producto.

IA también aborda la incompetencia inconsciente y la incompetencia consciente de sus usuarios.

incompetencia inconsciente es cuando tus usuarios no saben lo que no saben. Incorporación de usuarios la documentación ayuda a educar a sus usuarios de este estado. Pero, ¿qué pasa con el resto del tiempo?

incompetencia perniciosa es cuando tus usuarios ya están conscientes de lo que no saben y tienen un problema con tu software. El trabajo de sus documentos es proporcionarles el contenido adecuado que solucione sin problemas sus problemas.

4. Chunk tu contenido de la base de conocimiento para descubrimiento no lineal

La documentación de productos SaaS no se va a consumir linealmente como un libro. Los usuarios llegarán a su base de conocimientos desde diferentes lugares.

En los viejos tiempos de los manuales de usuario técnicos impresos, cada edición del manual tuvo que ser re impresa cada vez que salió una nueva versión de la tecnología. Se escribió en un estilo destinado a que los usuarios puedan leer de A a B o utilizar la tabla de contenidos.

Esta tendencia se ha trasladado al campo de documentación. Pero los hábitos de navegación modernos significan que sus clientes vendrán a su documentación desde diferentes fuentes. Cada pieza de contenido tiene que tener sentido como una página de destino potencial independiente.

La clave es hacer que tu contenido sea fácil de escanear, haciéndolo claro y conciso. Trata cada pieza de contenido como un ‘fragmento de información’ reciclable.

Asegúrese de no tener más de un tema esencial cubierto en cada pieza y enlazar temas relacionados con el contenido juntos. Utilice menús y navegación para ayudar a los usuarios a acceder a otros temas.

Piensa en tu contenido como parte de una nube, en lugar de una secuencia.  

5. Reconocer documentación de calidad

La calidad es un estado comprensivo, pero hay algunos criterios que puedes usar para evaluar si estás produciendo o no documentación de calidad.

Cumplimiento

No puede adoptar un enfoque de dispersión de su documentación, ya que esto erosionará la confianza. Si una de sus características clave no está documentada o la documentación está desactualizada, esto es posiblemente peor que no tener documentación en absoluto.

Su documentación tiene que ser una biblioteca completa de todo lo que sus usuarios quieran saber sobre su producto. Esto no significa que incluyas todos los artículos en tu página de inicio de la base de conocimientos, pero toda la información debería estar disponible en algún lugar.

Conciso

Al mismo tiempo, todo lo que se incluya debe ser muy relevante. No es momento de ser redundante ni de complicar tu contenido.

Ve al grano rápidamente y elimina cualquier información superflua. Si planeabas volver a leer tu documentación para editarla y te sientes aburrido, eso es una gran bandera roja que indica que hay demasiada información en tus documentos.

Utiliza solo el número preciso de palabras que necesites para transmitir tu mensaje. Coloca la solución al problema que estás abordando cerca del comienzo de tu contenido, y luego elabora para aquellos usuarios que necesitan un proceso paso a paso.

Contextual

Los usuarios finales de su producto dependerán de usted para proporcionar todo el contexto necesario para su documentación. Esto significa que no hay conjeturas: los usuarios deben entender inmediatamente si han encontrado o no el contenido correcto.

Puede proporcionar contexto explicando brevemente cuánto deben saber los usuarios antes de que puedan beneficiarse de su artículo. Mozilla lo hace muy bien en sus documentos de desarrolladores:

Simple

Simple no es lo mismo que dúmp-down. Cuando su documentación es sencilla, esto significa que ha decidido mostrar la información básica en cualquier momento dado.

Sólo un pequeño número de las características de su producto utilizadas por sus clientes, así que compruebe sus análisis para ver qué documentación es más necesaria. Utiliza esto para determinar un camino para enviar a tus usuarios cuando lleguen a tu base conocimiento de producto.

Stripe lo mantiene muy simple:

En última instancia, la documentación de calidad descansa en conocer a su audiencia, cómo aprenden mejor y cómo puede satisfacer sus expectativas. No hay una fórmula mágica porque cada audiencia es diferente.

Siga estos principios probados para maximizar sus posibilidades de éxito, y contrate escritores técnicos profesionales para ayudarle a lograr este objetivo.

6. Distinguir entre la documentación del código y la documentación del producto

Algunas empresas son fanáticos de las metodologías ágiles y siguen un enfoque de documentación. Aunque esto puede ser un enfoque increíblemente útil, la documentación del producto SaaS sigue un proceso ligeramente diferente que la documentación de código.

Los documentos de producto deben actualizarse con la frecuencia que sea necesario – cuando se encuentren errores o cuando se produzca un nuevo contenido. No necesariamente se alinea con tus ciclos de desarrollo y con la frecuencia con que te gusta enviar código. Adicionalmente, puede que no sea muy realista esperar que sus escritores técnicos o agentes de apoyo aprendan a usar herramientas de desarrollo como Github para publicar documentos.

A veces el usuario final de su software es un desarrollador, pero esto no hace que la documentación del producto sea la misma que la documentación de código. La documentación de código es específicamente acerca del código y está generalmente dirigida a mejorar la comunicación entre desarrolladores internos de todos modos. Documentación del producto dirigida a audiencias fuera de su empresa.

Los diferentes equipos y miembros del equipo deben ser responsables de entregar diferentes tipos de documentación, aunque todos ellos estén elaborando “documentación”. La evaluación debe realizarse a diferentes niveles para medir el éxito, por lo que no obligue a todos a usar las mismas herramientas o procesos.

7. Utilice la solución de software adecuada para alojar su base de conocimiento

Si está vendiendo un producto SaaS, normalmente necesitará una base de conocimiento en línea para alojar su contenido de ayuda. Las soluciones de software de base de conocimiento son abundantes, pero pocas están diseñadas específicamente para documentación de SaaS.

Herramientas de autoría técnica como Bengala de Madcap están destinadas a empresas de gran escala que producen documentación en muchos formatos diferentes, sobreimpresión, y web. Estos son demasiado pesados e inapropiados para su empresa SaaS promedio.

Otras soluciones de base de conocimientos dirigidas a las empresas tienen un precio que igualar. Las empresas nuevas de SaaS necesitan software que se escale a un precio que se sienta cómodo con un presupuesto más modesto.

Y puesto que puede que ya tenga una solución de mesa de ayuda con la que esté satisfecho, probablemente no desee una base de conocimiento incluida en el software de soporte. Usted sólo quiere una base de conocimiento sencilla.

Cursivo para ver cómo funciona para usted? Dive in – vea lo fácil que es gestionar la documentación!

¿Interesado en la base de conocimiento de Document360? Programe una demostración con uno de nuestros expertos.

Reserva una Demo

Como usted entrega el software de suscripción a través de la web, usted necesita una herramienta que funcione de la misma manera. Necesita una solución de base de conocimiento SaaS.

Nuestro propio producto Document360 es una base de conocimiento dirigido a empresas SaaS dirigido a empresas SaaS, y puedes registrarte para una prueba gratuita.

8. Usar múltiples formatos para el contenido

A veces a los productores de documentación les gusta acariciar su contenido con diferentes formatos como:

• Imágenes
• Vídeo
• Pantallas
• Audio
• Muestras de código interactivo

A menudo una imagen vale mil palabras y puede mejorar la experiencia de aprendizaje del usuario.

Recuerde, sin embargo, que los vídeos y los screencasts pueden ser más complicados para actualizar que la documentación escrita, y puede que tenga problemas en lo que respecta a la internacionalización.

Videos e imágenes tampoco son accesibles para los usuarios de lectores de pantalla, por lo que siempre debe proporcionar una versión escrita para acompañar a sus visuales. Esto puede acabar siendo un montón de trabajo extra.

Esto no quiere decir que no debas usar videos ya que pueden ser una manera increíble de transmitir información sobre tu producto. Estar al tanto de las cuestiones de mantenimiento y accesibilidad.

9. iterar continuamente en su documentación de SaaS

La documentación de su producto SaaS nunca está terminada. Siempre está evolucionando, al igual que su producto evoluciona.

La mayoría de las empresas SaaS están abiertas al hecho de que el servicio al cliente tiene lugar principalmente en línea, y así es donde debería estar su base de conocimiento. La naturaleza del desarrollo de software significa que están familiarizados con el concepto de iteración continua. De hecho, sus empresas se basan en ello.

Esto ha llevado a algunos documentales siguiendo un enfoque de código similar a los documentos (como mencionamos anteriormente). Esto significa tomar prestado de los principios de la ingeniería de software y mantener sus documentos en el mismo repositorio que su código.

Si esto será apropiado o no para su inicio debe decidirse caso por caso. Sin embargo, debe mantener la documentación completamente actualizada con la última versión de su producto.

En ningún momento los clientes deben poder acceder a documentos que no sean del todo precisos. Esto puede dañar la reputación de su producto y destruir su credibilidad.

Also Read: Product Requirements Document: Benefits, Tips & Examples

Comentarios finales

Algunas personas piensan que un buen producto sólo debe documentarse a sí misma. Esto significa que el producto es tan fácil de usar que no se necesita ninguna documentación. Este enfoque implica que, si su producto necesita documentación, ha fallado en la experiencia del usuario.

En realidad, la mayoría de los productos de software tienen suficiente complejidad que no todas las funciones son inmediatamente obvias. No todos los casos de uso de su software son siempre intuitivos. Aquí es donde el software de documentación del producto SaaS puede ser muy útil.

La importancia de la documentación se remonta a la idea de incompetencia inconsciente o de que sus clientes no saben lo que no saben.

La documentación del producto SaaS es su socio silencioso en la reducción de estragos y el aumento de la felicidad del cliente. ¡Apuesta que no puedes esperar para empezar ahora!

Siguientes pasos

Mira los términos de búsqueda más destacados en tu base de conocimiento si tienes uno. Si no lo hace, entrevistará a algunos de sus clientes sobre sus mayores problemas con su software. Luego, cree un plan para el contenido de su base de conocimientos y estructure la documentación de su producto SaaS alrededor de ese plan. 

Publique su contenido y mejore continuamente su base de conocimiento, creando nuevos procesos para asegurar el éxito.

Utilizar un software de base de conocimientos puede hacer que todo este proceso sea mucho más eficiente.

Su documentación necesita una casa hecha a medida para vivir. Piensa en invertir en software independiente de base de conocimiento como Document360

Comienza tu prueba gratuita