Ola pessoal, tudo certo?
Recentemente peguei para aprender um pouco mais sobre como documentar um software devido a um projeto da faculdade e estou com uma dúvida em como escrever esse documento, se é parecido com um TCC só que mais curto, se deve ser mais informal entre outras dúvidas. Desde já agradeço.
Penso que a documentação deve ser clara e objetiva, do jeito que você achar melhor. Seja ela informal, formal, estilo TCC, cheio de emoji, contanto que cumpra o objetivo de esclarecer do que se trata o software, como funciona, como executa, o que cada coisa faz, e como posso contribuir para o projeto.
Na faculdade me pediam muita documentacao mesmo, mas na vida real a documentacao sempre fica desatualizada. A melhor forma que encontrei de documentar meus softwares foi escrevendo testes.
Em cada teste eu descrevo o motivo daquele teste existir e oq ele deve testar. Quando alguem quer entender oq uma classe faz ela pode ler os testes.
A unica coisa que eu documento sao os passos para executar o programa, onde estao as classes mais importantes e os comandos basicos.