From 4c9ca5d356a91665c1b40bf1f0ff0f8b5a75c988 Mon Sep 17 00:00:00 2001 From: JohnPetros Date: Sun, 29 Sep 2024 22:16:22 -0300 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9A=20docs:=20improve=20readme=20secti?= =?UTF-8?q?ons=20organization?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 128 +++++++++++++++++++++++++++--------------------------- 1 file changed, 64 insertions(+), 64 deletions(-) diff --git a/README.md b/README.md index d2a1d74d..a411441e 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,70 @@ Stocker é uma aplicação que visa facilitar o gerenciamento de estoque, oferec --- +## Problema do cliente 👔 + +Atualmente, muitas empresas utilizam métodos manuais, como planilhas ou até mesmo papel, para controlar o estoque. Isso gera uma série de problemas, como a dificuldade de atualização em tempo real, erros manuais, falta de visibilidade sobre a quantidade de produtos disponíveis e problemas com a reposição de itens. Além disso, a ausência de um sistema centralizado impede a análise rápida e precisa das informações do inventário, prejudicando a tomada de decisões. + +--- + +## Objetivo do produto 🎯 + +A aplicação tem como objetivo automatizar o controle de estoque, permitindo o gerenciamento de produtos de forma eficiente e acessível. Os usuários poderão adicionar, editar e remover itens do estoque, com controle de permissões para garantir que apenas administradores possam realizar essas ações críticas. A interface intuitiva permite o acompanhamento em tempo real da situação do estoque, melhorando a gestão de inventários e facilitando a reposição de produtos. O sistema será acessível de qualquer lugar, permitindo que os usuários acompanhem e gerenciem o estoque remotamente. + +--- + +## Metodologia empregada 💡 + +Para a confecção do produto foi empregado o framework de [metodologia ágil Scrum](https://aws.amazon.com/pt/what-is/scrum/#:~:text=O%20Scrum%20%C3%A9%20um%20framework,uma%20entrega%20eficiente%20de%20projetos.), que consiste sumariamente dividir o desenvolvimento do projeto em Sprints, um conjunto de tarefas que devem ser executadas e desenvolvidas em um período pré-definido de tempo. Além disso, foi definido o Backlog do Produto, que são todas as funcionalidades que o software deverá ter com base nos requisitos levantados com o cliente. Uma vez aprovado por ele, para selecionar quais seriam as entregas das Sprints do projeto, primeiro foi definido o [MVP](https://rockcontent.com/br/blog/o-que-e-mvp/) de cada Sprint, que é uma versão do produto que prioriza as tarefas que trazem maior entrega de valor para o cliente. Então, a partir disso o Backlog do Produto foi dividido em 4 Backlog de Sprint. + +--- + +## MVP'S 🏆 + +### Sprint - 1️⃣ + +https://github.com/user-attachments/assets/2a9432b4-2785-4214-95e5-3daf1474814f + +### Sprint - 2️⃣ + +Work in progress... 🚧 + +### Sprint - 3️⃣ + +Work in progress... 🚧 + +### Sprint - 4️⃣ + +Work in progress... 🚧 + +--- + +## Requisitos 📒 + +Tabela contendo todos os requisitos em ordem de prioridade + +--- + +Primeira parte da tabela que contém todos as histórias de usuário +Segunda parte da tabela que contém todos as histórias de usuário + + +--- + +## Relatório e detalhes de cada Sprint 📅 + +- Sprint 1: [Acessar](https://github.com/CtrI-Alt-Del/stocker/blob/main/documentation/reports/sprint-1.md) + +- Sprint 2: Work in progress... 🚧 + +- Sprint 3: Work in progress... 🚧 + +- Sprint 4: Work in progress... 🚧 + +--- + ## Tecnologias 🛠️
@@ -101,24 +165,6 @@ Stocker é uma aplicação que visa facilitar o gerenciamento de estoque, oferec --- -## Problema do cliente 👔 - -Atualmente, muitas empresas utilizam métodos manuais, como planilhas ou até mesmo papel, para controlar o estoque. Isso gera uma série de problemas, como a dificuldade de atualização em tempo real, erros manuais, falta de visibilidade sobre a quantidade de produtos disponíveis e problemas com a reposição de itens. Além disso, a ausência de um sistema centralizado impede a análise rápida e precisa das informações do inventário, prejudicando a tomada de decisões. - ---- - -## Objetivo do produto 🎯 - -A aplicação tem como objetivo automatizar o controle de estoque, permitindo o gerenciamento de produtos de forma eficiente e acessível. Os usuários poderão adicionar, editar e remover itens do estoque, com controle de permissões para garantir que apenas administradores possam realizar essas ações críticas. A interface intuitiva permite o acompanhamento em tempo real da situação do estoque, melhorando a gestão de inventários e facilitando a reposição de produtos. O sistema será acessível de qualquer lugar, permitindo que os usuários acompanhem e gerenciem o estoque remotamente. - ---- - -## Metodologia empregada 💡 - -Para a confecção do produto foi empregado o framework de [metodologia ágil Scrum](https://aws.amazon.com/pt/what-is/scrum/#:~:text=O%20Scrum%20%C3%A9%20um%20framework,uma%20entrega%20eficiente%20de%20projetos.), que consiste sumariamente dividir o desenvolvimento do projeto em Sprints, um conjunto de tarefas que devem ser executadas e desenvolvidas em um período pré-definido de tempo. Além disso, foi definido o Backlog do Produto, que são todas as funcionalidades que o software deverá ter com base nos requisitos levantados com o cliente. Uma vez aprovado por ele, para selecionar quais seriam as entregas das Sprints do projeto, primeiro foi definido o [MVP](https://rockcontent.com/br/blog/o-que-e-mvp/) de cada Sprint, que é uma versão do produto que prioriza as tarefas que trazem maior entrega de valor para o cliente. Então, a partir disso o Backlog do Produto foi dividido em 4 Backlog de Sprint. - ---- - ## Como Executar Localmente no Windows 🖥️ ### Pré-requisitos @@ -205,52 +251,6 @@ Ou abra o navegador e navegue até `http://localhost:3333` (ou a porta que você --- -## MVP'S 🏆 - -### Sprint - 1️⃣ - -https://github.com/user-attachments/assets/2a9432b4-2785-4214-95e5-3daf1474814f - -### Sprint - 2️⃣ - -Work in progress... 🚧 - -### Sprint - 3️⃣ - -Work in progress... 🚧 - -### Sprint - 4️⃣ - -Work in progress... 🚧 - ---- - -## Requisitos 📒 - -Tabela contendo todos os requisitos em ordem de prioridade - ---- - -Primeira parte da tabela que contém todos as histórias de usuário -Segunda parte da tabela que contém todos as histórias de usuário - - ---- - -## Relatório e detalhes de cada Sprint 📅 - -- Sprint 1: [Acessar](https://github.com/CtrI-Alt-Del/stocker/blob/main/documentation/reports/sprint-1.md) - -- Sprint 2: Work in progress... 🚧 - -- Sprint 3: Work in progress... 🚧 - -- Sprint 4: Work in progress... 🚧 - ---- - ## Time de Desenvolvimento 👷🏻 | Foto | Nome | Função | Github | Linkedin |