Documentação Funcional (FSD) — MAIORE Simulador Tributário

O que este documento é: descrição formal do que o sistema deve fazer (funcionalidades, escopo, requisitos, histórias de usuário e critérios de aceite).
O que não é: como implementar em PHP/Laravel — ver ESPECIFICACAO_TECNICA.md.
Como operar a interface passo a passo: ver MANUAL_DO_SISTEMA.md.

1. Visão geral do projeto

2. Propósito

Qual problema de negócio estamos resolvendo?

Escritórios e consultorias precisam estimar o impacto da Reforma Tributária (CBS + IBS) com base em dados reais do cliente (SPED), sem substituir o ERP de apuração oficial.

Dores atendidas

Por que agora

O cronograma da reforma (EC 132 / LC 214) exige planejamento tributário antecipado (CONFIRMADO pelo posicionamento do produto e docs de escopo).

O que acontece se não fizermos isso

Consultorias continuam com planilhas manuais, sem padronização de qualidade de dados nem entregáveis reutilizáveis.

Alinhamento estratégico

Produto SaaS multi-tenant focado em análise consultiva CBS/IBS a partir de SPED — não apuração oficial.

3. Escopo

3.1 Dentro do escopo (CONFIRMADO)

3.2 Fora do escopo

Nota: o que está fora do escopo é tão importante quanto o que está dentro — gerencia expectativas e evita expansão indevida.

4. Requisitos funcionais

Linguagem: deve = obrigatório (CONFIRMADO no sistema atual); deveria = preferencial / parcialmente presente.

5. Requisitos não funcionais

6. Histórias de usuário

Formato: Como … quero … para …

US-01 — Login

Como consultor
quero entrar com minhas credenciais
para acessar com segurança as simulações do meu tenant.
Aceite: redirecionamento para /admin/simulacoes; apenas uma sessão ativa.

US-02 — Importar lote SPED

Como analista fiscal
quero enviar vários arquivos SPED de um ano
para montar análise anual consolidada sem digitar tudo.
Aceite: simulações de grupo/mês criadas; cliente detectado pelo CNPJ quando possível.

US-03 — Avaliar prontidão

Como analista fiscal
quero ver resultado do confronto e pendências
para saber se a base é confiável antes de apresentar o impacto CBS/IBS.
Aceite: classificação de prontidão visível; pendências bloqueantes listadas.

US-04 — Tratar problemas de dados

Como analista fiscal
quero resolver ou ignorar pendências com justificativa
para melhorar a prontidão e liberar o cálculo da reforma.
Aceite: status atualizado; auditoria registrada ao resolver/ignorar.

US-05 — Configurar cenários

Como analista fiscal
quero definir parâmetros CBS/IBS e cenários anuais
para simular anos de transição (ex.: 2026–2033).
Aceite: parâmetros salvos; recálculo usa o cenário selecionado.

US-06 — Simular reforma

Como analista fiscal
quero calcular CBS/IBS versus regime atual
para quantificar o impacto da reforma para o cliente.
Aceite: resultados exibidos; bloqueio se não estiver pronto, salvo força.

US-07 — Exportar entregáveis

Como consultor
quero exportar resumos em PDF/Excel
para apresentar achados ao cliente/diretoria.
Aceite: arquivos de export abrem/baixam corretamente.

US-08 — Trilha de auditoria

Como administrador
quero revisar quem alterou o quê
para garantir governança de premissas e correções.
Aceite: Auditoria lista eventos recentes com usuário/data-hora.

US-09 — Gerenciar usuários

Como administrador
quero criar e editar usuários e papéis
para que só pessoas autorizadas acessem o simulador.
Aceite: CRUD de usuário funciona dentro do tenant.

7. Premissas

8. Restrições

Seja honesto sobre restrições — elas definem expectativas realistas.

9. Critérios de aceite (nível de projeto)

Critérios SMART e binários (passa/falha).

10. Anexos

Capturas grandes e inventários técnicos profundos ficam referenciados aqui (não duplicados na narrativa principal).

Anexo A — Catálogo de telas e imagens

Imagens em docs/pdf-assets/ (mesmo padrão do Monithora).

Anexo B — Documentos relacionados

Anexo C — Fluxo operacional principal

flowchart TD
  A[Login] --> B[Criar simulação / Importar SPED]
  B --> C[Confronto + Pendências]
  C --> D[Parâmetros + De-para + Cenários]
  D --> E[Calcular CBS/IBS]
  E --> F{Pronto?}
  F -->|Não| C
  F -->|Sim| G[Dashboard + Exports]

Anexo D — Glossário