Docs
04 — Funcionalidades e Módulos
<!-- EXEMPLO: produto fictício "SiteScope". Substitua pelos módulos do seu produto real. -->
Módulos de plataforma (boilerplate)
Já implementados no monorepo — reaproveitar em qualquer fork.
| Módulo | Status | Descrição breve | Spec / regras |
|---|---|---|---|
| Setup / rebrand | 🟢 | Brand kit + pnpm rebrand:sync | packages/brand · checklist 001-setup-initial |
| Auth / sessão | 🟢 | Login, OAuth, refresh, reset, guards | specs/002-auth-module |
| Multi-tenant | 🟢 | Companies, membros, convites | specs/004-multi-tenant |
| Planos / billing | 🟢 | Stripe checkout, assinaturas, webhooks | specs/003-billing-subscriptions |
| Onboarding | 🟢 | Fluxo pós-registro (empresa, convites) | specs/005-onboarding |
| Storage | 🟢 | Upload e download de arquivos | specs/006-storage |
| Usuário / perfil | 🟢 | Conta, preferências, exclusão | Parcial em 002-auth-module |
| Backoffice / admin interno | 🟢 | CRUD users, companies, members; subscriptions; payments | specs/007-backoffice-admin-modules |
| Business Intelligence | 🔴 | Dashboards de receita, vendas, marketing, produto + Simulador Comercial interativo no backoffice | specs/008-business-intelligence |
| Functional Testing (E2E) | 🟢 | Suite Playwright cobrindo app, website e backoffice — auth, onboarding, settings, smoke tests | specs/009-functional-testing |
Gates do template: development/00-boilerplate-status.md · APIs: development/04-api-integrations.md
Legenda status: 🟢 live | 🟡 beta/partial | 🔴 planned
Módulos de produto (preencher no fork)
Cada linha vira uma spec em specs/NNN-nome/ na Fase 3. Alinhar aos pilares em 03-pillars-criteria.
| Módulo | Pilar | Status | Descrição breve | Spec / regras |
|---|---|---|---|---|
| Scanner | Diagnóstico | 🔴 | Varredura de URL/domínio; gera checks de SEO, performance e crawl | specs/007-scanner |
| Dashboard de sites | Diagnóstico | 🔴 | Visão consolidada dos scores de todos os sites da conta | specs/008-sites-dashboard |
| Agendamento de varreduras | Automação | 🔴 | Jobs recorrentes (diário/semanal/mensal) por site | specs/009-scan-scheduler |
| Alertas e notificações | Automação | 🔴 | Alertas por e-mail e Slack quando score cai acima de threshold | specs/010-alerts |
| Relatórios white-label | Relatórios | 🔴 | Geração de PDF/HTML com logo, cores e domínio da agência | specs/011-reports |
| Painel do cliente | Relatórios | 🔴 | Link público (sem login) com histórico de scores para o cliente final | specs/012-client-portal |
| Integração GA4 / Search Console | Diagnóstico | 🔴 | Importa dados de tráfego e impressões para enriquecer relatório | specs/013-ga4-integration |
Fluxo de negócio principal
<!-- Happy path do cliente em 5–8 passos -->- Agência cadastra conta e cria empresa (multi-tenant → plano Starter)
- Adiciona um ou mais domínios de clientes ao painel de sites
- Conecta GA4 / Search Console (opcional, enriquece dados)
- Roda primeira varredura manual ou agenda varredura recorrente
- Visualiza score de saúde e lista de issues priorizadas por impacto
- Gera relatório PDF white-label e envia link para o cliente
- Recebe alerta quando próxima varredura detecta regressão ≥ X pontos
- Repete ciclo mensal; expande plano ao atingir limite de sites
Regras de negócio por módulo
<!-- Invariantes, limites por plano, edge cases → viram FR na spec -->Scanner
- Varredura limitada por plano: Free = 1 site / 1 varredura manual por dia; Starter = 5 sites / ilimitado manual + agendado semanal; Pro = 20 sites / diário; Agency = ilimitado / diário
- Tempo máximo de varredura: 10 min; após timeout, job marcado como
partiale resultado parcial exibido com aviso - Dados de varredura retidos por 90 dias (Starter), 12 meses (Pro/Agency)
- Re-varredura de URL individual não consome cota de job agendado
Alertas
- Threshold padrão: queda de ≥ 10 pontos no score geral ou aparecimento de erro crítico (4xx em página indexada, meta robots noindex inesperado)
- Máximo de 3 destinatários de e-mail por site no plano Starter; ilimitado no Pro+
- Rate limit: máximo 1 alerta por site por hora (agrupa múltiplas regressões)
- Desativar alerta não cancela a varredura agendada
Relatórios white-label
- White-label (logo + cores) disponível a partir do plano Pro; no Starter, rodapé exibe "Powered by SiteScope"
- Domínio customizado para link do painel do cliente: apenas Agency
- Link do painel do cliente expira em 30 dias por padrão; renovável manualmente
Help in-app
Documentação para o cliente: apps/app/public/docs/ (inglês). Editar direto no Cursor ou copiar de docs/ quando aplicável.
Como adicionar um módulo
- Linha na tabela Módulos de produto com pilar e status
- Regras aqui ou na spec em
specs/ - Atualizar 03-pillars-criteria se novo critério
- FR-xxx na spec referenciando este módulo