Este paso en falso me enseñó que tengo que ver nuestro producto a través del prisma del cliente. Entonces se encendió la luz. Si ofrezco un producto que resuelva los puntos débiles del cliente y lo apoyo con una documentación profesional del producto, tendremos un ganador.
Y también descubrí que crear una documentación de producto profesional, estéticamente agradable y fácil de leer no era tarea fácil. Pero cuando se hace correctamente, la documentación del producto puede hacer que los clientes estén contentos y, en última instancia, aumentar los ingresos.
¿Cuáles son las mejores prácticas para crear una documentación de producto profesional?
Estas mejores prácticas crean una documentación de producto estéticamente agradable, informativa y fácil de usar. Seguir estas directrices le ayudará a ofrecer una documentación de producto que puede convertir a un buen cliente en un gran cliente. Y los grandes clientes, en última instancia, ayudan a las empresas a aumentar sus ingresos, siendo la documentación del producto un componente vital de la experiencia del cliente.
1. Comprenda a su público objetivo y ofrézcale lo que quiere
Es esencial saber cuáles son las expectativas de su público. Por ejemplo, ¿la documentación del producto va dirigida a administradores o a usuarios finales? El alcance de su público objetivo puede requerir una redacción técnica para administradores o en términos e instrucciones claramente definidos para el usuario final.
Una de las mejores prácticas para crear una documentación de producto profesional es comprender las expectativas del cliente a nivel de administrador o de usuario final. Algunos de los métodos para recopilar información identificativa de la audiencia son:
-
Cuestionarios y encuestas
-
Comentarios de la audiencia percibida
-
Lluvia de ideas de la empresa
-
Feedback sobre opiniones populares de clientes
-
Mesas redondas con los clientes
2. Crear un plan de documentación como mejor práctica
Redactar un plan de documentación puede ayudar a prever posibles cuellos de botella durante la ejecución del proyecto. Crear la documentación de un producto puede ser todo un reto, por lo que una de las mejores prácticas consiste en crear un plan de documentación que ayude a prever los problemas que puedan surgir durante el proceso de documentación.
Entre las ventajas de crear un plan de documentación se encuentran las siguientes:
-
Auditoría de la documentación existente para recuperar información aplicable que pueda reutilizarse con el nuevo plan de documentación del producto.
-
Observar las plantillas y guías de estilo - Si la documentación del producto es para un nuevo producto, asegurarse de que se mantiene dentro de la voz y el estilo de la industria, o si la documentación pertenece a un producto existente, mantener las guías de estilo y plantillas actuales para asegurar la continuidad de la marca.
-
Las herramientas de documentación pueden definir y agilizar el proceso de documentación de productos, garantizando al mismo tiempo la continuidad del trabajo en equipo y una mejor comprensión del proceso de desarrollo de documentos.
3. Simplificar la documentación del producto como mejor práctica
En 2016 se realizó un estudio para determinar cuántos usuarios leen la documentación del producto. Los resultados fueron reveladores, ya que descubrieron que solo el [25 % de los usuarios no lee la documentación del producto] (https://academic.oup.com/iwc/article-abstract/28/1/27/2363584?redirectedFrom=fulltext&login=false). El estudio reveló que la falta de lectura de la documentación del producto por parte de los usuarios finales se debe en parte a lo siguiente:
-
Los usuarios son impacientes - Con la llegada de la información inmediata a través de la web, los usuarios suelen ser menos pacientes a la hora de descubrir respuestas a sus problemas. Leer la documentación de un producto en línea o fuera de línea puede resultar laborioso debido a la copiosa cantidad de información que requiere un producto concreto.
-
Síndrome de saltarse la documentación - Los usuarios suelen saltarse la documentación necesaria del producto para ir directamente a lo básico sobre cómo utilizarlo. Los usuarios aprenden y comprenden el funcionamiento de los productos interactuando con ellos, en lugar de leer instrucciones detalladas. Las instrucciones deben ser lo más claras e informativas posible.
-
Diseño y estructura confusos - Los manuales suelen estar escritos en un formato difícil de entender y seguir. Muchos usuarios encuentran la documentación del producto confusa o irrelevante para su pregunta, por lo que se frustran y desisten de leer el manual. A menudo, la empresa no ha realizado un estudio detallado de la audiencia y no ha entendido correctamente lo que el usuario necesitaba, por lo que se siente demasiado confuso para terminar de leer.
4. Incluir capturas de pantalla e información gráfica
Piense en la documentación del producto como una hoja de ruta que cuenta una historia sobre el producto. Guíe al cliente por un camino fácilmente identificable con capturas de pantalla u otros gráficos y cómo interactúa cada gráfico diferente con los demás. Explique claramente qué está viendo el usuario o cuándo se activa una función, cómo reacciona ante el producto y qué puede esperar a continuación. Asegúrate de que cada gráfico tiene un propósito y de que el flujo de trabajo del producto funciona entre sí.
5. Utilice enlaces cruzados para una comprensión más precisa de los temas.
He descubierto que los enlaces cruzados tienen un valor incalculable a la hora de leer la documentación del producto Comprender lo que hace una característica o un proceso de función ayuda enormemente a establecer enlaces cruzados con un tema asociado. Además, al cruzar los puntos de datos asociados, se hace más evidente la imagen general de cómo interactúa el sistema y el flujo de trabajo.
6. Recuerde el principio KISS para la documentación del producto.
Recuerde utilizar el principio KISS (Keep It Simple, Stupid) al crear la documentación. Sin embargo, es importante documentar a fondo el proceso, pero no hasta el punto de documentarlo en exceso. Además, el usuario de la documentación puede estar buscando cierta información sobre elementos específicos, por lo que adherirse al principio KISS permite una navegación y comprensión de la documentación mucho más fáciles.
Por ejemplo, unas simples anotaciones pueden bastar para explicar una función, quizá con una referencia (enlace cruzado) al tema principal. Mantenga los datos claros y no exagere, para que el usuario pueda buscar fácilmente la información relevante para sus necesidades. Puede que no les interese leer todos los aspectos del producto.
7. Adaptarse a los distintos estilos de aprendizaje
Cada persona tiene un estilo de aprendizaje diferente. Algunos prefieren descripciones detalladas, mientras que otros prefieren gráficos y representaciones visuales. Sin embargo, algunos usuarios aprenden más a través de la participación práctica que de la lectura concentrada.
Asegúrese de tener en cuenta todos los estilos de aprendizaje a la hora de crear una documentación de producto eficaz e informativa. Por ejemplo, insertar gráficos como capturas de pantalla, gráficos, texto estructurado o enlaces a vídeos ayuda a garantizar que todos los estilos de aprendizaje entienden la documentación del producto.
8. Personalice y estructure el contenido de la incorporación
Personalice la [documentación] del producto en función de la función de la audiencia (https://www.deanhouston.com/news/knowing-audience-document-right-document/). Cree diferentes versiones de la documentación en función de las funciones de los destinatarios cuando incorpore el contenido. Por ejemplo, las preguntas de un administrador pueden no ser relevantes para las preguntas de un usuario avanzado sobre la documentación.
La documentación puede introducir una capa de personalización mediante la creación de versiones ligeramente diferentes del documento orientadas más al papel de la audiencia prevista. Modificar el contenido de la incorporación en función de la función de la audiencia confiere a la documentación un elemento de personalización.
9. Definir claramente los términos para públicos específicos
En función de la audiencia a la que vaya dirigida, es una buena práctica explicar el significado de cada término utilizado a lo largo de la documentación. Puede utilizar términos más complejos con alguna aclaración si el público es interno. Sin embargo, cuando los usuarios externos acceden a la documentación, no hay forma de conocer la experiencia de los usuarios.
Definir claramente los términos únicos o complejos establece una comunicación mucho mejor y más eficaz para todas las partes interesadas internas y los usuarios externos.
10. Proporcionar un método para recoger las opiniones de los usuarios
Los comentarios sobre la documentación proporcionan información muy valiosa sobre la eficacia del documento. Proporcione un enlace o un simple botón con "Me gusta/No me gusta" para recoger información valiosa sobre la calidad de la documentación. Mediante la recogida de comentarios de los usuarios, se puede perfeccionar y mejorar la documentación.
11 Evite la documentación con una estructura plana
Al crear la documentación del producto, asegúrese de que la documentación no está escrita como una "estructura plana". Leer un documento lleno de texto plano es laborioso, y también puede llegar a ser tedioso. Además, el interés del lector por la documentación aumentará si la información es relevante para el tema tratado y el lector puede consumirla rápidamente.
Rompa el texto continuo y plano resaltando la información seleccionada o integrando vídeos, imágenes, enlaces y otros métodos para ofrecer una mejor UX. Además, al presentar el contenido del documento en trozos del tamaño de un bocado, el lector tendrá una experiencia más agradable y será menos reacio a leer la documentación.
12. 12. Cree documentación compatible con SEO
Una de las mejores prácticas de documentación de productos en línea es asegurarse de que está escrita en un estilo que es documentación SEO-friendly. Asegúrese de que la documentación está escrita para maximizar los resultados de búsqueda de su documentación en Internet. Los clientes pueden necesitar buscar su documentación, y cuando no tienen el enlace explícito al sitio de alojamiento, al introducir términos de búsqueda, las respuestas son más rápidas y concisas cuando son SEO friendly.
13. Mantenga actualizada la documentación del producto
El mantenimiento de la documentación del producto es crucial, sobre todo si se accede a ella en línea. A menudo, los requisitos de un producto cambian y la documentación en línea debe reflejar cualquier nuevo cambio o actualización. Por lo tanto, la documentación del usuario debe estar al día y actualizarse para cualquier actualización reciente y garantizar que el cliente es notificado y consciente de los cambios en la documentación del producto.
14. Comprender que es posible que los usuarios no lean la documentación del producto
Un estudio de 2014 descubrió que los usuarios no leían completamente toda la documentación del producto. Las principales razones para no leer la documentación fueron:
-
La documentación del producto era excesivamente compleja
-
la documentación no respondía directamente a sus preguntas
-
Los usuarios no utilizaron muchas funciones del producto porque no leyeron la documentación.
-
En lugar de leer la documentación, muchos usuarios preferían el aprendizaje práctico.
15. Gestionar contenidos dinámicos y estáticos
La documentación del producto evoluciona continuamente con actualizaciones, nuevas funciones, contenido corregido, alertas de mantenimiento actualizadas y otros elementos. Esta actualización se considera un documento vivo que evoluciona continuamente en función de los requisitos del producto.
El contenido estático proporciona al usuario datos que no cambian a lo largo de la vida del producto. La idea del contenido estático es ofrecer a los usuarios, especialmente a los nuevos, información que permanezca estática a lo largo del ciclo de vida del producto. El contenido estático es vital para una documentación rica, pero suele quedar relegado a un segundo plano frente a la documentación dinámica.
El mantenimiento del conjunto de la documentación es más fácil cuando el contenido está clasificado como dinámico o estático. La documentación del ciclo de vida del producto puede implementarse y validarse más fácilmente cuando la documentación se clasifica como dinámica o estática. Puede haber cambios menores en la documentación para actualizaciones de nuevas características (estática) o actualizaciones detalladas del producto (dinámica).
16. Mejores prácticas para la disponibilidad de la documentación del producto
Aunque los usuarios no lean necesariamente mucha documentación del producto, cuando la necesitan, la quieren inmediatamente. El método tradicional de entrega de la documentación era un manual impreso que viajaba con el producto. Sin embargo, en el mundo digital y en línea de hoy en día, la documentación suele entregarse a través de Internet.
Independientemente de cómo se entregue la documentación del producto, es esencial disponer de puntos de acceso fácilmente accesibles. Por lo tanto, los métodos predominantes para proporcionar documentación hoy en día son:
Documentación fuera de línea - Muchos productos se entregan con manuales impresos u hojas de acceso rápido. Estos documentos suelen ser "únicos" y no se distribuyen fácilmente. Sin embargo, muchos manuales se suministran opcionalmente en formato PDF encapsulado, lo que favorece su portabilidad o la opción de imprimirlos bajo demanda.
-
Documentación en línea- Cada vez que buscas en Google una respuesta a un problema, probablemente estés echando mano de un fragmento de documentación en línea. La llegada de la web ha suplantado la impresión de manuales o materiales de documentación de productos para los usuarios finales. Algunas de las ventajas de la documentación en línea son:
-
Teletrabajo - Una cosa que nos enseñó la pandemia es que trabajar desde casa puede ser tan productivo como la oficina, sobre todo cuando nuestras preguntas se responden con documentación en línea.
-
Colaboración - Con un portal de documentación en línea de fácil acceso, los miembros del equipo pueden compartir información sobre la marcha y crear trabajo en equipo, lo que a menudo es imposible en la oficina.
-
La llegada de dispositivos móviles como iPads y smartphones ha desbancado poco a poco a los PC en las interacciones cotidianas. Se puede acceder fácilmente a la documentación en línea con un teléfono inteligente, y cualquier problema persistente del producto se puede investigar fácilmente, incluso en su cafetería favorita durante el almuerzo.