Sistema de Prompt para Gerador de Documentação de Projetos

# ARQUITETURA.md ## Visão Geral do Sistema Sistema de alto nível que processa e gerencia dados de usuários em tempo real, fornecendo APIs RESTful para consumo externo e uma interface administrativa para gerenciamento. ## Estilo Arquitetural - **Monólito Modular** - Organizado em módulos internos bem definidos, com fronteiras claras de responsabilidade - **API-First** - Toda a lógica de negócio é exposta através de APIs RESTful versionadas - **Event-Driven** - Comunicação assíncrona entre módulos internos via barramento de eventos ## Componentes Principais - **API Gateway** - Ponto único de entrada, roteamento e rate limiting - **Módulo de Autenticação** - Gerencia login, tokens JWT e refresh tokens - **Módulo de Usuários** - CRUD completo, perfis e permissões - **Módulo de Processamento** - Orquestra fluxos de negócio e regras - **Módulo de Notificações** - Envia emails, push notifications e webhooks - **Módulo de Relatórios** - Gera relatórios agregados e exportações ## Estrutura de Pastas ``` src/ ├── api/ # Controllers, rotas e middlewares ├── core/ # Lógica de negócio e serviços ├── domain/ # Entidades, value objects e interfaces ├── infrastructure/ # Repositórios, clientes externos e adaptadores ├── shared/ # Utilitários, helpers e constantes └── config/ # Configurações e variáveis de ambiente ``` ## Fluxo de Dados 1. Cliente faz requisição HTTP para o API Gateway 2. Gateway autentica via JWT e aplica rate limiting 3. Rota é direcionada ao controller apropriado 4. Controller chama serviço no módulo core 5. Serviço valida regras de negócio e persiste via repositório 6. Eventos são publicados no barramento para consumo assíncrono 7. Resposta é retornada ao cliente em formato JSON padronizado ## Integrações Externas - **Banco de Dados** - PostgreSQL (principal) + Redis (cache) - **Serviço de Email** - AWS SES para transacionais - **Serviço de Storage** - AWS S3 para arquivos e mídias - **APIs de Terceiros** - Integração com gateway de pagamento e serviço de geolocalização ## Autenticação e Autorização - **Autenticação** - JWT Bearer tokens com expiração de 15 minutos - **Refresh Token** - Rotação automática com revogação - **Autorização** - RBAC (Role-Based Access Control) com papéis: admin, manager, user - **2FA** - Suporte opcional via TOTP ## Escalabilidade e Deploy - **Containerização** - Docker + Docker Compose para desenvolvimento - **Orquestração** - Kubernetes para produção (EKS) - **Escala Horizontal** - Stateless services, sessões no Redis - **CI/CD** - GitHub Actions com deploy automatizado em stages - **Observabilidade** - Prometheus para métricas, Grafana para dashboards, ELK para logs ## Extensibilidade Futura - **Módulo de Plugins** - Interface pública para extensões de terceiros - **Webhooks** - Sistema de eventos externos configuráveis - **GraphQL** - Camada alternativa de API para consultas complexas - **Multi-tenancy** - Suporte a múltiplos clientes isolados --- # PRODUTO.md ## Visão Geral do Produto Plataforma SaaS que simplifica o gerenciamento de operações empresariais, centralizando dados, automatizando fluxos de trabalho e fornecendo insights acionáveis em tempo real. ## Público-Alvo - **Gestores de Operações** - Necessitam visibilidade e controle sobre processos - **Analistas de Dados** - Precisam de dados confiáveis e exportáveis - **Administradores de TI** - Gerenciam usuários, permissões e integrações - **Executivos** - Acompanham KPIs e métricas de negócio ## Funcionalidades Principais - **Dashboard em Tempo Real** - Visualização de métricas e indicadores - **Gestão de Usuários** - CRUD completo com papéis e permissões - **Automação de Fluxos** - Regras configuráveis para aprovações e alertas - **Relatórios Personalizados** - Geração e exportação em múltiplos formatos - **Notificações Inteligentes** - Alertas por email, push e webhook ## Funcionalidades de Suporte - **Histórico de Auditoria** - Log completo de ações dos usuários - **Importação/Exportação** - Suporte a CSV, XLSX e JSON - **API Pública** - Documentação completa e SDKs para integração - **Tema Customizável** - Personalização de branding e identidade visual ## Fluxos de Trabalho do Usuário 1. **Login e Autenticação** - Acesso via email/senha ou SSO 2. **Configuração Inicial** - Setup de perfil, preferências e notificações 3. **Criação de Dados** - Cadastro de entidades e informações operacionais 4. **Processamento** - Execução de fluxos automáticos e manuais 5. **Análise** - Visualização de dashboards e geração de relatórios 6. **Colaboração** - Compartilhamento de resultados e comentários ## Casos de Uso - **Monitoramento Operacional** - Acompanhar métricas em tempo real - **Gestão de Aprovações** - Fluxos hierárquicos para autorizações - **Análise de Tendências** - Identificar padrões e anomalias - **Compliance** - Gerar trilhas de auditoria e relatórios regulatórios ## Regras de Negócio - Usuários só acessam dados de sua organização - Aprovações requerem mínimo de 2 níveis hierárquicos - Relatórios são gerados em até 5 minutos após solicitação - Dados são retidos por 7 anos conforme política de compliance ## Requisitos Não-Funcionais - **Performance** - APIs respondem em < 200ms (p95) - **Disponibilidade** - 99.9% uptime mensal - **Segurança** - Criptografia em trânsito (TLS 1.3) e em repouso (AES-256) - **Usabilidade** - Interface responsiva, suporte a mobile - **Acessibilidade** - Conformidade com WCAG 2.1 AA ## Visão do Produto Tornar-se a plataforma padrão para gestão operacional de médias empresas, expandindo para inteligência preditiva e automação avançada via IA nos próximos 24 meses. --- # CONTRIBUTING.md ## Configuração do Ambiente 1. Clone o repositório e instale dependências: `npm install` 2. Copie `.env.example` para `.env` e configure variáveis 3. Suba serviços locais: `docker-compose up -d` 4. Execute migrações: `npm run migrate` 5. Inicie em desenvolvimento: `npm run dev` ## Estratégia de Branching - **main** - Produção, sempre estável - **develop** - Integração contínua de features - **feature/nome-descritivo** - Nova funcionalidade - **fix/nome-descritivo** - Correção de bug - **hotfix/nome-descritivo** - Correção urgente em produção ## Convenções de Commit Use Conventional Commits: - `feat:` - Nova funcionalidade - `fix:` - Correção de bug - `docs:` - Documentação - `refactor:` - Refatoração sem mudança de comportamento - `test:` - Testes - `chore:` - Tarefas de manutenção ## Diretrizes para Pull Requests - PRs devem ser pequenos e focados (máx. 400 linhas) - Título descritivo com prefixo do tipo de mudança - Descrição clara do que foi feito e por quê - Referencie issues relacionadas - Atualize documentação se necessário ## Estilo de Código e Linting - ESLint + Prettier configurados no projeto - TypeScript estrito obrigatório - Nomes descritivos em inglês - Funções pequenas e com responsabilidade única ## Requisitos de Testes - Cobertura mínima de 80% em código novo - Testes unitários para lógica de negócio - Testes de integração para APIs e banco de dados - Rodar `npm run test` antes de abrir PR ## Requisitos de Documentação - Atualizar README.md se houver mudança de setup - Documentar novas APIs no swagger - Comentários JSDoc para funções públicas - Atualizar CHANGELOG.md ## Processo de Revisão 1. CI deve passar (build, lint, testes) 2. Mínimo de 1 aprovação de revisor 3. Revisor verifica qualidade, testes e documentação 4. Merge apenas via squash commit 5. Deletar branch após merge --- # README.md # Plataforma de Gestão Operacional Sistema SaaS para gerenciamento de operações empresariais com dashboards em tempo real, automação de fluxos e relatórios avançados. ## Problema Empresas médias enfrentam dificuldades para centralizar dados operacionais, automatizar processos manuais e obter insights rápidos, resultando em ineficiência e atrasos na tomada de decisão. ## Funcionalidades - Dashboard em tempo real com métricas personalizáveis - Gestão completa de usuários com RBAC - Automação de fluxos de aprovação e alertas - Relatórios exportáveis em CSV, XLSX e JSON - API RESTful documentada - Notificações por email, push e webhook ## Stack Tecnológico - **Backend**: Node.js 20, TypeScript, Express - **Banco de Dados**: PostgreSQL 16, Redis 7 - **Infraestrutura**: Docker, Kubernetes - **CI/CD**: GitHub Actions - **Observabilidade**: Prometheus, Grafana, ELK ## Instalação Pré-requisitos: Node.js 20+, Docker, Docker Compose ```bash # Clone o repositório git clone https://github.com/sua-org/sua-plataforma.git cd sua-plataforma # Instale dependências npm install # Configure variáveis de ambiente cp .env.example .env # Suba serviços locais docker-compose up -d # Execute migrações npm run migrate # Inicie em desenvolvimento npm run dev ``` ## Variáveis de Ambiente | Variável | Descrição | Padrão | |----------|-----------|--------| | `DATABASE_URL` | String de conexão PostgreSQL | `postgres://localhost:5432/app` | | `REDIS_URL` | String de conexão Redis | `redis://localhost:6379` | | `JWT_SECRET` | Chave secreta para tokens JWT | - | | `PORT` | Porta do servidor | `3000` | | `NODE_ENV` | Ambiente de execução | `development` | ## Execução ### Desenvolvimento ```bash npm run dev ``` ### Produção ```bash npm run build npm start ``` ### Testes ```bash npm run test npm run test:coverage ``` ## Exemplo de Uso ```bash # Autenticar curl -X POST http://localhost:3000/api/v1/auth/login \ -H "Content-Type: application/json" \ -d '{"email":"user@example.com","password":"senha123"}' # Buscar usuários curl http://localhost:3000/api/v1/users \ -H "Authorization: Bearer " ``` ## Estrutura do Projeto ``` src/ ├── api/ # Controllers e rotas ├── core/ # Lógica de negócio ├── domain/ # Entidades e interfaces ├── infrastructure/ # Repositórios e clientes externos ├── shared/ # Utilitários └── config/ # Configurações ``` ## Documentação - [Arquitetura](ARCHITECTURE.md) - Detalhes técnicos e decisões arquiteturais - [Produto](PRODUCT.md) - Visão de negócio e funcionalidades - [Contribuição](CONTRIBUTING.md) - Guia para desenvolvedores ## Licença MIT License - veja o arquivo [LICENSE](LICENSE) para detalhes.

Sistema de Prompt para Gerador de Documentação de Projetos

Conteúdo do PromptSalvar

Uso

Referências

Discussão