15 buenas prácticas para la documentación de nuevos productos

Una de las mejores prácticas a la hora de lanzar un nuevo producto es llevar a cabo los preparativos para su lanzamiento. En particular, queremos centrarnos en la redacción de la documentación del nuevo producto para respaldar su lanzamiento. Sin ella, los usuarios potenciales no dispondrán de información relevante que puedan utilizar como punto de referencia tras adquirir su nueva solución.

Como parte de una estrategia de marketing más amplia, los jefes de producto y los miembros del equipo de producto deberían seguir leyendo para conocer las 15 mejores prácticas a seguir durante su próximo lanzamiento. Al final, comprenderá cómo hacer que estos importantes documentos sean los mejores posibles.

¿Qué tipos de documentación de producto debo tener en cuenta?

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

• Documentación de requisitos del producto - Un documento de requisitos del producto o PRD es un tipo de documentación interna del producto que se utiliza para ayudar a las empresas a cumplir los criterios de lanzamiento. En él se explica lo que el producto final debe lograr para un usuario, sin definir específicamente cómo o dónde. A continuación, los equipos de desarrollo y de pruebas utilizan un PRD para alinear el producto con los requisitos empresariales listos para su lanzamiento. Los PRD son habituales en los productos de software, pero pueden utilizarse para ajustarse a cualquier hoja de ruta de producto.

• Guías de usuario y autoservicio - Los equipos de producto necesitarán crear guías de usuario como requisito previo para el éxito del lanzamiento del producto. Como su nombre indica, se trata de documentación para ayudar a los usuarios finales a maximizar su productividad al utilizar un nuevo producto. Aquí, todas las funciones importantes para el usuario deben explicarse en su totalidad, para que los clientes puedan obtener el máximo valor. Mejor aún, comparta estas guías en una base de conocimientos externa de autoservicio para que los clientes puedan ayudarse a sí mismos.

• Guías de instalación y configuración - Si un producto requiere instalación y configuración, este es otro recurso de documentación técnica del producto que tendrá que crear. El objetivo es ilustrar claramente estos procesos desde la perspectiva del usuario y, en su caso, del desarrollador. Esto puede abarcar varios dispositivos y sistemas operativos si se trata de documentación de software; algo a tener en cuenta.

• Activos de marketing - Puede que no pienses que esto es documentación de producto, ¡pero lo es! El estilo y el formato de los recursos de marketing influyen en la percepción que los clientes tienen de su producto antes de empezar a utilizarlo. Causar una buena impresión es vital. ¿Cómo describe las nuevas funciones del producto? ¿A qué público va dirigido? ¿Cómo mejorará el trabajo o la vida personal de alguien? ¿Es esto lo que usted y la empresa en general quieren que piensen los clientes?

15 Buenas prácticas de documentación para el lanzamiento de nuevos productos

Después de esta introducción a la documentación de los productos, viene la lista de las mejores prácticas:

1: ¡Empiece!

¿Estás empezando con la documentación de productos? ¡Estupendo! No dude en empezar. Mucha gente quiere conseguir que la documentación del producto sea PERFECTA; y en la búsqueda de la perfección, se paralizan ante la tarea. Consiga el concepto básico de sus servicios sobre el papel y, a continuación, céntrese en ponerlo a punto para impresionar a sus clientes. Las notas de la versión son excelentes para definir lo básico y, a partir de ahí, se puede desarrollar el producto.

2: Mantenlo simple, estúpido...

Abreviado como KISS, se trata de un principio de diseño real que flotó (juego de palabras intencionado) en la marina estadounidense en los años sesenta. La misma regla puede aplicarse a la documentación de un producto. Pregúntese: "¿Cómo puedes transmitir la información necesaria de forma que todos los grupos demográficos puedan entenderla?".

Para aplicar esto a la visión de tu producto, te recomendamos la prueba de legibilidad de Flesch-Kincaid. Las herramientas de calificación de contenidos como Grammarly suelen utilizar este sistema. Esto le da una puntuación equivalente a un grado de la escuela secundaria de EE.UU. al analizar el contenido escrito. Apunte al grado 8 o a la edad de 13 a 14 años como edad de escolarización para maximizar la interpretabilidad del contenido; espere, podríamos haber dicho... lo fácil que es entender su escritura.

3: Entender al público objetivo

Ya has empezado y lo has hecho sencillo. Por ejemplo, el público objetivo de las empresas de software será muy diferente al de un fabricante de automóviles.

Imaginemos una empresa de software educativo que se centra en herramientas sencillas para ayudar a los jóvenes estudiantes a aprender conceptos paso a paso. El primer pensamiento en tu cabeza puede ser: "entonces, el público objetivo son los niños, ¿no?". No necesariamente... El público objetivo es el principal responsable de la toma de decisiones sobre paquetes de software en un jardín de infancia o un instituto, como el departamento de informática y las partes interesadas internas encargadas de las adquisiciones. Un público secundario serían los jóvenes estudiantes, que pueden ver el software educativo en la naturaleza y abogar por su uso en su escuela.

4: Centrarse en el valor, más que en una historia

Aunque a todo el mundo le gusta una buena historia, los clientes quieren saber qué valor ofrecerá su producto. ¿Simplificará una tarea o un flujo de trabajo? ¿Está su producto disponible fuera de línea, frente a los competidores que sólo están en línea? ¿Su producto es más rápido que otros productos de la competencia?

Estos ejemplos constituyen puntos de venta únicos (USP) para una oferta concreta. Centrarse en los PUE y destacarlos tentará a los clientes potenciales y les ayudará a entender qué tiene usted que no tengan los demás para aumentar la cuota de mercado. Puede definir los puntos de venta únicos realizando un análisis de la competencia frente a los competidores de su sector.

5: Aproveche el formato para clasificar la información

La documentación no debe ser un gran bloque de texto. A los usuarios finales les resulta difícil escanearla y navegar por ella. En su lugar, utiliza encabezados y otras opciones de formato para dividir el texto.

Los encabezados H1 son lo primero que se ve al entrar en una página. Los H2 y H3 actúan como subtítulos de los temas tratados en la página. Puedes utilizar viñetas o listas numeradas para agrupar el contenido y facilitar la lectura, e incluso optar a Rich Snippets para mejorar el SEO y la visibilidad en las SERPS. Si tienes conocimientos de Markdown, un editor de Markdown en línea como Docsie ofrece numerosas opciones de formato para que tus documentos de producto destaquen.

6: Mantenga su documentación en una ubicación centralizada

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

¡Para esta mejor práctica, tenemos que mencionar Docsie! El software de base de conocimientos en línea permite almacenar documentos en una única ubicación centralizada en la nube. Desde aquí, los empleados y contratistas pueden colaborar en el contenido para agilizar la finalización lista para el lanzamiento. Docsie ofrece gestión de control de versiones cuando necesitas actualizar conocimientos, y gestión de idiomas para la localización global de contenidos. Si desea automatizar la creación de contenido global, también disponemos de un ingenioso robot fantasma de traducción de idiomas con IA que traduce con precisión por usted en segundo plano.

7: Una imagen vale más que mil palabras

Aunque escribir una larga explicación sobre cómo hacer una cosa funcione, no es una forma eficaz de enseñar a los usuarios finales. En lugar de eso, enséñales con imágenes, ¡o incluso con imágenes en movimiento!

Intente crear un tutorial en vídeo para cada documento de producto. Así, los que prefieren leer pueden hojear el texto, mientras que los que aprenden visualmente pueden optar por el vídeo. Del mismo modo, los GIF y las imágenes pueden ayudar a los usuarios a ver a qué se está refiriendo, sobre todo en la interfaz de usuario de un software. Adaptarse a distintos estilos de aprendizaje le ayudará a ayudar a un mayor número de usuarios, lo que se traduce en un mayor potencial para su producto.

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

¿Cuál es la intención del documento? La intención del usuario es fundamental en la documentación de productos en línea, y le ayuda a alinear su contenido con las secciones del recorrido del usuario.

• Aprendizaje - Si una persona nunca ha visto una cosa 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". Al final, el usuario habrá alcanzado el objetivo: exportar un PDF.

• Comprensión** - También denominado investigación, es para clientes que ya tienen conocimientos prácticos sobre un tema, pero quieren comprenderlo más a fondo.

• Información - El sujeto tiene una pregunta y quiere una respuesta concreta. Puede ser algo tan sencillo como el tiempo en tiempo real en un lugar concreto o un vídeo sobre "cómo construir una casa en un árbol".

9: Facilite las búsquedas

Antes de hacer pública la documentación, ¿pueden los usuarios buscar palabras clave en el texto?

Si no es así, le recomendamos que busque una plataforma de documentación que lo permita. El principal factor disuasorio para los usuarios es no poder encontrar rápidamente la información. Esto conduce a la frustración, la carga de trabajo adicional del equipo de atención al cliente si no pueden encontrar la información, y una experiencia general negativa del cliente (CX). Por si te lo estabas preguntando, Docsie admite la búsqueda global.

10: Prepararse para recopilar comentarios útiles

Los redactores de la documentación son conscientes de que la versión inicial del contenido cambiará con el tiempo. Hasta que el público no vea la documentación, los redactores sólo podrán intercambiar ideas y comentarios.

Una vez publicada la documentación, creemos que es esencial contar con un sistema de recogida de opiniones. De este modo, sus redactores podrán convertir cualquier aspecto negativo relacionado con el contenido en positivo escuchando a clientes y usuarios finales reales. No hace falta que busque en otra parte, ¡puede beneficiarse de la recopilación de opiniones en Docsie!

11: Enlace a una página cuando mencione un tema

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

Cuando menciona una palabra clave, ¿la enlaza? Cuando haga referencia a otros temas, es posible que los usuarios aún no comprendan el otro tema en el contexto de la página actual. Debería enlazar a cualquier tema mencionado que tenga documentación, ya que esto permite a los lectores consultar rápidamente subtemas mientras aprenden sobre un tema principal.

12: Claridad, no ambigüedad

La claridad es mejor que la ambigüedad a la hora de redactar la documentación de un producto. Puede utilizar un inglés sencillo para evitar la ambigüedad, lo que básicamente significa evitar la jerga y el lenguaje técnico a menos que sea absolutamente necesario. Si utiliza jerga, asegúrese de escribir inmediatamente después una definición simplificada para los lectores legos.

"Si tiene problemas para comprender la información de 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".

¿Qué prefiere?

13: Crear plantillas para agilizar los documentos

Con el lanzamiento de un nuevo producto, agilizar el proceso de creación de documentación es una prioridad. Puede hacerlo utilizando plantillas.

Las plantillas definen una estructura reutilizable para las páginas, lo que ayuda a los redactores a crear contenidos más rápidamente y con mayor coherencia. También puede crear varias plantillas para diferentes estilos de contenido. Docsie ofrece una gama de plantillas prediseñadas para su uso, además de soporte para plantillas personalizadas.

14: Establezca un tono de voz y una guía de estilo para los redactores

¿Qué grado de libertad tienen sus redactores?

Es importante controlar a los redactores, ya que esto puede provocar incoherencias en los borradores finales de la documentación del producto. Puedes hacerlo con directrices sobre el tono de voz y guías de estilo para la redacción de contenidos.

• Tono de voz - No es lo que has dicho... es la forma en que lo has dicho. ¿Quiere que los redactores sean formales y correctos, o más informales? ¿Se permite el humor o los temas son más serios? ¿Su contenido es más conversacional y apasionado, o sólo quiere hechos fríos y duros?

• Directrices de estilo - Este documento puede explicar la misión de la empresa y cómo los redactores pueden seguir un estilo determinado al escribir y dar formato a las páginas. En él podrían incluirse los usuarios a los que dirigirse, principios de SEO como las meta descripciones y requisitos de citación o referencia (Chicago, AP Style, etc.).

15: Publique su documentación utilizando una potente plataforma de base de conocimientos

Si su contenido escrito es combustible, ¿qué vehículo utiliza para transmitir el mensaje?

Una potente plataforma de base de conocimientos es esencial para desplegar una documentación de producto de calidad. Si los documentos no están disponibles o las páginas tardan en cargarse, todo el esfuerzo invertido en crearlos se irá al traste.

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

Lo ha adivinado. Todas estas funciones están disponibles en Docsie. Pruebe estas funciones, ¡pruebe nuestro plan gratuito para siempre para empezar!