A la hora de documentar tu producto, elegir el formato adecuado es tan crucial como el contenido que presentamos. Un formato bien pensado no solo mejora la accesibilidad y la comprensión del producto, sino que también asegura que la documentación sea atractiva y retenga el interés del lector. Este capítulo explora cómo seleccionar el formato más efectivo para presentar la información de manera que resuene con tu audiencia y refuerce la propuesta de valor de tu documentación.
¿Cómo quiero contarlo?
Como hemos visto en otros capítulos, una buena documentación de producto se centra en presentarse de manera asequible y amena, para que no caiga en el olvido. Aunque lo crucial va a ser el contenido, el formato es clave para la comprensión del producto.
Una vez tengamos La Estructura, sería recomendable ir organizando el contenido existente en torno a ésta y de ahí editarlo para mejorarlo y completarlo. Todo lo que sea nuevo contenido se puede dejar para después, puesto que esta parte de “maquetación” y edición nos ayuda a generar contenido de cero de forma más rápida y eficiente.
Con "El Formato" nos veremos supeditados a la plataforma donde documentamos nuestro producto, pero en general casi todas permiten integrar elementos multimedia.
Personalmente, recomiendo una lectura ligera que incluya vídeos cortos, enlaces a espacios donde se profundiza y conecta la información para dar más contexto y se juegue con el texto rico en formato (colores, cursivas, títulos y subtítulos) para guiar al lector y permitirle tomarse pausas. Todo con mesura: no hace falta que el texto parezcan mis apuntes subrayados del instituto, ni que sean todo vídeos y pantallazos. Aunque las imágenes comunican mucho, es importante usar palabras clave para búsquedas rápidas (CTRL + F) que ayuden a nuestra audiencia.
Si se van a abordar métricas y data en general, es recomendable usar la visualización que ha elaborado el equipo de Datos, y añadir contexto por si acaso.
Una landing page que ayude a navegar los distintos componentes y áreas que se documentan, además de proporcionar un canal de feedback, son la guinda del pastel para hacerlo accesible y atractivo.
El Formato entraría dentro de la “propuesta de valor” puesto que tiene el hecho diferencial que hace destacar esta documentación y ofrece una manera de leerla única. Además, es lo que más feedback suele recibir y con lo que se itera para mejorar la experiencia de la lectura.
Por ponerte un ejemplo…
En mi labor documentadora, que he ido contando en esta serie, me beneficié de que ya había una práctica extendida en toda la organización de crear una página principal a modo de portada. Pero como la necesidad estaba centrada en igualar el conocimiento entre stakeholders y mapear roles y responsabilidades de cara al lanzamiento, recurrí mucho a diagramas de flujo (para explicar procesos e infraestructura) y tablas (para glosarios de vocabulario interno, tipos de reuniones, funciones de cada miembro del squad…), así como negritas en aquellos datos y frases a los que quería dirigir la atención de quien leyera. Normalmente los relacionados con aquellos requisitos del producto y del servicio que suelen preguntar otros stakeholders. También pude “esconder” mucha información tras enlaces que se desplegaban en la misma página, para que la información se pudiese digerir. Y los pantallazos o GIFs siempre eran detalles que acompañaban al texto, señalando lo que se describía.
Foto de creativeart en freepik
