# 📚 Documentação SteelBook

Bem-vindo à documentação completa do SteelBook! Aqui você encontrará tudo que precisa saber sobre a plataforma.

## 📖 Documentos Disponíveis

### Para Usuários Finais

#### [Manual do Usuário](MANUAL_USUARIO.md) 📘
Guia completo e didático para usar o SteelBook.

**Conteúdo:**
- Primeiros passos e login
- Navegação pelo Dashboard
- Criando seu primeiro databook
- Gerenciando documentos
- Tópicos e categorias
- Configurações da plataforma
- Gerando PDFs profissionais
- Dicas e truques
- Perguntas frequentes
- Glossário de termos

**Ideal para:** Usuários novos, gerentes de projeto, engenheiros

---

### Para Desenvolvedores

#### [Arquitetura Técnica](ARQUITETURA_TECNICA.md) 🏗️
Documentação técnica detalhada sobre a arquitetura do sistema.

**Conteúdo:**
- Visão geral da arquitetura
- Stack tecnológico
- Estrutura do banco de dados (13 tabelas)
- Relacionamentos entre tabelas
- Fluxo de dados
- Componentes principais
- Autenticação e segurança
- Queries importantes
- Variáveis de ambiente
- Deployment
- Troubleshooting

**Ideal para:** Desenvolvedores, arquitetos, DevOps

---

## 🎯 Começar Rápido

### Sou um Usuário Novo
1. Leia [Primeiros Passos](MANUAL_USUARIO.md#primeiros-passos) no Manual do Usuário
2. Explore o [Dashboard](MANUAL_USUARIO.md#dashboard)
3. Crie seu [Primeiro Databook](MANUAL_USUARIO.md#criando-um-databook)

### Sou um Desenvolvedor
1. Entenda a [Arquitetura](ARQUITETURA_TECNICA.md#arquitetura-do-sistema)
2. Estude o [Banco de Dados](ARQUITETURA_TECNICA.md#banco-de-dados)
3. Configure o [Ambiente](ARQUITETURA_TECNICA.md#variáveis-de-ambiente)

---

## 📊 Estrutura da Documentação

```
docs/
├── README.md                    # Este arquivo
├── MANUAL_USUARIO.md           # Guia para usuários finais
└── ARQUITETURA_TECNICA.md      # Documentação técnica
```

---

## 🔍 Índice Rápido

### Conceitos Principais

| Conceito | Descrição | Documentação |
|----------|-----------|--------------|
| **Databook** | Documento técnico completo | [Manual](MANUAL_USUARIO.md#glossário) |
| **Tópico** | Seção individual do databook | [Manual](MANUAL_USUARIO.md#tópicos-e-categorias) |
| **Categoria** | Classificação de tópicos | [Manual](MANUAL_USUARIO.md#categorias) |
| **Documento** | Arquivo adicionado a uma seção | [Manual](MANUAL_USUARIO.md#gerenciando-documentos) |
| **Template** | Modelo pré-configurado | [Manual](MANUAL_USUARIO.md#criando-um-databook) |
| **Progresso** | Percentual de conclusão | [Manual](MANUAL_USUARIO.md#entendendo-o-progresso) |

### Funcionalidades

| Funcionalidade | Usuário | Desenvolvedor |
|----------------|--------|---------------|
| Criar Databook | [Manual](MANUAL_USUARIO.md#criando-um-databook) | [Arquitetura](ARQUITETURA_TECNICA.md#fluxo-de-dados) |
| Upload Documentos | [Manual](MANUAL_USUARIO.md#adicionando-documentos) | [Arquitetura](ARQUITETURA_TECNICA.md#upload-de-documentos) |
| Gerar PDF | [Manual](MANUAL_USUARIO.md#gerando-pdf) | [Arquitetura](ARQUITETURA_TECNICA.md#geração-de-pdf) |
| Configurações | [Manual](MANUAL_USUARIO.md#configurações) | [Arquitetura](ARQUITETURA_TECNICA.md#componentes-principais) |

---

## 🆘 Precisa de Ajuda?

### Problema Comum?
Consulte a seção [Perguntas Frequentes](MANUAL_USUARIO.md#perguntas-frequentes) do Manual do Usuário.

### Erro Técnico?
Veja [Troubleshooting](ARQUITETURA_TECNICA.md#troubleshooting) na Arquitetura Técnica.

### Não encontrou?
Entre em contato com o time de desenvolvimento.

---

## 📝 Convenções

### Ícones Usados

- 📘 Manual do Usuário
- 🏗️ Arquitetura Técnica
- 💡 Dica
- ⚠️ Aviso
- ✅ Sucesso
- ❌ Erro
- 🔐 Segurança

### Formatação

- **Negrito** - Termos importantes
- `Código` - Comandos e código
- > Citação - Notas importantes
- ```sql - Blocos de código

---

## 🔄 Versão e Atualizações

**Versão Atual:** 1.0.0  
**Última Atualização:** Novembro 2024

### Histórico de Versões

- **v1.0.0** (Nov 2024) - Lançamento inicial
  - Manual do Usuário completo
  - Arquitetura Técnica detalhada
  - Documentação de todas as funcionalidades

---

## 📞 Contato e Suporte

- **Email:** support@steelbook.dev
- **GitHub:** [SteelBook Issues](https://github.com/steelbook/issues)
- **Documentação:** Este arquivo

---

## 📄 Licença

Esta documentação está licenciada sob a Licença MIT.

---

## 🙏 Contribuindo

Encontrou um erro na documentação? Quer adicionar algo?

1. Abra uma issue no GitHub
2. Envie um pull request com as mudanças
3. Descreva claramente o que foi alterado

---

**Desenvolvido com ❤️ para profissionais de engenharia.**

Última atualização: Novembro 2024