Una buena práctica al lanzar un nuevo producto: la preparación de documentación¶

Cuando lanzamos un nuevo producto, es fundamental preparar documentación de calidad. Sin ella, los potenciales usuarios no tendrán información relevante para consultar después de adquirir nuestra solución.

Como parte de una estrategia de marketing más amplia, los gestores y equipos de producto deberían continuar leyendo para conocer 15 buenas prácticas que seguir en su próximo lanzamiento. ¡Al final, entenderás cómo hacer que estos documentos sean lo mejor posible!

¿Qué tipos de documentación de producto debo conocer?¶

Antes de entrar en las buenas prácticas, aclaremos qué tipos de documentación existen y cuál es el objetivo de cada uno:

• Documentación de Requisitos del Producto – Un documento de requisitos o PRD es documentación interna que ayuda a cumplir los criterios de lanzamiento. Explica qué debe lograr el producto final para el usuario, sin definir específicamente cómo o dónde. Los equipos de desarrollo y pruebas usan un PRD para alinear el producto con los requisitos empresariales. Los PRD son habituales en productos de software, pero pueden usarse con cualquier hoja de ruta de producto.

• Guías de Usuario y Autoservicio – Los equipos necesitan crear guías de usuario como prerrequisito para un lanzamiento exitoso. Esta documentación ayuda a los usuarios finales a maximizar su productividad. Aquí, toda la funcionalidad principal debe explicarse por completo para que los clientes obtengan el máximo valor. Mejor aún, ¡comparte estas guías en una base de conocimientos externa para que los clientes puedan ayudarse a sí mismos!

• Guías de Configuración e Instalación – Si un producto requiere configuración e instalación, este es otro activo de documentación técnica necesario. El objetivo es ilustrar claramente estos procesos desde la perspectiva del usuario y del desarrollador si corresponde. Puede abarcar múltiples dispositivos y sistemas operativos en el caso del software.

• Recursos de Marketing – Aunque no lo parezca, ¡esto también es documentación de producto! El estilo y formato de los materiales de marketing influye en cómo los clientes perciben tu producto antes de usarlo. Causar una buena impresión es vital. ¿Cómo describes las nuevas funciones? ¿A qué público va dirigido? ¿Cómo mejorará la vida laboral o personal? ¿Es esto lo que tú y la empresa queréis que piensen los clientes?

15 Buenas Prácticas para la Documentación al Lanzar Nuevos Productos¶

Después de esta introducción, veamos la lista de buenas prácticas:

1: ¡Empieza ya!¶

¿Empezando con la documentación de producto? ¡Genial! No dudes en dar el primer paso. Muchas personas quieren que la documentación sea PERFECTA, y en busca de la perfección, se paralizan. Plasma el concepto básico de tus servicios en papel y luego céntrate en pulirlo para impresionar a tus clientes. Las notas de versión son excelentes para definir lo básico, y a partir de ahí puedes ampliar.

2: Mantenlo Simple...¶

KISS (Keep It Simple, Stupid) es un principio de diseño que surgió en la marina estadounidense en los años 60. La misma regla puede aplicarse a la documentación de producto. Pregúntate: "¿Cómo puedo transmitir la información necesaria de manera que todos los públicos puedan entenderla?"

Para aplicar esto a tu visión de producto, recomendamos el test de legibilidad Flesch-Kincaid. Herramientas como Grammarly usan este sistema. Apunta a un nivel equivalente a 13-14 años para maximizar la comprensibilidad del contenido.

3: Comprende al Público Objetivo¶

Has comenzado y lo has mantenido simple. Ahora, necesitas saber para quién estás escribiendo. Por ejemplo, el público objetivo para empresas de software será muy diferente al de un fabricante de automóviles.

Imaginemos una empresa de software educativo centrada en herramientas simples para que los estudiantes aprendan conceptos paso a paso. Podrías pensar: "entonces, ¿el público objetivo son los niños, verdad?". No necesariamente... El público principal son los responsables de decisiones en colegios o institutos, como el departamento de TI y los responsables de compras. Un público secundario serían los estudiantes, que podrían ver el software y abogar por su uso en su escuela.

4: Céntrate en el Valor, No en una Historia¶

Aunque a todos nos gustan las buenas historias, los clientes quieren saber qué valor ofrece tu producto. ¿Simplificará una tarea o flujo de trabajo? ¿Tu producto funciona sin conexión, a diferencia de los competidores que solo funcionan online? ¿Tu producto hace las cosas más rápido que otros?

Estos ejemplos constituyen puntos de venta únicos (USP) para una oferta particular. Destacar los USP tentará a los clientes potenciales y les ayudará a entender qué tienes que otros no tienen. Puedes definir los USP realizando un análisis competitivo.

5: Utiliza el Formato para Categorizar la Información¶

La documentación no debe ser un gran bloque de texto. Esto dificulta la lectura rápida para los usuarios. En su lugar, usa encabezados y otras opciones de formato para dividir el texto.

Los encabezados H1 son lo primero que ven las personas al hacer clic en una página. H2 y H3 actúan como subtítulos. Puedes usar viñetas o listas numeradas para agrupar contenido y facilitar la lectura, e incluso ser elegible para fragmentos enriquecidos para mejorar el SEO. Si tienes conocimientos de Markdown, un editor como Docsie ofrece numerosas opciones de formato.

6: Mantén tu Documentación en un Lugar Centralizado¶

No hay nada peor que publicar documentación técnica y luego darse cuenta de lo complicado que será monitorearla y gestionarla a largo plazo. ¿Qué pasa si la documentación necesita una actualización? ¿Dónde está el documento original y cómo podemos lanzar nuevas versiones? ¿Y la traducción a otros idiomas?

¡Aquí tenemos que mencionar Docsie! El software de base de conocimientos te permite almacenar documentos en una ubicación centralizada en la nube. Desde aquí, empleados y colaboradores pueden trabajar juntos para acelerar la finalización antes del lanzamiento. Docsie ofrece control de versiones, gestión de idiomas para localización global y un bot de traducción con IA que traduce con precisión en segundo plano.

7: Una Imagen Vale Más que Mil Palabras¶

Aunque escribir una explicación detallada funcionará, no es la forma más efectiva de enseñar a los usuarios. En su lugar, muéstrales con imágenes o incluso con imágenes en movimiento.

Crea un tutorial en video para cada documento. Así, quienes prefieren leer pueden revisar el texto, mientras que los aprendices visuales pueden optar por el video. Del mismo modo, los GIF e imágenes pueden ayudar a los usuarios a ver a qué te refieres, especialmente en interfaces de software. Adaptarte a diferentes estilos de aprendizaje te ayudará a llegar a más usuarios.

8: Aprendizaje vs Objetivos vs Comprensión vs Información¶

¿Cuál es la intención del documento? La intención del usuario es crucial en la documentación online y te ayuda a alinear tu contenido con secciones del recorrido del usuario.

• Aprendizaje – Si una persona nunca ha visto algo antes, el contenido de aprendizaje le ayuda a entender los principios básicos.

• Objetivos – Este tipo de contenido debe ayudar a los usuarios a alcanzar un objetivo, como "Cómo exportar un archivo PDF desde Docsie".

• Comprensión – También conocido como investigación, esto es para clientes que ya tienen conocimientos sobre un tema, pero quieren profundizar.

• Información – El usuario tiene una pregunta y quiere una respuesta específica. Puede ser tan simple como el clima en tiempo real en una ubicación específica.

9: Hazlo Buscable¶

Antes de hacer pública esta documentación, ¿pueden tus usuarios buscar palabras clave dentro del texto?

Si no es así, recomendamos encontrar una plataforma de documentación que lo permita. El principal obstáculo para los usuarios es no poder encontrar información rápidamente. Esto genera frustración, carga adicional para el equipo de soporte y una experiencia negativa para el cliente. ¡Docsie sí admite búsqueda global!

10: Preparándose para Recopilar Comentarios Útiles¶

Los redactores de documentación saben que la versión inicial del contenido cambiará con el tiempo. Hasta que el público vea la documentación, tus redactores solo pueden intercambiar ideas y comentarios entre ellos.

Una vez publicada tu documentación, es esencial tener un sistema de recopilación de comentarios. Así, tus redactores pueden convertir cualquier aspecto negativo en positivo escuchando a los clientes reales. ¡Puedes aprovechar la recopilación de comentarios en Docsie!

11: Enlaza a una Página Cuando Menciones un Tema¶

Esta buena práctica se relaciona con el SEO y las estructuras de navegación de páginas web.

Cuando mencionas una palabra clave, ¿la enlazas? Cuando haces referencia a otros temas, es posible que los usuarios aún no los entiendan en el contexto de la página actual. Debes enlazar a cualquier tema mencionado que tenga documentación, esto permite a los lectores consultar rápidamente subtemas mientras aprenden sobre un tema principal.

12: Claridad, No Ambigüedad¶

La claridad supera a la ambigüedad al redactar documentación. Puedes usar un lenguaje sencillo para evitar ambigüedades, lo que básicamente significa evitar jerga y lenguaje técnico a menos que sea absolutamente necesario. Si usas jerga, asegúrate de escribir una definición simplificada inmediatamente después.

"Si tiene problemas para comprender la información en esta documentación, solicite detalles adicionales sobre cómo superar esta dificultad de comprensión a nuestro representante de atención al cliente."

"Si el contenido mostrado es difícil de entender, puede pedir ayuda al servicio de atención al cliente."

¿Cuál prefieres?

13: Crea Plantillas para Hacer Documentos Más Rápido¶

Con un nuevo producto en lanzamiento, acelerar el proceso de creación de documentación es una prioridad. Puedes hacerlo usando plantillas.

Las plantillas definen una estructura reutilizable para las páginas, ayudando a los redactores a crear contenido más rápido y con mayor consistencia. También puedes crear múltiples plantillas para diferentes estilos de contenido. Docsie ofrece una variedad de plantillas prediseñadas, además de soporte para plantillas personalizadas.

14: Establece un Tono de Voz y una Guía de Estilo para Redactores¶

¿Cuánta libertad tienen tus redactores?

Controlar a los redactores es importante, ya que la falta de control puede llevar a inconsistencias en los borradores finales. Puedes hacerlo con directrices de Tono de Voz (ToV) y guías de estilo de redacción.

• Tono de Voz – No es lo que dijiste... es cómo lo dijiste. ¿Quieres que los redactores sean formales y correctos, o más casuales? ¿Se permite el humor, o los temas son más serios? ¿Tu contenido es más conversacional y apasionado, o solo quieres hechos concretos?

• Guías de Estilo – Este documento puede explicar la misión de la empresa y cómo los redactores pueden seguir un estilo establecido al escribir y formatear páginas. Aquí podrían incluirse personas objetivo, principios de SEO como metadescripciones y requisitos de citación (Chicago, AP Style, etc.).

15: Publica tu Documentación Usando una Plataforma Potente de Base de Conocimientos¶

Si tu contenido escrito es el combustible, ¿qué vehículo estás usando para transmitir el mensaje?

Una plataforma potente de base de conocimientos es esencial para desplegar documentación de calidad. Si los documentos no están disponibles o las páginas tardan en cargar, todo el esfuerzo dedicado a crear estos documentos se desperdiciará.

Necesitas la capacidad de importar documentos existentes, colaborar con equipos internos, crear y editar nuevos documentos, incrustar contenido dinámico y publicar en un sitio de conocimiento. El control de versiones también es crítico para actualizaciones a largo plazo, junto con la gestión de idiomas y traducción automática para la localización global.

¡Lo has adivinado! Todas estas funciones están disponibles en Docsie. ¡Prueba nuestro plan Gratuito para empezar!