📚 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 📘
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 🏗️
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
- Leia Primeiros Passos no Manual do Usuário
- Explore o Dashboard
- Crie seu Primeiro Databook
Sou um Desenvolvedor
- Entenda a Arquitetura
- Estude o Banco de Dados
- Configure o 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 |
| Tópico | Seção individual do databook | Manual |
| Categoria | Classificação de tópicos | Manual |
| Documento | Arquivo adicionado a uma seção | Manual |
| Template | Modelo pré-configurado | Manual |
| Progresso | Percentual de conclusão | Manual |
Funcionalidades
| Funcionalidade | Usuário | Desenvolvedor |
|---|---|---|
| Criar Databook | Manual | Arquitetura |
| Upload Documentos | Manual | Arquitetura |
| Gerar PDF | Manual | Arquitetura |
| Configurações | Manual | Arquitetura |
🆘 Precisa de Ajuda?
Problema Comum?
Consulte a seção Perguntas Frequentes do Manual do Usuário.
Erro Técnico?
Veja 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
-
🔄 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
- 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?
- Abra uma issue no GitHub
- Envie um pull request com as mudanças
- Descreva claramente o que foi alterado
Desenvolvido com ❤️ para profissionais de engenharia.
Última atualização: Novembro 2024