| Data | +Versão | +Descrição | +Autores | +
|---|---|---|---|
| 15/12/2024 | +0.1 | +Desenvolvimento do backlog do produto | +Marcos | +
| 16/12/2024 | +0.2 | +Organizando em Temas, Épicos e User Stories | +Marcos | +
A tabela organiza os componentes do backlog do produto da seguinte forma:
+Tema: Agrupa funcionalidades relacionadas, representando áreas principais do sistema (ex: segurança, gestão de estoque).
+Épicos: São grandes funcionalidades dentro de cada tema, que são desmembradas em tarefas menores.
+User Stories: Descrevem necessidades específicas dos usuários de forma simples, explicando o que querem fazer no sistema e por quê.
+| Tema | +Épicos | +User Stories | +
|---|---|---|
| TM01 - Segurança e Controle de Acesso | +EP01 - Gerenciamento de Acesso | +US01 - Eu como usuário quero logar na plataforma para acessar as informações de estoque e suas ferramentas. | +
| TM02 - Gestão Operacional e Monitoramento | +EP02 - Relatórios de Estoque | +US02 - Eu como usuário quero gerar um relatório diário de movimentação de estoque ao final do expediente. | +
| + | + | US03 - Eu como usuário quero acessar relatórios mensais de movimentação de estoque. | +
| + | EP03 - Controle e Atualização de Insumos | +US04 - Eu como usuário quero consultar os insumos disponíveis no estoque para planejar a produção e reposições. | +
| + | + | US05 - Eu como usuário quero editar os insumos disponíveis para que os dados reflitam a realidade. | +
| + | + | US10 - Eu como usuário quero registrar novos insumos utilizados na produção para manter o controle de estoque atualizado. | +
| + | + | US13 - Eu como usuário quero excluir insumos que não são mais utilizados para manter o cadastro atualizado. | +
| + | EP04 - Monitoramento e Notificações | +US06 - Eu como usuário quero receber notificações de insumos em baixo estoque para evitar a falta de ingredientes. | +
| + | + | US07 - Eu como usuário quero receber alertas de estoque próximo ao vencimento para evitar desperdício de produtos. | +
| + | EP05 - Gerenciamento de Cardápios | +US09 - Eu como usuário quero cadastrar o Cardápio associando os insumos necessários para facilitar a organização e planejamento da cozinha. | +
| + | + | US11 - Eu como usuário quero editar os insumos associados a um cardápio para refletir mudanças na receita ou produção. | +
| + | + | US12 - Eu como usuário quero excluir cardápios antigos ou obsoletos para manter os cardápios atuais e que reflitam a realidade. | +
| TM03 - Análise e Suporte à Decisão | +EP06 - Análise de Indicadores | +US14 - Eu como usuário quero analisar o custo de cada prato produzido para definir preços adequados e controlar margem. | +
| + | + | US15 - Eu como usuário quero acessar um painel visual com gráficos e métricas para analisar o desempenho do estoque e da produção. | +
| + | EP07 - Pesquisa e Histórico | +US16 - Eu como usuário quero usar uma pesquisa avançada para encontrar rapidamente insumos ou cardápios com base em critérios como nome, categoria ou data de criação. | +
| + | + | US08 - Eu como usuário quero consultar histórico de movimentações para rastrear alterações e verificar inconsistências. | +
| Data | +Versão | +Descrição | +Autores | +
|---|---|---|---|
| 15/12/2024 | +0.1 | +Criação do DoR e DoD | +Marcos | +
O DoR é um acordo entre o time e o Product Owner (PO) indicando quando um requisito estará preparado para ser puxado para uma Sprint. Alguns itens que podem ser verificados para determinar se um requisito está "Ready" são:
+O DoD é um acordo que demonstra a qualidade do requisito produzido, indicando que “Done” comprova a satisfação de todos com o trabalho realizado. Se um requisito não atende ao “Done”, ele não deve ser liberado ou apresentado na Sprint Review. Alguns itens que devem ser verificados para determinar se um requisito está "Done" são:
+| Data | +Versão | +Descrição | +Autores | +
|---|---|---|---|
| 15/12/2024 | +0.1 | +Adicionando os épicos do backlog | +Marcos | +
Cada linha da tabela corresponde a um épico, que é uma unidade de trabalho de alto nível dentro do backlog do produto. Os épicos representam grandes blocos de funcionalidades ou objetivos estratégicos do sistema, normalmente divididos em requisitos funcionais e user stories menores para facilitar o planejamento e a execução no desenvolvimento.
+| ID do Épico | +Épico | +Descrição | +
|---|---|---|
| EP01 | +Gerenciamento de Acesso | +Funcionalidades relacionadas ao login e acesso à plataforma. | +
| EP02 | +Relatórios de Estoque | +Funcionalidades para geração e visualização de relatórios diários e mensais de movimentação. | +
| EP03 | +Controle e Atualização de Insumos | +Funcionalidades para consultar, adicionar, editar ou excluir insumos no estoque. | +
| EP04 | +Monitoramento e Notificações | +Funcionalidades para enviar notificações sobre insumos em baixo estoque ou próximos ao vencimento. | +
| EP05 | +Gerenciamento de Cardápios | +Funcionalidades para cadastrar, editar ou excluir cardápios e associar insumos necessários. | +
| EP06 | +Análise de Indicadores | +Funcionalidades para calcular custos de pratos e exibir gráficos e métricas de desempenho. | +
| EP07 | +Pesquisa e Histórico | +Funcionalidades para realizar buscas avançadas e consultar histórico de movimentações. | +
| Data | +Versão | +Descrição | +Autores | +
|---|---|---|---|
| 15/12/2024 | +0.1 | +Desenvolvimento da priorização para o MVP | +Marcos | +
Para critério de priorização do backlog, utilizamos os indicadores: complexidade técnica e valor de négocio. Seus graus e descrições são apresentados na tabela a seguir:
+| Grau de Complexidade Técnica | +Descrição | +
|---|---|
| 1 | +Tabelas de fácil e rápida execuçao, que demandam conhecimentos básicos. | +
| 2 | +Compreende tarefas com um grau de complexidade um pouco maior, mas ainda não apresenta muitos desafios. | +
| 3 | +Requer habilidades técnicas intermediárias, envolvendo desafios técnicos moderados. | +
| 4 | +Compreende tarefas mais desafiadoras, exigem conhecimentos técnicos avançados. | +
| 5 | +Inclui atividades complexas, demandam conhecimentos técnicos excepcionais e são de difícil execução. | +
| Grau de Valor de Negócio | +Descrição | +
|---|---|
| 1 | +Impacto mínimo no negócio, gerando poucos benefícios e com pouco impacto nos resultados gerais do negócio. | +
| 2 | +Traz benefícios úteis, mas contribuindo ainda de forma limitada para os objetivos do negócio. | +
| 3 | +Gera um valor significativo, contribuindo para melhorias relevantes no negócio. | +
| 4 | +Gera um alto impacto, gerando melhorias visíveis e competitivas. | +
| 5 | +Oferece um valor de negócio excepcional, transformando o negócio e diferenciando dos outros, criando oportunidades de liderança no mercado. | +
Para calcular a priorização, utilizamos os User Stories (US) como base. Cada US é avaliado em termos de valor de negócio e complexidade técnica. A combinação desses dois fatores nos permite determinar a prioridade de cada item no backlog, ajudando a focar nos itens que trazem maior valor com menor esforço. O valor do resultado é dado pela fórmula:
+2 * Valor de Negócio - Complexidade Técnica
+| US | +Valor de Negócio | +Complexidade Técnica | +Resultado | +
|---|---|---|---|
| US04 | +5 | +2 | +8 | +
| US02 | +5 | +3 | +7 | +
| US10 | +5 | +3 | +7 | +
| US08 | +4 | +2 | +6 | +
| US14 | +5 | +4 | +6 | +
| US09 | +4 | +3 | +5 | +
| US11 | +4 | +3 | +5 | +
| US03 | +4 | +4 | +4 | +
| US13 | +3 | +2 | +4 | +
| US01 | +3 | +3 | +3 | +
| US05 | +3 | +3 | +3 | +
| US12 | +2 | +2 | +2 | +
| US16 | +3 | +4 | +2 | +
| US06 | +2 | +3 | +1 | +
| US07 | +2 | +3 | +1 | +
| US15 | +2 | +3 | +1 | +
Com base na priorização do backlog, foram selecionadas para o MVP as histórias de usuário com resultado igual ou maior que 3. Esse critério assegura que o MVP abranja funcionalidades essenciais, como controle de acesso, consulta de insumos, geração de relatórios e gerenciamento de estoque e cardápios, atendendo às demandas principais do sistema.
+| US | +Título | +Descrição | +
|---|---|---|
| US01 | +Logar na plataforma | +Eu como usuário quero logar na plataforma para acessar as informações de estoque e suas ferramentas. | +
| US02 | +Gerar relatório diário | +Eu como usuário quero gerar um relatório diário de movimentação de estoque ao final do expediente. | +
| US03 | +Acessar relatórios mensais | +Eu como usuário quero acessar relatórios mensais de movimentação de estoque. | +
| US04 | +Consultar insumos disponíveis | +Eu como usuário quero consultar os insumos disponíveis no estoque para planejar a produção e reposições. | +
| US05 | +Editar insumos disponíveis | +Eu como usuário quero editar os insumos disponíveis para que os dados reflitam a realidade. | +
| US08 | +Consultar histórico de movimentações | +Eu como usuário quero consultar histórico de movimentações para rastrear alterações e verificar inconsistências. | +
| US09 | +Cadastrar cardápio | +Eu como usuário quero cadastrar o cardápio associando os insumos necessários para facilitar a organização e planejamento da cozinha. | +
| US10 | +Registrar novos insumos | +Eu como usuário quero registrar novos insumos utilizados na produção para manter o controle de estoque atualizado. | +
| US11 | +Editar insumos associados ao cardápio | +Eu como usuário quero editar os insumos associados a um cardápio para refletir mudanças na receita ou produção. | +
| US13 | +Excluir insumos | +Eu como usuário quero excluir insumos que não são mais utilizados para manter o cadastro atualizado. | +
| US14 | +Analisar custo de cada prato | +Eu como usuário quero analisar o custo de cada prato produzido para definir preços adequados e controlar margem. | +
| Data | +Versão | +Descrição | +Autores | +
|---|---|---|---|
| 15/12/2024 | +0.1 | +Adicionando os requisitos do produto | +Marcos | +
| 16/12/2024 | +0.2 | +Separando os Requisitos em três colunas | +Marcos | +
Os requisitos funcionais especificam as funcionalidades que o sistema deve implementar para atender às necessidades operacionais do Panelas Grill. A seguir, apresenta-se o conjunto preliminar de requisitos.
+| ID | +Funcionalidade | +Descrição | +
|---|---|---|
| RF01 | +Autenticar na plataforma | +Dar acesso à plataforma a um usuário já cadastrado. | +
| RF02 | +Gerar relatório diário de estoque | +Disponibilizar, ao final do expediente, um relatório detalhado das entradas e saídas de itens no estoque. | +
| RF03 | +Visualizar relatório mensal de estoque | +Fornecer relatórios mensais de movimentação de estoque. | +
| RF04 | +Atualizar insumos | +Permitir a atualização das informações dos insumos no estoque. | +
| RF05 | +Consultar insumos no estoque | +Permitir a consulta detalhada dos insumos disponíveis no estoque. | +
| RF06 | +Registrar novos insumos no estoque | +Permitir a adição de novos insumos no estoque. | +
| RF07 | +Cadastrar cardápio | +Permitir o registro de cardápios, associando os insumos necessários. | +
| RF08 | +Notificar insumos em baixo estoque | +Enviar notificações automáticas sobre insumos com estoque abaixo do limite mínimo. | +
| RF09 | +Notificar insumos com vencimento próximo | +Enviar alertas automáticos para determinados insumos com validade próxima. | +
| RF10 | +Analisar custo de pratos | +Calcular o custo de pratos para auxílio na definição de preços e controle de margem. | +
| RF11 | +Editar cardápios | +Atualizar os insumos utilizados no cardápio. | +
| RF12 | +Excluir cardápios | +Permitir a exclusão de cardápios na plataforma. | +
| RF13 | +Excluir insumos | +Permitir a exclusão de insumos na plataforma. | +
| RF14 | +Oferecer dashboard de análise de indicadores | +Oferecer um painel visual com gráficos e métricas, como insumos mais utilizados e itens com maior custo. | +
| RF15 | +Implementar pesquisa inteligente | +Implementar um sistema de busca avançada para encontrar insumos ou cardápios por nome, categoria ou data de criação. | +
| RF16 | +Consultar histórico de movimentações do estoque | +Consultar todas as movimentações realizadas no estoque, permitindo consultas detalhadas de eventos passados. | +
Os requisitos não funcionais descrevem as características de qualidade que o sistema deve possuir para garantir sua eficiência, usabilidade e manutenção.
+| Código | +Descrição | +
|---|---|
| RNF01 | +Suportabilidade (Supportability): O sistema deve funcionar corretamente em navegadores modernos como Google Chrome (versão 90 ou superior), Mozilla Firefox (versão 88 ou superior), Safari (versão 14 ou superior), além de ser compatível com sistemas operacionais Android (versão 10 ou superior) e iOS (versão 13 ou superior), garantindo uma experiência consistente em diferentes plataformas. | +
| RNF02 | +Usabilidade (Usability): A interface deve ser intuitiva, permitindo que os usuários realizem tarefas como localizar cardápios em poucos cliques, sem necessidade de suporte. Todas as funcionalidades principais devem ser acessíveis de forma clara e eficiente, minimizando erros e garantindo uma navegação fluida. | +
| RNF03 | +Desempenho (Performance): O sistema deve processar e responder às solicitações de consulta de insumos em até 2 segundos, mesmo quando houver um grande volume de itens cadastrados no estoque. | +
| RNF04 | +Escalabilidade (Scalability): O sistema deve ser capaz de suportar um grande volume de dados, sem degradação significativa no desempenho. | +
| RNF05 | +Manutenibilidade (Maintainability): O código do sistema deve ser bem documentado e estruturado, facilitando a manutenção e a implementação de novas funcionalidades. | +
| Data | +Versão | +Descrição | +Autores | +
|---|---|---|---|
| 15/12/2024 | +0.1 | +Adicionando as user stories do produto | +Marcos | +
As User Stories são descrições simples e curtas de funcionalidades ou características do sistema, escritas da perspectiva do usuário final. Elas ajudam a equipe de desenvolvimento a entender o que o usuário precisa e por que é importante. Cada User Story segue um formato padrão que inclui um identificador único (ID), uma breve descrição da funcionalidade desejada e o valor ou benefício que ela traz para o usuário. Abaixo estão as User Stories para o projeto:
+| ID | +História de Usuário | +
|---|---|
| US01 | +Eu como usuário quero logar na plataforma para acessar as informações de estoque e suas ferramentas | +
| US02 | +Eu como usuário quero gerar um relatório diário de movimentação de estoque ao final do expediente | +
| US03 | +Eu como usuário quero acessar relatórios mensais de movimentação de estoque | +
| US04 | +Eu como usuário quero consultar os insumos disponíveis no estoque para planejar a produção e reposições | +
| US05 | +Eu como usuário quero editar os insumos disponíveis para que os dados reflitam a realidade | +
| US06 | +Eu como usuário quero receber notificações de insumos em baixo estoque para evitar a falta de ingredientes | +
| US07 | +Eu como usuário quero receber alertas de estoque próximo ao vencimento para evitar desperdício de produtos | +
| US08 | +Eu como usuário quero consultar histórico de movimentações para rastrear alterações e verificar inconsistências | +
| US09 | +Eu como usuário quero cadastrar o Cardápio associando os insumos necessários para facilitar a organização e planejamento da cozinha | +
| US10 | +Eu como usuário quero registrar novos insumos utilizados na produção para manter o controle de estoque atualizado | +
| US11 | +Eu como usuário quero editar os insumos associados a um cardápio para refletir mudanças na receita ou produção | +
| US12 | +Eu como usuário quero excluir cardápios antigos ou obsoletos para manter os cardápios atuais e que reflitam a realidade | +
| US13 | +Eu como usuário quero excluir insumos que não são mais utilizados para manter o cadastro atualizado | +
| US14 | +Eu como usuário quero analisar o custo de cada prato produzido para definir preços adequados e controlar margem | +
| US15 | +Eu como usuário quero acessar um painel visual com gráficos e métricas para analisar o desempenho do estoque e da produção | +
| US16 | +Eu como usuário quero usar uma pesquisa avançada para encontrar rapidamente insumos ou cardápios com base em critérios como nome, categoria ou data de criação | +
feature/nome-da-funcionalidade (e.g., feature/login).bugfix/corrigir-erro (e.g., bugfix/erro-validacao).hotfix/corrigir-urgente (e.g., hotfix/fix-prod-error).release/v1.0.0 (e.g., release/v1.2.0).main: Sempre a versão de produção estável. Não trabalhe diretamente nela.develop: Base para novas funcionalidades. Faça merge de features e bugfixes aqui.develop.develop ao concluir a tarefa. Use Pull Requests (PRs) para revisão.| Versão | +Data | +Descrição | +Autor | +
|---|---|---|---|
| 1.0 | +11/11/2024 | +Adicionando políticas de boas práticas para branch | +Marcos Vieira | +
O padrão de escrita de mensagens de commit deve seguir uma estrutura específica parar facilitar a geração de changelogs automatizados, melhorar a comunicação entre desenvolvedores e ajudar a mander o histórico do repositório organizado. Esse padrão está alinhado com o semver (semantic versioning), descrevendo recursos (features), correções (fixes) e alterações (changes) efetuadas nos commits.
+feat(usuario): criação da tela de login
+- criação da tela
+- validação do e-mail
+- validação da senha
+Closes #123
+Cada mensagem de commit deve apresentar um cabeçalho, um corpo e um rodapé.
+<type>(<scope>): <subject>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+Podemos ler da seguinte forma:
+Tipo(Escopo): [DESCRIÇÃO_DO_COMMIT]
+[
+CORPO_DO_COMMIT
+]
+[RODAPE_DO_COMMIT]
+Os prefixos em "Conventional Commits" são labels utilizadas para indentificar o tipo de mudança feita em um commit. O objetivo dos prefoxps é fortalecer uma maneira padronizada de identificar o tipo de mudança em um repositório. Confira abaixo os itens existentes.
+O escopo do commit é uma parte opcional, curta e de fácil compreenssão. É nela que iremos dizer qual parte do código foi modificada e como indicar que fizemos alterações apenas na camada de Client de um serviço.
+A descrição, juntamente com o tipo, é uma das partes mais importantes do padrão: é aqui que deve ser descrito, de maneira clara, sucinta e simplificada, o que foi realizado no commit. É recomendado que essa parte tenha, no máximo, 70 caracteres.
+O corpo é a parte da mensagem de commit que fornece detalhes adicionais sobre as alterações feitas no código. O corpo do commit deve ser escrito em uma ou mais linhas e deve fornecer informações suficientes para que outros desenvolvedores possam entender o que foi mudado.
+O rodapé também é uma parte opcional da mensagem de commit que pode ser usado para fornecer informações adicionais sobre as alterações feitas no código.O Rodapé do commit pode ser usado para incluir informações como números de ticket de suporte, links para relatórios de bugs ou outros recursos relacionados
+| Versão | +Data | +Descrição | +Autor | +
|---|---|---|---|
| 1.0 | +11/11/2024 | +Adicionando boas práticas de commit | +Marcos Vieira | +
bug, feature, enhancement, documentation).v1.0.0).Closes #123 para vincular e fechar a issue automaticamente ao mesclar um PR.Fixes #<número-da-issue> no commit ou PR para fechar a issue automaticamente.| Versão | +Data | +Descrição | +Autor | +
|---|---|---|---|
| 1.0 | +11/11/2024 | +Adicinando as políticas de boas issues | +Marcos Vieira | +