Qué hacer y qué no hacer en la documentación agile
Con todo esto en mente, aquí hay algunos consejos tácticos para abordar tu práctica de documentación agile:
Sí: Documentar continuamente mientras trabajas
Gran parte de las quejas sobre la documentación tienen que ver con que es un proceso intensivo que le quita tiempo al trabajo real de codificación y desarrollo del producto. Sin embargo, no tiene por qué ser así.
Un artículo reciente de InfoQ postula un enfoque de documentación continua que se basa en acoplar tu documentación con la codificación y producir documentación "cuando sea mejor", que podría ser inmediatamente después de una corrección de errores, por ejemplo, en lugar de solo después de un gran proyecto. Y los propios escritos de Lucid sobre repositorios de innovación sugieren un enfoque para convertir todo el trabajo más amplio de lluvias de ideas, planificación y ejecución que ya se está haciendo en un "plan dinámico" de cómo tu negocio lleva a la práctica sus mejores ideas.
Pensar en la documentación de esta manera la convierte en una extensión natural del proceso de creación, codificación, seguridad, pruebas de venta y marketing, en lugar de ser una tarea separada que se hace a regañadientes. También es más eficiente documentar mientras se trabaja porque se pueden tomar notas del proceso sin que este deje de ser lo más importante.
No: Crear documentación porque sí
A lo largo del proceso de documentación continua, es importante hacerse las siguientes preguntas para evitar crear documentación sin sentido:
- ¿Cuál es el propósito de esta documentación?
- ¿Para quién es este documento y cómo lo usará?
- ¿Este documento ya existe en otra parte?
Adoptar una mentalidad de documentación continua no significa que debas hacer trabajos redundantes, sino que debes buscar oportunidades para agregar documentación y mejorar la existente siempre que sea posible.
Abordar los problemas de gestión de versiones, optimizar una documentación difícil de encontrar o difícil de leer para facilitar la disponibilidad de la información y la legibilidad, o agregar capturas de pantalla y diagramas a la documentación con mucho texto son formas importantes en las que puedes cambiar la base de conocimientos de tu empresa más allá de crear nuevos documentos desde cero.
Sí: Buscar oportunidades para automatizar siempre que sea posible
Agregar base de datos y otras integraciones puede reducir los errores que surgen cuando tienes que actualizar la documentación manualmente, en especial los diagramas de entidad-relación (ERD, por sus siglas en inglés) u otra documentación que muestre relaciones de datos complejas.
La automatización también puede ayudarte a ahorrar tiempo y trabajo manual, ya que se actualizan partes clave de tu documentación sin que ni siquiera lo pienses (o sepas que está ocurriendo). Tener los datos más recientes al alcance de la mano en lugar de tener que buscarlos puede ayudarte a generar información mejor y más útil y a descubrir patrones que, de otro modo, podrías haber pasado por alto.
No: Esperar hasta el final del proyecto para documentar
Esperar hasta que termine un proyecto para documentarlo conlleva el riesgo de olvidar información, introduce más espacio para el error y agrega una carga innecesaria al final de un sprint largo, cuando el entusiasmo por hacer "una cosa más" probablemente esté en su punto más bajo.
Si abordas la documentación agile desde la perspectiva de la creación de un repositorio de innovación en el momento y a lo largo del tiempo, la documentación se integra como una parte natural del proyecto (desde la idea y la planificación hasta el diseño y el lanzamiento) en lugar de ser una tarea añadida al final.
No: Producir documentos en silos
Dedicar tiempo a crear documentos individualmente y luego recopilar comentarios cuando ya empezaste un borrador es ineficiente. Si el alcance de tu documentación no es adecuado o faltan detalles críticos, tendrás que dedicarle tiempo a una revisión importante que es completamente evitable.
Involucrar a otras personas desde el principio mediante entrevistas de descubrimiento para averiguar qué documentación es realmente necesaria, o invitándolos a colaborar en la propia documentación, te ahorrará tiempo y dificultades más adelante.
Sí: Crear documentación en colaboración con el equipo
La documentación no tiene que ser un esfuerzo individual, especialmente cuando se crea a partir de código, tableros de lluvia de ideas, mapas de planificación u otros documentos que ya se han creado en equipo.
Involucrar a otros en el proceso asegura que el equipo tenga conocimiento y esté de acuerdo, lo que lo convierte en un proceso colaborativo. También crea la responsabilidad colectiva de asegurar que la organización sea rigurosa en cuanto a la documentación, lo que refuerza la importancia de mantener los documentos actualizados como equipo. Para los empleados más nuevos o júnior, participar en el proceso de creación también puede ser una experiencia de aprendizaje muy memorable.
