Adicionando dicionário de módulos e guia de RAG

2026-05-06 16:05:25 -03:00
parent 842b8e1448
commit 9ccd6c53dd
+37
@@ -0,0 +1,37 @@
# 📚 Dicionário de Módulos (Base de Conhecimento)
Este documento mapeia a estrutura de pastas do repositório para os conceitos de negócio da plataforma Fluig, servindo como guia para usuários e agentes de IA.
## 📂 Mapeamento de Diretórios
### 1. `Plataforma - Documentação técnica/`
O núcleo central da extração. Este diretório contém a hierarquia completa de guias técnicos.
* **Arquitetura e Conceitos**: Documentos sobre o funcionamento base da plataforma.
* **Desenvolvimento**: APIs, SDKs e frameworks (Style Guide).
* **Serviços de Core**: Detalhes sobre os pilares do Fluig:
* **BPM (Business Process Management)**: Modelagem, eventos de processos e regras de negócio.
* **ECM (Enterprise Content Management)**: Gestão de documentos, pastas, aprovações e versionamento.
* **WCM (Web Content Management)**: Criação de portais, páginas e widgets.
* **Social/Identity**: Integração com redes sociais corporativas e gestão de acessos.
### 2. `images/`
Repositório central de mídia.
* Contém todos os diagramas, fluxogramas e capturas de tela extraídos do TDN.
* As referências no Markdown são mantidas de forma relativa para garantir a visualização tanto no Gitea quanto em visualizadores locais.
---
## 🛠️ Como usar este dicionário para RAG
Se você estiver configurando um agente de IA (como no LangChain ou LlamaIndex), utilize este mapeamento para criar "metadados" por pasta:
| Pasta | Metadado Sugerido | Contexto de Busca |
| :--- | :--- | :--- |
| `BPM/` | `categoria: processos` | Fluxos, Eventos, Atividades |
| `ECM/` | `categoria: documentos` | Upload, Pastas, Segurança |
| `WCM/` | `categoria: portais` | Layouts, Widgets, Páginas |
| `API/` | `categoria: integracao` | REST, SOAP, Endpoints |
---
**Nota:** A base é atualizada periodicamente via script de extração. Se um módulo novo for adicionado, este dicionário será expandido.