Seleccionar la herramienta adecuada es fundamental cuando se trata de documentar tu producto. Esta decisión no solo afecta cómo se presenta la información sino también cómo interactúan los usuarios con ella. Una herramienta efectiva debe facilitar no solo la creación de contenido, sino también su consumo y comprensión. En este capítulo, examinamos las diversas opciones de software disponibles y cómo cada una puede servir mejor a los objetivos de nuestra documentación, asegurando que se adapten a las necesidades específicas del producto y del equipo.
¿Cuál es el soporte? ¿Qué me permite hacer?
Esto es todo un mundo... que si Confluence, que si Google Drive, que si SharePoint. Y por supuesto, que si Notion y que si Miro. En mi opinión, no es tan importante como el contenido pero sí juega un papel en presentar la información: algunos gestores de contenido tienen más flexibilidad en la maquetación, más integraciones con otras herramientas o simplemente permiten una mejor navegación.
Para no reinventar la rueda, aquello que se use ya en la organización debería servirnos, y los límites que tenga la herramienta se pueden puentear con otras estrategias que desgranamos más adelante.
La plataforma donde documentemos nuestro producto tendrá que posibilitar la estructura, formato y enfoque que queremos dar, por lo que habremos aprendido a usarla antes de hacer esos otros pasos. Seguramente durante La Avalancha es donde te has familiarizado con el soporte donde se documenta.
Crear plantillas para que otros compañeros las usen es una gran manera de no tener que enfrentarse a la página en blanco. Y sobre todo, asegurarse que La Audiencia tiene acceso a este contenido, porque si se usan distintas plataformas según el equipo, habrá que replicarlo.
Accede a nuestra plantilla Documentación de Producto by Thiga
Aunque la herramienta permita muchísimas florituras, pensemos también si nuestro lector está en su móvil, o si su conexión es tan buena como la nuestra para cargar vídeos pesados.
Además, si es la primera vez que entran (por ejemplo, porque sí que has identificado que hay que cambiar de plataforma o documentar tu producto en un espacio distinto al habitual) intentaremos reducir la carga mental de aprender a navegar un sitio nuevo. Los manuales de instrucciones es un buen ejemplo: con más dibujos o menos, en varios idiomas o no, para una plancha o para montar una estantería, pero siempre son cuadernillos de papel con índice.
La Herramienta, al fin y al cabo, va a ser nuestra infraestructura e interfaz donde construyamos todo lo que hemos venido definiendo por lo que conocer bien sus posibilidades solucionará mucho del trabajo que aún nos queda por hacer.
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.
Si quieres saber cómo continua la historia, haz click aquí:(Ahora SÍ) La documentación - Docutopía #8
Foto de RDNE Stock project en pexels
