A importância de se documentar um código
Ao escrevermos linhas de código nos deparamos com muitos desafios e temos que fazer escolhas que afetarão todo o funcionamento do mesmo, desde as linguagens, passando pelos frameworks e comandos para a utilização do mesmo.
Mais tarde ao retornamos para esse mesmo código, precisamos de instruções para fazê-lo funcionar. Também desejamos analisar os pontos de melhorias para uma atualização, mas não temos disponível nenhuma informação, nenhum manual. E o mesmo pode acontecer quando um terceiro precisa avaliar o seu progresso.
Por isso é importante documentar o seu código. Para isso não se tornar uma tarefa maçante ou alguns detalhes se percam durante o processo, pŕeencha o "readme" durante o desenvolvimento do código. A cada atualização, vá incluindo novos detalhes.
Com isso, você não só facilita o próprio trabalho, como também de quem tem acesso ao seu código.
