Índice da Documentação


Este documento organiza toda a documentação do projeto Arah de forma estruturada e fácil de navegar.

Reorganização federal: Foi criada uma estrutura por domínios (produto, arquitetura, API, BFF, app Flutter, operações, governança, backlog, wiki, técnico) e arquivados PRs/temporários. Ver Plano de Reorganização Federal para a estrutura completa e pastas 01-produto/11-tecnico-especial/, archive/.

Estrutura da Documentação

Documentos sobre a visão do produto, roadmap e funcionalidades.

  • Visão do Produto ⭐ - Visão geral, princípios e evolução estratégica do Arah
  • Roadmap Estratégico ⭐ - Planejamento completo de funcionalidades e épicos, reorganizado estrategicamente
  • Backlog - Lista de funcionalidades e prioridades
  • User Stories - Histórias de usuário consolidadas (MVP e pós-MVP)
  • Glossário - Termos e conceitos do projeto

Documentos técnicos sobre arquitetura, decisões e design.

Documentos sobre desenvolvimento, testes e implementação.

Documentos sobre moderação, observabilidade e operações.

Documentação técnica das fases de implementação: Instalador, Modularização, BFF e Frontend.

  • Índice de Documentação Técnica ⭐ - Índice completo de todas as fases técnicas
  • Instalador Visual 🛠️ - Sistema de instalação e configuração visual (15 passos, Monolito/Multi-Cluster, módulos, feature flags)
  • Modularização 🧩 - Arquitetura modular e organização por domínios (15 módulos, feature flags, dependências)

Documentação da API BFF que expõe operações em forma de jornadas (user journeys), criando uma camada de abstração entre interfaces visuais e o backend.

Documentos sobre segurança, configuração e implementação de medidas de segurança.

Documentos sobre histórico e mudanças do projeto.

Documentos de planejamento e recomendações de implementação.

Documentos de estratégia de convergência de mercado e análise comparativa.

  • Mapa de Funcionalidades - Mercado 📊 ⭐⭐⭐ - Mapeamento completo de funcionalidades implementadas, planejadas e previstas para atingir níveis de mercado, comparação com Closer.earth e plataformas líderes
  • Estratégia de Convergência de Mercado 🎯 ⭐⭐⭐ - Plano estratégico completo de convergência com padrões de mercado, análise competitiva, roadmap de adequação e mudanças organizacionais

Produção e Deploy

Documentos sobre prontidão para produção e deploy.

Pull Requests

Documentação detalhada de todos os Pull Requests implementados.

Documentação Organizada por Categoria

Refatorações

Validações

Recomendações

Análises

Busca Rápida

Produto e Funcionalidades:

  • Visão do Produto → 01_PRODUCT_VISION.md
  • User Stories → 04_USER_STORIES.md
  • Roadmap → 02_ROADMAP.md
  • Mapa de Funcionalidades → 38_MAPA_FUNCIONALIDADES_MERCADO.md
  • Estratégia de Convergência → 39_ESTRATEGIA_CONVERGENCIA_MERCADO.md

Arquitetura:

  • Decisões Arquiteturais → 10_ARCHITECTURE_DECISIONS.md
  • Arquitetura de Services → 11_ARCHITECTURE_SERVICES.md
  • Modelo de Domínio → 12_DOMAIN_MODEL.md

Fases Técnicas:

  • Índice de Documentação Técnica → TECNICO_INDEX.md
  • Instalador Visual → TECNICO_INSTALADOR_VISUAL.md
  • Modularização → TECNICO_MODULARIZACAO.md
  • Backend for Frontend (BFF) → AVALIACAO_BFF_BACKEND_FOR_FRONTEND.md
  • Frontend Flutter → 24_FLUTTER_FRONTEND_PLAN.md

Desenvolvimento:

  • Plano de Implementação → 20_IMPLEMENTATION_PLAN.md
  • Revisão de Código → 21_CODE_REVIEW.md
  • Análise de Coesão → 22_COHESION_AND_TESTS.md
  • Planejamento do Frontend Flutter → 24_FLUTTER_FRONTEND_PLAN.md

Operações:

  • Moderação → 30_MODERATION.md
  • Observabilidade → 31_ADMIN_OBSERVABILITY.md
  • Logs e Monitoramento → LOGS_MONITORAMENTO_ARQUITETURA.md
  • Monitoramento → MONITORING.md
  • Métricas → METRICS.md
  • Troubleshooting → TROUBLESHOOTING.md
  • Runbook → RUNBOOK.md
  • API BFF → AVALIACAO_BFF_BACKEND_FOR_FRONTEND.md
  • Contrato BFF → BFF_API_CONTRACT.yaml
  • Exemplo Flutter → BFF_FLUTTER_EXAMPLE.md

Convenções de Nomenclatura

Todos os arquivos na raiz seguem o padrão:

  • NN_NOME_DESCRITIVO.md onde NN é um número sequencial para ordenação
  • Nomes em inglês para consistência
  • Hífens substituídos por underscores para melhor ordenação
  • Categorias por prefixo numérico:
  • 00-09: Índices e guias
  • 10-19: Arquitetura e Design
  • 20-29: Desenvolvimento e Implementação
  • 30-39: Operações, Governança e Estratégia
  • 40-49: Histórico e Mudanças
  • 50-59: Produção e Deploy
  • 60-69: API e Funcionalidades
  • TECNICO_*: Fases Técnicas (Instalador, Modularização, BFF, Frontend)

Documentos adicionais são organizados em pastas:

  • refactoring/ - Documentação de refatorações realizadas
  • validation/ - Validações técnicas (REST, segurança, estrutura)
  • recommendations/ - Recomendações e planos futuros
  • analysis/ - Análises técnicas do projeto
  • prs/ - Documentação detalhada de Pull Requests
Nome Antigo Nome Novo
PRODUCT_VISION.md 01_PRODUCT_VISION.md
USER_STORIES.md 04_USER_STORIES.md
user-stories.md (removido - duplicado)
ROADMAP.md 02_ROADMAP.md
BACKLOG.md 03_BACKLOG.md
GLOSSARY.md 05_GLOSSARY.md
DECISOES_ARQUITETURAIS.md 10_ARCHITECTURE_DECISIONS.md
ARQUITETURA_SERVICES.md 11_ARCHITECTURE_SERVICES.md
DOMAIN_MODEL_MER.md 12_DOMAIN_MODEL.md
domain-routing.md 13_DOMAIN_ROUTING.md
IMPLEMENTATION_PLAN.md 20_IMPLEMENTATION_PLAN.md
PLANO_IMPLEMENTACAO_RECOMENDACOES.md (consolidado em 20_IMPLEMENTATION_PLAN.md)
REVISAO_CODIGO.md 21_CODE_REVIEW.md
ANALISE_COESAO_E_TESTES.md 22_COHESION_AND_TESTS.md
IMPLEMENTACAO_RECOMENDACOES.md 23_IMPLEMENTATION_RECOMMENDATIONS.md
MODERATION_REPORTS.md 30_MODERATION.md
ADMIN_OBSERVABILITY.md 31_ADMIN_OBSERVABILITY.md
TRACEABILITY.md 32_TRACEABILITY.md
CHANGELOG.md Documento unificado (40_CHANGELOG arquivado em archive/substituidos/)
CONTRIBUTING.md Raiz + 41_CONTRIBUTING.md (redireciona para raiz)

Mudanças Recentes no Projeto

  • Avaliação Estratégica: Documentação completa da avaliação e proposta de implementação do BFF
  • Contratos OpenAPI: Contrato OpenAPI 3.0.3 completo com todos os endpoints de jornadas
  • Guias de Implementação: Guias completos para frontend (Flutter) com exemplos práticos
  • Ferramentas de Teste: Coleção Postman completa com ambientes pré-configurados
  • Desenvolvimento Paralelo: Documentação permite desenvolvimento paralelo do frontend enquanto backend é implementado
  • Ver detalhes em: Avaliação BFF | Contrato OpenAPI | Exemplo Flutter
  • Análise Comparativa: Análise profunda do Closer.earth e padrões de mercado estabelecidos
  • Novas Fases Estratégicas: 15 novas fases identificadas (Fase 30 documentada + Fases 31-44 conceituais) para convergência com padrões de investimento
  • Priorização Atualizada: Reorganização completa de prioridades baseada em gaps críticos vs. mercado
  • Roadmap Revisado: Roadmap estratégico reorganizado em 9 ondas com foco em valor entregue
  • Mapa de Funcionalidades: Mapeamento completo de funcionalidades implementadas, planejadas e previstas
  • Ver detalhes em: Estratégia de Convergência de Mercado | Mapa de Funcionalidades
  • Fase 30: Proof of Sweat (Tradicional) - Sistema de registro de atividades territoriais
  • Fase 31: Dashboard de Métricas Comunitárias - Transparência e visualização de impacto
  • Fase 32: Subscriptions & Recurring Payments - Sustentabilidade financeira
  • Fase 33: Ticketing para Eventos - Monetização de eventos
  • Fases 34-37: Preparação Web3 - Blockchain, wallets, smart contracts
  • Fases 38-40: DAO e Tokenização - Tokens on-chain, governança tokenizada
  • Fases 41-44: Diferenciação - Learning Hub, Rental System, Agente IA
  • SystemAdmin implícito: SystemAdmin tem todas as MembershipCapabilities em todos os territórios
  • Operações de configuração: GrantAsync/RevokeAsync implementados com auditoria completa
  • Auditoria completa: Todos os eventos de grant/revoke são registrados
  • Invalidação automática de cache: Via eventos de domínio
  • Ver detalhes em: Hierarquia de Permissões
  • Reorganização de Domínio: Criada pasta Membership/ em Domain
  • UserTerritory removido: Substituído por TerritoryMembership
  • SystemPermission: Permissões globais (Admin, SystemOperator) separadas de roles territoriais
  • AuthProvider: Renomeado de Provider para AuthProvider no User
  • Renomeação listing → item: API e contratos atualizados (/api/v1/listings/api/v1/items)
  • Documentação XML: Adicionada em todas as entidades principais
  • Ver detalhes em: Refatoração User-Centric

Documentação Externa

  • Developer Portal: Disponível em /devportal quando a API está rodando
  • Swagger/OpenAPI: Disponível em /swagger em desenvolvimento
  • Health Check: Disponível em /health