Este documento existe para resolver uma confusao comum:
nem todo doc foi feito para mandar.
Alguns docs explicam a visao. Alguns guiam execucao. Alguns registram historia. Alguns so guardam uma fotografia de um momento.
Sem esse filtro, o time corre o risco de usar diario de obra como se fosse planta aprovada.
Quando houver conflito entre docs, use esta ordem:
- runtime real, testes e estrutura atual do codigo
- ../../README.md para produto, escopo e estado geral
- docs canonicos de arquitetura e direcao ativa
- planos ativos da frente atual
- referencias tecnicas de navegacao e ownership
- runbooks e gates operacionais de rollout
- docs de experiencia e UX como guardrail de fachada
- diagnosticos e relatorios como leitura auxiliar de momento
- historico e retrospectivas como contexto, nunca como regra viva
- inspiracao e manifestos como linguagem cultural, nunca como verdade operacional isolada
Traducao pratica:
- se o codigo e o doc divergem, o codigo vence e o doc precisa ser corrigido
- se dois docs divergem, vence o que tiver papel mais alto nesta hierarquia
- se dois docs do mesmo nivel divergem, vence o mais especifico para a pergunta atual
Arquivo canonico:
Papel:
- explicar o produto
- declarar o estado geral do repositorio
- apontar portas de entrada da documentacao
Quando vence:
- duvida sobre o que o produto e
- duvida sobre escopo atual
- duvida sobre qual categoria de doc abrir primeiro
Quando perde:
- detalhes finos de codigo, quando a referencia tecnica estiver mais especifica
- status operacional curto de uma frente, quando existir um board ativo mais especifico
Pasta:
Papel:
- tese estrutural
- core conceitual
- rumo de medio e longo prazo
- fronteiras permanentes do predio
Autoridade:
- alta para conceito, direcao e linguagem oficial da arquitetura
Exemplos fortes:
- ../architecture/octobox-architecture-model.md
- ../architecture/octobox-conceptual-core.md
- ../architecture/django-core-strategy.md
- ../architecture/promoted-public-facades-map.md
- ../architecture/themeOctoBox.md para tema visual oficial, assinatura e precedencia de linguagem estetica
Pasta:
Papel:
- frente ativa
- ordem de execucao
- criterio de fechamento
- convergencia tática da fase atual
Autoridade:
- alta para o que esta sendo conduzido agora
- media quando o plano ja foi absorvido, fechado ou superado
Regra:
- plano ativo manda na execucao da fase
- plano antigo ou ultrapassado vira referencia historica da frente, nao lei viva
Exemplos fortes:
- ../plans/front-end-restructuring-guide.md
- ../plans/front-beta-closure-board.md
- ../plans/catalog-page-payload-presenter-blueprint.md
- ../plans/theme-implementation-final.md para a ordem pratica de implantacao do tema oficial
- ../plans/in-flight-board.md para "o que esta em voo agora" entre sessoes/worktrees e higiene de branch orfa
Pasta:
Papel:
- navegacao tecnica
- ownership
- guias de leitura
- checklists de manutencao
Autoridade:
- alta para localizar arquivos e entender circuitos
- baixa para redefinir direcao de produto ou tese arquitetural
Exemplos fortes:
- reading-guide.md
- front-end-ownership-map.md
- front-end-city-map.md
- front-end-card-architecture.md
- functional-circuits-matrix.md
Pasta:
Papel:
- onboarding arquitetural
- sintese do estado vivo
- trilha curta para explicar o projeto sem mergulhar cedo demais em docs profundos
Autoridade:
- media para orientacao
- baixa para substituir architecture, plans ou reference especializado
Regra:
- guides resumem e conectam
- guides nao vencem docs canonicos de tese, plano ou ownership
- se um guide divergir de um doc mais alto na hierarquia, o guide deve ser corrigido
- trilhas por perfil em
guides/profiles/*organizam onboarding e prioridade de leitura, nao ownership tecnico final
Pasta:
Papel:
- gate operacional
- homologacao
- deploy
- piloto
- validacao de campo
Autoridade:
- alta para liberacao, checklist e operacao assistida
Exemplos fortes:
- ../rollout/beta-internal-release-gate.md
- ../rollout/beta-role-test-agenda.md
- ../rollout/environment-activation-registry.md para "mergeado != ativado" (env vars + comandos de ativacao por ambiente)
Pasta:
Papel:
- guardrails de front e UX
- linguagem da fachada
- criterio de leitura e composicao visual
Autoridade:
- alta para principios de experiencia
- media para status operacional de momento
Regra:
- docs conceituais daqui envelhecem devagar
- docs com data, rodada, checklist ou viewport envelhecem rapido e devem ser tratados como snapshot
- se um doc de experience conflitar com ../architecture/themeOctoBox.md em tema, paleta, glow, atmosfera ou assinatura visual, a arquitetura vence
Pastas:
Papel:
- laudo
- fotografia de um problema
- leitura auxiliar para decidir correcao
Autoridade:
- media para explicar um momento
- baixa para disputar com docs canonicos sem nova evidencia
Pasta:
Papel:
- preservar aprendizado
- registrar trade-offs
- explicar como se pensou em uma fase
Autoridade:
- baixa para decisao atual
Regra:
- historia ensina
- historia nao governa o runtime de hoje
Pasta:
Papel:
- inspirar linguagem, visao e sentimento de produto
Autoridade:
- muito baixa para execucao operacional
Se um doc tiver um ou mais sinais abaixo, sua autoridade operacional cai ate ser revisado:
- links quebrados
- caminho de arquivo que nao existe mais
- status temporal como
quase pronto,pendente,rodada aberta,data basesem revisao posterior - duplicidade de estados ou conclusoes contraditorias
- referencias a arquitetura antiga ja promovida ou reorganizada
- evidencias muito datadas sem nova validacao
Use:
Use:
- ../architecture/octobox-architecture-model.md
- ../architecture/octobox-conceptual-core.md
- ../architecture/themeOctoBox.md para tema visual oficial e precedencia de linguagem
Use:
- ../plans/front-end-restructuring-guide.md para tese e estrutura
- ../plans/front-beta-closure-board.md para status atual de fechamento
- ../plans/theme-implementation-final.md para a implantacao pratica do tema visual oficial
Use:
Use:
Use com cautela:
- docs com data explicita sao snapshot
- eles ajudam a lembrar o que foi visto
- eles nao provam o estado atual sozinhos
Antes de sair abrindo tudo, siga esta ordem:
- leia o ../../README.md
- leia este mapa
- escolha a pasta certa para a pergunta
- leia o doc canonico da categoria
- so depois abra docs irmaos ou historicos
- se encontrar conflito, registre o conflito e prefira runtime mais doc de maior autoridade
Documento bonito nao basta.
Documento vivo e aquele que:
- aponta para arquivos reais
- fala do estado atual
- manda apenas no territorio certo
- aceita perder quando o runtime mostra outra verdade