Manual da Engenharia para Codar
Um engenheiro ou cientista de dados trabalhando em um projeto da Engenharia…
- Tem responsabilidades para com sua equipe – mentorar, treinar e liderar.
- Conhece seu manual. Segue seu manual. Corrige seu manual se ele estiver quebrado. Se encontrar um manual melhor, copia-o. Se alguém puder usar seu manual, dê o seu.
- Lidera pelo exemplo. Modela os comportamentos que desejamos tanto interpessoalmente quanto tecnicamente.
- Esforça-se para entender como seu trabalho se encaixa em um contexto mais amplo e garante o resultado.
Este é o nosso manual. Todas as contribuições são bem-vindas! Sinta-se à vontade para enviar um pull request para se envolver.
Nota: Se você está lendo isso no GitHub - vá para https://armandoguimaraes.github.io/manual-da-engenharia-para-codar/ para uma melhor experiência de leitura
Por que ter um Manual
- Para aumentar a eficiência geral dos membros da equipe e da equipe como um todo.
- Reduzir o número de erros e evitar armadilhas comuns.
- Esforçar-se para ser um engenheiro melhor e aprender com a experiência compartilhada de outras pessoas.
“A” Lista de Verificação
Se você não fizer mais nada, siga a Lista de Verificação dos Fundamentos de Engenharia! Ela está aqui para ajudar a seguir os Fundamentos de Engenharia.
Estrutura de um Sprint
Uma divisão de seções de acordo com a estrutura de um sprint ágil.
Orientação Geral
- Mantenha o padrão de qualidade do código elevado.
- Valorize a qualidade e a precisão em detrimento de ‘fazer as coisas’.
- Trabalhe diligentemente na coisa mais importante.
- Como uma equipe distribuída, reserve um tempo para compartilhar o contexto via wiki, equipes e itens de backlog.
- Faça a coisa simples funcionar agora. Construa menos recursos hoje, mas garanta que eles funcionem incrivelmente bem. Depois adicione mais recursos amanhã.
- Evite adicionar escopo a um item de backlog, em vez disso, adicione um novo item de backlog.
- Nosso objetivo é enviar valor incremental ao cliente.
- Mantenha os detalhes do item de backlog atualizados para comunicar o estado das coisas com o resto de sua equipe.
- Relate problemas de produto encontrados e forneça feedback de engenharia claro e repetível!
- Todos nós somos proprietários de nosso código e cada um de nós tem a obrigação de tornar todas as partes da solução excelentes.
Links Rápidos
Fundamentos de Engenharia
- Acessibilidade
- Desenvolvimento Ágil
- Testes Automatizados
- Revisões de Código
- Entrega Contínua (CD)
- Integração Contínua (CI)
- Design
- Developer Experience
- Documentação
- Feedback de Engenharia
- Observabilidade
- Segurança
- Privacidade
- Controle de Fonte
- Confiabilidade
Fundamentos para Áreas Tecnológicas Específicas
Contribuindo
Veja CONTRIBUTING.md para diretrizes de contribuição.