Capturar todos os termos no boarding e adicionar na seção Termos
Documentar todos os campos das Entidades
Documentar todas as descrições e parâmetros dos Decorators e Middlewares
Documentar todas as pastas/módulos com suas descrições e times que são atendidos por elas
Documentar todas as tabelas de dados com descrição da tabela, colunas, descrição das colunas e entidades relacionadas
Documentar todos os padrões de projeto, com descrição, imagem ilustrativa e exemplo de uso
Documentar todos os padrões de código, com descrição, etapas de criação e snippets para o vscode
Documentar toda a jornada do usuário, juntamente com as rotas utilizadas, os parâmetros passados, fluxogramas, e o mapeamento de cenários de erros
Criar Slides para treinamento das equipes
🌅 1. Introdução
Para absorver a arquitetura do projeto, temos 3 objetivos
Entender os padrões de projetos adotados no desenvolvimento do software
Entender como cada peça do software comunica entre si
Entender a Linguagem de domínio do projeto, ou seja, as teminologias adotas no desenvolvimento do mesmo
Para desenvolver a Arquitetura do projeto, temos 3 objetivos
Entender como o que está sendo desenvolvido impacta no usuário final, ou na squad que consumirá sua feature
Escrever um código que expressa com clareza o que está sendo feito, adotando os princípios do Clean code, juntamente com o designer de domínio (DDD), acima de 98% do código testado
Manter uma documentação enxuta de todos os endpoint, com o auxilio do swagger-autogen
🆎 2. Terminologias
🚧 Verificar as tarefas no board em busca de termos e siglas desconhecidos
📁 3. Estrutura de Pastas
📁 v1:corresponde a 1º versão do projeto. Está em processo de migração para v2
📁 v2: corresponde a 2º versão do projeto. É nele onde é criado as novas features
📁 banking:
📁 caradhras-infrastructure: módulo responsável para fazer a comunicação com a Dock
📁 fretepago-app: módulo responsável pelas regras de negócio que são exclusivas do aplicativo Android