mirror of
https://github.com/welton89/RRBEC.git
synced 2026-04-05 13:35:42 +00:00
doc: first docs
This commit is contained in:
46
doc/App Gestão/App Gestão - Visão Geral.md
Normal file
46
doc/App Gestão/App Gestão - Visão Geral.md
Normal file
@@ -0,0 +1,46 @@
|
||||
# Aplicativo de Gestão do Bar - Visão Geral
|
||||
|
||||
O **Aplicativo de Gestão do Bar** é uma plataforma web centralizada, desenvolvida em Django/Python, destinada a administradores e gerentes do bar. Ele atua como o cérebro da operação, integrando e gerenciando todas as funcionalidades dos aplicativos mobile (BarApp e GarçomApp), além de introduzir capacidades essenciais de gestão empresarial.
|
||||
|
||||
## Propósito
|
||||
|
||||
O principal objetivo deste aplicativo é proporcionar um controle abrangente e eficiente sobre todas as áreas do negócio, desde a operação diária até a análise estratégica e financeira. Ele visa otimizar processos, reduzir erros e fornecer insights valiosos para a tomada de decisões.
|
||||
|
||||
## Principais Funcionalidades:
|
||||
|
||||
- **Gestão de Usuários:** Gerenciamento completo de clientes (do BarApp) e garçons (do GarçomApp), incluindo cadastro, edição e permissões.
|
||||
|
||||
- **Gestão de Cardápio e Produtos:** Cadastro, edição, exclusão e controle de disponibilidade de todos os itens do cardápio.
|
||||
|
||||
- **Gestão de Tickets e Eventos:** Visualização detalhada das vendas de tickets e ingressos, além do gerenciamento completo de eventos (cadastro, edição, exclusão).
|
||||
|
||||
- **Gestão da Fila do Karaokê:** Controle administrativo da fila, permitindo adicionar, editar, remover e reordenar participantes.
|
||||
|
||||
- **Gestão de Comandas:** Visão geral e gerenciamento detalhado de todas as comandas abertas, aguardando pagamento, pagas e fechadas.
|
||||
|
||||
- **Gestão de Funcionários:** Cadastro, manutenção de dados, cargos e controle de acesso para toda a equipe do bar.
|
||||
|
||||
- **Gestão de Pagamentos de Salário:** Registro de pagamentos, cálculo de holerites e histórico de salários.
|
||||
|
||||
- **Gestão de Estoque e Mercadorias:** Registro de entradas de produtos, atualização automática de estoque, visualização do inventário atual e alertas de estoque baixo.
|
||||
|
||||
- **Dashboards e Relatórios:** Painéis visuais e relatórios detalhados sobre vendas, lucratividade, desempenho de funcionários, estoque e finanças, permitindo análises estratégicas.
|
||||
|
||||
|
||||
## Integração com os Outros Aplicativos:
|
||||
|
||||
Este aplicativo de gestão é o backend central para o **BarApp (cliente)** e o **GarçomApp (interno)**. Todas as informações de cardápio, tickets, ingressos, comandas, fila do karaokê e notificações são gerenciadas aqui e sincronizadas em tempo real com os aplicativos mobile, garantindo uma operação coesa e eficiente.
|
||||
|
||||
## Documentos Relacionados:
|
||||
|
||||
Para mais detalhes sobre o Aplicativo de Gestão do Bar, consulte os seguintes documentos:
|
||||
|
||||
- [[Requisitos - Aplicativo de Gestão]]
|
||||
|
||||
- [[Casos de Uso - Aplicativo de Gestão]]
|
||||
|
||||
- [[Histórias de Usuário - Aplicativo de Gestão]]
|
||||
|
||||
- [[Modelagem de Banco de Dados]]
|
||||
|
||||
- [[Visão Geral do Projeto]]
|
||||
298
doc/App Gestão/Casos de Uso - Aplicativo de Gestão.md
Normal file
298
doc/App Gestão/Casos de Uso - Aplicativo de Gestão.md
Normal file
@@ -0,0 +1,298 @@
|
||||
# Casos de Uso do Aplicativo de Gestão do Bar
|
||||
|
||||
Este documento descreve os principais casos de uso para o aplicativo de gestão do bar, detalhando as interações entre os atores e o sistema.
|
||||
|
||||
## Atores
|
||||
|
||||
- **Administrador:** Usuário com acesso total ao sistema.
|
||||
|
||||
- **Gerente:** Usuário com acesso operacional e de relatórios.
|
||||
|
||||
- **Funcionário Administrativo:** Usuário com acesso a módulos específicos (e.g., estoque, folha de pagamento).
|
||||
|
||||
- **Sistema de Pagamento:** Serviço externo para processamento de transações.
|
||||
|
||||
- **Sistema de Cozinha:** Sistema responsável pelo gerenciamento de pedidos na cozinha.
|
||||
|
||||
|
||||
## Casos de Uso
|
||||
|
||||
### 1. Gerenciamento de Usuários (Clientes e Garçons)
|
||||
|
||||
#### CUGSA001: Gerenciar Clientes
|
||||
|
||||
- **Nome:** Gerenciar Clientes
|
||||
|
||||
- **Ator:** Administrador
|
||||
|
||||
- **Descrição:** Permite ao administrador visualizar, editar e excluir informações de clientes do BarApp.
|
||||
|
||||
- **Fluxo Principal:**
|
||||
|
||||
1. Administrador acessa o módulo de "Clientes".
|
||||
|
||||
2. Sistema exibe lista de clientes.
|
||||
|
||||
3. Administrador seleciona cliente para visualizar/editar/excluir.
|
||||
|
||||
4. Sistema realiza a ação solicitada.
|
||||
|
||||
|
||||
#### CUGSA002: Gerenciar Garçons
|
||||
|
||||
- **Nome:** Gerenciar Garçons
|
||||
|
||||
- **Ator:** Administrador
|
||||
|
||||
- **Descrição:** Permite ao administrador cadastrar, editar e excluir garçons.
|
||||
|
||||
- **Fluxo Principal:**
|
||||
|
||||
1. Administrador acessa o módulo de "Garçons".
|
||||
|
||||
2. Sistema exibe lista de garçons.
|
||||
|
||||
3. Administrador seleciona opção para "Cadastrar Novo Garçom", "Editar Garçom" ou "Excluir Garçom".
|
||||
|
||||
4. Sistema realiza a ação e atualiza o registro de garçons.
|
||||
|
||||
|
||||
### 2. Gerenciamento de Cardápio e Produtos
|
||||
|
||||
#### CUGSA003: Gerenciar Produtos do Cardápio
|
||||
|
||||
- **Nome:** Gerenciar Produtos do Cardápio
|
||||
|
||||
- **Ator:** Administrador, Gerente
|
||||
|
||||
- **Descrição:** Permite gerenciar produtos, incluindo cadastro, edição, exclusão e status de disponibilidade.
|
||||
|
||||
- **Fluxo Principal:**
|
||||
|
||||
1. Ator acessa o módulo de "Cardápio/Produtos".
|
||||
|
||||
2. Sistema exibe lista de produtos.
|
||||
|
||||
3. Ator seleciona opção para "Adicionar Produto", "Editar Produto", "Excluir Produto" ou "Alterar Disponibilidade".
|
||||
|
||||
4. Sistema realiza a ação e atualiza o cardápio.
|
||||
|
||||
|
||||
### 3. Gerenciamento de Tickets e Ingressos
|
||||
|
||||
#### CUGSA004: Consultar Tickets
|
||||
|
||||
- **Nome:** Consultar Tickets
|
||||
|
||||
- **Ator:** Administrador, Gerente
|
||||
|
||||
- **Descrição:** Permite visualizar e consultar detalhes de tickets vendidos e seus históricos.
|
||||
|
||||
- **Fluxo Principal:**
|
||||
|
||||
1. Ator acessa o módulo de "Tickets".
|
||||
|
||||
2. Sistema exibe lista de tickets.
|
||||
|
||||
3. Ator pode filtrar por produto, usuário, status, data.
|
||||
|
||||
4. Ator seleciona ticket para ver histórico de uso/transferência.
|
||||
|
||||
|
||||
#### CUGSA005: Gerenciar Eventos e Ingressos
|
||||
|
||||
- **Nome:** Gerenciar Eventos e Ingressos
|
||||
|
||||
- **Ator:** Administrador, Gerente
|
||||
|
||||
- **Descrição:** Permite gerenciar eventos e os ingressos associados.
|
||||
|
||||
- **Fluxo Principal:**
|
||||
|
||||
1. Ator acessa o módulo de "Eventos".
|
||||
|
||||
2. Sistema exibe lista de eventos.
|
||||
|
||||
3. Ator seleciona opção para "Cadastrar Novo Evento", "Editar Evento", "Excluir Evento".
|
||||
|
||||
4. Ator pode visualizar lista de ingressos vendidos para um evento específico.
|
||||
|
||||
|
||||
### 4. Gerenciamento da Fila do Karaokê
|
||||
|
||||
#### CUGSA006: Gerenciar Fila do Karaokê (Admin)
|
||||
|
||||
- **Nome:** Gerenciar Fila do Karaokê (Admin)
|
||||
|
||||
- **Ator:** Administrador, Gerente
|
||||
|
||||
- **Descrição:** Permite o controle total da fila do karaokê.
|
||||
|
||||
- **Fluxo Principal:**
|
||||
|
||||
1. Ator acessa o módulo de "Karaokê".
|
||||
|
||||
2. Sistema exibe a fila em tempo real.
|
||||
|
||||
3. Ator pode adicionar, editar, remover ou reordenar pessoas na fila.
|
||||
|
||||
|
||||
### 5. Gerenciamento de Comandas
|
||||
|
||||
#### CUGSA007: Gerenciar Comandas (Admin)
|
||||
|
||||
- **Nome:** Gerenciar Comandas (Admin)
|
||||
|
||||
- **Ator:** Administrador, Gerente
|
||||
|
||||
- **Descrição:** Permite visualizar, editar e fechar comandas.
|
||||
|
||||
- **Fluxo Principal:**
|
||||
|
||||
1. Ator acessa o módulo de "Comandas".
|
||||
|
||||
2. Sistema exibe lista de comandas com seus status.
|
||||
|
||||
3. Ator seleciona comanda para ver detalhes, editar itens, alterar status ou fechar.
|
||||
|
||||
|
||||
### 6. Gerenciamento de Funcionários
|
||||
|
||||
#### CUGSA008: Gerenciar Dados de Funcionários
|
||||
|
||||
- **Nome:** Gerenciar Dados de Funcionários
|
||||
|
||||
- **Ator:** Administrador, Funcionário Administrativo (RH)
|
||||
|
||||
- **Descrição:** Permite o cadastro e a manutenção dos dados dos funcionários.
|
||||
|
||||
- **Fluxo Principal:**
|
||||
|
||||
1. Ator acessa o módulo de "Funcionários".
|
||||
|
||||
2. Sistema exibe lista de funcionários.
|
||||
|
||||
3. Ator seleciona opção para "Cadastrar Novo Funcionário", "Editar Dados" ou "Excluir Funcionário".
|
||||
|
||||
4. Sistema atualiza o cadastro de funcionários.
|
||||
|
||||
|
||||
### 7. Gestão de Pagamentos de Salário
|
||||
|
||||
#### CUGSA009: Registrar Pagamento de Salário
|
||||
|
||||
- **Nome:** Registrar Pagamento de Salário
|
||||
|
||||
- **Ator:** Administrador, Funcionário Administrativo (RH)
|
||||
|
||||
- **Descrição:** Permite registrar os pagamentos de salário e gerar holerites.
|
||||
|
||||
- **Fluxo Principal:**
|
||||
|
||||
1. Ator acessa o módulo de "Folha de Pagamento".
|
||||
|
||||
2. Ator seleciona funcionário e insere detalhes do pagamento (valor, período).
|
||||
|
||||
3. Sistema registra o pagamento e gera o holerite.
|
||||
|
||||
|
||||
#### CUGSA010: Consultar Histórico de Pagamentos
|
||||
|
||||
- **Nome:** Consultar Histórico de Pagamentos
|
||||
|
||||
- **Ator:** Administrador, Funcionário Administrativo (RH)
|
||||
|
||||
- **Descrição:** Permite visualizar o histórico de pagamentos de salário por funcionário.
|
||||
|
||||
- **Fluxo Principal:**
|
||||
|
||||
1. Ator acessa o módulo de "Folha de Pagamento".
|
||||
|
||||
2. Ator seleciona funcionário para ver seu histórico de pagamentos.
|
||||
|
||||
|
||||
### 8. Gestão de Estoque e Entrada de Mercadorias
|
||||
|
||||
#### CUGSA011: Registrar Entrada de Mercadoria
|
||||
|
||||
- **Nome:** Registrar Entrada de Mercadoria
|
||||
|
||||
- **Ator:** Administrador, Funcionário Administrativo (Estoque)
|
||||
|
||||
- **Descrição:** Permite registrar a entrada de novos produtos no estoque.
|
||||
|
||||
- **Fluxo Principal:**
|
||||
|
||||
1. Ator acessa o módulo de "Estoque/Entrada de Mercadorias".
|
||||
|
||||
2. Ator seleciona produto, quantidade, fornecedor e custo.
|
||||
|
||||
3. Sistema registra a entrada e atualiza o estoque do produto.
|
||||
|
||||
|
||||
#### CUGSA012: Gerenciar Estoque
|
||||
|
||||
- **Nome:** Gerenciar Estoque
|
||||
|
||||
- **Ator:** Administrador, Funcionário Administrativo (Estoque)
|
||||
|
||||
- **Descrição:** Permite visualizar o estoque atual e gerenciar fornecedores.
|
||||
|
||||
- **Fluxo Principal:**
|
||||
|
||||
1. Ator acessa o módulo de "Estoque".
|
||||
|
||||
2. Sistema exibe o estoque atual de todos os produtos.
|
||||
|
||||
3. Ator pode gerenciar fornecedores (cadastrar, editar, excluir).
|
||||
|
||||
|
||||
### 9. Dashboard de Resultados e Relatórios
|
||||
|
||||
#### CUGSA013: Visualizar Dashboard de Vendas
|
||||
|
||||
- **Nome:** Visualizar Dashboard de Vendas
|
||||
|
||||
- **Ator:** Administrador, Gerente
|
||||
|
||||
- **Descrição:** Permite visualizar gráficos e métricas de vendas.
|
||||
|
||||
- **Fluxo Principal:**
|
||||
|
||||
1. Ator acessa o "Dashboard de Vendas".
|
||||
|
||||
2. Sistema exibe métricas como total de vendas, vendas por produto/período/garçom.
|
||||
|
||||
|
||||
#### CUGSA014: Visualizar Dashboard de Lucratividade
|
||||
|
||||
- **Nome:** Visualizar Dashboard de Lucratividade
|
||||
|
||||
- **Ator:** Administrador, Gerente
|
||||
|
||||
- **Descrição:** Permite visualizar gráficos e métricas de lucratividade.
|
||||
|
||||
- **Fluxo Principal:**
|
||||
|
||||
1. Ator acessa o "Dashboard de Lucratividade".
|
||||
|
||||
2. Sistema exibe receita, custos e lucro bruto.
|
||||
|
||||
|
||||
#### CUGSA015: Gerar Relatórios
|
||||
|
||||
- **Nome:** Gerar Relatórios
|
||||
|
||||
- **Ator:** Administrador, Gerente, Funcionário Administrativo
|
||||
|
||||
- **Descrição:** Permite gerar diversos relatórios para análise.
|
||||
|
||||
- **Fluxo Principal:**
|
||||
|
||||
1. Ator acessa o módulo de "Relatórios".
|
||||
|
||||
2. Ator seleciona o tipo de relatório (estoque, financeiro, desempenho de funcionários).
|
||||
|
||||
3. Ator define filtros (período, funcionário, produto).
|
||||
|
||||
4. Sistema gera o relatório e permite exportação.
|
||||
165
doc/App Gestão/Histórias de Usuário - Aplicativo de Gestão.md
Normal file
165
doc/App Gestão/Histórias de Usuário - Aplicativo de Gestão.md
Normal file
@@ -0,0 +1,165 @@
|
||||
# Histórias de Usuário do Aplicativo de Gestão do Bar
|
||||
|
||||
Este documento apresenta as histórias de usuário para o aplicativo de gestão do bar, focando na perspectiva dos usuários de gestão (Administradores, Gerentes, Funcionários Administrativos) e no valor que cada funcionalidade entrega.
|
||||
|
||||
## 1. Gerenciamento de Usuários (Clientes e Garçons)
|
||||
|
||||
- **HUGSA001 - Gerenciar Clientes:**
|
||||
|
||||
- **Como um** administrador,
|
||||
|
||||
- **Eu quero** visualizar e gerenciar os cadastros dos clientes do BarApp,
|
||||
|
||||
- **Para que** eu possa ter controle sobre a base de usuários e realizar manutenções.
|
||||
|
||||
- **HUGSA002 - Gerenciar Garçons:**
|
||||
|
||||
- **Como um** administrador,
|
||||
|
||||
- **Eu quero** cadastrar e gerenciar os garçons que usam o GarçomApp,
|
||||
|
||||
- **Para que** eu possa controlar o acesso da equipe e suas informações.
|
||||
|
||||
|
||||
## 2. Gerenciamento de Cardápio e Produtos
|
||||
|
||||
- **HUGSA003 - Gerenciar Produtos:**
|
||||
|
||||
- **Como um** gerente,
|
||||
|
||||
- **Eu quero** cadastrar, editar e remover produtos do cardápio,
|
||||
|
||||
- **Para que** o cardápio no aplicativo do cliente esteja sempre atualizado com os itens disponíveis.
|
||||
|
||||
- **HUGSA004 - Gerenciar Disponibilidade de Produtos:**
|
||||
|
||||
- **Como um** gerente,
|
||||
|
||||
- **Eu quero** marcar produtos como disponíveis ou indisponíveis,
|
||||
|
||||
- **Para que** os clientes vejam apenas o que está sendo servido no momento.
|
||||
|
||||
|
||||
## 3. Gerenciamento de Tickets e Ingressos
|
||||
|
||||
- **HUGSA005 - Consultar Vendas de Tickets:**
|
||||
|
||||
- **Como um** gerente,
|
||||
|
||||
- **Eu quero** visualizar todos os tickets vendidos e seus status de uso,
|
||||
|
||||
- **Para que** eu possa acompanhar as vendas de tickets e o consumo dos clientes.
|
||||
|
||||
- **HUGSA006 - Gerenciar Eventos:**
|
||||
|
||||
- **Como um** administrador,
|
||||
|
||||
- **Eu quero** cadastrar e gerenciar os eventos do bar,
|
||||
|
||||
- **Para que** os clientes possam comprar ingressos e participar das festas.
|
||||
|
||||
|
||||
## 4. Gerenciamento da Fila do Karaokê
|
||||
|
||||
- **HUGSA007 - Gerenciar Fila do Karaokê (Admin):**
|
||||
|
||||
- **Como um** gerente,
|
||||
|
||||
- **Eu quero** ter controle total sobre a fila do karaokê,
|
||||
|
||||
- **Para que** eu possa organizar as apresentações e garantir a fluidez do evento.
|
||||
|
||||
|
||||
## 5. Gerenciamento de Comandas
|
||||
|
||||
- **HUGSA008 - Visualizar e Gerenciar Comandas:**
|
||||
|
||||
- **Como um** gerente,
|
||||
|
||||
- **Eu quero** visualizar todas as comandas abertas e fechadas,
|
||||
|
||||
- **Para que** eu possa acompanhar o consumo das mesas e o status dos pagamentos.
|
||||
|
||||
|
||||
## 6. Gerenciamento de Funcionários
|
||||
|
||||
- **HUGSA009 - Cadastrar Funcionário:**
|
||||
|
||||
- **Como um** administrador,
|
||||
|
||||
- **Eu quero** cadastrar novos funcionários,
|
||||
|
||||
- **Para que** eu possa manter um registro completo da equipe.
|
||||
|
||||
- **HUGSA010 - Gerenciar Dados de Funcionários:**
|
||||
|
||||
- **Como um** administrador,
|
||||
|
||||
- **Eu quero** editar os dados dos funcionários,
|
||||
|
||||
- **Para que** as informações da equipe estejam sempre atualizadas.
|
||||
|
||||
|
||||
## 7. Gestão de Pagamentos de Salário
|
||||
|
||||
- **HUGSA011 - Registrar Pagamento de Salário:**
|
||||
|
||||
- **Como um** funcionário administrativo (RH),
|
||||
|
||||
- **Eu quero** registrar os pagamentos de salário dos funcionários,
|
||||
|
||||
- **Para que** a folha de pagamento seja organizada e os holerites gerados corretamente.
|
||||
|
||||
- **HUGSA012 - Consultar Histórico de Pagamentos:**
|
||||
|
||||
- **Como um** funcionário administrativo (RH),
|
||||
|
||||
- **Eu quero** consultar o histórico de pagamentos de salário de cada funcionário,
|
||||
|
||||
- **Para que** eu possa verificar registros passados e resolver dúvidas.
|
||||
|
||||
|
||||
## 8. Gestão de Estoque e Entrada de Mercadorias
|
||||
|
||||
- **HUGSA013 - Registrar Entrada de Mercadoria:**
|
||||
|
||||
- **Como um** funcionário administrativo (estoque),
|
||||
|
||||
- **Eu quero** registrar a entrada de novas mercadorias,
|
||||
|
||||
- **Para que** o estoque seja atualizado e eu tenha controle sobre o que entra no bar.
|
||||
|
||||
- **HUGSA014 - Visualizar Estoque e Alertas:**
|
||||
|
||||
- **Como um** gerente,
|
||||
|
||||
- **Eu quero** visualizar o estoque atual de produtos e receber alertas de estoque baixo,
|
||||
|
||||
- **Para que** eu possa garantir que nunca falte produto e planejar novas compras.
|
||||
|
||||
|
||||
## 9. Dashboard de Resultados e Relatórios
|
||||
|
||||
- **HUGSA015 - Visualizar Dashboard de Vendas:**
|
||||
|
||||
- **Como um** gerente,
|
||||
|
||||
- **Eu quero** ver um dashboard com os resultados de vendas,
|
||||
|
||||
- **Para que** eu possa analisar o desempenho do bar e identificar tendências.
|
||||
|
||||
- **HUGSA016 - Visualizar Dashboard de Lucratividade:**
|
||||
|
||||
- **Como um** administrador,
|
||||
|
||||
- **Eu quero** ver um dashboard com a lucratividade do bar,
|
||||
|
||||
- **Para que** eu possa tomar decisões financeiras estratégicas.
|
||||
|
||||
- **HUGSA017 - Gerar Relatórios:**
|
||||
|
||||
- **Como um** administrador,
|
||||
|
||||
- **Eu quero** gerar relatórios detalhados (estoque, financeiro, desempenho de funcionários),
|
||||
|
||||
- **Para que** eu possa ter informações precisas para auditorias e planejamento.
|
||||
225
doc/App Gestão/Requisitos - Aplicativo de Gestão.md
Normal file
225
doc/App Gestão/Requisitos - Aplicativo de Gestão.md
Normal file
@@ -0,0 +1,225 @@
|
||||
# Documento de Requisitos do Aplicativo de Gestão do Bar
|
||||
|
||||
## 1. Introdução
|
||||
|
||||
### 1.1. Propósito
|
||||
|
||||
Este documento detalha os requisitos funcionais, não funcionais, regras de negócio e requisitos de sistema para o desenvolvimento de um aplicativo web de gestão para o bar, a ser desenvolvido em Django/Python. Este aplicativo centralizará o controle de todas as operações do bar, incluindo as funcionalidades já existentes nos aplicativos mobile (BarApp e GarçomApp), além de novas funcionalidades de gestão empresarial.
|
||||
|
||||
### 1.2. Escopo
|
||||
|
||||
O aplicativo de gestão será uma plataforma web acessível por navegadores, destinada a administradores e gerentes do bar. Ele englobará a gestão de clientes, produtos, tickets, ingressos, karaokê, comandas, funcionários, salários, estoque e dashboards de resultados.
|
||||
|
||||
### 1.3. Público-alvo
|
||||
|
||||
- **Administradores:** Usuários com acesso total ao sistema, responsáveis pela configuração e gestão estratégica.
|
||||
|
||||
- **Gerentes:** Usuários com acesso a funcionalidades operacionais e de relatórios.
|
||||
|
||||
- **Funcionários Administrativos:** Usuários com acesso a funcionalidades específicas, como gestão de estoque ou folha de pagamento.
|
||||
|
||||
|
||||
## 2. Requisitos Funcionais (RF)
|
||||
|
||||
Os requisitos funcionais descrevem as funcionalidades que o sistema deve oferecer aos usuários do aplicativo de gestão.
|
||||
|
||||
### 2.1. Gerenciamento de Usuários (Clientes e Garçons)
|
||||
|
||||
- **RFGSA001 - Gerenciar Clientes (BarApp):** O sistema deve permitir que o administrador visualize, edite e exclua cadastros de clientes do BarApp.
|
||||
|
||||
- **RFGSA002 - Gerenciar Garçons (GarçomApp):** O sistema deve permitir que o administrador cadastre, edite (nome, usuário, senha) e exclua garçons que utilizarão o GarçomApp.
|
||||
|
||||
- **RFGSA003 - Gerenciar Permissões de Garçons:** O sistema deve permitir que o administrador atribua diferentes níveis de permissão aos garçons (e.g., acesso a comandas, acesso a karaokê).
|
||||
|
||||
|
||||
### 2.2. Gerenciamento de Cardápio e Produtos
|
||||
|
||||
- **RFGSA004 - Cadastrar Produto:** O sistema deve permitir que o administrador cadastre novos produtos no cardápio (nome, descrição, preço, imagem, categoria).
|
||||
|
||||
- **RFGSA005 - Editar Produto:** O sistema deve permitir que o administrador edite informações de produtos existentes.
|
||||
|
||||
- **RFGSA006 - Excluir Produto:** O sistema deve permitir que o administrador exclua produtos do cardápio.
|
||||
|
||||
- **RFGSA007 - Gerenciar Categorias de Produtos:** O sistema deve permitir o cadastro, edição e exclusão de categorias de produtos.
|
||||
|
||||
- **RFGSA008 - Gerenciar Disponibilidade de Produtos:** O sistema deve permitir que o administrador marque produtos como disponíveis ou indisponíveis no cardápio do BarApp.
|
||||
|
||||
|
||||
### 2.3. Gerenciamento de Tickets
|
||||
|
||||
- **RFGSA009 - Visualizar Tickets Vendidos:** O sistema deve exibir uma lista de todos os tickets vendidos, com detalhes (produto, comprador, data de compra, status).
|
||||
|
||||
- **RFGSA010 - Consultar Histórico de Tickets:** O sistema deve permitir a consulta do histórico de uso e transferência de tickets.
|
||||
|
||||
- **RFGSA011 - Configurar Prazo de Validade de Tickets:** O sistema deve permitir que o administrador configure o prazo de validade padrão para os tickets.
|
||||
|
||||
- **RFGSA012 - Configurar Limite de Compra de Tickets:** O sistema deve permitir que o administrador configure o limite de compra de tickets por produto por usuário.
|
||||
|
||||
|
||||
### 2.4. Gerenciamento de Eventos e Ingressos
|
||||
|
||||
- **RFGSA013 - Cadastrar Evento:** O sistema deve permitir que o administrador cadastre novos eventos (nome, data, hora, descrição, preço do ingresso, imagem).
|
||||
|
||||
- **RFGSA014 - Editar Evento:** O sistema deve permitir que o administrador edite informações de eventos existentes.
|
||||
|
||||
- **RFGSA015 - Excluir Evento:** O sistema deve permitir que o administrador exclua eventos.
|
||||
|
||||
- **RFGSA016 - Visualizar Ingressos Vendidos:** O sistema deve exibir uma lista de todos os ingressos vendidos para eventos.
|
||||
|
||||
- **RFGSA017 - Consultar Status de Ingressos:** O sistema deve permitir verificar o status de uso de cada ingresso.
|
||||
|
||||
|
||||
### 2.5. Gerenciamento da Fila do Karaokê
|
||||
|
||||
- **RFGSA018 - Visualizar Fila do Karaokê:** O sistema deve exibir a fila do karaokê em tempo real, permitindo ao administrador acompanhar e gerenciar.
|
||||
|
||||
- **RFGSA019 - Gerenciar Fila do Karaokê (Admin):** O sistema deve permitir que o administrador adicione, edite, exclua e altere a posição de pessoas na fila do karaokê.
|
||||
|
||||
|
||||
### 2.6. Gerenciamento de Comandas
|
||||
|
||||
- **RFGSA020 - Visualizar Todas as Comandas:** O sistema deve exibir uma lista completa de todas as comandas (abertas, aguardando pagamento, pagas, fechadas).
|
||||
|
||||
- **RFGSA021 - Detalhes da Comanda:** O sistema deve permitir que o administrador visualize os detalhes de cada comanda (itens, valores, histórico de pagamentos).
|
||||
|
||||
- **RFGSA022 - Editar Comanda (Admin):** O sistema deve permitir que o administrador edite qualquer informação de uma comanda (itens, status, etc.).
|
||||
|
||||
- **RFGSA023 - Fechar Comanda (Admin):** O sistema deve permitir que o administrador feche uma comanda manualmente.
|
||||
|
||||
- **RFGSA024 - Gerar Relatório de Comandas:** O sistema deve gerar relatórios de comandas por período, garçom, status, etc.
|
||||
|
||||
|
||||
### 2.7. Gerenciamento de Funcionários
|
||||
|
||||
- **RFGSA025 - Cadastrar Funcionário:** O sistema deve permitir o cadastro de novos funcionários (nome, CPF, cargo, data de contratação, salário base, dados bancários).
|
||||
|
||||
- **RFGSA026 - Editar Dados do Funcionário:** O sistema deve permitir a edição dos dados cadastrais dos funcionários.
|
||||
|
||||
- **RFGSA027 - Excluir Funcionário:** O sistema deve permitir a exclusão de registros de funcionários.
|
||||
|
||||
- **RFGSA028 - Gerenciar Cargos:** O sistema deve permitir o cadastro, edição e exclusão de cargos e suas descrições.
|
||||
|
||||
|
||||
### 2.8. Gestão de Pagamentos de Salário
|
||||
|
||||
- **RFGSA029 - Registrar Pagamento de Salário:** O sistema deve permitir o registro de pagamentos de salário para funcionários (valor, data, período de referência).
|
||||
|
||||
- **RFGSA030 - Gerar Holerite:** O sistema deve gerar holerites (recibos de pagamento) para os funcionários, contendo detalhes do salário, descontos e benefícios.
|
||||
|
||||
- **RFGSA031 - Visualizar Histórico de Pagamentos:** O sistema deve exibir o histórico de pagamentos de salário por funcionário.
|
||||
|
||||
|
||||
### 2.9. Gestão de Estoque e Entrada de Mercadorias
|
||||
|
||||
- **RFGSA032 - Registrar Entrada de Mercadoria:** O sistema deve permitir o registro de entrada de mercadorias no estoque (produto, quantidade, data, fornecedor, custo unitário).
|
||||
|
||||
- **RFGSA033 - Atualizar Estoque:** O sistema deve atualizar automaticamente o estoque dos produtos após a entrada de mercadorias.
|
||||
|
||||
- **RFGSA034 - Visualizar Estoque Atual:** O sistema deve exibir o estoque atual de todos os produtos.
|
||||
|
||||
- **RFGSA035 - Alerta de Estoque Baixo:** O sistema deve gerar alertas quando o estoque de um produto atingir um nível mínimo configurável.
|
||||
|
||||
- **RFGSA036 - Gerenciar Fornecedores:** O sistema deve permitir o cadastro, edição e exclusão de informações de fornecedores.
|
||||
|
||||
|
||||
### 2.10. Dashboard de Resultados e Relatórios
|
||||
|
||||
- **RFGSA037 - Dashboard de Vendas:** O sistema deve exibir um dashboard com métricas de vendas (total de vendas, vendas por produto, vendas por período, vendas por garçom).
|
||||
|
||||
- **RFGSA038 - Dashboard de Lucratividade:** O sistema deve exibir um dashboard com métricas de lucratividade (receita, custo de mercadoria vendida, lucro bruto).
|
||||
|
||||
- **RFGSA039 - Relatório de Estoque:** O sistema deve gerar relatórios detalhados sobre o estoque (movimentação, valor do estoque).
|
||||
|
||||
- **RFGSA040 - Relatório de Desempenho de Funcionários:** O sistema deve gerar relatórios sobre o desempenho dos garçons (e.g., número de comandas abertas, valor total de vendas).
|
||||
|
||||
- **RFGSA041 - Relatório Financeiro:** O sistema deve gerar relatórios financeiros consolidados (receitas, despesas, fluxo de caixa).
|
||||
|
||||
|
||||
## 3. Requisitos Não Funcionais (RNF)
|
||||
|
||||
### 3.1. Usabilidade
|
||||
|
||||
- **RNFGSA001 - Interface Web Intuitiva:** A interface web deve ser intuitiva, responsiva e fácil de navegar para administradores e gerentes.
|
||||
|
||||
- **RNFGSA002 - Painéis de Controle Claros:** Os dashboards e relatórios devem apresentar informações de forma clara e visualmente atraente.
|
||||
|
||||
- **RNFGSA003 - Geração de Relatórios:** Relatórios devem ser exportáveis em formatos comuns (e.g., PDF, CSV, Excel).
|
||||
|
||||
|
||||
### 3.2. Desempenho
|
||||
|
||||
- **RNFGSA004 - Tempo de Resposta:** O tempo de resposta para operações de gestão e carregamento de dashboards não deve exceder 5 segundos.
|
||||
|
||||
- **RNFGSA005 - Capacidade de Processamento:** O sistema deve ser capaz de processar um grande volume de dados de vendas, estoque e funcionários sem lentidão.
|
||||
|
||||
|
||||
### 3.3. Segurança
|
||||
|
||||
- **RNFGSA006 - Autenticação de Administradores:** O sistema deve garantir que apenas usuários autorizados (administradores, gerentes) possam acessar o painel de gestão.
|
||||
|
||||
- **RNFGSA007 - Controle de Acesso Baseado em Papéis (RBAC):** O sistema deve implementar um controle de acesso robusto, onde diferentes papéis de usuário (administrador, gerente, etc.) têm permissões específicas.
|
||||
|
||||
- **RNFGSA008 - Proteção de Dados Sensíveis:** Informações financeiras, de funcionários e de clientes devem ser armazenadas e transmitidas de forma criptografada e segura.
|
||||
|
||||
- **RNFGSA009 - Auditoria:** O sistema deve registrar logs de auditoria para ações críticas realizadas pelos usuários de gestão.
|
||||
|
||||
|
||||
### 3.4. Confiabilidade
|
||||
|
||||
- **RNFGSA010 - Disponibilidade:** O sistema deve estar disponível 99,5% do tempo.
|
||||
|
||||
- **RNFGSA011 - Integridade dos Dados:** O sistema deve garantir a integridade e consistência de todos os dados financeiros e de estoque.
|
||||
|
||||
- **RNFGSA012 - Backup e Recuperação:** Deve haver um plano de backup e recuperação de desastres para os dados do sistema.
|
||||
|
||||
|
||||
### 3.5. Manutenibilidade
|
||||
|
||||
- **RNFGSA013 - Arquitetura Modular:** O sistema deve ser desenvolvido com uma arquitetura modular para facilitar a manutenção e a adição de novas funcionalidades.
|
||||
|
||||
- **RNFGSA014 - Documentação Interna:** O código e a arquitetura do sistema devem ser bem documentados.
|
||||
|
||||
|
||||
### 3.6. Compatibilidade
|
||||
|
||||
- **RNFGSA015 - Compatibilidade com Navegadores:** O sistema deve ser compatível com os principais navegadores web modernos (Chrome, Firefox, Edge, Safari).
|
||||
|
||||
- **RNFGSA016 - Responsividade Web:** A interface deve ser responsiva e adaptável a diferentes tamanhos de tela (desktops, tablets).
|
||||
|
||||
|
||||
## 4. Regras de Negócio (RN)
|
||||
|
||||
### 4.1. Funcionários e Salários
|
||||
|
||||
- **RNGSA001 - Salário Base:** Cada funcionário deve ter um salário base definido.
|
||||
|
||||
- **RNGSA002 - Período de Pagamento:** Salários são pagos em períodos definidos (e.g., mensalmente).
|
||||
|
||||
- **RNGSA003 - Descontos Legais:** O sistema deve calcular e aplicar descontos legais (e.g., impostos, previdência) nos holerites.
|
||||
|
||||
|
||||
### 4.2. Estoque
|
||||
|
||||
- **RNGSA004 - Atualização de Estoque:** A venda de produtos (via tickets ou comandas) deve decrementar automaticamente o estoque.
|
||||
|
||||
- **RNGSA005 - Custo Médio Ponderado:** O sistema deve calcular o custo médio ponderado dos produtos em estoque para fins de lucratividade.
|
||||
|
||||
|
||||
## 5. Requisitos de Sistema (RS)
|
||||
|
||||
### 5.1. Tecnologia
|
||||
|
||||
- **RSGSA001 - Framework:** O sistema será desenvolvido utilizando o framework Django (Python).
|
||||
|
||||
- **RSGSA002 - Banco de Dados:** Será utilizado um banco de dados relacional (e.g., PostgreSQL, MySQL).
|
||||
|
||||
- **RSGSA003 - Servidor Web:** O sistema será hospedado em um servidor web (e.g., Nginx, Apache).
|
||||
|
||||
|
||||
### 5.2. Integrações
|
||||
|
||||
- **RSGSA004 - Integração com BarApp e GarçomApp:** O sistema de gestão atuará como o backend central para os aplicativos mobile, gerenciando seus dados.
|
||||
|
||||
- **RSGSA005 - Integração com Gateway de Pagamento:** O sistema de gestão deve ter acesso às informações de transações do gateway de pagamento.
|
||||
|
||||
- **RSGSA006 - Integração com Sistema de Cozinha:** O sistema de gestão deve se comunicar com o sistema da cozinha para gerenciar o status dos pedidos.
|
||||
1
doc/App Gestão/db.json
Normal file
1
doc/App Gestão/db.json
Normal file
@@ -0,0 +1 @@
|
||||
[]
|
||||
Reference in New Issue
Block a user