6.4 KiB
6.4 KiB
🚀 Comece Aqui - SteelBook
Bem-vindo ao SteelBook! Este arquivo ajudará você a começar rapidamente.
👤 Qual é o seu perfil?
👨💼 Sou um Usuário Final
Você quer usar o SteelBook para criar e gerenciar databooks.
Próximos passos:
- Leia Manual do Usuário
- Comece com Primeiros Passos
- Crie seu Primeiro Databook
Tempo estimado: 30 minutos
👨💻 Sou um Desenvolvedor
Você quer entender a arquitetura e contribuir com código.
Próximos passos:
- Leia Arquitetura Técnica
- Estude o Banco de Dados
- Configure o Ambiente
- Clone e instale o projeto
Tempo estimado: 1 hora
🏢 Sou um Administrador
Você quer configurar e manter o SteelBook.
Próximos passos:
- Leia README Principal
- Configure Supabase
- Acesse Configurações
- Gerencie Usuários
Tempo estimado: 1 hora
📚 Documentação Disponível
📘 Para Usuários
- Manual do Usuário - Guia completo
- Como usar cada funcionalidade
- Passo a passo ilustrado
- Dicas e truques
- Perguntas frequentes
🏗️ Para Desenvolvedores
- Arquitetura Técnica - Documentação técnica
- Estrutura do sistema
- Banco de dados (13 tabelas)
- Fluxo de dados
- Segurança e autenticação
📖 Índice Geral
- Índice de Documentação - Navegação centralizada
- Todos os documentos
- Índices rápidos
- Conceitos principais
🎯 Tarefas Comuns
Criar um Databook
→ Manual do Usuário - Criando um Databook
Adicionar Documentos
→ Manual do Usuário - Gerenciando Documentos
Gerar PDF
→ Manual do Usuário - Gerando PDF
Configurar Categorias
→ Manual do Usuário - Categorias
Entender o Progresso
→ Manual do Usuário - Progresso
Configurar Banco de Dados
→ Arquitetura Técnica - Banco de Dados
Fazer Deploy
🆘 Precisa de Ajuda?
Encontrei um Erro
- Verifique Troubleshooting
- Consulte FAQ
- Entre em contato com o suporte
Não Encontrei o que Procuro
- Use o Índice de Documentação
- Procure por palavra-chave
- Consulte o Glossário
Tenho uma Sugestão
- Abra uma issue no GitHub
- Descreva sua sugestão
- Aguarde feedback
📱 Acessar Manual no App
Dentro do SteelBook:
- Clique em Configurações (menu lateral)
- Clique na aba Manual do Usuário
- Escolha entre:
- Ler online
- Download
- Navegar por seções
- Ver FAQ
🚀 Instalação Rápida
Pré-requisitos
- Node.js 16+
- npm ou yarn
- Conta Supabase
Passos
# 1. Clone o repositório
git clone https://github.com/seu-usuario/steelbook.git
cd steelbook
# 2. Instale dependências
npm install
# 3. Configure variáveis de ambiente
cp .env.example .env
# Edite .env com suas credenciais Supabase
# 4. Inicie o servidor
npm run dev
# 5. Abra no navegador
# http://localhost:5173
Veja README para detalhes completos.
📊 Estrutura do Projeto
steelbook/
├── docs/ # Documentação
│ ├── README.md # Índice
│ ├── MANUAL_USUARIO.md # Para usuários
│ └── ARQUITETURA_TECNICA.md # Para devs
├── src/ # Código-fonte
├── supabase/ # Banco de dados
├── README.md # Documentação principal
└── COMECE_AQUI.md # Este arquivo
🎓 Aprendizado Recomendado
Dia 1: Fundamentos
- Ler Primeiros Passos
- Explorar Dashboard
- Criar primeiro databook
Dia 2: Funcionalidades
- Adicionar documentos
- Gerenciar tópicos
- Usar categorias
Dia 3: Avançado
- Configurar pastas
- Personalizar aparência
- Gerar PDF
Semana 1: Domínio
- Ler Dicas e Truques
- Explorar todas as configurações
- Dominar o workflow
💡 Dicas Iniciais
- Comece simples - Crie um databook básico primeiro
- Use categorias - Organize seus tópicos desde o início
- Nomeie bem - Use nomes descritivos para documentos
- Revise antes - Sempre visualize antes de gerar PDF
- Explore - Clique em tudo para aprender
🔗 Links Importantes
| Link | Descrição |
|---|---|
| Manual do Usuário | Guia completo |
| Arquitetura Técnica | Documentação técnica |
| README | Documentação principal |
| GitHub | Código-fonte |
| Supabase | Backend |
📞 Suporte
- Email: support@steelbook.dev
- GitHub Issues: Abrir issue
- Documentação: docs/README.md
✅ Checklist de Início
- Li este arquivo
- Identifiquei meu perfil (usuário/dev/admin)
- Acessei a documentação apropriada
- Instalei/Acessei o SteelBook
- Criei meu primeiro databook
- Explorei as configurações
- Salvei os links importantes
🎉 Pronto para Começar?
Escolha seu caminho:
👨💼 Usuário
👨💻 Desenvolvedor
🏢 Administrador
Bem-vindo ao SteelBook! 🚀
Desenvolvido com ❤️ para profissionais de engenharia.
Última atualização: Novembro 2024