publico/.agent
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

aplimoramento de agent

Browse source
This commit is contained in:
Luiz Silva 2026-09-02 10:23:53 -03:00
parent b361f25955
commit f597436be3
83 changed files with 1312 additions and 574 deletions
Download patch file Download diff file Expand all files Collapse all files

35
DOCUMENTACAO/README
View file

@ -30,27 +30,32 @@ No ecossistema Azteca, a documentação precede o código. Nenhum artefato (regr
| :--- | :--- | :--- | :--- | :--- |
| **1. Código-Fonte** | `.ts`, `.vue`, `.js` | JSDoc + comentários inline | Desenvolvedores / IA | Comentários claros e coerentes quanto à aplicação prática e contexto de negócio. |
| **2. Ajuda na Tela (UI)** | `*-front/.../{componente}.ajuda.md` | Markdown co-localizado | Usuários da UI | Para `modalX.vue`, o arquivo **DEVE** ser `modalX.ajuda.md`. Explica objetivo, botões, campos e instruções de uso. |
| **3. Wiki do Usuário** | `../../wiki/<modulo>/` | Markdown (VitePress) | Usuários / Clientes | Aplicação VitePress voltada ao acesso dos usuários. Manuais operacionais, tutoriais de uso, conceitos de negócio e fluxos da aplicação. |
| **4. Wiki de Desenvolvimento** | `../../wiki/dev/<modulo>/` | Markdown (VitePress) | Desenvolvedores / Arquitetos | Aplicação VitePress com acesso interno exclusivo da equipe de desenvolvimento. Arquitetura técnica, modelos de banco, regras de negócio (`{modulo}.regras-negocio.md`), filas BullMQ, CRONs e ADRs. |
| **3. Wiki do Usuário** | `<base_projeto>/../wiki/<modulo-id>/` | Markdown (VitePress) | Usuários / Clientes | Aplicação VitePress voltada ao acesso dos usuários. Manuais operacionais, tutoriais de uso, conceitos de negócio e fluxos da aplicação. |
| **4. Wiki de Desenvolvimento** | `<base_projeto>/../wiki/dev/<modulo-id>/` | Markdown (VitePress) | Desenvolvedores / Arquitetos | Aplicação VitePress com acesso interno exclusivo da equipe de desenvolvimento. Arquitetura técnica, modelos de banco, regras de negócio (`{modulo}.regras-negocio.md`), filas BullMQ, CRONs e ADRs. |
| **5. Integração de IA** | Rota Backend `/llm.md` | Markdown dinâmico | Agentes de IA / LLMs | Catálogo vivo de schemas Zod, enums canônicos e contratos de API para consumo por LLMs. |
| **6. Memória das Ações da IA** | `<base_projeto>/memorias-ia/` | Markdown com frontmatter | Agentes de IA / Auditoria | Registros de sessões, otimizações executadas, histórico de decisões arquiteturais. |
| **6. Memória das Ações da IA e Identidade** | `<base_projeto>/memorias-ia/` | YAML / Markdown | Agentes de IA / Auditoria | Arquivo mandatório `modulo.yml` (`modulo-id`, `modulo-caminho`, `modulo-descricao`, `modulo-tipo`), registros de sessões e decisões arquiteturais. |
> ℹ️ **Arquitetura VitePress (`../../wiki`)**:
> - `../../wiki/` é uma aplicação **VitePress**.
> - `../../wiki/<modulo>/` representa a documentação de **acesso dos usuários e operadores**.
> - `../../wiki/dev/<modulo>/` representa a documentação de **acesso interno pela equipe de desenvolvimento e arquitetura**.
> ℹ️ **Arquitetura VitePress (`<base_projeto>/../wiki`) e Identidade do Projeto**:
> - `<base_projeto>/../wiki/` é uma aplicação **VitePress**.
> - `<base_projeto>/../wiki/<modulo-id>/` representa a documentação de **acesso dos usuários e operadores** (onde `<modulo-id>` provém de `memorias-ia/modulo.yml`).
> - `<base_projeto>/../wiki/dev/<modulo-id>/` representa a documentação de **acesso interno pela equipe de desenvolvimento e arquitetura**.
> - O arquivo `<base_projeto>/memorias-ia/modulo.yml` é **obrigatório em todos os projetos** e define `modulo-id`, `modulo-caminho`, `modulo-descricao` e `modulo-tipo`.
---
## Hub Central de Templates (`DOCUMENTACAO/`)
## Hub Central de Templates (`DOCUMENTACAO/templates/`)
| Categoria | Diretório | O que documenta | Template |
| :--- | :--- | :--- | :--- |
| **Arquitetura (ADRs)** | `DOCUMENTACAO/arquitetura/` ou `../../wiki/dev/<modulo>/adrs/` | Decisões técnicas e arquiteturais | `_template-adr` |
| **Módulos / Domínio** | `DOCUMENTACAO/modulos/` ou `../../wiki/dev/<modulo>/` | Domínio, glossário e entidades | `_template-modulo` |
| **Regras de Negócio** | `DOCUMENTACAO/regras-negocio/` | Regras globais ou extraídas do código | `_template-regra` |
| **Contratos de API** | `DOCUMENTACAO/contratos/` | Contratos de rotas e endpoints | `_template-contrato` |
| **Fluxos de Usuário** | `DOCUMENTACAO/fluxos/` | Jornadas do usuário e telas | `_template-fluxo` |
Todos os modelos canônicos para instanciar a documentação nos projetos residem em `DOCUMENTACAO/templates/`:
| Pilar / Categoria | Destino Canônico no Projeto | Template Canônico |
| :--- | :--- | :--- |
| **Identidade do Módulo (Pilar 6)** | `<base_projeto>/memorias-ia/modulo.yml` | [`modulo.yml.template`](file:///home/luiz/Arquivos/DEV/Industria/SIGMA2026/.agent/DOCUMENTACAO/templates/modulo.yml.template) |
| **Domínio do Módulo (Pilar 3 e 4)** | `<base_projeto>/../wiki/<modulo-id>/index.md` | [`modulo-dominio.md.template`](file:///home/luiz/Arquivos/DEV/Industria/SIGMA2026/.agent/DOCUMENTACAO/templates/modulo-dominio.md.template) |
| **Regras de Negócio (Pilar 4)** | `<base_projeto>/../wiki/dev/<modulo-id>/<servico>.regras-negocio.md` | [`regra-negocio.md.template`](file:///home/luiz/Arquivos/DEV/Industria/SIGMA2026/.agent/DOCUMENTACAO/templates/regra-negocio.md.template) |
| **Decisões Arquiteturais - ADR (Pilar 4)** | `<base_projeto>/../wiki/dev/<modulo-id>/adrs/` | [`adr.md.template`](file:///home/luiz/Arquivos/DEV/Industria/SIGMA2026/.agent/DOCUMENTACAO/templates/adr.md.template) |
| **Ajuda na Tela / UI (Pilar 2)** | `*-front/src/.../{componente}.ajuda.md` | [`ajuda-tela.md.template`](file:///home/luiz/Arquivos/DEV/Industria/SIGMA2026/.agent/DOCUMENTACAO/templates/ajuda-tela.md.template) |
| **Contratos de API (Pilar 5 e 4)** | Rota `/llm.md` ou `<base_projeto>/../wiki/dev/<modulo-id>/contratos/` | [`contrato-api.md.template`](file:///home/luiz/Arquivos/DEV/Industria/SIGMA2026/.agent/DOCUMENTACAO/templates/contrato-api.md.template) |
| **Fluxos e Telas (Pilar 3 e 4)** | `<base_projeto>/../wiki/<modulo-id>/fluxos/` | [`fluxo-usuario.md.template`](file:///home/luiz/Arquivos/DEV/Industria/SIGMA2026/.agent/DOCUMENTACAO/templates/fluxo-usuario.md.template) |
---