¿Cómo es una buena documentación?
¿Cómo es una buena documentación?
Ya para otra ocasión, debatimos sobre cómo debe estar diseñada esa documentación, pero de momento, quedémonos con su importancia.
Bienvenido, bienvenida a Rodobo, un boletín quincenal que explora la relación entre el diseño de producto, la experimentación, analítica y las empresas.
Cuando me senté a escribir esta edición lo hice con un único objetivo, desarrollar alguna de las muchas ideas de contenido que tengo apuntadas en una base de datos en Notion. Pero entre que no era capaz de desarrollar alguna de esas ideas, y que Notion no funcionaba lo rápido que me hubiese gustado, invertí el tiempo de escritura en buscar herramientas para documentar.
De las características que buscaba en documentar, y de una serie de conversaciones en la que se me plantearon varios problemas en torno a cómo dar forma a una buena documentación surge esta edición.
Conversaciones
Con Salvador Serrano, co-CEO de mendesaltaren.
Hoy tengo al otro lado a una persona que es un ejemplo, no sólo por su dedicación sino por el respeto, cariño y liderazgo que ejerce en su equipo.
Salvador y yo hablamos de:
Carrera profesional
Confianza y transparencia en las relaciones de trabajo
Delegar y el concepto de Molly Graham, “Regala tus Legos”
De qué forma se impulsa la cultura desde la gestión de personas
Experimentación y fallar rápido
Pensar en problemas, no en soluciones
Pensamiento crítico y habilidades importantes en un diseñador
Perspectiva y riesgos para ofrecer la mejor solución
Muchas gracias por tu tiempo, Salvador. Nos vemos, como quien dice, por el barrio.
Te dejo el episodio aquí abajo y en este enlace.
También puedes leer la newsletter de Salvador, Fundamentos Serrano, en este enlace.
¿Qué hace que una documentación sea buena?
La pregunta que da título a esta edición es una pregunta seria. Una que todos deberíamos hacernos con respecto a documentar.
Hace más de un año desde que publiqué un artículo sobre la importancia de escribir trabajando en remoto. Por aquel entonces comentaba que en el trabajo en remoto (ahora pienso que no solamente debería ser en remoto), nos comunicamos principalmente a través de lo que escribimos.
Seguro que en tu entorno envías mensajes todos los días, convocas reuniones con una descripción sobre el propósito de la misma. Te pasas gran parte de tu jornada de trabajo escribiendo. Pero escribir no es documentar.
Siempre me he considerado a mí mismo un guardian de la documentación. Creo que una buena documentación es una de las mejores herramientas para mantener la alineación a largo plazo, sirviendo a su vez como una heurística para ver cómo se mantiene la comunicación del equipo, fomentando que ésta pueda ser cada vez más asíncrona.
De hecho, documentar es una de las herramientas que permite tener un histórico de qué ha pasado, qué acciones se llevaron a cabo y por qué. Es una de las herramientas que se integran en todo el proceso de desarrollo de producto, incluso antes de que se desarrolle.
También después de su lanzamiento, sigue siendo crítico para revisar qué se hizo y por qué, en caso de que surja algún imprevisto.
Y por si esto no te convence, déjame comentarte lo siguiente.
Los peligros de una documentación deficiente
En muchas ocasiones, y no es por repetirme, siento que la mayoría de los problemas nacen de la comunicación entre personas. De su forma de comunicarse, de la madurez emocional, los estilos de trabajo y las motivaciones e intereses propios, y sobre todo de empatía. También de empatía en la otra persona. No en vano, ¿no es la documentación un canal de comunicación que nos permite adaptarnos a todo lo anterior?
Sin documentación, los equipos terminan tomando decisiones como cualquier jugador de fútbol que termina pasando el balón sin saber a qué compañero tiene cerca. Decisiones que no están alineadas.
Puede ser que en el corto plazo no afecte mucho, pero en el largo, puedes estar seguro, que perderás muchas horas tratando de comprender qué sucede. Ir a la raíz del problema, como comentaba en la anterior edición, será más complicado por su profundidad.
Para muchos, documentar no es importante porque, aunque mitiga el desastre, lo hace en silencio. Y como lo hace en silencio terminamos con una documentación fragmentada e inaccesible.
Y entonces, ¿cómo es una buena documentación?
Últimamente estoy dándole vueltas a un pensamiento sobre simplificar, elegir el tipo de información que necesite el equipo dependiendo del proyecto y las características del mismo.
A mayor riesgo, la documentación debe ser más extensa y precisa. ¿Y qué es riesgo y cómo lo valoramos? Acaba de surgir un tema muy interesante para una próxima edición.
Lo que si tengo claro es que una buena documentación es aquella a la que puedes acceder de forma rápida y fácil, es visible, a la que puedes acudir cuando necesitas una respuesta, y aquella que siempre está mejorando con el tiempo dentro de tu sistema de trabajo. Es decir, es sistemática.
Pasemos a describir esto más en detalle.
Visible y accesible de forma rápida y fácil
Cuando buscamos algún tipo de documentación generalmente lo hacemos en un momento en el que necesitamos entender. Es el momento ideal en el que nos preguntamos dónde está. Y en ese sentido, el espacio en el que documentamos no debe requerir de pensamiento alguno por parte de la persona que busca información. Una buena documentación depende de las diferentes formas de hacer visible una información.
Y sin embargo, ser visible, no es suficiente, necesitas que se pueda acceder a ella de forma rápida y fácil. No hay nada peor que aquellos documentos ocultos, o peor aún, aquellos en los que no tienes permisos de visualización.
Haz que sea fácilmente encontrable. Si nadie encuentra lo que necesita, tu documentación, por muy bien que esté, no sirve, no cumple con su función principal.
Da una respuesta
Antes mencionaba el hecho de que cuando buscas información lo haces en un momento de necesidad. Un momento en el que necesitas entender. Necesitas una respuesta.
La documentación tiene que ser sencilla, fácilmente interpretable y no debe requerir pensamiento instantáneo por parte de quien la procesa. Debe dar contexto sobre lo que se ha hecho. Y depende del tipo de proyecto, también sobre lo que se hará.
En este sentido, habla con el equipo sobre cómo es la mejor forma de presentar este tipo de información, organízala de una forma que todos puedan entenderla. De hecho, habla con ellos sobre la importancia de la misma. Recuerda que documentar es para todo tipo de personas.
En la práctica, cuando anteriormente mencionaba la forma de comunicarse, la madurez emocional, los estilos de trabajo y las motivaciones e intereses propios, con la documentación debes estar preparado para diferentes estilos y preferencias.
Mejora con el tiempo
Todo lo anterior está bien, pero como citaba al inicio de este apartado, llevo un tiempo pensando que menos es más, y que documentar está bien, pero ¿cómo mejoramos lo que escribimos?
La respuesta que encuentro a día de hoy es que la documentación debería iterar a medida que lo hace el equipo, la madurez de tu empresa e incluso el producto o los proyectos en los que trabajas.
Depende de muchos factores, del riesgo, del equipo de trabajo, del tiempo dedicado al proyecto, del objetivo del mismo, etc. Por lo que abogo es porque la documentación, al igual que otra tarea del proyecto, debería tener hitos y no ser tan diferente a lo demás.
De hecho, cada vez que se realice algún tipo de trabajo, tener unos minutos para pensar y decidir por qué es útil y qué no lo es ayudará a ganar velocidad de documentación.
Algunas conclusiones sobre documentar
Puede que esté escribiendo esto como un fan de documentar. En el fondo, me gusta escribir, ¿no se nota? Lo que sé, en mi experiencia, es que documentar sirve como una forma de ahorrar tiempo y mitigar riesgos al dar al equipo un método asíncrono para conseguir las respuestas que necesitan.
Y es que, cuando la documentación es buena, se convierte en una herramienta importante para la toma de decisiones y para la resolución de problemas. Además de que ayuda a mantener consistencia y uniformidad en todos los procesos y operaciones. ¿Y esto qué mejora? Eficiencia y calidad.
Ya para otra ocasión, debatimos sobre cómo debe estar diseñada esa documentación, pero de momento, quedémonos con su importancia.
Lo que he leído estas semanas
Una frase
Cada diseño exitoso es sólo la última iteración en una serie de fracasos. Khoi Vinh.
Construyendo en público
Suscripciones: 1.687 personas (me equivoque en la anterior edición)
Tasa de apertura de la edición anterior: 48%
Clics en enlaces: 9%
Visualizaciones de la edición anterior: 1.502.
Si te gusta mi contenido, lo mejor que puedes hacer es compartirlo. También he habilitado una página en Ko-fi para que puedas invitarme a un café.
Nada más, por ahora, nos leemos en 15 días.
Gracias.
Me ha encantado!