|
|
| (20 revisões intermediárias por 2 usuários não estão sendo mostradas) |
| Linha 1: |
Linha 1: |
| | Esta seção descreve as melhores práticas, ferramentas e orientações que são adotadas pela equipe de desenvolvimento do sistema Redome. | | Esta seção descreve as melhores práticas, ferramentas e orientações que são adotadas pela equipe de desenvolvimento do sistema Redome. |
| | | | |
| − | ==Contrato Social da Equipe== | + | <div class="toccolours" style="width:400px; overflow:auto;"> |
| − | O contrato social é um acordo feito entre os membros da equipe de desenvolvimento do sistema Redome e tem a função de destabelecer boas práticas para o dia-a-dia de trabalho.
| + | <div style="font-weight:bold;line-height:1.6;">Arquitetura do Sistema</div> |
| − | As diretrizes a seguir foram redijidas com os membros da equipe de desenvolvimento, e não representa uma obrigação, mas um comprometimento informal entre o time.
| + | * [[Arquitetura do Sistema - Visão Geral| Visão Geral]] |
| − | | + | * [[Arquitetura do Sistema - Requisitos Não Funcionais| Requisitos não funcionais]] |
| − | ===Cerimônias===
| + | * [[Arquitetura do Sistema - Princípios de Arquitetura| Princípios de Arquitetura]] |
| − | # A daily scrum meeting conta com a presença de todo o Dev Team com 15 minutos de duração com o objetivo de compartilhar o trabalho e identificação de impedimentos
| + | * [[Arquitetura do Sistema - Modelo Operacional| Modelo Operacional]] |
| − | # Assegurar que todas as reuniões tenham uma agenda e que as ações sejam registradas
| + | * [[Arquitetura do Sistema - Decisões de Arquitetura| Decisões de Arquitetura]] |
| − | # Se você não puder participar ou precisar sair mais cedo de uma reunião, notifique a equipe antes
| + | * [[Dicionário de Dados]] |
| − | # Venha preparado para reuniões
| + | * [[Permissões| Mapeamento das Permissões dos Perfis]] |
| − | # Seja pontual ( as reuniões começam no horário agendado independente da presença de todos )
| + | </div> |
| − | | |
| − | ===Fluxo de Trabalho===
| |
| − | # Se receber/pegar um trabalho, apropriar-se dele e mantê-lo atualizado
| |
| − | # Se você acha que precisa trabalhar até tarde para fazer o trabalho, acordar com o Scrum Master/GC
| |
| − | | |
| − | ===Comunicação===
| |
| − | # Avise para o scrum master de forma imediata caso tenha um problema
| |
| − | # Respeitar um ao outro e compreender as diferenças de conhecimento
| |
| − | # Demonstrar respeito tanto com palavras quanto atitudes
| |
| − | # Todos os documentos da equipe devem ser compartilhados
| |
| − | # Não há perguntas tolas, se você não entender, pergunte
| |
| − | # Não faça inferências, pergunte
| |
| − | # Concentre-se nos aspectos positivos
| |
| − | # Respeitar quando outra pessoa do time estiver falando
| |
| − | | |
| − | == Padrões ==
| |
| − | === Banco de Dados ===
| |
| − | Padronização de nomenclatura de estrutura de dados e diretrizes para a criação de qualquer objeto no banco de dados tal como tabelas, colunas, chaves primárias, estrangeiras, índices, dentre outros.
| |
| − | | |
| − | <small>[ [[Padrão de Desenvolvimento - Banco de Dados|Mostrar Padrão]] ] </small>
| |
| − | === Codificação ===
| |
| − | Convenções de codificação para o desenvolvimento do backend (Java) e frontend (Angular) do sistema Redome. Esse padrão define as regras de como o código-fonte deve ser escrito.
| |
| − | | |
| − | <small>[ [[Padrão de Desenvolvimento - Codificação|Mostrar Padrão]] ] </small>
| |
| − | === Documentação ===
| |
| − | Diretrizes para documentar o código-fonte de modo a explicar O QUE faz cada classe e método do sistema Redome. A documentação não pretende explicar COMO cada método faz o que faz, porque o desenvolvedor interessado nesse assunto deve ser capaz de ler o código-fonte.
| |
| − | | |
| − | <small>[ [[Padrão de Desenvolvimento - Documentação|Mostrar Padrão]] ] </small>
| |
| − | === Testes Unitários ===
| |
| − | Padrão para escrever os testes unitários automatizados e orientação para utilização da técnica de desenvolvimento dirigido por testes (TDD).
| |
| − |
| |
| − | <small>[ [[Padrão de Desenvolvimento - Testes Unitários|Mostrar Padrão]] ] </small>
| |
| − | | |
| − | == Arquitetura do Sistema: ==
| |
| − | Este seção detalha as diretrizes de arquitetura que nortearam o desenvolvimento do sistema e aprenta a visão geral da arquitetura da solução do Projeto de Modernização do Redome, expondo as perspectivas funcionais e não funcionais relacionadas à solução.
| |
| − |
| |
| − | A arquitetura de sistemas é responsável por conceituar e representar os componentes de software, suas propriedades externas e relacionamentos, bem como os direcionadores que justificam sua existência dentro da solução proposta.
| |
| − | | |
| − | | |
| − | === Visão Geral ===
| |
| − | Esta seção descreve o contexto do projeto, os processos de negócio envolvidos e detalha como o sistema computacional está organizado em termos de seus componentes de software.
| |
| − | | |
| − | <small>[ [[Arquitetura do Sistema - Visão Geral|Mostrar Padrão]] ] </small> | |
| − | | |
| − | === Requisitos não funcionais ===
| |
| − | Os Requerimentos não funcionais remetem a aspectos que, embora não afetem diretamente as funcionalidades do sistema sob a ótica de negócio dos usuários, pode ter um profundo efeito na forma como o sistema é aceito pelos usuários e pessoas que dão suporte ao sistema.
| |
| − | | |
| − | <small>[ [[Arquitetura do Sistema - Requisitos Não Funcionais|Mostrar Padrão]] ] </small>
| |
| − | | |
| − | === Princípios de Arquitetura ===
| |
| − | Nesta seção estão descritos os princípios de arquitetura para o sistema computacional objeto deste projeto. Tais princípios são definições de alto nível de valores fundamentais, regras gerais e diretrizes que orientam o processo de tomada de decisões técnicas, servindo de base para a arquitetura e desenvolvimento deste sistema.
| |
| − | | |
| − | <small>[ [[Arquitetura do Sistema - Princípios de Arquitetura|Mostrar Padrão]] ] </small>
| |
| − | | |
| − | === Modelo Operacional ===
| |
| − | O modelo operacional tem por objetivo definir e documentar a forma como os componentes do sistema serão desenvolvidos e distribuídos em nós, junto com as conexões necessárias para suportar as interações requeridas por estes, de forma a atender os requerimentos funcionais e não funcionais da solução, considerando as restrições de tecnologia.
| |
| − | | |
| − | <small>[ [[Arquitetura do Sistema - Modelo Operacional|Mostrar Padrão]] ] </small>
| |
| − | | |
| − | === Decisões de Arquitetura ===
| |
| − | Esta seção reune e apresentar as decisões arquiteturais relacionadas ao projeto, detalhando as razões e justificativas que motivaram cada decisão.
| |
| − | | |
| − | <small>[ [[Arquitetura do Sistema - Decisões de Arquitetura|Mostrar Padrão]] ] </small>
| |
| − | | |
| − | == Ferramentas & Frameworks para: ==
| |
| − | A seguir estão detalhadas as ferramentas utilizadas no processo de desenvolvimento do sistema Redome.
| |
| − | === Realizar Teste de Software ===
| |
| − | <small>[ [[Ferramentas & Frameworks - Realizar Teste de Software|Ler Mais]] ] </small>
| |
| − | | |
| − | == Orientações para: ==
| |
| − | === Configurar o ambiente de desenvolvimento ===
| |
| − | | |
| − | <small>[ [[Orientação - Configurar o ambiente de desenvolvimento|Mostrar Orientação]] ] </small>
| |
| − | | |
| − | === Controlar as mudanças feitas no código (GIT) ===
| |
| − | | |
| − | <small>[ [[Orientação - Controlar as mudanças feitas no código|Mostrar Orientação]] ] </small>
| |
| − | | |
| − | === Realizar a revisão do código-fonte ===
| |
| − | | |
| − | <small>[ [[Orientação - Realizar a revisão do código-fonte|Mostrar Orientação]] ] </small>
| |
| − | | |
| − | === Organizar a estrutura do código-fonte===
| |
| − | | |
| − | <small>[ [[Orientação - Organizar a estrutura do código-fonte|Mostrar Orientação]] ] </small>
| |
| − | | |
| − | === Efetuar correções de bugs em produção/homologação ===
| |
| − | | |
| − | <small>[ [[Orientação - Efetuar correções de bugs em produção ou homologação|Mostrar Orientação]] ] </small>
| |
| − | | |
| − | === Como acessar o Build Pipeline ===
| |
| − | | |
| − | <small>[ [[Orientação - Como acessar o Build Pipeline|Mostrar Orientação]] ] </small>
| |
| − | | |
| − | === Configurar container Kubernete da Wiki Redome ===
| |
| − | | |
| − | <small>[ [[Orientação - Configurar container Kubernete da Wiki Redome|Mostrar Orientação]] ] </small>
| |
