Skip to content

Commit 8254ebb

Browse files
authored
Merge branch 'main' into dev
2 parents 337ada2 + d74f7cc commit 8254ebb

9 files changed

Lines changed: 513 additions & 69 deletions

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,11 @@ pnpm lint
5050
pnpm test
5151
```
5252

53-
## Documentação do Repositório
53+
# Deploy
54+
55+
<li><a href="https://meupj-api-student.delightfulwave-8b9abc5f.brazilsouth.azurecontainerapps.io/">meupj.azurecontainerapps.io</a></li>
56+
57+
# Apresentação
5458

5559
- [`src/README.md`](src/README.md): documentação técnica canônica do código atual
5660
- [`docs/`](docs): artefatos acadêmicos organizados por etapa

docs/04-Projeto de Interface.md

Lines changed: 250 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,271 @@
11
# Projeto de Interface
22

3-
<span style="color:red">Pré-requisitos: <a href="02-Especificação do Projeto.md"> Documentação de Especificação</a></span>
3+
## Visão Geral
44

5-
Este documento apresenta a visão geral da interação do usuário com as principais telas do sistema nas versões web e mobile. A solução foi organizada para priorizar fluxos curtos, leitura rápida do estado do negócio e execução direta das ações mais frequentes.
5+
O projeto de interface foi desenvolvido com o objetivo de proporcionar uma experiência simples, intuitiva e eficiente para profissionais autônomos e pequenos prestadores de serviço, conforme identificado nas personas e histórias de usuário.
66

7-
As interfaces foram elaboradas de forma a atender os requisitos funcionais do sistema, especialmente autenticação, manutenção de clientes, catálogo, pedidos, lançamentos financeiros, emissão de documentos e contato rápido com clientes.
7+
As interfaces foram projetadas considerando:
8+
9+
- Facilidade de uso (RNF-003)
10+
- Rapidez na execução de tarefas
11+
- Clareza na visualização das informações
12+
- Compatibilidade entre desktop e dispositivos móveis (RNF-004)
13+
14+
A navegação do sistema foi organizada em módulos principais (Clientes, Catálogo, Pedidos e Financeiro), permitindo que o usuário acesse rapidamente as funcionalidades essenciais do sistema.
815

916
## Diagrama de Fluxo
1017

11-
O fluxo principal da aplicação pode ser resumido da seguinte forma:
18+
O fluxo de interação do usuário foi estruturado de forma simples e linear, reduzindo a complexidade e facilitando o uso diário.
19+
20+
### Fluxo principal do sistema
21+
22+
Login / Cadastro
23+
24+
Dashboard / Financeiro
25+
26+
├── Clientes
27+
│ ├── Listar clientes
28+
│ └── Cadastrar / Editar cliente
29+
30+
├── Catálogo
31+
│ ├── Listar produtos/serviços
32+
│ └── Cadastrar item
33+
34+
├── Pedidos
35+
│ ├── Criar pedido
36+
│ ├── Editar pedido
37+
│ └── Gerar documentos (recibo/orçamento/OS)
38+
39+
└── Financeiro
40+
├── Visualizar painel
41+
└── Criar lançamento
1242

13-
1. O usuário cria conta ou realiza login.
14-
2. Após autenticação, acessa o painel principal com visão resumida do financeiro.
15-
3. A partir da navegação principal, pode acessar clientes, catálogo, pedidos e configurações.
16-
4. Nos módulos operacionais, pode criar, editar, excluir e consultar registros.
17-
5. Em pedidos e lançamentos, pode emitir documentos em PDF conforme as regras do sistema.
18-
6. Em clientes, pode acionar rapidamente telefone e WhatsApp quando houver telefone válido.
43+
Esse fluxo permite que o usuário realize suas tarefas principais com poucos passos, atendendo especialmente:
1944

20-
Na versão web, a navegação prioriza listas com ações contextuais por item, cabeçalhos fixos, filtros e visualização direta dos documentos. Na versão mobile, a navegação prioriza tabs, telas de detalhe e menus contextuais adaptados ao toque.
45+
- João (rapidez)
46+
- Carla (organização)
47+
- Marcos (visão compartilhada)
2148

22-
> **Pendência registrada:** o diagrama visual desta seção deve ser atualizado para refletir os fluxos reais atuais de login, dashboard, clientes, catálogo, pedidos, documentos e ações rápidas de contato.
2349

2450
## Wireframes
2551

26-
As principais interfaces do sistema implementado são:
52+
### 1. Autenticação (Login, Cadastro e Recuperação de Senha)
53+
54+
#### Objetivo
55+
Permitir que o usuário acesse o sistema de forma segura e crie sua conta.
56+
57+
#### Funcionalidades
58+
- Login com e-mail e senha
59+
- Cadastro de novo usuário
60+
- Recuperação de senha
61+
62+
#### Requisitos atendidos
63+
- RF-001
64+
- RF-002
65+
- RF-003
66+
- RNF-001
67+
- RNF-002
68+
69+
#### Decisões de design
70+
- Layout dividido com área visual e formulário
71+
- Campos simples e diretos
72+
- Botões de ação destacados
73+
- Versão mobile otimizada para uso rápido
74+
75+
#### Relação com personas
76+
- João: acesso rápido
77+
- Carla: experiência profissional
78+
- Marcos: facilidade para múltiplos acessos
79+
80+
81+
![Login e Cadastro](./img/login_cadastro.jpeg)
82+
83+
### 2. Catálogo (Produtos e Serviços)
84+
85+
#### Objetivo
86+
Gerenciar os itens oferecidos pelo usuário.
87+
88+
#### Funcionalidades
89+
- Listagem em cards
90+
- Filtro por tipo (produto/serviço)
91+
- Cadastro e edição de itens
92+
- Definição de preço e unidade
93+
94+
#### Requisitos atendidos
95+
- RF-012
96+
- RF-013
97+
- RF-014
98+
- RF-015
99+
100+
#### Decisões de design
101+
- Uso de cards para melhor visualização
102+
- Separação por abas (Todos, Produtos, Serviços)
103+
- Destaque para preço
104+
105+
#### Diferencial
106+
- Campo de custo e margem para produtos
107+
108+
#### Relação com personas
109+
- João: visão rápida
110+
- Carla: padronização
111+
- Marcos: controle facilitado
112+
113+
---
114+
![Catalogo](./img/catalogo.jpeg)
115+
116+
117+
### 3. Financeiro
118+
119+
#### Objetivo
120+
Apresentar a situação financeira do negócio de forma clara e centralizada.
121+
122+
#### Funcionalidades
123+
- Painel com indicadores:
124+
- Receita confirmada
125+
- Valores a receber
126+
- Valores em atraso
127+
- Resultado
128+
- Lista de lançamentos
129+
- Cadastro de receitas e custos
130+
131+
#### Requisitos atendidos
132+
- RF-016
133+
- RF-017
134+
- RF-018
135+
136+
#### Decisões de design
137+
- Uso de cores para status:
138+
- Verde → confirmado
139+
- Azul → pendente
140+
- Vermelho → atraso
141+
- Gráfico simplificado para análise rápida
142+
- Lista com informações resumidas
143+
144+
#### Relação com personas
145+
- João: controle básico
146+
- Carla: visão estratégica
147+
- Marcos: acompanhamento financeiro
148+
149+
### 4. Lista de Clientes
150+
![Lista de Clientes](./img/lista_clientes.jpeg)
151+
152+
#### Objetivo
153+
Permitir a visualização, organização e gerenciamento dos clientes cadastrados no sistema.
154+
155+
#### Descrição da Interface
156+
A tela apresenta uma listagem clara e organizada dos clientes, permitindo acesso rápido às informações principais. Cada cliente é exibido com dados resumidos, facilitando a identificação e seleção.
157+
158+
Além da listagem, a interface permite o acesso ao cadastro completo do cliente, estruturado em seções bem definidas para melhor organização das informações.
159+
160+
#### Funcionalidades
161+
- Visualização da lista de clientes cadastrados
162+
- Busca de clientes por nome
163+
- Identificação do tipo de cliente (Pessoa Física ou Jurídica)
164+
- Acesso ao cadastro completo do cliente
165+
- Criação, edição e exclusão de clientes
166+
167+
#### Estrutura do Cadastro de Cliente
168+
O formulário de cadastro foi organizado em blocos para facilitar o preenchimento e leitura:
169+
170+
- **Identificação:** nome, CPF ou CNPJ
171+
- **Contato:** telefone e e-mail
172+
- **Endereço:** rua, número, bairro, cidade, estado e CEP
173+
- **Anotações:** campo livre para observações internas
174+
175+
#### Decisões de Design
176+
- Separação das informações por seções → melhora a usabilidade
177+
- Lista simples → facilita leitura rápida
178+
- Campos objetivos → reduz tempo de preenchimento
179+
180+
#### Requisitos atendidos
181+
- RF-004
182+
- RF-005
183+
- RF-006
184+
- RF-007
185+
186+
---
187+
188+
### 5. Perfil do Usuário ("Meu Perfil")
189+
190+
![Perfil](./img/perfil.jpeg)
191+
192+
#### Objetivo
193+
Permitir que o usuário gerencie seus dados pessoais e as informações do seu negócio, utilizadas nos documentos e na personalização do sistema.
194+
195+
#### Descrição da Interface
196+
A tela de perfil centraliza todas as informações do usuário e do seu negócio, permitindo edição completa dos dados. A organização em seções facilita a atualização e manutenção das informações.
197+
198+
#### Funcionalidades
199+
- Visualização e edição dos dados pessoais
200+
- Atualização das informações do negócio
201+
- Upload e alteração do logotipo
202+
- Alteração de senha
203+
- Personalização de dados exibidos nos documentos
204+
205+
#### Estrutura das Informações
206+
207+
O perfil foi dividido em blocos para melhor organização:
208+
209+
- **Dados do usuário:** nome e informações de acesso
210+
- **Dados do negócio:** nome do negócio e razão social
211+
- **Documento:** CPF ou CNPJ
212+
- **Contato:** telefone e e-mail comercial
213+
- **Logotipo:** imagem utilizada nos documentos
214+
- **Rodapé padrão:** texto exibido em propostas, recibos e ordens de serviço
215+
- **Anotações:** campo livre para informações adicionais
216+
217+
#### Decisões de Design
218+
- Centralização de todas as configurações em uma única tela
219+
- Organização por seções → facilita edição
220+
- Campos editáveis de forma direta → maior agilidade
221+
- Personalização visual (logotipo e rodapé) → reforça profissionalismo
222+
223+
#### Requisitos atendidos
224+
- RF-001
225+
- RF-002
226+
- RNF-003
227+
228+
229+
## Versão Mobile
230+
231+
A versão mobile foi projetada com foco em praticidade e uso rápido.
232+
233+
#### Características
234+
- Layout vertical
235+
- Botão flutuante (+) para ações principais
236+
- Navegação simplificada
237+
- Elementos adaptados para toque
238+
239+
#### Requisitos atendidos
240+
- RNF-004
241+
242+
---
243+
244+
## Justificativa de Design
245+
246+
O projeto foi baseado em três pilares principais:
27247

28-
### Interface Web
248+
### Simplicidade
249+
- Interfaces limpas
250+
- Redução de elementos desnecessários
251+
- Navegação direta
29252

30-
- **Login e cadastro:** entrada do sistema com autenticação por sessão.
31-
- **Dashboard financeiro:** exibe KPIs, gráfico resumido, filtros por período e listagem recente de lançamentos.
32-
- **Clientes:** listagem paginada com busca, filtro por tipo, ações de editar, excluir, ligar e abrir WhatsApp.
33-
- **Catálogo:** listagem e manutenção de produtos e serviços com foco em reaproveitamento nos pedidos.
34-
- **Pedidos:** lista por status, busca, criação, edição, exclusão e emissão de orçamento/ordem de serviço.
35-
- **Documentos:** páginas de preview para orçamento, ordem de serviço e recibo, com abertura e download do PDF.
36-
- **Configurações:** edição do perfil do usuário e do negócio.
253+
### Eficiência
254+
- Ações principais sempre visíveis
255+
- Redução de cliques
256+
- Fluxo otimizado
37257

38-
### Interface Mobile
258+
### Clareza
259+
- Uso de cores para indicar status
260+
- Organização por módulos
261+
- Hierarquia visual bem definida
39262

40-
- **Autenticação:** login e cadastro com guarda de sessão.
41-
- **Dashboard:** resumo financeiro, listagem recente e emissão contextual de recibo.
42-
- **Clientes:** listagem com navegação para detalhe, cadastro, edição, exclusão e ações rápidas de contato.
43-
- **Catálogo:** listagem, cadastro e edição de itens.
44-
- **Pedidos:** listagem, criação, edição, detalhe e emissão de documentos.
45-
- **Configurações:** edição dos dados do usuário e do negócio.
263+
---
46264

47-
### Decisões de Interface
265+
## Conclusão
48266

49-
- priorização de ações operacionais na própria lista, reduzindo a dependência de telas intermediárias;
50-
- uso de feedback de loading, erro e confirmação nas operações críticas;
51-
- separação visual clara entre ações administrativas e ações operacionais;
52-
- adaptação dos fluxos de documento por plataforma: preview web e abertura/compartilhamento externo no mobile nativo.
267+
As interfaces desenvolvidas atendem às necessidades do público-alvo ao oferecer uma experiência simples, organizada e eficiente.
53268

54-
> **Pendência registrada:** os wireframes e capturas desta seção devem ser substituídos por representações reais das telas implementadas. Os exemplos visuais antigos não devem ser tratados como fonte de verdade da interface atual.
269+
A aplicação permite que profissionais autônomos e pequenos empreendedores tenham maior controle sobre suas atividades comerciais e financeiras, contribuindo para uma gestão mais profissional e estruturada.
55270

56-
> **Links Úteis**:
57-
>
58-
> - [Protótipos vs Wireframes](https://www.nngroup.com/videos/prototypes-vs-wireframes-ux-projects/)
59-
> - [Ferramentas de Wireframes](https://rockcontent.com/blog/wireframes/)
60-
> - [Figma](https://www.figma.com/)
271+
Além disso, a adaptação para dispositivos móveis garante acessibilidade e uso contínuo no dia a dia, reforçando a proposta de praticidade da solução.

0 commit comments

Comments
 (0)