Palavra do Rei - melhores práticas em desenvolvimento de software (proposta de meme)
Na Myfreecom criamos uma série de regras que são o início do que virá a ser o conjunto de melhores práticas no desenvolvimento de software na empresa. “O Rei” é a inteligência superior resultante da opinião pessoal de cada um em relação a desenvolvimento de software.
Todos nós temos estas “melhores práticas” definidas em nossa mente, mas nem sempre elas são iguais entre a equipe. Esta diferença muitas vezes causa frustação, pois nem sempre as práticas do companheiro de equipe atinge nossas espectativas, ou vice-versa.
O Rei da Myfreecomm diz:
Programação
- Todo o código de programação deve ser escrito em inglês.
- Os nomes de variáveis são em inglês.
- Os parâmetros são em inglês.
- Não devemos usar abreviação em variáveis e parâmetros.
- Nunca uma variável e parâmetro terá apenas uma letra, ela será sempre uma palavra (em inglês) auto-explicativa (com excessão de variáveis locais em iteração, exemplo clássico a variável "i").
- Nunca suponha em seu código qual será o endereço de uma url ou localização de arquivo. Mantenha suas funções parametrizadas.
- Nunca coloque o nome do produto ou do cliente em variáveis ou nome de projetos.
Deployment
- Nunca duplique um código.
- Quando pensar em duplicar um código, por precisar de uma solução rápida e mais segura, Pare!
- Um código deve sempre estar em um ÚNICO lugar nos ambientes de produção.
- Uma hora ganha por duplicar o código hoje, equivale a uma semana perdida amanhã.
Banco de Dados
- O banco de dados é sagrado, apenas uma programação (a dona do bd) deve ter permissão de acesso.
- Não escreva qualquer programação que acesse direto o bd, além da dona, mesmo que seja apenas para leitura.
- Os nomes de banco de dados, tabelas e campos.. em inglês.
- Nunca teste um código em um banco de dados em produção, pois você destruirá a integridade das informações do banco.
URL
- A definição de uma URL de acesso interno é um recurso caro. O custo de mudança é muito alto.
- Ao definir uma URL de acesso interno, pense bem no escopo em que ela se encontra e abstraia o máximo possível.
- Não use caracter "_" em domínios e sub-domínios, o Internet Explorer vai te dar uma rasteira.
- Prefira "-" para substituir o espaço nos domínios e sub-domínios.
Nós acreditamos que esta lista é dinâmica e nunca se completará. Conforme formos trabalhando, aprendendo novas tecnologias, o Rei vai soltando mais regrinhas e a euipe vai mantendo a equipe com uma idéia única. Sabemos que esta lista mesmo está incompleta ainda…
Acreditamos também que não existe uma única lista “correta” e que cada empresa vai achar o seu conjunto de melhores práticas, de acordo com a sua situação, mercado e visão.
Não tenho dúvidas, que O Rei da Improve-it, por exemplo, vai dizer muita coisa em relação à testes, BDD e afins…
E você, o que acha destas regras, discorda de alguma? Alguma vez já escreveu seu conjunto de melhores práticas? O que o Rei da sua empresa diz?
Convido cada um postar em seu blog a sua lista de melhores práticas e colocar um trackback para cá, que tal?
Seria um MEME interessante, talvez com o apoio de blogs mais fortes, que lêem este, conseguimos começar a trocar uma idéia sobre esse assunto ;-)
Abraços e até a próxima.