Initial commit DBMaker - Oficiais e Funcionando
This commit is contained in:
432
docs/MANUAL_USUARIO.md
Normal file
432
docs/MANUAL_USUARIO.md
Normal file
@@ -0,0 +1,432 @@
|
||||
# 📚 SteelBook - Manual do Usuário
|
||||
|
||||
## Bem-vindo ao SteelBook!
|
||||
|
||||
SteelBook é sua solução completa para criar, organizar e gerar Databooks técnicos profissionais. Este manual guiará você por cada funcionalidade da plataforma.
|
||||
|
||||
---
|
||||
|
||||
## 📑 Índice
|
||||
|
||||
1. [Primeiros Passos](#primeiros-passos)
|
||||
2. [Dashboard](#dashboard)
|
||||
3. [Criando um Databook](#criando-um-databook)
|
||||
4. [Gerenciando Documentos](#gerenciando-documentos)
|
||||
5. [Tópicos e Categorias](#tópicos-e-categorias)
|
||||
6. [Configurações](#configurações)
|
||||
7. [Gerando PDF](#gerando-pdf)
|
||||
8. [Dicas e Truques](#dicas-e-truques)
|
||||
|
||||
---
|
||||
|
||||
## Primeiros Passos
|
||||
|
||||
### Login
|
||||
|
||||
1. Acesse a plataforma SteelBook
|
||||
2. Digite seu **email** e **senha**
|
||||
3. Clique em **"Entrar"**
|
||||
4. Você será redirecionado para o Dashboard
|
||||
|
||||
> **Dica:** Se esqueceu sua senha, entre em contato com o administrador.
|
||||
|
||||
### Sua Primeira Sessão
|
||||
|
||||
Após fazer login, você verá:
|
||||
- **Dashboard** com seus projetos recentes
|
||||
- **Barra de navegação** no topo
|
||||
- **Menu lateral** com opções principais
|
||||
|
||||
---
|
||||
|
||||
## Dashboard
|
||||
|
||||
O Dashboard é sua central de controle. Aqui você vê:
|
||||
|
||||
### 📊 Estatísticas Rápidas
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────┐
|
||||
│ Total Projetos: 5 │ Em Andamento: 2 │ Finalizados: 3 │
|
||||
└─────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
### 📋 Projetos Recentes
|
||||
|
||||
Uma tabela mostrando seus últimos projetos com:
|
||||
|
||||
| Campo | Descrição |
|
||||
|-------|-----------|
|
||||
| **Projeto** | Nome e número do projeto |
|
||||
| **Cliente** | Empresa cliente |
|
||||
| **Status** | Rascunho, Em Andamento, Revisão, Finalizado |
|
||||
| **Progresso** | Barra visual com percentual |
|
||||
| **Ações** | Ver, Editar, Clonar, Deletar |
|
||||
|
||||
### 🎯 Entendendo o Progresso
|
||||
|
||||
A barra de progresso mostra quantos tópicos já têm documentos:
|
||||
|
||||
```
|
||||
Progresso = (Tópicos com documentos / Total de tópicos) × 100
|
||||
|
||||
Exemplo:
|
||||
├─ Total de tópicos: 28
|
||||
├─ Tópicos com documentos: 7
|
||||
└─ Progresso: 25% ✓
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Criando um Databook
|
||||
|
||||
### Passo 1: Novo Databook
|
||||
|
||||
1. Clique no botão **"Novo Databook"** (canto superior direito)
|
||||
2. Você será levado à página de criação
|
||||
|
||||
### Passo 2: Informações Básicas
|
||||
|
||||
Preencha os campos:
|
||||
|
||||
- **Número do Projeto:** Ex: `PROJ-2024-001`
|
||||
- **Nome do Projeto:** Ex: `Databook Turbina XYZ`
|
||||
- **Cliente:** Selecione na lista ou crie novo
|
||||
- **Template:** Escolha o template padrão ou customizado
|
||||
- **Data de Início:** Quando o projeto começa
|
||||
- **Data de Entrega:** Prazo para conclusão
|
||||
|
||||
### Passo 3: Configurações do Databook
|
||||
|
||||
Na aba **"Configurações"**, customize:
|
||||
|
||||
#### Informações do Produto
|
||||
- Nome do produto
|
||||
- Tipo (Ex: Turbina, Compressor)
|
||||
- Descrição técnica
|
||||
- Normas aplicáveis
|
||||
|
||||
#### Informações do Cliente
|
||||
- Nome da empresa
|
||||
- Contato principal
|
||||
- Email
|
||||
- Telefone
|
||||
|
||||
#### Aparência
|
||||
- **Cores:** Primária e secundária
|
||||
- **Logo da Empresa:** Upload da logo
|
||||
- **Logo do Cliente:** Upload da logo
|
||||
- **Marca d'água:** Imagem de fundo
|
||||
- **Título Principal:** Título do databook
|
||||
- **Subtítulo:** Subtítulo opcional
|
||||
|
||||
#### Formato do PDF
|
||||
- **Tamanho:** A4 ou Letter
|
||||
- **Orientação:** Retrato ou Paisagem
|
||||
- **Margens:** Ajuste em mm
|
||||
- **Opções:** Marca d'água, Numeração de páginas
|
||||
|
||||
### Passo 4: Salvar
|
||||
|
||||
Clique em **"Salvar Configurações"** para confirmar.
|
||||
|
||||
---
|
||||
|
||||
## Gerenciando Documentos
|
||||
|
||||
### Adicionando Documentos
|
||||
|
||||
1. Abra o databook que deseja editar
|
||||
2. Navegue até a seção desejada
|
||||
3. Clique em **"+ Adicionar Documento"**
|
||||
4. Selecione o arquivo (PDF, JPG, PNG)
|
||||
5. Preencha os dados:
|
||||
- **Título:** Nome do documento
|
||||
- **Número:** Código do documento
|
||||
- **Revisão:** Versão (Ex: Rev. 1)
|
||||
- **Data:** Data do documento
|
||||
- **Tags:** Palavras-chave
|
||||
|
||||
### Visualizando Documentos
|
||||
|
||||
Cada documento mostra:
|
||||
- **Thumbnail:** Prévia do arquivo
|
||||
- **Informações:** Título, número, revisão
|
||||
- **Ações:** Visualizar, Editar, Deletar
|
||||
|
||||
### Organizando Documentos
|
||||
|
||||
Você pode:
|
||||
- **Reordenar:** Arrastar e soltar
|
||||
- **Filtrar:** Por categoria ou tag
|
||||
- **Buscar:** Por título ou número
|
||||
|
||||
### Deletando Documentos
|
||||
|
||||
1. Clique no ícone **🗑️ (Lixo)**
|
||||
2. Confirme a exclusão
|
||||
3. Documento será removido permanentemente
|
||||
|
||||
---
|
||||
|
||||
## Tópicos e Categorias
|
||||
|
||||
### Entendendo Tópicos
|
||||
|
||||
Tópicos são as seções do seu databook. Exemplo:
|
||||
|
||||
```
|
||||
1. Atestado de Conformidade
|
||||
1.1 Certificados
|
||||
1.2 Desenhos
|
||||
2. Procedimentos
|
||||
2.1 Soldagem
|
||||
2.2 Inspeção
|
||||
```
|
||||
|
||||
### Gerenciando Tópicos
|
||||
|
||||
Acesse **Menu → Gestão de Tópicos**
|
||||
|
||||
#### Criar Novo Tópico
|
||||
|
||||
1. Clique **"Novo Tópico"**
|
||||
2. Preencha:
|
||||
- **Número:** Ex: `1.1`
|
||||
- **Título:** Nome do tópico
|
||||
- **Descrição:** Detalhes (opcional)
|
||||
- **Categoria:** Selecione uma categoria
|
||||
- **Obrigatório:** Marque se é obrigatório
|
||||
3. Clique **"Criar"**
|
||||
|
||||
#### Editar Tópico
|
||||
|
||||
1. Clique no ícone **✏️ (Editar)**
|
||||
2. Modifique os dados
|
||||
3. Clique **"Atualizar"**
|
||||
|
||||
#### Reordenar Tópicos
|
||||
|
||||
1. Clique e segure o ícone **⋮⋮ (Arrastar)**
|
||||
2. Arraste para a nova posição
|
||||
3. A ordem é atualizada automaticamente
|
||||
|
||||
### Categorias
|
||||
|
||||
Categorias organizam seus tópicos por tipo:
|
||||
|
||||
| Categoria | Cor | Uso |
|
||||
|-----------|-----|-----|
|
||||
| 🟢 Certificados | Verde | Certificações e conformidade |
|
||||
| 🔵 Desenhos | Azul | Desenhos técnicos |
|
||||
| 🟠 Relatórios | Laranja | Relatórios de inspeção |
|
||||
| 🟣 Procedimentos | Roxo | Procedimentos e instruções |
|
||||
| 🔴 Normas | Vermelho | Normas e especificações |
|
||||
|
||||
---
|
||||
|
||||
## Configurações
|
||||
|
||||
Acesse **Menu → Configurações** para:
|
||||
|
||||
### 1️⃣ Mapeamento de Pastas
|
||||
|
||||
Configure pastas locais ou na nuvem para sincronização automática.
|
||||
|
||||
**Criar Mapeamento:**
|
||||
1. Clique **"Novo Mapeamento"**
|
||||
2. Preencha:
|
||||
- **Tipo de Documento:** Ex: `Certificados`
|
||||
- **Categoria:** Selecione
|
||||
- **Caminho:** Local ou URL da nuvem
|
||||
- **Frequência:** Manual, Ao criar, Diário, Semanal
|
||||
3. Clique **"Criar"**
|
||||
|
||||
**Tipos de Armazenamento:**
|
||||
- **Local:** Pasta no seu computador
|
||||
- **Nuvem:** Google Drive, OneDrive, etc.
|
||||
|
||||
### 2️⃣ Gerenciamento de Categorias
|
||||
|
||||
Crie e customize categorias.
|
||||
|
||||
**Criar Categoria:**
|
||||
1. Clique **"Nova Categoria"**
|
||||
2. Preencha:
|
||||
- **Nome:** Ex: `Testes`
|
||||
- **Descrição:** Detalhes
|
||||
- **Cor:** Escolha uma cor
|
||||
- **Ícone:** Opcional
|
||||
3. Clique **"Criar"**
|
||||
|
||||
### 3️⃣ Gerenciamento de Usuários
|
||||
|
||||
(Apenas para administradores)
|
||||
|
||||
Adicione e gerencie usuários do sistema.
|
||||
|
||||
**Adicionar Usuário:**
|
||||
1. Clique **"Novo Usuário"**
|
||||
2. Preencha:
|
||||
- **Email:** Email do usuário
|
||||
- **Nome:** Nome completo
|
||||
- **Perfil:** Admin, Gerente, Engenheiro, Cliente
|
||||
3. Clique **"Criar"**
|
||||
|
||||
### 4️⃣ Logs do Sistema
|
||||
|
||||
Visualize histórico de ações e processamentos.
|
||||
|
||||
**Filtrar Logs:**
|
||||
- Por data
|
||||
- Por tipo de ação
|
||||
- Por usuário
|
||||
|
||||
### 5️⃣ Integração com IA
|
||||
|
||||
Configure provedores de IA para análise automática.
|
||||
|
||||
**Configurar IA:**
|
||||
1. Selecione o provedor (OpenAI, Claude, Gemini)
|
||||
2. Insira a API Key
|
||||
3. Clique **"Testar Conexão"**
|
||||
4. Se OK, ative a integração
|
||||
|
||||
---
|
||||
|
||||
## Gerando PDF
|
||||
|
||||
### Visualizar Preview
|
||||
|
||||
1. Abra o databook
|
||||
2. Clique em **"Preview"**
|
||||
3. Veja como ficará o PDF final
|
||||
|
||||
### Gerar PDF
|
||||
|
||||
1. Clique em **"Gerar PDF"**
|
||||
2. Aguarde o processamento
|
||||
3. O arquivo será baixado automaticamente
|
||||
|
||||
### Personalizações no PDF
|
||||
|
||||
O PDF incluirá:
|
||||
- ✅ Logo da empresa
|
||||
- ✅ Logo do cliente
|
||||
- ✅ Marca d'água
|
||||
- ✅ Cores personalizadas
|
||||
- ✅ Numeração de páginas
|
||||
- ✅ Todos os documentos organizados
|
||||
|
||||
---
|
||||
|
||||
## Dicas e Truques
|
||||
|
||||
### 💡 Dica 1: Use Categorias Consistentemente
|
||||
|
||||
Sempre use as mesmas categorias para manter a organização.
|
||||
|
||||
### 💡 Dica 2: Nomeie Documentos Claramente
|
||||
|
||||
Use nomes descritivos:
|
||||
- ✅ Bom: `Certificado_Soldagem_Rev1_2024`
|
||||
- ❌ Ruim: `doc1`, `arquivo`
|
||||
|
||||
### 💡 Dica 3: Revise Antes de Gerar PDF
|
||||
|
||||
Sempre visualize o preview antes de gerar o PDF final.
|
||||
|
||||
### 💡 Dica 4: Use Tags para Busca
|
||||
|
||||
Adicione tags relevantes aos documentos para facilitar busca posterior.
|
||||
|
||||
### 💡 Dica 5: Mantenha Backups
|
||||
|
||||
Exporte seus databooks regularmente como backup.
|
||||
|
||||
### 💡 Dica 6: Organize Hierarquicamente
|
||||
|
||||
Use a numeração hierárquica:
|
||||
- `1` - Tópico principal
|
||||
- `1.1` - Subtópico
|
||||
- `1.1.1` - Sub-subtópico
|
||||
|
||||
### 💡 Dica 7: Aproveite a Sincronização
|
||||
|
||||
Configure mapeamento de pastas para sincronizar automaticamente.
|
||||
|
||||
---
|
||||
|
||||
## Atalhos de Teclado
|
||||
|
||||
| Atalho | Ação |
|
||||
|--------|------|
|
||||
| `Ctrl + S` | Salvar |
|
||||
| `Ctrl + N` | Novo |
|
||||
| `Ctrl + Z` | Desfazer |
|
||||
| `Ctrl + Y` | Refazer |
|
||||
| `Esc` | Fechar modal |
|
||||
|
||||
---
|
||||
|
||||
## Perguntas Frequentes
|
||||
|
||||
### P: Como faço para clonar um databook?
|
||||
|
||||
R: No Dashboard, clique no ícone **📋 (Clonar)** ao lado do projeto. Uma cópia será criada com status "Rascunho".
|
||||
|
||||
### P: Posso editar um databook finalizado?
|
||||
|
||||
R: Sim, mas recomenda-se criar uma nova revisão. Clique em **"Nova Revisão"** nas configurações.
|
||||
|
||||
### P: Qual é o tamanho máximo de arquivo?
|
||||
|
||||
R: Até 50 MB por arquivo. Comprima se necessário.
|
||||
|
||||
### P: Como faço backup dos meus databooks?
|
||||
|
||||
R: Exporte como PDF ou entre em contato com o administrador para backup do banco de dados.
|
||||
|
||||
### P: Posso compartilhar um databook com outro usuário?
|
||||
|
||||
R: Sim, adicione o usuário no painel de configurações e defina as permissões.
|
||||
|
||||
---
|
||||
|
||||
## Suporte
|
||||
|
||||
Encontrou um problema? Aqui estão os passos:
|
||||
|
||||
1. **Verifique a documentação** - Consulte este manual
|
||||
2. **Limpe o cache** - Pressione `Ctrl + Shift + Delete`
|
||||
3. **Recarregue a página** - Pressione `F5`
|
||||
4. **Entre em contato** - Fale com o administrador
|
||||
|
||||
---
|
||||
|
||||
## Glossário
|
||||
|
||||
| Termo | Significado |
|
||||
|-------|------------|
|
||||
| **Databook** | Documento técnico completo com múltiplas seções |
|
||||
| **Tópico** | Seção individual do databook |
|
||||
| **Categoria** | Classificação de tópicos por tipo |
|
||||
| **Documento** | Arquivo (PDF, imagem) adicionado a uma seção |
|
||||
| **Template** | Modelo pré-configurado de tópicos |
|
||||
| **Revisão** | Versão do databook |
|
||||
| **RLS** | Row Level Security - Segurança de dados |
|
||||
| **IA** | Inteligência Artificial para análise automática |
|
||||
|
||||
---
|
||||
|
||||
## Versão
|
||||
|
||||
**SteelBook v1.0** - 2024
|
||||
|
||||
Desenvolvido com ❤️ para profissionais de engenharia.
|
||||
|
||||
---
|
||||
|
||||
**Última atualização:** Novembro 2024
|
||||
|
||||
Para atualizações e novidades, visite o painel de configurações.
|
||||
Reference in New Issue
Block a user