Epístola 8, sobre Rufino y la documentación

Estábamos Rufino y yo probándonos un disfraz de disfraz, cuando se me apareció en la cabeza la imagen de una foca con un parche en el ojo.

— ¡Rufino! —dije yo— hoy es el cumple de mi ahijado.

— ¡Santo cielo!

Rufino cogió el palo de pegar y golpeó tres veces la olla donde estábamos preparando las migas. Esta, se convirtió en un portal intergaláctico y nos transportamos a la Alemania del siglo XV donde nos encontramos a un distraído Johanes Gutemberg tarareando la Macarena.

— Hombre Rufi, ¡cuanto tiempo! contigo quería yo hablar.

— Dime majo, dime.

— Pues mira, desde que inventé la prensa y esas cosas, tengo la manía de dejar todo por escrito. Que si este cilindro aquí, que si esa tinta allí, que si como cocinar un mapache… Pero la cuestión es que me doy cuenta de que tengo muchos documentos empezados y nunca los termino.

— DImelo a mi, que empecé a escribir esto hace 8 años

— ¿Empezaste a escribir que?

— ¿Qué?

— ¿Qué?

— ¡Viva Honduras! —Exclamé yo

Rufino y Gutemberg se miraron confundidos y luego hubo unos intensos e incómodos 3 segundos en el que se veía claramente que Gutemberg le iba a pedir salir a Rufino. Este, que había vivido mucho tiempo en los suburbios de Córdoba, reaccionó rápidamente.

— Pues verás muchacho, cuando uno empieza en el negocio de la gestión, ya sea proyectos o personas, si tiene una cabeza más o menos ordenada intentará transcribir las claves de la operativa. Por ejemplo, la especificación de un proyecto web. Qué páginas tiene, funcionalidad, conexión con terceros. Pero hay que tener cuidado porque si una cosa es importante en la documentación, es tenerla actualizada

— Pero no es más importante que se detalle todo al máximo posible?

— Pues en mi experiencia, no. Pero ojo, esto lo digo en base a los recursos que dispongas y al objetivo de la documentación. Si lo haces para acotar el alcance de un proyecto por supuesto que sí. Pero si lo haces para guiar el desarrollo de un software, ahí te diría que no. En ese caso es mejor hacer un guión, revisarlo con el equipo y centrarse solo en las partes que generen más trabajo o fricción.

—Y Rufino —Dijo Johanes mientras se depilaba las piernas— ¿cómo lo puedes organizar para no perderte entre todo lo que escribes?

— En general tendemos a organizar la documentación en carpetas, ya sea en un disco duro o en una herramienta documental. Mi primer consejo sería versionar documentos, no carpetas. Es decir, no hagas lo típico de “Carpeta versión 1” con un montón de documentos y “Carpeta versión 2” con otro montón.

— Vale, me puedes repetir lo de las magdalenas?

— Segundo, intenta que cada carpeta padre no tenga muchos hijos, de hecho no más de 4. Es mucho mejor bucear en profundidad que en anchura.

— Vale, 2 huevos, 125g de mantequilla, 125 harina normal y 125 gramos de azúcar.

— Tercero, no tengas carpetas y documentos en el mismo sitio. Siempre que te vaya a ocurrir eso, crea una carpeta nueva con ese documento suelto.

— Mezclo primero el azúcar con la harina, luego añado los huevos y lo remuevo vigorosamente

— Cuarto, haz un documento con un índice con el resto de la documentación. No te flipes poniendo en qué carpeta está exactamente, ni cuantas versiones, ni nada. Simplemente explica para qué sirve cada documento y que quien lo vaya a utilizar se las ingenie para encontrarlo. Como mucho incluye un enlace del sistema que uses (por ejemplo, un enlace de google drive)

— Derrito la mantequilla hasta que se comience a quemar y lo mezclo todo de nuevo vigorosamente.

— Quinto, utiliza esta estructura cuando llegues al último nivel de carpetas. “Draft”, “Old” y “Latest”. En “Draft” puedes poner las cosas que no estén terminadas, en “Latest” la documentación que debes utilizar, y en “Old” las versiones antiguas por si es necesario revisarlas a nivel histórico.

— Y luego lo distribuyo todo en moldes pequeños y lo dejo enfriar durante una hora en la nevera.

— Y ya está. Porque si el procedimiento para documentar es complicado, la documentación también lo será. Intenta contenerla al máximo en cuanto al número de ficheros, Es mejor tener un documento general que uno para las páginas, otro para los endpoints, otro para el modelo de datos. Puedes utilizar por supuesto otros elementos de apoyo (que puedes guardar en draft), pero es importante que el documento de consulta reúna toda la información posible para que nadie se pierda entre los diferentes ficheros.

— Finalmente lo horneamos durante 15 minutos a 180 grados.

— En resumen, no te flipes con la documentación y haz algo práctico. No por hacer más documentos vas a ser mejor manager. Lo importante es que la gente encuentre respuesta a sus problemas, así que prioridad el fondo sobre la forma. Y si un documento no se actualiza desde hace tiempo, a la carpeta de “Old”.

— Que bueno eres Rufino, gracias por compartir tu sabiduría —Dijo Gutemberg mientras golpeaba el techo de su Volkswagen Jetta— Y ahora que hemos terminado, te importa que te pregunte una cosa

— ¡Yo no soy Rufino! Soy el recuerdo de una estufa que tenían tus padres en Badajoz. Lo que ha pasado no ha pasado.

— ¡Cielo santo es cierto! !Ay ay ay madresita qué quilombo! —Gritó un atribulado Gutemberg.

Y mientras todo esto ocurría, Rufino y yo seguíamos intentando cuadrar la foto de su primera comunión en el pasillo.

—Más a la derecha.

—¿Así?

—Si, así está perfecto. Asi está… perfecto… ¡¡¡Muahahahaha!!!