¿Cómo documentar un mal proyecto sin avergonzar a nadie?

He participado en un catastrófico proyecto freelance lleno de malas decisiones. Lo dejé. Como parte de la entrega, tengo que "documentar mi trabajo", lo que esencialmente significa que tengo que documentar todo el proyecto (soy el primero en escribir documentos sobre él).

Ahora tengo que explicar cómo va la cosa, su estructura, arquitectura, flujos de trabajo de desarrollo, etc. Está lleno de errores. Ahora que lo escribo, estoy impactado y también sorprendido.

El comportamiento profesional sería que simplemente escribo el documento sin mencionar nada de lo que pienso al respecto. Ahora el problema es que mi nombre estará en este documento, y así parecerá que las malas decisiones serían al menos parcialmente mías.

Por supuesto que podría explicar, o al menos mencionar indirectamente, que "no, no fue mi decisión". Podría, pero obviamente sería muy poco profesional.

También podría escribir los documentos sin mencionar nada sobre las responsabilidades. El problema es que en este caso también avergonzaría mi nombre. También puedo sospechar que mis (ex) compañeros de trabajo tenderían a avergonzarme, en lugar de reconocer sus errores. Pero obviamente no puedo avergonzarme también de su nombre.

¿Cómo resolver esta contradicción? O, en un sentido más amplio: ¿cuál es la forma profesional óptima en tal situación?

¿Planteó usted estas inquietudes cuando el proyecto estaba en ejecución? Si no hizo nada en ese momento, entonces es cómplice de los problemas y debe ser nombrado. La retrospectiva es algo maravilloso de lo que podemos aprender, pero echar el dedo de la culpa si dejas que suceda es tratar de desviar el problema al que realmente contribuiste.
En el pasado he evitado culpar a la gente diciendo cosas como; algunos códigos heredados heredados no cumplían con los estándares de codificación actuales:
O ; La fase de integración reducida significaba que no se podían realizar todas las pruebas planificadas. Lo mismo ocurre con los datos de prueba que faltan. Los requisitos del cliente llegaron demasiado tarde para cumplirse satisfactoriamente. Las limitaciones de tiempo significaban que las habilidades del personal no estaban al día. Ese tipo de cosas.

Respuestas (3)

Su documentación debe ser 100% neutral. Como mencionó, no debe poner nada de su aporte personal en la documentación con respecto a cómo se siente con respecto al proyecto, las personas que trabajaron en el proyecto, los detalles del diseño, etc. Si mantuvo un buen registro en papel o tiene el registro en papel desde el personas que estuvieron en el proyecto, estarás bien ya que quedará claro que no fuiste tú quien tomó las malas decisiones.

En cuanto a su nueva documentación, se puede hacer sin mencionar a nadie en concreto. Por ejemplo, "Tom decidió desnormalizar las tablas de la base de datos para que el código fuera más fácil de escribir, pero al final se volvió inmanejable y difícil de trabajar con él" podría reescribirse como "La decisión que se tomó con respecto al almacenamiento de datos fue desnormalizar la base de datos". tablas para reducir la cantidad de código necesario para escribir en el lado de la aplicación. Sin embargo, los datos se volvieron muy difíciles de administrar debido a la falta de buenas relaciones y estructura entre los datos y las tablas". Esto le permite comunicar claramente el problema y lo que sucedió sin culpar.

La culpa viene cuando proporciona correos electrónicos, actas de reuniones y cualquier otra cosa para desarrollar un registro en papel de cómo se tomaron las decisiones. Nuevamente, usted permanece neutral como la persona que está haciendo la documentación, pero proporciona cualquier comunicación relevante y deja que el lector llegue a la conclusión lógica basada en el contenido. Si hay una cadena de correo electrónico en la que no está de acuerdo con una decisión o ni siquiera fue parte de una decisión que terminó fallando, cualquiera que lea el correo electrónico entenderá que no fue su culpa.

Normalmente dirías cosas como "Yo decidí", "nosotros decidimos", "nuestro líder de equipo decidió". Si dices "se tomó la decisión de hacer X" o "se decidió hacer X", especialmente si resulta obvio que fue una mala decisión, eso significa claramente que no quieres mencionar nombres, y que niega haber contribuido a esta decisión.

Está documentando el sistema tal cual. No estás juzgando ni a él ni a quienes lo escribieron. No se preocupe, si la documentación es lo suficientemente clara, otros juzgarán por usted.

Si la aplicación se almacena correctamente en varias versiones con sello de fecha, debe quedar claro que su documento se produjo mucho después de que el sistema estuviera "terminado". Si la aplicación es tan grande que se necesitó de varias personas para escribirla, entonces no veo cómo esta aplicación podría fijarse en usted y solo en usted.

Haz tu trabajo de documentar y olvídate de todo. Una advertencia: cuando documente, asegúrese de no usar "yo" o "nosotros".