Documentação Técnica
EM VALIDAÇÃO

README

Sistema Gastronômico para Operações com Mesas

VERSÃO v0.1

Visão Geral

Este sistema organiza a jornada completa de atendimento em operações gastronômicas que utilizam o modelo de mesas. A jornada parte do acesso ao Cardápio por QR Code associado ao contexto da Mesa, integrando o Cardápio Digital, a gestão do Carrinho e a criação do Pedido sem fricção. No backend operacional, as interfaces de Recepção e Cozinha apoiam o acompanhamento operacional do Pedido e da produção, enquanto o Cliente acompanha o andamento do próprio Pedido pelo dispositivo.

Desde a revisão v0.2, o sistema é oferecido como SaaS multi-tenant: a mesma aplicação atende múltiplas Organizações (restaurantes) com isolamento de dados garantido no banco de dados, não apenas no código. Restaurante Exemplo é a primeira Organização cliente, não o único cliente possível do produto.

Documentação Oficial

DocumentoVersãoStatusRota
PRDv0.3APROVADO/docs/prd
ERDv0.3APROVADO/docs/erd
RBAC/RLSv0.3APROVADO/docs/rbac-rls
Fluxos UXv0.2APROVADO/docs/fluxos-ux
Roadmapv0.3APROVADO/docs/roadmap
READMEv0.1EM VALIDAÇÃO/docs/readme

Escopo do Produto

MVP (Baseline v0.1)

QR Code e MesaM01
Cardápio DigitalM02
CarrinhoM03
FinalizaçãoM04
PedidoM05
RecepçãoM06
CozinhaM07
Acompanhamento do ClienteM08

Evolução Prevista

EstoqueM09
ValidadeM10
Ficha TécnicaM11
CMVM12

Jornada Principal (MVP)

QR CODE / MESA
CARDÁPIO
CARRINHO
FINALIZAÇÃO
PEDIDO
RECEPÇÃO / COZINHA
ACOMPANHAMENTO DO CLIENTE

* Gestão atua em supervisão/administração quando aplicável e não é uma etapa obrigatória do caminho normal do Pedido.

Dados do Cliente

Cliente pode visualizar e navegar pelo Cardápio sem cadastro prévio.

NomeOBRIGATÓRIO
WhatsAppOBRIGATÓRIO
E-mailOPCIONAL
MesaContexto do QR Code

Não existe cadastro completo obrigatório de Cliente.

Estados do Pedido

Pedido recebido
Em preparo
Pronto
Entregue
Problema / situação operacional

* Lifecycle definitivo permanece pendente no PRD TBD-005.

Atores e Acesso

ClienteAtor externo da jornada
Recepção, Cozinha, GestãoPerfis internos (RBAC/RLS v0.3)
Usuário InternoEntidade/conceito de usuários internos da operação, não um perfil equivalente.

Perfis Internos

RECEPÇÃO

Atendimento e acompanhamento operacional.

COZINHA

Operação de produção.

GESTÃO

Gestão operacional e módulos evolutivos.

Privacidade Operacional

“Nome, WhatsApp, E-mail e identificação da Mesa não são informações necessárias ao contexto de produção da Cozinha na baseline v0.1.”

Governança conforme RBAC/RLS v0.3 aprovado.

Estoque e Validade

Estoque

Saldo de EstoqueDERIVADO
Persistência FísicaA DEFINIR
Baixa AutomáticaPRD TBD-008 — PENDENTE
Governança de InventárioPRD TBD-010 — PENDENTE

Validade

Controle conceitual de Lotes, Validade e identificação de itens próximos do vencimento conforme PRD TBD-009.

Regra FIFO / FEFOPENDENTE

Ficha Técnica e CMV

Ficha Técnica

Relação entre Produto, Insumos, Quantidades, Custos, Rendimento e Perdas.

Custo da FichaDERIVADO
Persistência FísicaA DEFINIR

CMV

“O sistema deve permitir cálculo ou visualização do CMV quando os dados necessários estiverem disponíveis.”

Cálculo de CMVDERIVADO
Persistência HistóricaERD-TBD-006 — PENDENTE
Faixas OficiaisPRD TBD-011 — PENDENTE
Atualização dos CustosPRD TBD-012 — PENDENTE

Modelo de Dados (Visão Resumida)

Núcleo / Acesso

  • Organização
  • Usuário Interno

Atendimento

  • Mesa
  • QR Code
  • Cliente

Cardápio

  • Categoria Produto
  • Produto

Venda

  • Pedido
  • Item Pedido

Estoque

  • Categoria Insumo
  • Insumo
  • Movimentação de Estoque
  • Lote

Ficha Técnica

  • Ficha Técnica
  • Item da Ficha Técnica

* Conforme ERD v0.3 aprovado. Conceitos derivados não constituem novas entidades.

Tecnologia e Estado de Implementação

TECNOLOGIAS PRESENTES NO FRONT-END ATUAL

React 19TanStack Start v1Vite 8Tailwind CSS v4Lucide ReactZod

DECISÕES ARQUITETURAIS AINDA NÃO FORMALIZADAS

A presença de bibliotecas no front-end não define a stack definitiva de backend ou as decisões de infraestrutura. O README descreve o estado documental do produto e não comprova que todas as funcionalidades estejam implementadas ou em produção.

Decisões Ainda Abertas

AutenticaçãoPRD TBD-001
Multiunidade (uma conta gerenciando várias unidades)PRD TBD-004 (parcial v0.2)
Governança de cobrança/assinatura (novo)PRD TBD-019
Lifecycle do PedidoPRD TBD-005
Alteração/Cancelamento após envioPRD TBD-006
Ciclo do QR Code (regenerar/revogar)PRD TBD-017, ERD-TBD-005 (parcial v0.3)
Cadastro de Organização (autoatendimento ou manual)PRD TBD-020, ACESSO-TBD-012
Gateway de pagamento do PedidoPRD TBD-021
Provedor de API de CNPJPRD TBD-022
Identidade/Persistência do ClienteERD-TBD-003
EstoquePRD TBD-008, PRD TBD-010
Lotes e ValidadePRD TBD-009
Atualização de CustosPRD TBD-012
CMVPRD TBD-011, PRD TBD-012, ERD-TBD-006
Retenção de DadosPRD TBD-016
Disponibilidade de ProdutosPRD TBD-018

“A referência a uma pendência no README não representa sua resolução. Quando uma decisão não estiver formalmente definida nas baselines aprovadas, ela deve permanecer pendente até nova decisão explícita.”

Riscos Documentados

RISK-001: Privacidade e Proteção de Dados (PII)
RISK-002: Isolamento de Dados (Multi-tenancy)
RISK-003: Indisponibilidade de QR Code / Mesa
RISK-004: Concorrência de Pedidos na mesma Mesa
RISK-005: Lentidão na Atualização (Cozinha/Recepção)
RISK-006: Inconsistência de Estoque (Baixa Manual)
RISK-007: Uso de Insumos Vencidos
RISK-008: Divergência de CMV por Preço de Insumo
RISK-009: Perda de Histórico Transacional
RISK-010: Escalabilidade da Arquitetura

* Visão resumida dos riscos oficiais conforme PRD v0.3.

Integrações

“Duas integrações identificadas em v0.3 — gateway de pagamento (PRD TBD-021) e API de CNPJ (PRD TBD-022) — nenhuma com provedor definido nem obrigatória para o núcleo MVP.”

O que a Baseline v0.3 Não Define

Stack física definitiva de backend
Multiunidade (uma conta gerenciando várias unidades)
Governança de cobrança/assinatura (gatilho de tenant_escrita_liberada())
Autenticação definitiva
Lifecycle definitivo do Pedido
Modelo de cadastro de Organização (autoatendimento ou onboarding manual)
Gateway de pagamento do Pedido
Provedor de API de CNPJ
Ciclo do QR Code (regenerar/revogar)
Integrações externas obrigatórias
Mecanismo definitivo de baixa de Estoque
FIFO/FEFO definitivo
Faixas oficiais de CMV
Método definitivo de atualização dos custos
Periodicidade de CMV

Governança Documental

PRD, ERD, RBAC/RLS e Roadmap v0.3, e Fluxos UX v0.2, são baselines aprovadas. Alterações futuras nessas baselines devem ser explicitamente solicitadas, auditáveis e rastreáveis.

“O README consolida e referencia as baselines, mas não substitui nem modifica seus conteúdos.”

Como os documentos se relacionam

PRD v0.3

Define os requisitos e o que o produto precisa fazer, incluindo o modelo de negócio SaaS, Mesa/QR Code e Pagamento.

ERD v0.3

Organiza conceitualmente os dados, entidades e relacionamentos necessários ao produto, incluindo o isolamento multi-tenant.

RBAC/RLS v0.3

Organiza atores, perfis, permissões conceituais, limites de acesso e o isolamento por Organização.

Fluxos UX v0.2

Organiza as jornadas e interações dos atores.

Roadmap v0.3

Organiza as fases, dependências e evolução conceitual do produto.

README v0.1

Funciona como visão consolidada e orientação para consulta das baselines.

“Nenhum desses documentos substitui os demais.”

Evolução do Produto

ROAD-01Baseline Documental
CONCLUÍDA NA DOCUMENTAÇÃO v0.1
ROAD-02Decisões Técnicas Pré-Implementação
PREVISTO PARA EVOLUÇÃO
ROAD-03Núcleo MVP: Acesso e Pedido
PREVISTO
ROAD-04Operação da Recepção
PREVISTO
ROAD-05Operação da Cozinha
PREVISTO
ROAD-06Acompanhamento e Integração Operacional
PREVISTO
ROAD-07Estabilização Operacional e Qualidade
PREVISTO
ROAD-08Insumos e Estoque
EVOLUÇÃO PREVISTA
ROAD-09Lotes e Validade
EVOLUÇÃO PREVISTA
ROAD-10Ficha Técnica e Custos
EVOLUÇÃO PREVISTA
ROAD-11CMV
EVOLUÇÃO PREVISTA

“Os status acima representam o planejamento documental do Roadmap e NÃO comprovam implementação ou produção.”

Dependência Conceitual dos Módulos Evolutivos

INSUMOS
ESTOQUE / LOTES / VALIDADE
FICHA TÉCNICA
CUSTO ESTIMADO
CMV

“Esta sequência representa dependências conceituais de evolução e não define automações, persistência física ou ordem cronológica obrigatória de implantação.”

Como utilizar esta documentação

1. Consultar o README para compreender o contexto geral do produto.
2. Consultar o PRD antes de criar ou alterar funcionalidade.
3. Consultar o ERD antes de criar ou alterar estruturas de dados e relacionamentos.
4. Consultar o RBAC/RLS antes de definir permissões, visibilidade e limites de acesso.
5. Consultar Fluxos UX antes de construir telas, jornadas e interações.
6. Consultar o Roadmap antes de interpretar fases e dependências de evolução.
7. Quando uma decisão estiver registrada como TBD/PENDENTE, não tratá-la como definida sem nova decisão explícita.

“A existência de uma referência no README não substitui a consulta ao documento de origem.”

Rotas da Documentação

/docsHub da Documentação
/docs/prdPRD v0.3 — APROVADO
/docs/erdERD v0.3 — APROVADO
/docs/rbac-rlsRBAC/RLS v0.3 — APROVADO
/docs/fluxos-uxFluxos UX v0.1 — APROVADO
/docs/roadmapRoadmap v0.3 — APROVADO
/docs/readmeREADME v0.1 — EM VALIDAÇÃO

Integridade Documental — v0.1

Baselines Aprovadas5
MVPM01–M08
EvoluçãoM09–M12
Integrações0
PRD: v0.3 — APROVADO
ERD: v0.3 — APROVADO
RBAC/RLS: v0.3 — APROVADO
Fluxos UX: v0.1 — APROVADO
Roadmap: v0.3 — APROVADO
README: v0.1 — EM VALIDAÇÃO
TBDs: PRESERVADOS
Riscos: RISK-001 a RISK-010
Stack Backend: NÃO DEFINIDA

“O README consolida o estado documental da baseline v0.1. Ele não comprova, por si só, que todas as funcionalidades documentadas estejam implementadas ou em produção.”