Develop Coding Standards
O processo de criação de padrões de codificação é fundamental para garantir que todo o código desenvolvido dentro da organização atenda aos requisitos de qualidade, segurança e eficiência.
Este processo envolve a definição de diretrizes detalhadas que orientam os desenvolvedores na escrita de código consistente, legível e fácil de manter.
Os padrões de codificação incluem convenções de nomenclatura, práticas recomendadas para estruturas de controle, diretrizes de formatação, técnicas de otimização de desempenho e medidas de segurança.
Além disso, este processo abrange a definição de regras para a revisão de código, a utilização de ferramentas de análise estática e dinâmica e a documentação adequada do código.
A implementação de padrões de codificação robustos assegura que o código seja de alta qualidade, reduzindo o risco de erros e facilitando a colaboração entre as equipes de desenvolvimento.
· PDCA focus: Plan
· Periodicidade: Anual
|
# |
Nome da Atividade |
Descrição |
Inputs |
Outputs |
RACI |
DARE |
|
1 |
Define Naming Conventions |
Definir convenções de nomenclatura para variáveis, funções, classes e outros elementos de código. |
Práticas de mercado, diretrizes organizacionais |
Convenções de nomenclatura documentadas |
Responsible: Solution Engineering & Development; Accountable: Solution Engineering & Development; Consulted: Architecture & Technology Visioning; Informed: IT Governance & Transformation |
Decider: Solution Engineering & Development; Advisor: Architecture & Technology Visioning; Recommender: IT Governance & Transformation; Executer: Solution Engineering & Development |
|
2 |
Establish Code Formatting Rules |
Estabelecer regras de formatação de código para assegurar consistência e legibilidade. |
Práticas de mercado, diretrizes organizacionais |
Regras de formatação de código estabelecidas |
Responsible: Solution Engineering & Development; Accountable: Solution Engineering & Development; Consulted: IT Governance & Transformation; Informed: Data, AI & New Technology |
Decider: Solution Engineering & Development; Advisor: IT Governance & Transformation; Recommender: Data, AI & New Technology; Executer: Solution Engineering & Development |
|
3 |
Define Security Practices |
Definir práticas de segurança para proteger o código contra vulnerabilidades e ameaças. |
Práticas de mercado, diretrizes organizacionais |
Práticas de segurança documentadas |
Responsible: Solution Engineering & Development; Accountable: Solution Engineering & Development; Consulted: Cybersecurity; Informed: IT Governance & Transformation |
Decider: Solution Engineering & Development; Advisor: Cybersecurity; Recommender: IT Governance & Transformation; Executer: Solution Engineering & Development |
|
4 |
Create Review Guidelines |
Criar diretrizes para a revisão de código, incluindo critérios de qualidade e procedimentos de revisão. |
Práticas de mercado, diretrizes organizacionais |
Diretrizes de revisão de código documentadas |
Responsible: Solution Engineering & Development; Accountable: Solution Engineering & Development; Consulted: IT Governance & Transformation; Informed: Architecture & Technology Visioning |
Decider: Solution Engineering & Development; Advisor: IT Governance & Transformation; Recommender: Architecture & Technology Visioning; Executer: Solution Engineering & Development |
|
5 |
Document Coding Standards |
Documentar todos os padrões de codificação estabelecidos e garantir que estejam acessíveis a todos os desenvolvedores. |
Convenções de nomenclatura, regras de formatação, práticas de segurança, diretrizes de revisão |
Documentação dos padrões de codificação |
Responsible: Solution Engineering & Development; Accountable: Solution Engineering & Development; Consulted: IT Governance & Transformation; Informed: Data, AI & New Technology |
Decider: Solution Engineering & Development; Advisor: IT Governance & Transformation; Recommender: Data, AI & New Technology; Executer: Solution Engineering & Development |
Plan Coding Activities
O planejamento das atividades de codificação é um processo crítico que assegura que o desenvolvimento do código seja conduzido de maneira organizada e eficiente.
Este processo envolve a definição do escopo e das prioridades das atividades de codificação, a alocação de recursos e a definição de cronogramas e marcos importantes.
O planejamento deve considerar os requisitos do projeto, as dependências entre diferentes componentes do código e os riscos potenciais que podem afetar o progresso do desenvolvimento.
Além disso, é essencial estabelecer critérios claros para a aceitação do código, garantindo que todas as funcionalidades sejam implementadas conforme especificado.
Um planejamento bem estruturado facilita a coordenação entre as equipes, promove a transparência e contribui para a entrega de soluções de alta qualidade dentro dos prazos estabelecidos.
· PDCA focus: Plan
· Periodicidade: Mensal
|
# |
Nome da Atividade |
Descrição |
Inputs |
Outputs |
RACI |
DARE |
|
1 |
Define Scope |
Definir o escopo das atividades de codificação, identificando as funcionalidades a serem desenvolvidas. |
Requisitos do projeto, especificações de design |
Escopo das atividades de codificação definido |
Responsible: Solution Engineering & Development; Accountable: Solution Engineering & Development; Consulted: Architecture & Technology Visioning; Informed: IT Governance & Transformation |
Decider: Solution Engineering & Development; Advisor: Architecture & Technology Visioning; Recommender: IT Governance & Transformation; Executer: Solution Engineering & Development |
|
2 |
Allocate Resources |
Alocar os recursos necessários para as atividades de codificação, incluindo desenvolvedores, ferramentas e infraestruturas. |
Escopo definido, recursos disponíveis |
Recursos alocados |
Responsible: Solution Engineering & Development; Accountable: Solution Engineering & Development; Consulted: IT Infrastructure & Operation; Informed: Data, AI & New Technology |
Decider: Solution Engineering & Development; Advisor: IT Infrastructure & Operation; Recommender: Data, AI & New Technology; Executer: Solution Engineering & Development |
|
3 |
Develop Schedule |
Desenvolver um cronograma detalhado para as atividades de codificação, incluindo marcos importantes. |
Escopo definido, recursos alocados |
Cronograma de codificação detalhado |
Responsible: Solution Engineering & Development; Accountable: Solution Engineering & Development; Consulted: IT Governance & Transformation; Informed: Architecture & Technology Visioning |
Decider: Solution Engineering & Development; Advisor: IT Governance & Transformation; Recommender: Architecture & Technology Visioning; Executer: Solution Engineering & Development |
|
4 |
Identify Dependencies |
Identificar dependências críticas que podem afetar as atividades de codificação. |
Escopo definido, cronograma de codificação |
Documento de dependências identificadas |
Responsible: Solution Engineering & Development; Accountable: Solution Engineering & Development; Consulted: IT Infrastructure & Operation; Informed: Data, AI & New Technology |
Decider: Solution Engineering & Development; Advisor: IT Infrastructure & Operation; Recommender: Data, AI & New Technology; Executer: Solution Engineering & Development |
|
5 |
Define Acceptance Criteria |
Definir critérios de aceitação para as atividades de codificação. |
Escopo definido, cronograma de codificação, documento de dependências |
Critérios de aceitação documentados |
Responsible: Solution Engineering & Development; Accountable: Solution Engineering & Development; Consulted: Architecture & Technology Visioning; Informed: IT Governance & Transformation |
Decider: Solution Engineering & Development; Advisor: Architecture & Technology Visioning; Recommender: IT Governance & Transformation; Executer: Solution Engineering & Development |
Write Code
O desenvolvimento do código conforme planejado e de acordo com os padrões estabelecidos é o núcleo da capability de Coding.
Este processo envolve a tradução dos requisitos de software em código de programação funcional, utilizando as linguagens e ferramentas apropriadas.
Os desenvolvedores devem seguir as boas práticas de codificação para garantir a legibilidade, eficiência e segurança do código.
Além disso, a integração contínua e os testes automatizados são adotados para detectar e corrigir erros precocemente.
Durante este processo, é crucial manter uma documentação adequada e realizar revisões regulares do código para identificar e resolver problemas.
O objetivo final é produzir código de alta qualidade que atenda aos requisitos do projeto e possa ser facilmente mantido e escalado no futuro.
· PDCA focus: Do
· Periodicidade: Ad-hoc
|
# |
Nome da Atividade |
Descrição |
Inputs |
Outputs |
RACI |
DARE |
|
1 |
Implement Features |
Implementar as funcionalidades conforme especificado nos requisitos do projeto. |
Requisitos do projeto, especificações de design |
Funcionalidades implementadas |
Responsible: Solution Engineering & Development; Accountable: Solution Engineering & Development; Consulted: Architecture & Technology Visioning; Informed: IT Governance & Transformation |
Decider: Solution Engineering & Development; Advisor: Architecture & Technology Visioning; Recommender: IT Governance & Transformation; Executer: Solution Engineering & Development |
|
2 |
Write Unit Tests |
Escrever testes unitários para verificar a funcionalidade do código desenvolvido. |
Funcionalidades implementadas, requisitos do projeto |
Testes unitários escritos |
Responsible: Solution Engineering & Development; Accountable: Solution Engineering & Development; Consulted: IT Infrastructure & Operation; Informed: Data, AI & New Technology |
Decider: Solution Engineering & Development; Advisor: IT Infrastructure & Operation; Recommender: Data, AI & New Technology; Executer: Solution Engineering & Development |
|
3 |
Conduct Code Reviews |
Realizar revisões de código para assegurar a qualidade e conformidade com os padrões estabelecidos. |
Código desenvolvido, testes unitários escritos |
Código revisado |
Responsible: Solution Engineering & Development; Accountable: Solution Engineering & Development; Consulted: IT Governance & Transformation; Informed: Architecture & Technology Visioning |
Decider: Solution Engineering & Development; Advisor: IT Governance & Transformation; Recommender: Architecture & Technology Visioning; Executer: Solution Engineering & Development |
|
4 |
Integrate Code |
Integrar o código desenvolvido com o restante do sistema utilizando práticas de integração contínua. |
Código revisado, testes unitários escritos |
Código integrado |
Responsible: Solution Engineering & Development; Accountable: Solution Engineering & Development; Consulted: IT Infrastructure & Operation; Informed: Data, AI & New Technology |
Decider: Solution Engineering & Development; Advisor: IT Infrastructure & Operation; Recommender: Data, AI & New Technology; Executer: Solution Engineering & Development |
|
5 |
Document Code |
Documentar o código desenvolvido para facilitar a manutenção e futuras atualizações. |
Código integrado, padrões de documentação |
Código documentado |
Responsible: Solution Engineering & Development; Accountable: Solution Engineering & Development; Consulted: IT Governance & Transformation; Informed: Architecture & Technology Visioning |
Decider: Solution Engineering & Development; Advisor: IT Governance & Transformation; Recommender: Architecture & Technology Visioning; Executer: Solution Engineering & Development |
Review Code Quality
A revisão contínua da qualidade do código é um processo essencial para garantir que o código desenvolvido atenda aos padrões de qualidade estabelecidos e seja livre de erros críticos.
Este processo envolve a realização de revisões de código periódicas, utilizando ferramentas de análise estática e dinâmica, além de revisões manuais por pares.
Durante as revisões, são avaliados aspectos como a legibilidade, eficiência, segurança e aderência aos padrões de codificação.
Quaisquer problemas identificados são documentados e corrigidos.
A implementação de testes automatizados é outro componente vital deste processo, permitindo a detecção precoce de defeitos e a validação contínua do código.
A revisão de qualidade do código garante que as soluções desenvolvidas sejam robustas, seguras e fáceis de manter.
· PDCA focus: Check
· Periodicidade: Semanal
|
# |
Nome da Atividade |
Descrição |
Inputs |
Outputs |
RACI |
DARE |
|
1 |
Perform Static Analysis |
Realizar análise estática do código para identificar erros e problemas de conformidade. |
Código desenvolvido |
Relatório de análise estática |
Responsible: Solution Engineering & Development; Accountable: Solution Engineering & Development; Consulted: Architecture & Technology Visioning; Informed: IT Governance & Transformation |
Decider: Solution Engineering & Development; Advisor: Architecture & Technology Visioning; Recommender: IT Governance & Transformation; Executer: Solution Engineering & Development |
|
2 |
Conduct Peer Reviews |
Conduzir revisões por pares para avaliar a qualidade e conformidade do código. |
Código desenvolvido |
Relatórios de revisões por pares |
Responsible: Solution Engineering & Development; Accountable: Solution Engineering & Development; Consulted: IT Governance & Transformation; Informed: Data, AI & New Technology |
Decider: Solution Engineering & Development; Advisor: IT Governance & Transformation; Recommender: Data, AI & New Technology; Executer: Solution Engineering & Development |
|
3 |
Run Automated Tests |
Executar testes automatizados para validar a funcionalidade e desempenho do código. |
Código desenvolvido, scripts de testes automatizados |
Relatórios de testes automatizados |
Responsible: Solution Engineering & Development; Accountable: Solution Engineering & Development; Consulted: IT Infrastructure & Operation; Informed: Architecture & Technology Visioning |
Decider: Solution Engineering & Development; Advisor: IT Infrastructure & Operation; Recommender: Architecture & Technology Visioning; Executer: Solution Engineering & Development |
|
4 |
Document Issues |
Documentar quaisquer problemas identificados durante as revisões e testes. |
Relatórios de análises estática, revisões por pares, testes automatizados |
Lista de problemas documentada |
Responsible: Solution Engineering & Development; Accountable: Solution Engineering & Development; Consulted: IT Governance & Transformation; Informed: Data, AI & New Technology |
Decider: Solution Engineering & Development; Advisor: IT Governance & Transformation; Recommender: Data, AI & New Technology; Executer: Solution Engineering & Development |
|
5 |
Implement Fixes |
Implementar correções para os problemas identificados durante as revisões e testes. |
Lista de problemas documentada, código desenvolvido |
Código corrigido |
Responsible: Solution Engineering & Development; Accountable: Solution Engineering & Development; Consulted: Architecture & Technology Visioning; Informed: IT Governance & Transformation |
Decider: Solution Engineering & Development; Advisor: Architecture & Technology Visioning; Recommender: IT Governance & Transformation; Executer: Solution Engineering & Development |
Optimize Coding Practices
A otimização das práticas de codificação é um processo contínuo que visa melhorar a eficiência, qualidade e segurança do código desenvolvido.
Este processo envolve a análise dos feedbacks recebidos durante as revisões de código e testes, a identificação de áreas de melhoria e a implementação de mudanças nas práticas de codificação.
As otimizações podem incluir a adoção de novas ferramentas, técnicas de programação mais eficientes, aprimoramento das práticas de segurança e atualização dos padrões de codificação.
A colaboração entre as equipes de desenvolvimento é fundamental para compartilhar conhecimentos e promover uma cultura de melhoria contínua.
A otimização das práticas de codificação assegura que a organização mantenha um alto padrão de qualidade no desenvolvimento de software e esteja preparada para enfrentar novos desafios tecnológicos.
· PDCA focus: Act
· Periodicidade: Mensal
|
# |
Nome da Atividade |
Descrição |
Inputs |
Outputs |
RACI |
DARE |
|
1 |
Collect Feedback |
Coletar feedbacks das revisões de código e testes realizados. |
Relatórios de revisões de código, relatórios de testes |
Feedbacks coletados |
Responsible: Solution Engineering & Development; Accountable: Solution Engineering & Development; Consulted: Architecture & Technology Visioning; Informed: IT Governance & Transformation |
Decider: Solution Engineering & Development; Advisor: Architecture & Technology Visioning; Recommender: IT Governance & Transformation; Executer: Solution Engineering & Development |
|
2 |
Identify Improvement Areas |
Identificar áreas de melhoria com base no feedback coletado. |
Feedbacks coletados, relatórios de revisões de código, relatórios de testes |
Lista de áreas de melhoria identificadas |
Responsible: Solution Engineering & Development; Accountable: Solution Engineering & Development; Consulted: IT Governance & Transformation; Informed: Data, AI & New Technology |
Decider: Solution Engineering & Development; Advisor: IT Governance & Transformation; Recommender: Data, AI & New Technology; Executer: Solution Engineering & Development |
|
3 |
Develop Optimization Plan |
Desenvolver um plano de otimização das práticas de codificação. |
Lista de áreas de melhoria identificadas |
Plano de otimização documentado |
Responsible: Solution Engineering & Development; Accountable: Solution Engineering & Development; Consulted: Architecture & Technology Visioning; Informed: IT Governance & Transformation |
Decider: Solution Engineering & Development; Advisor: Architecture & Technology Visioning; Recommender: IT Governance & Transformation; Executer: Solution Engineering & Development |
|
4 |
Implement Optimizations |
Implementar as otimizações nas práticas de codificação. |
Plano de otimização documentado |
Práticas de codificação otimizadas |
Responsible: Solution Engineering & Development; Accountable: Solution Engineering & Development; Consulted: IT Infrastructure & Operation; Informed: Data, AI & New Technology |
Decider: Solution Engineering & Development; Advisor: IT Infrastructure & Operation; Recommender: Data, AI & New Technology; Executer: Solution Engineering & Development |
|
5 |
Review and Adjust |
Revisar as otimizações implementadas e ajustar conforme necessário. |
Práticas de codificação otimizadas, feedbacks contínuos |
Práticas de codificação ajustadas |
Responsible: Solution Engineering & Development; Accountable: Solution Engineering & Development; Consulted: Architecture & Technology Visioning; Informed: IT Governance & Transformation |
Decider: Solution Engineering & Development; Advisor: Architecture & Technology Visioning; Recommender: IT Governance & Transformation; Executer: Solution Engineering & Development |
