Documentação é a chave

Melhor prática 2 - Complete seus documentos antes da próxima etapa

Eu tinha passado meu mestrado em Computação e Aplicativos e era tão apaixonado por escrever código-fonte, mesmo sem compreender e documentar completamente os requisitos. O documento de design e a documentação de casos de teste não estavam em lugar nenhum no ciclo de vida de desenvolvimento de software ... houve um salto direto para a codificação.

Em estágios posteriores, me encontrei em um grande problema e logo percebi Documentation is the Key para se tornar um desenvolvedor de software, testador ou arquiteto de sucesso.

Antes de começar a desenvolver um software pequeno ou grande, você deve ter respostas para as seguintes perguntas:

Onde está a especificação de requisitos?
Onde está o documento de análise de impacto?
Onde está o documento de design?
Você documentou todas as suposições e limitações de maneira adequada?
Você revisou todos os documentos?
Você conseguiu a aprovação de todos os documentos de todas as partes interessadas?

Depois de ter respostas positivas para todas as perguntas acima, você está seguro e pronto para prosseguir para a codificação. Muitas organizações teriam regras rígidas a serem seguidas, mas outras não. A prática recomendada é preencher toda a documentação necessária e obter as aprovações adequadas antes de prosseguir com a codificação do software.

O que você aprende hoje, te prepara para amanhã!

Portanto, novamente, é uma das melhores práticas ter a documentação o máximo possível. Alguns documentos importantes que o prepararão para o futuro são:

Abordagens de Design
Dicas e truques
Funções, comandos e instruções especiais
Lições aprendidas
Situações peculiares
Métodos de depuração
Melhores Práticas
Qualquer coisa que possa te ajudar no futuro

Manter documentos eletronicamente não custa nada. Portanto, vamos começar a manter a documentação necessária.