Documentar seu software pode parecer irrelevante quando comparado as necessidades de apresentar funcionalidades para atender as demandas de mercado, mas cuidado, tal atitude pode gerar prejuízos futuros ou até mesmo a falência do projeto. Por ter vivido este cenário traumático com alguns clientes resolvi elaborar uma lista com informações que garantem a vitalidade do seu projeto:

• IDE, ambiente e versão de em que foi desenvolvido o sistema;
• Bibliotecas utilizadas no projeto e suas respectivas versões;
• Plug-ins e versão;
• Descritivo de implantação;
• Dependências do projeto;
• Diretrizes de segurança como portas que devem ser liberadas permissões de diretórios etc.;
• Versão do banco de dados;
• Dados de acesso ao banco.

Além das informações acima procure documentar alguns recursos que auxiliam novos desenvolvedores a dar manutenção em seu sistema como:

• Diagrama de banco de dados;
• Fluxograma das principais funções do sistema;
• Fluxograma de gatilhos de eventos;
• Comentários de rotinas.

Após a documentação elaborada teste com um desenvolvedor que não faz parte de sua equipe a implantação de seu projeto em ambiente virtual e acredite isso evitará inúmeros transtornos futuros.