Executando verificação de segurança...
Em resposta a [Não disponível]
2

Existem sim algumas formas de documentar as decisões e casos de uso, seja com UML, diagramas de atividade ou também documento de texto (tipo o que cada página faz e as regras de negócio). No entanto, se a sua ideia é documentar o que cada arquivo faz, não sei se é a melhor decisão, visto que a ideia, tomando como base o clean code, é o próprio código dizer o que faz.

Carregando publicação patrocinada...
2

Concordo com seu ponto de vista.
Documentar o que o código faz, é uma fuga total de um dos principios do clean code. O que seria interessante você documentar é a regra de negócio que cada processo é responsável e o impacto que ele tem. Isso, caso algum dia você queira migrar para uma outra linguagem de programação, tornaria o processo muito mais rápido, com menos bugs em regras de negócio.

1

De fato. Documentar a regra de negócio é muito mais importante do que o código em si, se você fez um bom trabalho no código a única coisa que impede de alguém entender o processo por completo é não conhecer a regra de negócio.