Arkorizon Developer Handbook

Documentação oficial de padrões técnicos, arquitetura, convenções e fluxo de desenvolvimento da Arkorizon.

Este handbook existe para reduzir ambiguidade entre projetos, acelerar onboarding e manter consistência técnica entre serviços, bibliotecas, bancos de dados, commits e decisões de arquitetura.

Ver padrões de desenvolvimento

Objetivo

Centralizar as regras que orientam como projetos Arkorizon devem ser criados, organizados, versionados e evoluídos.

O handbook deve responder:

• Como nomear serviços, pacotes, repositórios e imagens?
• Como estruturar APIs Java e Spring Boot?
• Como aplicar arquitetura hexagonal nos serviços?
• Como padronizar banco de dados e migrations?
• Como escrever commits, branches e Pull Requests?

Estrutura

Área	Conteúdo
Padrões	Convenções de nomenclatura, Java e banco de dados.
Arquitetura	Modelo de arquitetura hexagonal para serviços Java.
Workflow	Padrões de commit, branches e colaboração.

Princípios

• Código em inglês.
• Convenções explícitas.
• Arquitetura simples e evolutiva.
• Separação clara de responsabilidades.
• Automação sempre que possível.
• Pull Requests pequenos, revisáveis e rastreáveis.

Escopo atual

Este handbook cobre os padrões iniciais mais importantes para projetos backend e documentação técnica. Novas seções devem ser adicionadas conforme a stack evoluir.