melhorias no agent
This commit is contained in:
parent
d0e6567652
commit
df68976703
17 changed files with 171 additions and 40 deletions
|
|
@ -39,18 +39,22 @@ Especificação dinâmica servida pelo backend para consumo por agentes e LLMs.
|
|||
## 6. Memória das Ações da IA e Identidade (`<base_projeto>/memorias-ia/`)
|
||||
Identidade canônica do projeto pai e registros de sessões, otimizações e decisões da IA.
|
||||
- **Identidade do Módulo:** `<base_projeto>/memorias-ia/modulo.yml` (mandatório com `modulo-id`, `modulo-caminho`, `modulo-descricao`, `modulo-tipo`)
|
||||
- **Índice Central de Ações:** `<base_projeto>/memorias-ia/historico-acoes.md` (tabela: `Data | Memória / Ação | Arquivo Memoria | Citações no Código-Fonte`)
|
||||
- **Arquivos Individuais de Sessão:** `<base_projeto>/memorias-ia/sessao-AAAA-MM-DD-slug.md`
|
||||
- **Regra:** `rules/identidade-modulo.md`
|
||||
- **Diretório:** `<base_projeto>/memorias-ia/` (na raiz do projeto pai)
|
||||
- **Workflow:** `global/workflows/aprimora-ia.md`
|
||||
- **Workflows e Skills:** `global/workflows/doc.md`, `global/workflows/documentacao.md`, `global/workflows/aprimora-ia.md`
|
||||
|
||||
---
|
||||
|
||||
## Templates Padronizados (`DOCUMENTACAO/templates/`)
|
||||
|
||||
- **Identidade do Módulo (Pilar 6):** [`DOCUMENTACAO/templates/modulo.yml.template`](file:///home/luiz/Arquivos/DEV/Industria/SIGMA2026/.agent/DOCUMENTACAO/templates/modulo.yml.template)
|
||||
- **Domínio do Módulo (Pilares 3 e 4):** [`DOCUMENTACAO/templates/modulo-dominio.md.template`](file:///home/luiz/Arquivos/DEV/Industria/SIGMA2026/.agent/DOCUMENTACAO/templates/modulo-dominio.md.template)
|
||||
- **Regras de Negócio (Pilar 4):** [`DOCUMENTACAO/templates/regra-negocio.md.template`](file:///home/luiz/Arquivos/DEV/Industria/SIGMA2026/.agent/DOCUMENTACAO/templates/regra-negocio.md.template)
|
||||
- **Decisões Arquiteturais - ADRs (Pilar 4):** [`DOCUMENTACAO/templates/adr.md.template`](file:///home/luiz/Arquivos/DEV/Industria/SIGMA2026/.agent/DOCUMENTACAO/templates/adr.md.template)
|
||||
- **Ajuda na Tela / UI (Pilar 2):** [`DOCUMENTACAO/templates/ajuda-tela.md.template`](file:///home/luiz/Arquivos/DEV/Industria/SIGMA2026/.agent/DOCUMENTACAO/templates/ajuda-tela.md.template)
|
||||
- **Contratos de API (Pilar 5):** [`DOCUMENTACAO/templates/contrato-api.md.template`](file:///home/luiz/Arquivos/DEV/Industria/SIGMA2026/.agent/DOCUMENTACAO/templates/contrato-api.md.template)
|
||||
- **Fluxos de Usuário (Pilar 3):** [`DOCUMENTACAO/templates/fluxo-usuario.md.template`](file:///home/luiz/Arquivos/DEV/Industria/SIGMA2026/.agent/DOCUMENTACAO/templates/fluxo-usuario.md.template)
|
||||
- **Identidade do Módulo (Pilar 6):** [`DOCUMENTACAO/templates/modulo.yml.template`](./templates/modulo.yml.template)
|
||||
- **Índice de Ações da IA (Pilar 6):** [`DOCUMENTACAO/templates/historico-acoes.md.template`](./templates/historico-acoes.md.template)
|
||||
- **Registro de Sessão da IA (Pilar 6):** [`DOCUMENTACAO/templates/sessao-memoria.md.template`](./templates/sessao-memoria.md.template)
|
||||
- **Domínio do Módulo (Pilares 3 e 4):** [`DOCUMENTACAO/templates/modulo-dominio.md.template`](./templates/modulo-dominio.md.template)
|
||||
- **Regras de Negócio (Pilar 4):** [`DOCUMENTACAO/templates/regra-negocio.md.template`](./templates/regra-negocio.md.template)
|
||||
- **Decisões Arquiteturais - ADRs (Pilar 4):** [`DOCUMENTACAO/templates/adr.md.template`](./templates/adr.md.template)
|
||||
- **Ajuda na Tela / UI (Pilar 2):** [`DOCUMENTACAO/templates/ajuda-tela.md.template`](./templates/ajuda-tela.md.template)
|
||||
- **Contratos de API (Pilar 5):** [`DOCUMENTACAO/templates/contrato-api.md.template`](./templates/contrato-api.md.template)
|
||||
- **Fluxos de Usuário (Pilar 3):** [`DOCUMENTACAO/templates/fluxo-usuario.md.template`](./templates/fluxo-usuario.md.template)
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ No ecossistema Azteca, a documentação precede o código. Nenhum artefato (regr
|
|||
| **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 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. |
|
||||
| **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`), índice central `historico-acoes.md` (`Data \| Memória / Ação \| Arquivo Memoria \| Citações no Código-Fonte`) e arquivos dedicados de sessão `sessao-AAAA-MM-DD-slug.md`. |
|
||||
|
||||
> ℹ️ **Arquitetura VitePress (`<base_projeto>/../wiki`) e Identidade do Projeto**:
|
||||
> - `<base_projeto>/../wiki/` é uma aplicação **VitePress**.
|
||||
|
|
@ -49,13 +49,15 @@ Todos os modelos canônicos para instanciar a documentação nos projetos reside
|
|||
|
||||
| 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) |
|
||||
| **Identidade do Módulo (Pilar 6)** | `<base_projeto>/memorias-ia/modulo.yml` | [`modulo.yml.template`](./templates/modulo.yml.template) |
|
||||
| **Índice de Ações da IA (Pilar 6)** | `<base_projeto>/memorias-ia/historico-acoes.md` | [`historico-acoes.md.template`](./templates/historico-acoes.md.template) |
|
||||
| **Registro de Sessão da IA (Pilar 6)** | `<base_projeto>/memorias-ia/sessao-AAAA-MM-DD-slug.md` | [`sessao-memoria.md.template`](./templates/sessao-memoria.md.template) |
|
||||
| **Domínio do Módulo (Pilar 3 e 4)** | `<base_projeto>/../wiki/<modulo-id>/index.md` | [`modulo-dominio.md.template`](./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`](./templates/regra-negocio.md.template) |
|
||||
| **Decisões Arquiteturais - ADR (Pilar 4)** | `<base_projeto>/../wiki/dev/<modulo-id>/adrs/` | [`adr.md.template`](./templates/adr.md.template) |
|
||||
| **Ajuda na Tela / UI (Pilar 2)** | `*-front/src/.../{componente}.ajuda.md` | [`ajuda-tela.md.template`](./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`](./templates/contrato-api.md.template) |
|
||||
| **Fluxos e Telas (Pilar 3 e 4)** | `<base_projeto>/../wiki/<modulo-id>/fluxos/` | [`fluxo-usuario.md.template`](./templates/fluxo-usuario.md.template) |
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
21
DOCUMENTACAO/templates/historico-acoes.md.template
Normal file
21
DOCUMENTACAO/templates/historico-acoes.md.template
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
# Histórico de Ações e Memórias da IA — <modulo-id>
|
||||
|
||||
Índice central de registros de sessões e memórias de ações executadas pela Inteligência Artificial no módulo `<modulo-id>`. Cada sessão possui seu arquivo dedicado no padrão `sessao-AAAA-MM-DD-slug.md` com as respectivas citações no código-fonte, regras de negócio e validações técnicas.
|
||||
|
||||
---
|
||||
|
||||
## Registros de Sessões / Memórias Individuais
|
||||
|
||||
| Data | Memória / Ação | Arquivo Memoria | Citações no Código-Fonte |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| **AAAA-MM-DD** | Breve descrição da ação / funcionalidade | [`sessao-AAAA-MM-DD-slug.md`](./sessao-AAAA-MM-DD-slug.md) | `caminho/arquivo1.ts`<br>`caminho/arquivo2.vue` |
|
||||
|
||||
---
|
||||
|
||||
## Resumo das Memórias
|
||||
|
||||
### 1. [AAAA-MM-DD] Título da Ação / Memória
|
||||
- **Arquivo Completo:** [`sessao-AAAA-MM-DD-slug.md`](./sessao-AAAA-MM-DD-slug.md)
|
||||
- **Problema / Contexto:** Descrição objetiva da demanda ou diagnóstico.
|
||||
- **Solução Técnica:** O que foi projetado e implementado na sessão.
|
||||
- **Citações no Código:** `caminho/arquivo1.ts`, `caminho/arquivo2.vue`.
|
||||
56
DOCUMENTACAO/templates/sessao-memoria.md.template
Normal file
56
DOCUMENTACAO/templates/sessao-memoria.md.template
Normal file
|
|
@ -0,0 +1,56 @@
|
|||
---
|
||||
type: memory
|
||||
name: sessao-AAAA-MM-DD-slug
|
||||
description: Registro de sessão de IA cobrindo diagnóstico, ações, regras e citações no código
|
||||
session_date: "AAAA-MM-DD"
|
||||
updatedAt: "AAAA-MM-DD"
|
||||
tags: [modulo-id, contexto, acao]
|
||||
---
|
||||
|
||||
# Registro de Sessão: [Título da Sessão / Ação]
|
||||
|
||||
- **Data:** AAAA-MM-DD
|
||||
- **Módulo:** `<modulo-id>`
|
||||
- **Arquivo de Índice:** [`historico-acoes.md`](./historico-acoes.md)
|
||||
|
||||
---
|
||||
|
||||
## 1. Contexto e Diagnóstico
|
||||
|
||||
- **Problema / Demanda:** [Descrição clara da necessidade operacional ou erro relatado]
|
||||
- **Causa Raiz:** [Identificação da causa do problema, se aplicável]
|
||||
- **Impacto no Sistema:** [Módulos, serviços ou fluxos impactados]
|
||||
|
||||
---
|
||||
|
||||
## 2. Solução Implementada
|
||||
|
||||
- [Descrição detalhada da arquitetura e decisões de código]
|
||||
- [Regras de negócio observadas e documentadas]
|
||||
|
||||
---
|
||||
|
||||
## 3. Citações no Código-Fonte
|
||||
|
||||
| Arquivo | Linhas / Trecho | Responsabilidade / Modificação |
|
||||
| :--- | :--- | :--- |
|
||||
| `caminho/arquivo1.ts` | Linhas ~X-Y | Descrição da alteração |
|
||||
| `caminho/arquivo2.vue` | Linhas ~W-Z | Descrição da alteração |
|
||||
|
||||
---
|
||||
|
||||
## 4. Documentação Sincronizada (DDD)
|
||||
|
||||
- **Pilar 1 (Código):** JSDoc inserido em `caminho/arquivo1.ts`
|
||||
- **Pilar 2 (Ajuda UI):** `modalX.ajuda.md` (quando aplicável)
|
||||
- **Pilar 3 (Wiki Usuário):** `<base_projeto>/../wiki/<modulo-id>/...`
|
||||
- **Pilar 4 (Wiki Dev):** `<base_projeto>/../wiki/dev/<modulo-id>/...`
|
||||
- **Pilar 5 (Rota IA):** `/llm.md`
|
||||
- **Pilar 6 (Memória IA):** Registrado neste arquivo e indexado em `historico-acoes.md`
|
||||
|
||||
---
|
||||
|
||||
## 5. Validação e Testes
|
||||
|
||||
- [Testes de tipagem, compilação ou execução realizados]
|
||||
- [Garantia de limite de 250 linhas (`verificar-linhas.sh`)]
|
||||
Loading…
Add table
Add a link
Reference in a new issue