Mi jefe quiere una explicación narrada en inglés línea por línea de nuestro código

155

Se me ha pedido específicamente que brinde línea por línea (o según corresponda, por ejemplo, imagen por imagen, etc.) explicación o comentario que mi jefe quiere poder leer y seguir.

Dado que no es un programador, no puede seguir el código, así que quiere que todo esté traducido al inglés.

¿Se le ha pedido a alguien que haga esto antes?

He comentado todo el código fuente y he usado JSDoc para generar la documentación completa de todas las funciones, variables, etc. ... e incluyó un ejemplo de implementación, y demostraciones de trabajo completas con comentarios en todo.

¿Hay algo más que pueda hacer para comentar el código para no programadores?

Esto no es una solicitud razonable, ¿verdad?

ACTUALIZACIÓN

Al final, logré explicar por qué no era un buen uso del tiempo hacer lo que me pedía. Él es un tipo razonable, y simplemente no entendía lo que implica mi trabajo. Una vez que vio este post, creo que comprendió rápidamente que no era una solicitud normal.

Sí proporcioné documentación que es adecuada para que la siga otro programador (JSDoc y comentarios en línea, así como algunas notas adicionales sobre problemas técnicos) y un diagrama de flujo muy amplio de la lógica principal del programa para que mi jefe seguir.

Al final, todas las partes quedaron satisfechas y hemos avanzado.

    
pregunta Billy Moon 24.10.2011 - 16:09
fuente

0 respuestas

Lea otras preguntas en las etiquetas