Documentação é a Chave

As Melhores práticas 2 - Preencher os documentos antes da próxima etapa

Eu tinha passado o meu mestrado em Computador e Aplicação e eu estava tão apaixonado a escrever código fonte mesmo sem entender completamente e documentar os requisitos. Documento de projeto e documentação casos de teste foram em parte alguma no ciclo de vida de desenvolvimento de software ... não foi direta saltar para a codificação.

Em fases posteriores, encontrei-me em apuros e logo percebi documentação é a chave para tornar-se bem sucedido desenvolvedor de software, arquiteto ou teste.

Antes de você começar a desenvolver pequenas ou grandes softwares, você deve ter resposta para as seguintes perguntas:

• Onde está a Especificação de Requisitos?

• Onde está a análise de impacto documento?

• Onde está o documento do projeto?

• Você documentou todas as hipóteses, limitações corretamente?

• Você já fez revisão de todos os documentos?

• Você fez pra sign off em todos os documentos de todas as partes interessadas?

Uma vez que você tenha as respostas positivas para todas as perguntas acima, você está seguro e pronto para passar para a codificação. Muitas organizações que têm regras muito rígidas a serem seguidas, mas os outros não têm. As melhores práticas são para concluir todos os documentos necessários e tomar as devidas aprovações antes de prosseguir para a codificação de software.

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

Assim, mais uma vez, que é uma das melhores práticas para ter documentação, tanto quanto possível. Alguns documentos importantes, que vai preparar você para o futuro são os seguintes:

• Abordagens de Design
• Dicas e truques.
• As funções especiais, comandos e instruções
• Lições aprendidas
• Situações peculiares
• Métodos de Depuração
• Melhores Práticas
• Tudo o que possa ajudá-lo no futuro

Conservação de documentos por via electrónica não lhe custar caro. Então, vamos começar a documentação necessária.