Fui especificamente solicitado a dar uma explicação ou comentário linha a linha (ou, conforme apropriado - por exemplo, imagem por imagem, etc.) que meu chefe queira ler e seguir.
Como ele não é um programador, ele não pode seguir o código e quer que ele seja traduzido para o inglês.
Alguém já foi solicitado a fazer isso antes?
Comentei todo o código-fonte e usei JSDoc para gerar uma documentação completa de todas as funções, variáveis, etc. ... e incluiu um exemplo de implementação e demonstrações completas de trabalho com comentários durante todo o processo.
Há mais alguma coisa que eu possa fazer para comentar o código para não programadores?
Este não é um pedido razoável, é?
No final, consegui explicar por que não era um bom uso do tempo para fazer o que ele estava pedindo. Ele é um cara razoável e simplesmente não tinha uma compreensão do que o meu trabalho envolve. Uma vez que ele viu este post, acho que ele rapidamente entendeu que não era um pedido normal.
Eu forneci a documentação que é adequada para outro programador seguir (JSDoc e comentários em linha - bem como algumas notas extras sobre questões técnicas), e um diagrama de fluxograma muito amplo da lógica principal do programa para o meu chefe seguir.
No final, todas as partes ficaram satisfeitas e seguimos em frente.
Tags documentation