Documentar tu producto va mucho más allá de simplemente redactar textos; es un proceso meticuloso que implica preparar, escribir y revisar con un propósito claro. Documentar nuestro producto implica una serie de pasos cuidadosamente planeados para asegurar que cada parte del contenido sea coherente, útil y accesible. En este capítulo, veremos cómo preparar efectivamente el material antes de la redacción final, asegurando que cada palabra escrita sirva a un propósito estratégico y aporte valor al usuario final.
Preparar el material. Escribir y revisar.
Cuando documentamos, a veces lo último que hacemos es redactar. Hemos tomado una serie de pasos para que sentarse a escribir se haga con un propósito en mente. Si eres de planear al detalle, un calendario de contenidos te ayudará a manejar el tiempo e ir publicando con una cadencia.
Por experiencia, es mejor escribir una idea del tirón. Si estás redactando cómo se comporta una funcionalidad en distintos escenarios, termina esa explicación antes de una reunión o de que acabe el día. Cuando te quieras volver a poner, a lo mejor la musa ya te ha abandonado. Aplica la misma lógica que los post-it e historias de usuario: algo que si vuelvo a leer en dos meses, todavía se entiende. De todas maneras, algo que me sirve es titular con un [Draft] o [WIP] aquellas secciones que no están completas, para saber dónde tengo que retomar.
También suelo dar prioridad a los temas que están ya establecidos y asentados: a lo mejor documentar una funcionalidad del producto que todavía está en fase de exploración te hace perder un poco el tiempo, puesto que aún está muy en el aire cómo se va a aterrizar su implementación.
Recuerda también consultar con stakeholders la información relevante, que ningún dato o descripción sean fruto de cosas que has oído en una reunión o te suena que funcionan así.
En organizaciones grandes, será muy importante mencionar a menudo a los equipos y stakeholders para que el lector sepa con quién debe tratar cada tema. Y aunque estés documentando con un lector específico en mente, recuerda que puede servir para otras personas en un futuro, así que evita acrónimos y jerga muy especializada. Puedes aclarar a medida que aparecen los términos, como en los contratos: “Nuestro catálogo incluye Product Information Page (PIP) y Product Landing Page (PLP). ” y el resto de ese texto usar las siglas.
Las plantillas que habremos elaborado pueden ser de gran ayuda para enfrentarse a una página en blanco, y una estructura flexible (que como apuntábamos, facilita el pensamiento paralelo) nos ayuda a ir componiendo el material a distintas velocidades y en sus distintos formatos: habrá días que tengamos más tiempo e inspiración para escribir párrafos y párrafos, y otros que nos centremos en organizar la biblioteca de imágenes y dejar todo maquetado para ir rellenando.
Por ponerte un ejemplo…
Como no suelo dedicar un día entero a escribir, intento reservarme horas tranquilas del día para redactar contenidos totalmente nuevos. Y aquellos días más ocupados o con menos inspiración, entro al material ya existente y releo y edito. Eso además suele darme ideas, así que siempre tengo abierto el bloc de notas o mi tablero Miro de documentación del producto para añadirlo y que no se me olvide.
Además, es bastante frecuente que mientras he estado preparando todo lo anterior, he ido pensando en títulos, índices y resúmenes para las distintas partes. Así, cuando toca desarrollar, ya hay algo empezado. Al releer, intento unificar el tono para que no se pierda el ritmo de lo escrito.
Foto de freepik
