He encontrado CUALQUIER documentación es mejor que NINGUNA documentación. La cantidad apropiada generalmente está determinada por la cantidad de tiempo que tenemos para hacerlo o por cuánto odiamos las llamadas telefónicas y los correos electrónicos de soporte.
Parece que los miembros de su equipo actual tienen algunas expectativas poco realistas de sus recuerdos, o están avergonzados de sus habilidades de escritura y no están dispuestos a practicar.
Me doy cuenta de que estoy en una minoría (especialidad inglesa que ingresó a la ingeniería de software en la escuela de posgrado) aquí, ya que no encuentro documentación como una tarea rutinaria. Es una valiosa herramienta profesional. Puede que no encuentre la escritura tan difícil de hacer como algunos de mis compañeros de trabajo, pero eso es principalmente porque tengo más práctica en ello. No considero que un proyecto esté terminado a menos que tenga documentación, y generalmente lo escribo por razones puramente egoístas: para que pueda darles a las personas algo para leer en lugar de recibir llamadas telefónicas y correos electrónicos, o así puedo recordar de qué hablamos al final mes, más o menos, puedo referirme a cómo hice algo si necesito apoyarlo en medio de la noche.
La mejor manera de abordar la documentación es escribirla A medida que avanza, exactamente como escribir el código de prueba. Es sorprendente cómo algunas plantillas preescritas (con encabezados, códigos, etc.) pueden hacer que la documentación sea más fácil y rápida. De esta manera, puede capturar el cambio a medida que sucede, y tiene menos terreno que cubrir con el tiempo. Usted es más eficiente de esta manera, ya que puede consultar la documentación según la necesite y cambiarla en el camino. Hacerlo en una wiki, por ejemplo, hace que las actualizaciones sean más fáciles, y puede evitar problemas con la versión del documento si la última y mejor siempre está en línea en el mismo lugar, y puede enviar enlaces a las personas que necesitan leerla.
Si pasa un poco de tiempo documentando, TODO trabajará más rápido, especialmente cuando alguien nuevo se una al equipo, ya que no tendrá que pasar todo ese tiempo averiguando todo. Resolver las cosas es una parte divertida de nuestros trabajos, pero no es divertido cuando tienes que hacerlo con prisa para arreglar la producción. Todos ahorraríamos mucho tiempo si todos escribiéramos un par de notas más.
¿Su equipo tiene los mismos problemas con las pruebas o al escribir el código de prueba? Si no, esta será una venta más fácil.
Su documentación es útil de muchas maneras:
1) Para usted, ahora mismo, y para sus compañeros de trabajo, mientras trabaja en el proyecto.
2) A sus clientes. Tener documentación (incluidos los diagramas) que puede mostrar a los usuarios facilita las discusiones en las reuniones, especialmente si se trata de sistemas complicados. Incluso si la documentación está incompleta, es un lugar para comenzar.
3) A las personas que heredarán su trabajo (que incluso puede ser usted, en tres años). Muchos de mis compañeros de trabajo más jóvenes piensan que recordarán cosas para siempre. Sé que no lo recordaré más allá de esta semana si no lo escribo. Tener documentación le ahorra tener que pasar medio día para recordar cómo estructuró algo y tener que resolverlo todo de nuevo.
4) Para usted y otros, si la situación se vuelve política o contenciosa. Como alguien que toma notas en las reuniones, para mantenerme despierto y luchar contra el aburrimiento, a menudo he sido el único con la versión escrita de una decisión. La persona que lo escribió gana la disputa. ¿Recuerdas esto la próxima vez que alguien diga "Recuerdas esa reunión que tuvimos el invierno pasado en la sala de conferencias 4, cuando íbamos a pasar por X? Fred estaba allí, ¿y quién es ese tipo de Contabilidad?"