Merge branch 'agent--e-licencie' into agent--elicencie-de-campo
This commit is contained in:
commit
73260f90f0
24 changed files with 436 additions and 142 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`)]
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -36,7 +36,7 @@ Toda sua comunicação — incluindo raciocínio interno, reflexões e respostas
|
|||
3. **Wiki do Usuário**: Aplicação VitePress com acesso dos usuários em `<base_projeto>/../wiki/<modulo>/` (manuais e guias de operação).
|
||||
4. **Wiki de Desenvolvimento**: Aplicação VitePress com acesso interno da equipe de desenvolvimento em `<base_projeto>/../wiki/dev/<modulo>/` (documentação técnica, arquitetura, modelos de banco, regras de negócio `{modulo}.regras-negocio.md`, filas e ADRs).
|
||||
5. **Integração de IA**: Rota do backend `/llm.md` (e `/sigma/llm.md`) gerando especificações dinâmicas para LLMs.
|
||||
6. **Memória das Ações da IA**: Registro de sessões, otimizações e decisões tomadas em `<base_projeto>/memorias-ia/`.
|
||||
6. **Memória das Ações da IA**: Registro de sessões (`sessao-AAAA-MM-DD-slug.md`) e índice cumulativo (`historico-acoes.md` com `Data | Memória / Ação | Arquivo Memoria | Citações no Código-Fonte`) em `<base_projeto>/memorias-ia/`.
|
||||
7. **Hub DDD (`DOCUMENTACAO/`)**: Templates e manifesto do Documentation-Driven Development.
|
||||
|
||||
## Responsabilidades
|
||||
|
|
@ -48,7 +48,8 @@ Toda sua comunicação — incluindo raciocínio interno, reflexões e respostas
|
|||
4. **Manter a Wiki do Usuário** — redigir e manter manuais na aplicação VitePress em `<base_projeto>/../wiki/<modulo>/` com linguagem do domínio para usuários.
|
||||
5. **Manter a Wiki de Desenvolvimento** — estruturar documentação técnica, arquitetura e regras de negócio na aplicação VitePress de acesso interno em `<base_projeto>/../wiki/dev/<modulo>/`.
|
||||
6. **Validar a Rota `/llm.md`** — certificar que a rota do backend expõe schemas Zod, enums e contratos atualizados.
|
||||
7. **Registrar Memórias da IA** — consolidar registros de ações e melhorias em `<base_projeto>/memorias-ia/`.
|
||||
7. **Registrar Memórias da IA** — consolidar sessões em arquivos dedicados `sessao-AAAA-MM-DD-slug.md` e atualizar o índice central `historico-acoes.md` em `<base_projeto>/memorias-ia/`.
|
||||
8. **Sincronizar Git da Wiki** — ao criar ou modificar documentações em `<base_projeto>/../wiki/` (Pilares 3 e 4), executar obrigatoriamente `git commit` e `git push` no repositório da Wiki.
|
||||
|
||||
## Restrições
|
||||
|
||||
|
|
@ -57,6 +58,7 @@ Toda sua comunicação — incluindo raciocínio interno, reflexões e respostas
|
|||
- NUNCA inventar, supor ou fabricar regras de negócio — documentar **exclusivamente** o que o código implementa ou o que o operador declarou.
|
||||
- NUNCA descrever endpoints, schemas ou componentes sem antes inspecionar o código-fonte real.
|
||||
- NUNCA usar jargões técnicos de TI na Wiki do Usuário (`<base_projeto>/../wiki/<modulo>/`) ou nos arquivos `.ajuda.md`.
|
||||
- NUNCA executar comandos de alteração de histórico Git (`git commit`, `git push`, etc.) no repositório da aplicação principal (`<base_projeto>`). A automação de commit e push é restrita e obrigatória **exclusivamente** para `<base_projeto>/../wiki` (ver `rules/proibido-commit-ia.md`).
|
||||
- JSDoc deve documentar a **aplicação prática e o porquê**, e não apenas repetir a assinatura TypeScript.
|
||||
- Gravar memórias da IA **sempre** em `<base_projeto>/memorias-ia/`.
|
||||
|
||||
|
|
@ -73,7 +75,9 @@ Toda sua comunicação — incluindo raciocínio interno, reflexões e respostas
|
|||
- [ ] Documentação de usuário está atualizada em `<base_projeto>/../wiki/<modulo>/`?
|
||||
- [ ] Documentação técnica e ADRs estão atualizados em `<base_projeto>/../wiki/dev/<modulo>/`?
|
||||
- [ ] Rota de backend `/llm.md` reflete fielmente os schemas Zod e enums canônicos?
|
||||
- [ ] Ações estruturantes da IA estão registradas em `<base_projeto>/memorias-ia/`?
|
||||
- [ ] Ações estruturantes da IA estão registradas em `<base_projeto>/memorias-ia/sessao-AAAA-MM-DD-slug.md` e indexadas em `historico-acoes.md`?
|
||||
- [ ] Alterações na Wiki foram commitadas e enviadas via push em `<base_projeto>/../wiki`?
|
||||
- [ ] Repositório da aplicação foi mantido intacto sem commits da IA?
|
||||
|
||||
## Memória Persistente & Identidade do Projeto
|
||||
|
||||
|
|
@ -82,5 +86,7 @@ O arquivo `<base_projeto>/memorias-ia/modulo.yml` é de **existência obrigatór
|
|||
- Toda memória das ações, registros de sessões e decisões tomadas pela IA deve ser armazenada em `<base_projeto>/memorias-ia/` na raiz do projeto pai.
|
||||
|
||||
### Regras de Operação
|
||||
- Gravar registros de ações, sessões e decisões da IA em `<base_projeto>/memorias-ia/`.
|
||||
- Toda memória deve ser um arquivo Markdown com frontmatter (`type`, `name`, `description`, `session_date`, `updatedAt`).
|
||||
- Gravar registros de ações, sessões e decisões da IA em arquivos individuais `<base_projeto>/memorias-ia/sessao-AAAA-MM-DD-slug.md`.
|
||||
- Manter o índice central `<base_projeto>/memorias-ia/historico-acoes.md` atualizado com a tabela:
|
||||
`| Data | Memória / Ação | Arquivo Memoria | Citações no Código-Fonte |`.
|
||||
- Toda memória de sessão deve ser um arquivo Markdown com frontmatter (`type`, `name`, `description`, `session_date`, `updatedAt`).
|
||||
|
|
|
|||
|
|
@ -27,6 +27,7 @@ O agente pode executar sem perguntar:
|
|||
- Gerar JSDoc em funções compartilhadas
|
||||
- Extrair CSS para arquivo co-localizado
|
||||
- Aplicar padrões de nomenclatura já definidos em rules
|
||||
- Executar `git add`, `git commit` e `git push` exclusivamente no repositório da Wiki (`<base_projeto>/../wiki`) ao criar ou atualizar documentações
|
||||
|
||||
## Ações que Requerem Confirmação
|
||||
|
||||
|
|
@ -44,6 +45,7 @@ O agente deve **propor e aguardar aprovação**:
|
|||
|
||||
O agente **nunca** deve:
|
||||
|
||||
- Executar `git commit` ou `git push` no repositório da aplicação (`<base_projeto>`)
|
||||
- Deletar ou corromper `memorias-ia/modulo.yml` ou memórias/ADRs sem instrução explícita do operador
|
||||
- Assumir ou inventar IDs de módulos ou rotas sem consultar `memorias-ia/modulo.yml`
|
||||
- Alterar artefatos globais (sufixo `.global`) sem justificativa
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ Todo desenvolvimento e manutenção no ecossistema deve obrigatoriamente respeit
|
|||
| **3. Wiki do Usuário** | `<base_projeto>/../wiki/<modulo-id>/` | Usuários / Operadores | Aplicação VitePress com acesso dos usuários. Manuais de operação completos, tutoriais de uso, conceitos de negócio e fluxos da aplicação. |
|
||||
| **4. Wiki de Desenvolvimento** | `<base_projeto>/../wiki/dev/<modulo-id>/` | Desenvolvedores / Arquitetos | Aplicação VitePress com acesso interno exclusivo da equipe de desenvolvimento. Arquitetura técnica detalhada, modelos de banco, regras de negócio (`{modulo}.regras-negocio.md`), fluxos de filas (BullMQ), CRONs e ADRs. |
|
||||
| **5. Integração de IA** | Rota de Backend `/llm.md` | Agentes de IA / LLMs | Documentação gerada/servida dinamicamente contendo schemas Zod, enums canônicos, endpoints e contratos para consumo por LLMs. |
|
||||
| **6. Memória das Ações da IA e Identidade** | `<base_projeto>/memorias-ia/` | Agentes de IA / Auditoria | Arquivo mandatório `modulo.yml` (`modulo-id`, `modulo-caminho`, `modulo-descricao`, `modulo-tipo`), registros de sessões, histórico de decisões e relatórios de aprimoramento. |
|
||||
| **6. Memória das Ações da IA e Identidade** | `<base_projeto>/memorias-ia/` | Agentes de IA / Auditoria | `modulo.yml` (identidade), índice central `historico-acoes.md` (`Data \| Memória / Ação \| Arquivo Memoria \| Citações no Código-Fonte`) e sessões individuais `sessao-AAAA-MM-DD-slug.md`. |
|
||||
|
||||
> ℹ️ **Estrutura da Wiki VitePress (`<base_projeto>/../wiki`)**:
|
||||
> - `<base_projeto>/../wiki/<modulo-id>/` $\rightarrow$ Aplicação VitePress voltada ao **acesso dos usuários e clientes** (onde `<modulo-id>` é o ID do módulo em `memorias-ia/modulo.yml`).
|
||||
|
|
@ -38,7 +38,7 @@ Todo desenvolvimento e manutenção no ecossistema deve obrigatoriamente respeit
|
|||
> 🧩 **Polimorfismo do `.agent` e Identidade do Projeto**:
|
||||
> O repositório `.agent` é **polimórfico e genérico**, sendo compartilhado entre múltiplos projetos do ecossistema. Toda personalização e identidade de cada projeto reside em:
|
||||
> - `./memorias-ia/modulo.yml` (na raiz do projeto pai): **Identificador mandatório** (`modulo-id`, `modulo-caminho`, `modulo-descricao`, `modulo-tipo`). Sempre consultado quando precisar de IDs, rotas base ou stack.
|
||||
> - `./memorias-ia/`: Registros de ações, sessões e decisões da IA.
|
||||
> - `./memorias-ia/`: Registros individuais `sessao-AAAA-MM-DD-slug.md` e índice cumulativo `historico-acoes.md`.
|
||||
> - `<base_projeto>/../wiki/<modulo-id>/`: Documentação do módulo com acesso dos usuários (VitePress).
|
||||
> - `<base_projeto>/../wiki/dev/<modulo-id>/`: Documentação técnica do módulo com acesso interno dev (VitePress).
|
||||
|
||||
|
|
@ -54,7 +54,7 @@ Para toda nova demanda, módulo ou funcionalidade, execute os passos abaixo:
|
|||
- É funcionalidade com impacto no usuário final? $\rightarrow$ Criar/atualizar documentação em `<base_projeto>/../wiki/<modulo>/` (Pilar 3).
|
||||
- É componente técnico, arquitetura, serviço ou fila? $\rightarrow$ Criar/atualizar documentação em `<base_projeto>/../wiki/dev/<modulo>/` (Pilar 4).
|
||||
- É endpoint, schema ou contrato de API? $\rightarrow$ Assegurar reflexão na rota `/llm.md` (Pilar 5).
|
||||
- É ação estruturante ou otimização de IA? $\rightarrow$ Registrar memória em `<base_projeto>/memorias-ia/` (Pilar 6).
|
||||
- É ação estruturante ou otimização de IA? $\rightarrow$ Registrar memória em `<base_projeto>/memorias-ia/sessao-AAAA-MM-DD-slug.md` e indexar em `historico-acoes.md` (Pilar 6).
|
||||
|
||||
2. **Documentar Antes de Codar**:
|
||||
- Redigir a documentação preliminar nos respectivos destinos e templates antes de iniciar a implementação.
|
||||
|
|
|
|||
|
|
@ -1,34 +1,38 @@
|
|||
---
|
||||
type: rule
|
||||
name: proibido-commit-ia
|
||||
description: A IA nunca pode executar git commit, git push ou qualquer operação que altere o histórico do repositório
|
||||
description: A IA nunca mexe no git da aplicação principal; commit e push são permitidos e obrigatórios exclusivamente no repositório da Wiki (../wiki)
|
||||
scope: global
|
||||
trigger: always_on
|
||||
updatedAt: "2026-06-19"
|
||||
updatedAt: "2026-09-05"
|
||||
---
|
||||
|
||||
# Regra: Proibido Commit pela IA
|
||||
# Regra: Proibido Commit pela IA na Aplicação e Exceção Obrigatória da Wiki
|
||||
|
||||
## Contexto
|
||||
|
||||
O controle de versão é responsabilidade exclusiva do usuário humano. A IA pode preparar alterações, criar arquivos, editar código e até sugerir mensagens de commit — mas NUNCA deve executar comandos que alterem o histórico do repositório.
|
||||
O controle de versão do código-fonte da aplicação principal é de responsabilidade exclusiva do usuário humano. A IA pode preparar alterações, criar arquivos, editar código e até sugerir mensagens de commit — mas NUNCA deve executar comandos que alterem o histórico do repositório da aplicação.
|
||||
|
||||
Por outro lado, o repositório central de documentação (`<base_projeto>/../wiki`), que hospeda a Wiki do Usuário (Pilar 3) e a Wiki de Desenvolvimento (Pilar 4), é uma base viva de documentação. Quando atualizado pelo agente (ex.: via `/doc`, `/documentacao` ou workflows DDD), o commit e o push DEVEM ser executados automaticamente pelo agente, restritos exclusivamente a esse repositório.
|
||||
|
||||
## Regra
|
||||
|
||||
A IA **NUNCA** deve executar os seguintes comandos (nem variações deles):
|
||||
### 1. Na Aplicação Principal (`<base_projeto>`) — RIGOROSAMENTE PROIBIDO MEXER NO GIT
|
||||
|
||||
- `git commit`
|
||||
- `git push`
|
||||
- `git merge`
|
||||
- `git rebase`
|
||||
- `git tag`
|
||||
- `git reset`
|
||||
- `git revert`
|
||||
- `git cherry-pick`
|
||||
- `git stash drop`
|
||||
- `git branch -d` / `git branch -D`
|
||||
A IA **NUNCA** deve executar comandos que alterem o histórico do repositório da aplicação (nem variações deles):
|
||||
|
||||
### Comandos permitidos (somente leitura e staging)
|
||||
- `git commit` ❌
|
||||
- `git push` ❌
|
||||
- `git merge` ❌
|
||||
- `git rebase` ❌
|
||||
- `git tag` ❌
|
||||
- `git reset` ❌
|
||||
- `git revert` ❌
|
||||
- `git cherry-pick` ❌
|
||||
- `git stash drop` ❌
|
||||
- `git branch -d` / `git branch -D` ❌
|
||||
|
||||
**Comandos permitidos na aplicação (somente leitura e staging):**
|
||||
|
||||
- `git status` ✅
|
||||
- `git diff` ✅
|
||||
|
|
@ -39,37 +43,52 @@ A IA **NUNCA** deve executar os seguintes comandos (nem variações deles):
|
|||
- `git ls-files` ✅
|
||||
- `git show` ✅
|
||||
|
||||
## Exemplos
|
||||
### 2. No Repositório da Wiki (`<base_projeto>/../wiki`) — COMMIT E PUSH OBRIGATÓRIOS
|
||||
|
||||
❌ **Errado** — commitar automaticamente:
|
||||
```sh
|
||||
git add -A && git commit -m "fix: corrigir bug"
|
||||
Sempre que a documentação em `<base_projeto>/../wiki` for criada ou modificada (manuais de usuário em `<modulo-id>/`, regras de negócio em `dev/<modulo-id>/`, ADRs em `dev/<modulo-id>/adrs/`, etc.), o agente **DEVE obrigatoriamente** realizar o commit e push das alterações:
|
||||
|
||||
```bash
|
||||
# Executar estritamente apontando para a pasta ../wiki
|
||||
git -C <base_projeto>/../wiki add -A
|
||||
git -C <base_projeto>/../wiki commit -m "docs(<modulo-id>): <descrição sucinta das alterações>"
|
||||
git -C <base_projeto>/../wiki push
|
||||
```
|
||||
|
||||
❌ **Errado** — push automático:
|
||||
**Fronteira Inegociável:** Esta permissão é restrita e isolada ao repositório `<base_projeto>/../wiki`. A IA **nunca** deve executar commit ou push na aplicação principal.
|
||||
|
||||
## Exemplos
|
||||
|
||||
### ❌ Errado — commitar automaticamente na aplicação
|
||||
```sh
|
||||
# Na raiz da aplicação (<base_projeto>): PROIBIDO
|
||||
git add -A && git commit -m "fix: corrigir bug"
|
||||
git push origin main
|
||||
```
|
||||
|
||||
✅ **Correto** — preparar e informar:
|
||||
### ✅ Correto — na aplicação principal, apenas preparar e sugerir
|
||||
```sh
|
||||
git add -A
|
||||
git status
|
||||
# Informar ao usuário: "Alterações staged. Revise e faça o commit quando estiver pronto."
|
||||
# Informar ao usuário: "Alterações staged na aplicação. Revise e faça o commit quando estiver pronto."
|
||||
# Sugestão de commit: git commit -m "feat: adicionar validação de schema"
|
||||
```
|
||||
|
||||
✅ **Correto** — sugerir mensagem de commit:
|
||||
```
|
||||
Sugestão de commit:
|
||||
git commit -m "feat: adicionar validação de schema no endpoint /usuarios"
|
||||
### ✅ Correto — na Wiki, commitar e enviar automaticamente
|
||||
```sh
|
||||
# No repositório de documentação (<base_projeto>/../wiki): OBRIGATÓRIO
|
||||
git -C ../wiki add -A
|
||||
git -C ../wiki commit -m "docs(e-licencie): atualizar regras de negócio e manuais"
|
||||
git -C ../wiki push
|
||||
```
|
||||
|
||||
## Impacto
|
||||
|
||||
- **Segurança:** o usuário mantém controle total sobre o que entra no histórico
|
||||
- **Revisão:** toda alteração pode ser inspecionada antes de ser commitada
|
||||
- **Reversibilidade:** evita commits acidentais que poluem o histórico
|
||||
- **Segurança na aplicação:** O desenvolvedor mantém controle total sobre o histórico de código da aplicação.
|
||||
- **Agilidade e perenidade na wiki:** A documentação fica sempre sincronizada e publicada imediatamente sem fricção manual.
|
||||
- **Isolamento de escopo:** Fronteira clara e explícita entre repositório de aplicação e repositório de documentação.
|
||||
|
||||
## Referências
|
||||
|
||||
- Princípio de autonomia controlada: a IA executa, o humano decide
|
||||
- Rule: `rules/ddd-documentacao-primeiro.md`
|
||||
- Skill: `skills/documentacao/SKILL.md`
|
||||
- Workflow: `global/workflows/documentacao.md`
|
||||
|
|
|
|||
|
|
@ -1,13 +1,13 @@
|
|||
---
|
||||
name: doc
|
||||
description: Alias rápido para /documentacao - acionar o Agente de Documentação & Memória
|
||||
description: Alias rápido para /documentacao - acionar o Agente de Documentação & Memória com versionamento automático na Wiki
|
||||
scope: global
|
||||
updatedAt: "2026-09-01"
|
||||
updatedAt: "2026-09-05"
|
||||
---
|
||||
|
||||
# Skill: /doc (Alias para /documentacao)
|
||||
|
||||
Atalho rápido para o **Agente de Documentação & Memória** cobrindo os 6 pilares canônicos:
|
||||
Atalho rápido para o **Agente de Documentação & Memória** cobrindo os 6 pilares canônicos do Documentation-Driven Development (DDD):
|
||||
|
||||
> ⚡ **Modo Padrão Sem Parâmetros:** Se executado apenas como `/doc`, documenta e sincroniza automaticamente todo o contexto e decisões da conversa atual no chat.
|
||||
|
||||
|
|
@ -16,6 +16,35 @@ Atalho rápido para o **Agente de Documentação & Memória** cobrindo os 6 pila
|
|||
- `3. Wiki Usuário` $\rightarrow$ `<base_projeto>/../wiki/<modulo>/` (VitePress com acesso dos usuários)
|
||||
- `4. Wiki Dev` $\rightarrow$ `<base_projeto>/../wiki/dev/<modulo>/` (VitePress com acesso interno dev e regras `{modulo}.regras-negocio.md`)
|
||||
- `5. Rota IA` $\rightarrow$ Rota do backend `/llm.md`
|
||||
- `6. Memória IA` $\rightarrow$ `<base_projeto>/memorias-ia/`
|
||||
- `6. Memória IA` $\rightarrow$ `<base_projeto>/memorias-ia/` (gera `sessao-AAAA-MM-DD-slug.md` e indexa no arquivo central `historico-acoes.md`)
|
||||
|
||||
Para ver a documentação completa e exemplos, consulte [`skills/documentacao/SKILL.md`](file:///home/luiz/Arquivos/DEV/Industria/SIGMA2026/.agent/skills/documentacao/SKILL.md).
|
||||
---
|
||||
|
||||
## 🧠 Pilar 6: Memória da IA e Histórico de Ações (`memorias-ia/`)
|
||||
|
||||
Ao documentar a sessão (seja via `/doc` ou `/documentacao`):
|
||||
1. **Arquivo da Sessão:** O agente gera o registro detalhado em `<base_projeto>/memorias-ia/sessao-AAAA-MM-DD-slug.md` descrevendo contexto, causa raiz, solução técnica, citações no código-fonte e validações.
|
||||
2. **Índice de Ações (`historico-acoes.md`):** O agente registra/atualiza a linha correspondente na tabela de `<base_projeto>/memorias-ia/historico-acoes.md`:
|
||||
```markdown
|
||||
| Data | Memória / Ação | Arquivo Memoria | Citações no Código-Fonte |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| **AAAA-MM-DD** | [Descrição da Ação] | [`sessao-AAAA-MM-DD-slug.md`](./sessao-AAAA-MM-DD-slug.md) | `caminho/arquivo.ts`<br>`outro/arquivo.vue` |
|
||||
```
|
||||
|
||||
|
||||
## 🔄 Versionamento Git Obrigatório da Wiki (`<base_projeto>/../wiki`)
|
||||
|
||||
Sempre que a documentação na Wiki (Pilares 3 e 4) for alterada ou criada:
|
||||
- O agente **DEVE obrigatoriamente executar commit e push** das alterações exclusivamente no repositório da Wiki:
|
||||
```bash
|
||||
git -C <base_projeto>/../wiki add -A
|
||||
git -C <base_projeto>/../wiki commit -m "docs(<modulo-id>): sincronizar documentação"
|
||||
git -C <base_projeto>/../wiki push
|
||||
```
|
||||
|
||||
> 🔒 **Fronteira Inegociável de Git:**
|
||||
> Na aplicação principal (`<base_projeto>`), o agente **NUNCA pode mexer no git** (proibido `git commit`, `git push`, `git merge`, etc.). O controle de versão do código da aplicação é de responsabilidade humana exclusiva (ver `rules/proibido-commit-ia.md`).
|
||||
|
||||
---
|
||||
|
||||
Para ver a especificação completa, comandos com argumentos e exemplos, consulte [`skills/documentacao/SKILL.md`](../documentacao/SKILL.md).
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
name: documentacao
|
||||
description: Acionar o Agente de Documentação & Memória para documentar o contexto da conversa ou gerar artefatos nos 6 pilares canônicos
|
||||
description: Acionar o Agente de Documentação & Memória para documentar o contexto da conversa ou gerar artefatos nos 6 pilares canônicos com versionamento automático na Wiki
|
||||
scope: global
|
||||
updatedAt: "2026-09-01"
|
||||
updatedAt: "2026-09-05"
|
||||
---
|
||||
|
||||
# Skill / Workflow: /documentacao
|
||||
|
|
@ -20,7 +20,15 @@ Esta skill aciona o **Agente de Documentação & Memória** para gerar, atualiza
|
|||
3. **Pilar 3 (Wiki do Usuário):** Atualiza tutoriais e manuais em `<base_projeto>/../wiki/<modulo>/` (aplicação VitePress com acesso dos usuários).
|
||||
4. **Pilar 4 (Wiki de Desenvolvimento):** Documenta regras de negócio (`{modulo}.regras-negocio.md`), modelos e ADRs em `<base_projeto>/../wiki/dev/<modulo>/` (aplicação VitePress com acesso interno dev).
|
||||
5. **Pilar 5 (Rota IA):** Assegura que novos schemas e rotas estejam refletidos na rota `/llm.md`.
|
||||
6. **Pilar 6 (Memória IA):** Registra o relatório completo da sessão em `<base_projeto>/memorias-ia/`.
|
||||
6. **Pilar 6 (Memória IA):** Registra o relatório completo da sessão no arquivo individual `<base_projeto>/memorias-ia/sessao-AAAA-MM-DD-slug.md` e atualiza o índice central `<base_projeto>/memorias-ia/historico-acoes.md` adicionando a linha correspondente na tabela com as colunas: `Data | Memória / Ação | Arquivo Memoria | Citações no Código-Fonte`.
|
||||
7. **Sincronização Git da Wiki (Obrigatório e Exclusivo):**
|
||||
- Se houver arquivos novos ou alterados em `<base_projeto>/../wiki/`:
|
||||
```bash
|
||||
git -C <base_projeto>/../wiki add -A
|
||||
git -C <base_projeto>/../wiki commit -m "docs(<modulo-id>): sincronizar documentação [contexto]"
|
||||
git -C <base_projeto>/../wiki push
|
||||
```
|
||||
- **Trava de Segurança da Aplicação:** Na aplicação (`<base_projeto>`), o agente **NÃO pode mexer no git** (o versionamento do código-fonte da aplicação permanece sob controle humano exclusivo).
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -33,7 +41,7 @@ Esta skill aciona o **Agente de Documentação & Memória** para gerar, atualiza
|
|||
| **3. Wiki do Usuário** | `<base_projeto>/../wiki/<modulo>/` | Usuários / Clientes | Aplicação VitePress com acesso dos usuários (manuais, tutoriais e fluxos). |
|
||||
| **4. Wiki de Desenvolvimento** | `<base_projeto>/../wiki/dev/<modulo>/` | Desenvolvedores / Arquitetos | Aplicação VitePress com acesso interno dev: regras de negócio (`{modulo}.regras-negocio.md`), arquitetura e ADRs (`adrs/`). |
|
||||
| **5. Integração de IA** | Rota Backend `/llm.md` | Agentes de IA / LLMs | Catálogo de schemas Zod, enums e contratos para consumo por LLMs. |
|
||||
| **6. Memória da IA** | `<base_projeto>/memorias-ia/` | Agentes de IA / Auditoria | Registros de sessões, otimizações executadas e decisões históricas. |
|
||||
| **6. Memória da IA** | `<base_projeto>/memorias-ia/` | Agentes de IA / Auditoria | `modulo.yml` (identidade), índice `historico-acoes.md` (`Data \| Memória / Ação \| Arquivo Memoria \| Citações no Código-Fonte`) e sessões individuais `sessao-AAAA-MM-DD-slug.md`. |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -49,16 +57,18 @@ Esta skill aciona o **Agente de Documentação & Memória** para gerar, atualiza
|
|||
# Criar ajuda contextual modalX.ajuda.md para modal/tela
|
||||
/documentacao ajuda <caminho/modalX.vue>
|
||||
|
||||
# Documentar domínio na Wiki do Usuário (VitePress)
|
||||
# Documentar domínio na Wiki do Usuário (VitePress) + commit/push na wiki
|
||||
/documentacao wiki-usuario <modulo>
|
||||
|
||||
# Documentar regras de negócio na Wiki Dev (VitePress)
|
||||
# Documentar regras de negócio na Wiki Dev (VitePress) + commit/push na wiki
|
||||
/documentacao regras <caminho/servico.ts>
|
||||
|
||||
# Criar um ADR na Wiki Dev
|
||||
# Criar um ADR na Wiki Dev + commit/push na wiki
|
||||
/documentacao adr "<Título da Decisão>"
|
||||
```
|
||||
|
||||
*Nota:* Qualquer comando que crie ou modifique arquivos na Wiki (`<base_projeto>/../wiki`) deve finalizar executando `git add`, `git commit` e `git push` dentro de `../wiki`.
|
||||
|
||||
---
|
||||
|
||||
## 🔒 Regras Inegociáveis
|
||||
|
|
@ -67,3 +77,4 @@ Esta skill aciona o **Agente de Documentação & Memória** para gerar, atualiza
|
|||
2. **Linguagem acessível no usuário:** Sem termos técnicos de TI na Wiki do Usuário ou em `.ajuda.md`.
|
||||
3. **JSDoc de Aplicação:** Explicar a utilidade prática no sistema, não apenas repetir tipos.
|
||||
4. **Polimorfismo:** O `.agent` é genérico; personalizações ficam em `./memorias-ia/` e `<base_projeto>/../wiki/`.
|
||||
5. **Fronteira Git e Push Obrigatório na Wiki:** Toda atualização em `<base_projeto>/../wiki` DEVE ser commitada e enviada via `git push` exclusivamente dentro do diretório `../wiki`. Na aplicação principal (`<base_projeto>`), a IA nunca mexe no Git (ver `rules/proibido-commit-ia.md`).
|
||||
|
|
|
|||
|
|
@ -103,3 +103,4 @@ Se o módulo introduziu ou alterou arquitetura ou regras consolidadas do módulo
|
|||
- Atualizar a especificação técnica na **Wiki de Desenvolvimento** em `<base_projeto>/../wiki/dev/<modulo>/`.
|
||||
- Criar ou atualizar ADR em `<base_projeto>/../wiki/dev/<modulo>/adrs/` via skill `documentar-decisao-tecnica`.
|
||||
- Registrar decisões e ações na memória em `<base_projeto>/memorias-ia/`.
|
||||
- **Sincronização Git:** Executar commit e push exclusivamente na Wiki (`git -C <base_projeto>/../wiki add -A && git -C <base_projeto>/../wiki commit -m "docs(<modulo-id>): regras de negócio" && git -C <base_projeto>/../wiki push`). Na aplicação (`<base_projeto>`), nunca mexer no git.
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
---
|
||||
type: workflow
|
||||
name: doc
|
||||
description: Alias para /documentacao - acionar o Agente de Documentação & Memória
|
||||
description: Alias para /documentacao - acionar o Agente de Documentação & Memória com versionamento automático na Wiki
|
||||
scope: global
|
||||
updatedAt: "2026-09-01"
|
||||
updatedAt: "2026-09-05"
|
||||
---
|
||||
|
||||
# Workflow: /doc (Alias para /documentacao)
|
||||
|
|
@ -17,6 +17,23 @@ Atalho rápido para o **Agente de Documentação & Memória** cobrindo os 6 pila
|
|||
- `3. Wiki Usuário` $\rightarrow$ `<base_projeto>/../wiki/<modulo>/` (VitePress com acesso dos usuários)
|
||||
- `4. Wiki Dev` $\rightarrow$ `<base_projeto>/../wiki/dev/<modulo>/` (VitePress com acesso interno dev e regras `{modulo}.regras-negocio.md`)
|
||||
- `5. Rota IA` $\rightarrow$ Rota do backend `/llm.md`
|
||||
- `6. Memória IA` $\rightarrow$ `<base_projeto>/memorias-ia/`
|
||||
- `6. Memória IA` $\rightarrow$ `<base_projeto>/memorias-ia/` (gera `sessao-AAAA-MM-DD-slug.md` e indexa no índice `historico-acoes.md` com a tabela `Data | Memória / Ação | Arquivo Memoria | Citações no Código-Fonte`)
|
||||
|
||||
Para ver todas as opções e sintaxes, consulte [`/documentacao`](file:///home/luiz/Arquivos/DEV/Industria/SIGMA2026/.agent/global/workflows/documentacao.md).
|
||||
---
|
||||
|
||||
## 🔄 Versionamento Git Obrigatório da Wiki (`<base_projeto>/../wiki`)
|
||||
|
||||
Sempre que a documentação na Wiki (Pilares 3 e 4) for criada ou atualizada:
|
||||
- O agente **DEVE obrigatoriamente executar commit e push** das alterações exclusivamente no diretório da Wiki:
|
||||
```bash
|
||||
git -C <base_projeto>/../wiki add -A
|
||||
git -C <base_projeto>/../wiki commit -m "docs(<modulo-id>): sincronizar documentação"
|
||||
git -C <base_projeto>/../wiki push
|
||||
```
|
||||
|
||||
> 🔒 **Fronteira Inegociável de Git:**
|
||||
> Na aplicação principal (`<base_projeto>`), o agente **NUNCA pode mexer no git** (proibido `git commit`, `git push`, `git merge`, etc.). O versionamento do código da aplicação é mantido exclusivamente pelo usuário (ver `rules/proibido-commit-ia.md`).
|
||||
|
||||
---
|
||||
|
||||
Para ver todas as opções, comandos e sintaxes completas, consulte [`/documentacao`](./documentacao.md).
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
---
|
||||
type: workflow
|
||||
name: documentacao
|
||||
description: Acionar o Agente de Documentação para documentar o contexto do chat ou executar comandos específicos nos 6 pilares
|
||||
description: Acionar o Agente de Documentação para documentar o contexto do chat ou executar comandos específicos nos 6 pilares com versionamento automático na Wiki
|
||||
scope: global
|
||||
updatedAt: "2026-09-01"
|
||||
updatedAt: "2026-09-05"
|
||||
---
|
||||
|
||||
# Workflow: /documentacao (Agente de Documentação & Memória)
|
||||
|
|
@ -24,9 +24,17 @@ Este workflow aciona o **Agente de Documentação** para gerar, atualizar ou aud
|
|||
- **Pilar 3 (Wiki Usuário):** Atualiza manuais em `<base_projeto>/../wiki/<modulo>/` se houver mudanças com impacto no usuário final.
|
||||
- **Pilar 4 (Wiki Dev):** Documenta regras técnicas (`{modulo}.regras-negocio.md`) e ADRs em `<base_projeto>/../wiki/dev/<modulo>/`.
|
||||
- **Pilar 5 (Rota IA):** Assegura que novos schemas e rotas estejam refletidos na rota `/llm.md`.
|
||||
- **Pilar 6 (Memória IA):** Registra o relatório completo da sessão em `<base_projeto>/memorias-ia/`.
|
||||
3. **Entrega de Relatório:**
|
||||
- Apresenta um resumo claro ao operador de tudo o que foi documentado com links diretos para os arquivos gerados.
|
||||
- **Pilar 6 (Memória IA):** Registra o relatório completo da sessão no arquivo dedicado `<base_projeto>/memorias-ia/sessao-AAAA-MM-DD-slug.md` e indexa a alteração no arquivo central `<base_projeto>/memorias-ia/historico-acoes.md` inserindo linha na tabela com as colunas: `Data | Memória / Ação | Arquivo Memoria | Citações no Código-Fonte`.
|
||||
3. **Sincronização Git da Wiki (Obrigatório e Exclusivo):**
|
||||
- Se houver arquivos novos ou alterados em `<base_projeto>/../wiki/`:
|
||||
```bash
|
||||
git -C <base_projeto>/../wiki add -A
|
||||
git -C <base_projeto>/../wiki commit -m "docs(<modulo-id>): sincronizar documentação [contexto]"
|
||||
git -C <base_projeto>/../wiki push
|
||||
```
|
||||
- **Fronteira Inegociável da Aplicação:** Na aplicação principal (`<base_projeto>`), o agente **NÃO pode mexer no git** (o versionamento do código-fonte da aplicação permanece sob controle humano exclusivo).
|
||||
4. **Entrega de Relatório:**
|
||||
- Apresenta um resumo claro ao operador de tudo o que foi documentado com links diretos para os arquivos gerados e confirmação do push na Wiki.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -39,7 +47,7 @@ Este workflow aciona o **Agente de Documentação** para gerar, atualizar ou aud
|
|||
| **3. Wiki do Usuário** | `<base_projeto>/../wiki/<modulo>/` | Aplicação VitePress com acesso dos usuários (manuais, tutoriais e fluxos). |
|
||||
| **4. Wiki de Desenvolvimento** | `<base_projeto>/../wiki/dev/<modulo>/` | Aplicação VitePress com acesso interno dev: regras de negócio (`{modulo}.regras-negocio.md`), modelos de banco, arquitetura e ADRs (`adrs/`). |
|
||||
| **5. Integração de IA** | Rota Backend `/llm.md` | Catálogo de schemas Zod, enums e contratos para consumo por LLMs. |
|
||||
| **6. Memória da IA** | `<base_projeto>/memorias-ia/` | Registros de sessões, otimizações executadas e decisões históricas. |
|
||||
| **6. Memória da IA** | `<base_projeto>/memorias-ia/` | `modulo.yml` (identidade), índice `historico-acoes.md` (`Data \| Memória / Ação \| Arquivo Memoria \| Citações no Código-Fonte`) e memórias de sessão `sessao-AAAA-MM-DD-slug.md`. |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -55,16 +63,18 @@ Este workflow aciona o **Agente de Documentação** para gerar, atualizar ou aud
|
|||
# Criar ajuda contextual modalX.ajuda.md para modal/tela
|
||||
/documentacao ajuda <caminho/modalX.vue>
|
||||
|
||||
# Documentar domínio na Wiki do Usuário (VitePress)
|
||||
# Documentar domínio na Wiki do Usuário (VitePress) + commit/push na wiki
|
||||
/documentacao wiki-usuario <modulo>
|
||||
|
||||
# Documentar regras de negócio na Wiki Dev (VitePress)
|
||||
# Documentar regras de negócio na Wiki Dev (VitePress) + commit/push na wiki
|
||||
/documentacao regras <caminho/servico.ts>
|
||||
|
||||
# Criar um ADR na Wiki Dev
|
||||
# Criar um ADR na Wiki Dev + commit/push na wiki
|
||||
/documentacao adr "<Título da Decisão>"
|
||||
```
|
||||
|
||||
*Nota:* Qualquer comando que crie ou modifique arquivos na Wiki (`<base_projeto>/../wiki`) deve finalizar executando `git add`, `git commit` e `git push` dentro de `../wiki`.
|
||||
|
||||
---
|
||||
|
||||
## 🔒 Regras Inegociáveis
|
||||
|
|
@ -73,3 +83,4 @@ Este workflow aciona o **Agente de Documentação** para gerar, atualizar ou aud
|
|||
2. **Linguagem acessível no usuário:** Sem termos técnicos de TI na Wiki do Usuário ou em `.ajuda.md`.
|
||||
3. **JSDoc de Aplicação:** Explicar a utilidade prática no sistema, não apenas repetir tipos.
|
||||
4. **Polimorfismo:** O `.agent` é genérico; personalizações ficam em `./memorias-ia/` e `<base_projeto>/../wiki/`.
|
||||
5. **Fronteira Git e Push Obrigatório na Wiki:** Toda atualização em `<base_projeto>/../wiki` DEVE ser commitada e enviada via `git push` exclusivamente dentro do diretório `../wiki`. Na aplicação principal (`<base_projeto>`), a IA nunca mexe no Git (ver `rules/proibido-commit-ia.md`).
|
||||
|
|
|
|||
|
|
@ -27,6 +27,7 @@ O agente pode executar sem perguntar:
|
|||
- Gerar JSDoc em funções compartilhadas
|
||||
- Extrair CSS para arquivo co-localizado
|
||||
- Aplicar padrões de nomenclatura já definidos em rules
|
||||
- Executar `git add`, `git commit` e `git push` exclusivamente no repositório da Wiki (`<base_projeto>/../wiki`) ao criar ou atualizar documentações
|
||||
|
||||
## Ações que Requerem Confirmação
|
||||
|
||||
|
|
@ -44,6 +45,7 @@ O agente deve **propor e aguardar aprovação**:
|
|||
|
||||
O agente **nunca** deve:
|
||||
|
||||
- Executar `git commit` ou `git push` no repositório da aplicação (`<base_projeto>`)
|
||||
- Deletar ou corromper `memorias-ia/modulo.yml` ou memórias/ADRs sem instrução explícita do operador
|
||||
- Assumir ou inventar IDs de módulos ou rotas sem consultar `memorias-ia/modulo.yml`
|
||||
- Alterar artefatos globais (sufixo `.global`) sem justificativa
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ Todo desenvolvimento e manutenção no ecossistema deve obrigatoriamente respeit
|
|||
| **3. Wiki do Usuário** | `<base_projeto>/../wiki/<modulo-id>/` | Usuários / Operadores | Aplicação VitePress com acesso dos usuários. Manuais de operação completos, tutoriais de uso, conceitos de negócio e fluxos da aplicação. |
|
||||
| **4. Wiki de Desenvolvimento** | `<base_projeto>/../wiki/dev/<modulo-id>/` | Desenvolvedores / Arquitetos | Aplicação VitePress com acesso interno exclusivo da equipe de desenvolvimento. Arquitetura técnica detalhada, modelos de banco, regras de negócio (`{modulo}.regras-negocio.md`), fluxos de filas (BullMQ), CRONs e ADRs. |
|
||||
| **5. Integração de IA** | Rota de Backend `/llm.md` | Agentes de IA / LLMs | Documentação gerada/servida dinamicamente contendo schemas Zod, enums canônicos, endpoints e contratos para consumo por LLMs. |
|
||||
| **6. Memória das Ações da IA e Identidade** | `<base_projeto>/memorias-ia/` | Agentes de IA / Auditoria | Arquivo mandatório `modulo.yml` (`modulo-id`, `modulo-caminho`, `modulo-descricao`, `modulo-tipo`), registros de sessões, histórico de decisões e relatórios de aprimoramento. |
|
||||
| **6. Memória das Ações da IA e Identidade** | `<base_projeto>/memorias-ia/` | Agentes de IA / Auditoria | `modulo.yml` (identidade), índice central `historico-acoes.md` (`Data \| Memória / Ação \| Arquivo Memoria \| Citações no Código-Fonte`) e sessões individuais `sessao-AAAA-MM-DD-slug.md`. |
|
||||
|
||||
> ℹ️ **Estrutura da Wiki VitePress (`<base_projeto>/../wiki`)**:
|
||||
> - `<base_projeto>/../wiki/<modulo-id>/` $\rightarrow$ Aplicação VitePress voltada ao **acesso dos usuários e clientes** (onde `<modulo-id>` é o ID do módulo em `memorias-ia/modulo.yml`).
|
||||
|
|
@ -38,7 +38,7 @@ Todo desenvolvimento e manutenção no ecossistema deve obrigatoriamente respeit
|
|||
> 🧩 **Polimorfismo do `.agent` e Identidade do Projeto**:
|
||||
> O repositório `.agent` é **polimórfico e genérico**, sendo compartilhado entre múltiplos projetos do ecossistema. Toda personalização e identidade de cada projeto reside em:
|
||||
> - `./memorias-ia/modulo.yml` (na raiz do projeto pai): **Identificador mandatório** (`modulo-id`, `modulo-caminho`, `modulo-descricao`, `modulo-tipo`). Sempre consultado quando precisar de IDs, rotas base ou stack.
|
||||
> - `./memorias-ia/`: Registros de ações, sessões e decisões da IA.
|
||||
> - `./memorias-ia/`: Registros individuais `sessao-AAAA-MM-DD-slug.md` e índice cumulativo `historico-acoes.md`.
|
||||
> - `<base_projeto>/../wiki/<modulo-id>/`: Documentação do módulo com acesso dos usuários (VitePress).
|
||||
> - `<base_projeto>/../wiki/dev/<modulo-id>/`: Documentação técnica do módulo com acesso interno dev (VitePress).
|
||||
|
||||
|
|
@ -54,7 +54,7 @@ Para toda nova demanda, módulo ou funcionalidade, execute os passos abaixo:
|
|||
- É funcionalidade com impacto no usuário final? $\rightarrow$ Criar/atualizar documentação em `<base_projeto>/../wiki/<modulo>/` (Pilar 3).
|
||||
- É componente técnico, arquitetura, serviço ou fila? $\rightarrow$ Criar/atualizar documentação em `<base_projeto>/../wiki/dev/<modulo>/` (Pilar 4).
|
||||
- É endpoint, schema ou contrato de API? $\rightarrow$ Assegurar reflexão na rota `/llm.md` (Pilar 5).
|
||||
- É ação estruturante ou otimização de IA? $\rightarrow$ Registrar memória em `<base_projeto>/memorias-ia/` (Pilar 6).
|
||||
- É ação estruturante ou otimização de IA? $\rightarrow$ Registrar memória em `<base_projeto>/memorias-ia/sessao-AAAA-MM-DD-slug.md` e indexar em `historico-acoes.md` (Pilar 6).
|
||||
|
||||
2. **Documentar Antes de Codar**:
|
||||
- Redigir a documentação preliminar nos respectivos destinos e templates antes de iniciar a implementação.
|
||||
|
|
|
|||
|
|
@ -1,34 +1,38 @@
|
|||
---
|
||||
type: rule
|
||||
name: proibido-commit-ia
|
||||
description: A IA nunca pode executar git commit, git push ou qualquer operação que altere o histórico do repositório
|
||||
description: A IA nunca mexe no git da aplicação principal; commit e push são permitidos e obrigatórios exclusivamente no repositório da Wiki (../wiki)
|
||||
scope: global
|
||||
trigger: always_on
|
||||
updatedAt: "2026-06-19"
|
||||
updatedAt: "2026-09-05"
|
||||
---
|
||||
|
||||
# Regra: Proibido Commit pela IA
|
||||
# Regra: Proibido Commit pela IA na Aplicação e Exceção Obrigatória da Wiki
|
||||
|
||||
## Contexto
|
||||
|
||||
O controle de versão é responsabilidade exclusiva do usuário humano. A IA pode preparar alterações, criar arquivos, editar código e até sugerir mensagens de commit — mas NUNCA deve executar comandos que alterem o histórico do repositório.
|
||||
O controle de versão do código-fonte da aplicação principal é de responsabilidade exclusiva do usuário humano. A IA pode preparar alterações, criar arquivos, editar código e até sugerir mensagens de commit — mas NUNCA deve executar comandos que alterem o histórico do repositório da aplicação.
|
||||
|
||||
Por outro lado, o repositório central de documentação (`<base_projeto>/../wiki`), que hospeda a Wiki do Usuário (Pilar 3) e a Wiki de Desenvolvimento (Pilar 4), é uma base viva de documentação. Quando atualizado pelo agente (ex.: via `/doc`, `/documentacao` ou workflows DDD), o commit e o push DEVEM ser executados automaticamente pelo agente, restritos exclusivamente a esse repositório.
|
||||
|
||||
## Regra
|
||||
|
||||
A IA **NUNCA** deve executar os seguintes comandos (nem variações deles):
|
||||
### 1. Na Aplicação Principal (`<base_projeto>`) — RIGOROSAMENTE PROIBIDO MEXER NO GIT
|
||||
|
||||
- `git commit`
|
||||
- `git push`
|
||||
- `git merge`
|
||||
- `git rebase`
|
||||
- `git tag`
|
||||
- `git reset`
|
||||
- `git revert`
|
||||
- `git cherry-pick`
|
||||
- `git stash drop`
|
||||
- `git branch -d` / `git branch -D`
|
||||
A IA **NUNCA** deve executar comandos que alterem o histórico do repositório da aplicação (nem variações deles):
|
||||
|
||||
### Comandos permitidos (somente leitura e staging)
|
||||
- `git commit` ❌
|
||||
- `git push` ❌
|
||||
- `git merge` ❌
|
||||
- `git rebase` ❌
|
||||
- `git tag` ❌
|
||||
- `git reset` ❌
|
||||
- `git revert` ❌
|
||||
- `git cherry-pick` ❌
|
||||
- `git stash drop` ❌
|
||||
- `git branch -d` / `git branch -D` ❌
|
||||
|
||||
**Comandos permitidos na aplicação (somente leitura e staging):**
|
||||
|
||||
- `git status` ✅
|
||||
- `git diff` ✅
|
||||
|
|
@ -39,37 +43,52 @@ A IA **NUNCA** deve executar os seguintes comandos (nem variações deles):
|
|||
- `git ls-files` ✅
|
||||
- `git show` ✅
|
||||
|
||||
## Exemplos
|
||||
### 2. No Repositório da Wiki (`<base_projeto>/../wiki`) — COMMIT E PUSH OBRIGATÓRIOS
|
||||
|
||||
❌ **Errado** — commitar automaticamente:
|
||||
```sh
|
||||
git add -A && git commit -m "fix: corrigir bug"
|
||||
Sempre que a documentação em `<base_projeto>/../wiki` for criada ou modificada (manuais de usuário em `<modulo-id>/`, regras de negócio em `dev/<modulo-id>/`, ADRs em `dev/<modulo-id>/adrs/`, etc.), o agente **DEVE obrigatoriamente** realizar o commit e push das alterações:
|
||||
|
||||
```bash
|
||||
# Executar estritamente apontando para a pasta ../wiki
|
||||
git -C <base_projeto>/../wiki add -A
|
||||
git -C <base_projeto>/../wiki commit -m "docs(<modulo-id>): <descrição sucinta das alterações>"
|
||||
git -C <base_projeto>/../wiki push
|
||||
```
|
||||
|
||||
❌ **Errado** — push automático:
|
||||
**Fronteira Inegociável:** Esta permissão é restrita e isolada ao repositório `<base_projeto>/../wiki`. A IA **nunca** deve executar commit ou push na aplicação principal.
|
||||
|
||||
## Exemplos
|
||||
|
||||
### ❌ Errado — commitar automaticamente na aplicação
|
||||
```sh
|
||||
# Na raiz da aplicação (<base_projeto>): PROIBIDO
|
||||
git add -A && git commit -m "fix: corrigir bug"
|
||||
git push origin main
|
||||
```
|
||||
|
||||
✅ **Correto** — preparar e informar:
|
||||
### ✅ Correto — na aplicação principal, apenas preparar e sugerir
|
||||
```sh
|
||||
git add -A
|
||||
git status
|
||||
# Informar ao usuário: "Alterações staged. Revise e faça o commit quando estiver pronto."
|
||||
# Informar ao usuário: "Alterações staged na aplicação. Revise e faça o commit quando estiver pronto."
|
||||
# Sugestão de commit: git commit -m "feat: adicionar validação de schema"
|
||||
```
|
||||
|
||||
✅ **Correto** — sugerir mensagem de commit:
|
||||
```
|
||||
Sugestão de commit:
|
||||
git commit -m "feat: adicionar validação de schema no endpoint /usuarios"
|
||||
### ✅ Correto — na Wiki, commitar e enviar automaticamente
|
||||
```sh
|
||||
# No repositório de documentação (<base_projeto>/../wiki): OBRIGATÓRIO
|
||||
git -C ../wiki add -A
|
||||
git -C ../wiki commit -m "docs(e-licencie): atualizar regras de negócio e manuais"
|
||||
git -C ../wiki push
|
||||
```
|
||||
|
||||
## Impacto
|
||||
|
||||
- **Segurança:** o usuário mantém controle total sobre o que entra no histórico
|
||||
- **Revisão:** toda alteração pode ser inspecionada antes de ser commitada
|
||||
- **Reversibilidade:** evita commits acidentais que poluem o histórico
|
||||
- **Segurança na aplicação:** O desenvolvedor mantém controle total sobre o histórico de código da aplicação.
|
||||
- **Agilidade e perenidade na wiki:** A documentação fica sempre sincronizada e publicada imediatamente sem fricção manual.
|
||||
- **Isolamento de escopo:** Fronteira clara e explícita entre repositório de aplicação e repositório de documentação.
|
||||
|
||||
## Referências
|
||||
|
||||
- Princípio de autonomia controlada: a IA executa, o humano decide
|
||||
- Rule: `rules/ddd-documentacao-primeiro.md`
|
||||
- Skill: `skills/documentacao/SKILL.md`
|
||||
- Workflow: `global/workflows/documentacao.md`
|
||||
|
|
|
|||
|
|
@ -1,13 +1,13 @@
|
|||
---
|
||||
name: doc
|
||||
description: Alias rápido para /documentacao - acionar o Agente de Documentação & Memória
|
||||
description: Alias rápido para /documentacao - acionar o Agente de Documentação & Memória com versionamento automático na Wiki
|
||||
scope: global
|
||||
updatedAt: "2026-09-01"
|
||||
updatedAt: "2026-09-05"
|
||||
---
|
||||
|
||||
# Skill: /doc (Alias para /documentacao)
|
||||
|
||||
Atalho rápido para o **Agente de Documentação & Memória** cobrindo os 6 pilares canônicos:
|
||||
Atalho rápido para o **Agente de Documentação & Memória** cobrindo os 6 pilares canônicos do Documentation-Driven Development (DDD):
|
||||
|
||||
> ⚡ **Modo Padrão Sem Parâmetros:** Se executado apenas como `/doc`, documenta e sincroniza automaticamente todo o contexto e decisões da conversa atual no chat.
|
||||
|
||||
|
|
@ -16,6 +16,35 @@ Atalho rápido para o **Agente de Documentação & Memória** cobrindo os 6 pila
|
|||
- `3. Wiki Usuário` $\rightarrow$ `<base_projeto>/../wiki/<modulo>/` (VitePress com acesso dos usuários)
|
||||
- `4. Wiki Dev` $\rightarrow$ `<base_projeto>/../wiki/dev/<modulo>/` (VitePress com acesso interno dev e regras `{modulo}.regras-negocio.md`)
|
||||
- `5. Rota IA` $\rightarrow$ Rota do backend `/llm.md`
|
||||
- `6. Memória IA` $\rightarrow$ `<base_projeto>/memorias-ia/`
|
||||
- `6. Memória IA` $\rightarrow$ `<base_projeto>/memorias-ia/` (gera `sessao-AAAA-MM-DD-slug.md` e indexa no arquivo central `historico-acoes.md`)
|
||||
|
||||
Para ver a documentação completa e exemplos, consulte [`skills/documentacao/SKILL.md`](file:///home/luiz/Arquivos/DEV/Industria/SIGMA2026/.agent/skills/documentacao/SKILL.md).
|
||||
---
|
||||
|
||||
## 🧠 Pilar 6: Memória da IA e Histórico de Ações (`memorias-ia/`)
|
||||
|
||||
Ao documentar a sessão (seja via `/doc` ou `/documentacao`):
|
||||
1. **Arquivo da Sessão:** O agente gera o registro detalhado em `<base_projeto>/memorias-ia/sessao-AAAA-MM-DD-slug.md` descrevendo contexto, causa raiz, solução técnica, citações no código-fonte e validações.
|
||||
2. **Índice de Ações (`historico-acoes.md`):** O agente registra/atualiza a linha correspondente na tabela de `<base_projeto>/memorias-ia/historico-acoes.md`:
|
||||
```markdown
|
||||
| Data | Memória / Ação | Arquivo Memoria | Citações no Código-Fonte |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| **AAAA-MM-DD** | [Descrição da Ação] | [`sessao-AAAA-MM-DD-slug.md`](./sessao-AAAA-MM-DD-slug.md) | `caminho/arquivo.ts`<br>`outro/arquivo.vue` |
|
||||
```
|
||||
|
||||
|
||||
## 🔄 Versionamento Git Obrigatório da Wiki (`<base_projeto>/../wiki`)
|
||||
|
||||
Sempre que a documentação na Wiki (Pilares 3 e 4) for alterada ou criada:
|
||||
- O agente **DEVE obrigatoriamente executar commit e push** das alterações exclusivamente no repositório da Wiki:
|
||||
```bash
|
||||
git -C <base_projeto>/../wiki add -A
|
||||
git -C <base_projeto>/../wiki commit -m "docs(<modulo-id>): sincronizar documentação"
|
||||
git -C <base_projeto>/../wiki push
|
||||
```
|
||||
|
||||
> 🔒 **Fronteira Inegociável de Git:**
|
||||
> Na aplicação principal (`<base_projeto>`), o agente **NUNCA pode mexer no git** (proibido `git commit`, `git push`, `git merge`, etc.). O controle de versão do código da aplicação é de responsabilidade humana exclusiva (ver `rules/proibido-commit-ia.md`).
|
||||
|
||||
---
|
||||
|
||||
Para ver a especificação completa, comandos com argumentos e exemplos, consulte [`skills/documentacao/SKILL.md`](../documentacao/SKILL.md).
|
||||
|
|
|
|||
|
|
@ -1,13 +1,13 @@
|
|||
---
|
||||
name: doc
|
||||
description: Alias rápido para /documentacao - acionar o Agente de Documentação & Memória
|
||||
description: Alias rápido para /documentacao - acionar o Agente de Documentação & Memória com versionamento automático na Wiki
|
||||
scope: global
|
||||
updatedAt: "2026-09-01"
|
||||
updatedAt: "2026-09-05"
|
||||
---
|
||||
|
||||
# Skill: /doc (Alias para /documentacao)
|
||||
|
||||
Atalho rápido para o **Agente de Documentação & Memória** cobrindo os 6 pilares canônicos:
|
||||
Atalho rápido para o **Agente de Documentação & Memória** cobrindo os 6 pilares canônicos do Documentation-Driven Development (DDD):
|
||||
|
||||
> ⚡ **Modo Padrão Sem Parâmetros:** Se executado apenas como `/doc`, documenta e sincroniza automaticamente todo o contexto e decisões da conversa atual no chat.
|
||||
|
||||
|
|
@ -16,6 +16,35 @@ Atalho rápido para o **Agente de Documentação & Memória** cobrindo os 6 pila
|
|||
- `3. Wiki Usuário` $\rightarrow$ `<base_projeto>/../wiki/<modulo>/` (VitePress com acesso dos usuários)
|
||||
- `4. Wiki Dev` $\rightarrow$ `<base_projeto>/../wiki/dev/<modulo>/` (VitePress com acesso interno dev e regras `{modulo}.regras-negocio.md`)
|
||||
- `5. Rota IA` $\rightarrow$ Rota do backend `/llm.md`
|
||||
- `6. Memória IA` $\rightarrow$ `<base_projeto>/memorias-ia/`
|
||||
- `6. Memória IA` $\rightarrow$ `<base_projeto>/memorias-ia/` (gera `sessao-AAAA-MM-DD-slug.md` e indexa no arquivo central `historico-acoes.md`)
|
||||
|
||||
Para ver a documentação completa e exemplos, consulte [`skills/documentacao/SKILL.md`](file:///home/luiz/Arquivos/DEV/Industria/SIGMA2026/.agent/skills/documentacao/SKILL.md).
|
||||
---
|
||||
|
||||
## 🧠 Pilar 6: Memória da IA e Histórico de Ações (`memorias-ia/`)
|
||||
|
||||
Ao documentar a sessão (seja via `/doc` ou `/documentacao`):
|
||||
1. **Arquivo da Sessão:** O agente gera o registro detalhado em `<base_projeto>/memorias-ia/sessao-AAAA-MM-DD-slug.md` descrevendo contexto, causa raiz, solução técnica, citações no código-fonte e validações.
|
||||
2. **Índice de Ações (`historico-acoes.md`):** O agente registra/atualiza a linha correspondente na tabela de `<base_projeto>/memorias-ia/historico-acoes.md`:
|
||||
```markdown
|
||||
| Data | Memória / Ação | Arquivo Memoria | Citações no Código-Fonte |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| **AAAA-MM-DD** | [Descrição da Ação] | [`sessao-AAAA-MM-DD-slug.md`](./sessao-AAAA-MM-DD-slug.md) | `caminho/arquivo.ts`<br>`outro/arquivo.vue` |
|
||||
```
|
||||
|
||||
|
||||
## 🔄 Versionamento Git Obrigatório da Wiki (`<base_projeto>/../wiki`)
|
||||
|
||||
Sempre que a documentação na Wiki (Pilares 3 e 4) for alterada ou criada:
|
||||
- O agente **DEVE obrigatoriamente executar commit e push** das alterações exclusivamente no repositório da Wiki:
|
||||
```bash
|
||||
git -C <base_projeto>/../wiki add -A
|
||||
git -C <base_projeto>/../wiki commit -m "docs(<modulo-id>): sincronizar documentação"
|
||||
git -C <base_projeto>/../wiki push
|
||||
```
|
||||
|
||||
> 🔒 **Fronteira Inegociável de Git:**
|
||||
> Na aplicação principal (`<base_projeto>`), o agente **NUNCA pode mexer no git** (proibido `git commit`, `git push`, `git merge`, etc.). O controle de versão do código da aplicação é de responsabilidade humana exclusiva (ver `rules/proibido-commit-ia.md`).
|
||||
|
||||
---
|
||||
|
||||
Para ver a especificação completa, comandos com argumentos e exemplos, consulte [`skills/documentacao/SKILL.md`](../documentacao/SKILL.md).
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
name: documentacao
|
||||
description: Acionar o Agente de Documentação & Memória para documentar o contexto da conversa ou gerar artefatos nos 6 pilares canônicos
|
||||
description: Acionar o Agente de Documentação & Memória para documentar o contexto da conversa ou gerar artefatos nos 6 pilares canônicos com versionamento automático na Wiki
|
||||
scope: global
|
||||
updatedAt: "2026-09-01"
|
||||
updatedAt: "2026-09-05"
|
||||
---
|
||||
|
||||
# Skill / Workflow: /documentacao
|
||||
|
|
@ -20,7 +20,15 @@ Esta skill aciona o **Agente de Documentação & Memória** para gerar, atualiza
|
|||
3. **Pilar 3 (Wiki do Usuário):** Atualiza tutoriais e manuais em `<base_projeto>/../wiki/<modulo>/` (aplicação VitePress com acesso dos usuários).
|
||||
4. **Pilar 4 (Wiki de Desenvolvimento):** Documenta regras de negócio (`{modulo}.regras-negocio.md`), modelos e ADRs em `<base_projeto>/../wiki/dev/<modulo>/` (aplicação VitePress com acesso interno dev).
|
||||
5. **Pilar 5 (Rota IA):** Assegura que novos schemas e rotas estejam refletidos na rota `/llm.md`.
|
||||
6. **Pilar 6 (Memória IA):** Registra o relatório completo da sessão em `<base_projeto>/memorias-ia/`.
|
||||
6. **Pilar 6 (Memória IA):** Registra o relatório completo da sessão no arquivo individual `<base_projeto>/memorias-ia/sessao-AAAA-MM-DD-slug.md` e atualiza o índice central `<base_projeto>/memorias-ia/historico-acoes.md` adicionando a linha correspondente na tabela com as colunas: `Data | Memória / Ação | Arquivo Memoria | Citações no Código-Fonte`.
|
||||
7. **Sincronização Git da Wiki (Obrigatório e Exclusivo):**
|
||||
- Se houver arquivos novos ou alterados em `<base_projeto>/../wiki/`:
|
||||
```bash
|
||||
git -C <base_projeto>/../wiki add -A
|
||||
git -C <base_projeto>/../wiki commit -m "docs(<modulo-id>): sincronizar documentação [contexto]"
|
||||
git -C <base_projeto>/../wiki push
|
||||
```
|
||||
- **Trava de Segurança da Aplicação:** Na aplicação (`<base_projeto>`), o agente **NÃO pode mexer no git** (o versionamento do código-fonte da aplicação permanece sob controle humano exclusivo).
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -33,7 +41,7 @@ Esta skill aciona o **Agente de Documentação & Memória** para gerar, atualiza
|
|||
| **3. Wiki do Usuário** | `<base_projeto>/../wiki/<modulo>/` | Usuários / Clientes | Aplicação VitePress com acesso dos usuários (manuais, tutoriais e fluxos). |
|
||||
| **4. Wiki de Desenvolvimento** | `<base_projeto>/../wiki/dev/<modulo>/` | Desenvolvedores / Arquitetos | Aplicação VitePress com acesso interno dev: regras de negócio (`{modulo}.regras-negocio.md`), arquitetura e ADRs (`adrs/`). |
|
||||
| **5. Integração de IA** | Rota Backend `/llm.md` | Agentes de IA / LLMs | Catálogo de schemas Zod, enums e contratos para consumo por LLMs. |
|
||||
| **6. Memória da IA** | `<base_projeto>/memorias-ia/` | Agentes de IA / Auditoria | Registros de sessões, otimizações executadas e decisões históricas. |
|
||||
| **6. Memória da IA** | `<base_projeto>/memorias-ia/` | Agentes de IA / Auditoria | `modulo.yml` (identidade), índice `historico-acoes.md` (`Data \| Memória / Ação \| Arquivo Memoria \| Citações no Código-Fonte`) e sessões individuais `sessao-AAAA-MM-DD-slug.md`. |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -49,16 +57,18 @@ Esta skill aciona o **Agente de Documentação & Memória** para gerar, atualiza
|
|||
# Criar ajuda contextual modalX.ajuda.md para modal/tela
|
||||
/documentacao ajuda <caminho/modalX.vue>
|
||||
|
||||
# Documentar domínio na Wiki do Usuário (VitePress)
|
||||
# Documentar domínio na Wiki do Usuário (VitePress) + commit/push na wiki
|
||||
/documentacao wiki-usuario <modulo>
|
||||
|
||||
# Documentar regras de negócio na Wiki Dev (VitePress)
|
||||
# Documentar regras de negócio na Wiki Dev (VitePress) + commit/push na wiki
|
||||
/documentacao regras <caminho/servico.ts>
|
||||
|
||||
# Criar um ADR na Wiki Dev
|
||||
# Criar um ADR na Wiki Dev + commit/push na wiki
|
||||
/documentacao adr "<Título da Decisão>"
|
||||
```
|
||||
|
||||
*Nota:* Qualquer comando que crie ou modifique arquivos na Wiki (`<base_projeto>/../wiki`) deve finalizar executando `git add`, `git commit` e `git push` dentro de `../wiki`.
|
||||
|
||||
---
|
||||
|
||||
## 🔒 Regras Inegociáveis
|
||||
|
|
@ -67,3 +77,4 @@ Esta skill aciona o **Agente de Documentação & Memória** para gerar, atualiza
|
|||
2. **Linguagem acessível no usuário:** Sem termos técnicos de TI na Wiki do Usuário ou em `.ajuda.md`.
|
||||
3. **JSDoc de Aplicação:** Explicar a utilidade prática no sistema, não apenas repetir tipos.
|
||||
4. **Polimorfismo:** O `.agent` é genérico; personalizações ficam em `./memorias-ia/` e `<base_projeto>/../wiki/`.
|
||||
5. **Fronteira Git e Push Obrigatório na Wiki:** Toda atualização em `<base_projeto>/../wiki` DEVE ser commitada e enviada via `git push` exclusivamente dentro do diretório `../wiki`. Na aplicação principal (`<base_projeto>`), a IA nunca mexe no Git (ver `rules/proibido-commit-ia.md`).
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
name: documentacao
|
||||
description: Acionar o Agente de Documentação & Memória para documentar o contexto da conversa ou gerar artefatos nos 6 pilares canônicos
|
||||
description: Acionar o Agente de Documentação & Memória para documentar o contexto da conversa ou gerar artefatos nos 6 pilares canônicos com versionamento automático na Wiki
|
||||
scope: global
|
||||
updatedAt: "2026-09-01"
|
||||
updatedAt: "2026-09-05"
|
||||
---
|
||||
|
||||
# Skill / Workflow: /documentacao
|
||||
|
|
@ -20,7 +20,15 @@ Esta skill aciona o **Agente de Documentação & Memória** para gerar, atualiza
|
|||
3. **Pilar 3 (Wiki do Usuário):** Atualiza tutoriais e manuais em `<base_projeto>/../wiki/<modulo>/` (aplicação VitePress com acesso dos usuários).
|
||||
4. **Pilar 4 (Wiki de Desenvolvimento):** Documenta regras de negócio (`{modulo}.regras-negocio.md`), modelos e ADRs em `<base_projeto>/../wiki/dev/<modulo>/` (aplicação VitePress com acesso interno dev).
|
||||
5. **Pilar 5 (Rota IA):** Assegura que novos schemas e rotas estejam refletidos na rota `/llm.md`.
|
||||
6. **Pilar 6 (Memória IA):** Registra o relatório completo da sessão em `<base_projeto>/memorias-ia/`.
|
||||
6. **Pilar 6 (Memória IA):** Registra o relatório completo da sessão no arquivo individual `<base_projeto>/memorias-ia/sessao-AAAA-MM-DD-slug.md` e atualiza o índice central `<base_projeto>/memorias-ia/historico-acoes.md` adicionando a linha correspondente na tabela com as colunas: `Data | Memória / Ação | Arquivo Memoria | Citações no Código-Fonte`.
|
||||
7. **Sincronização Git da Wiki (Obrigatório e Exclusivo):**
|
||||
- Se houver arquivos novos ou alterados em `<base_projeto>/../wiki/`:
|
||||
```bash
|
||||
git -C <base_projeto>/../wiki add -A
|
||||
git -C <base_projeto>/../wiki commit -m "docs(<modulo-id>): sincronizar documentação [contexto]"
|
||||
git -C <base_projeto>/../wiki push
|
||||
```
|
||||
- **Trava de Segurança da Aplicação:** Na aplicação (`<base_projeto>`), o agente **NÃO pode mexer no git** (o versionamento do código-fonte da aplicação permanece sob controle humano exclusivo).
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -33,7 +41,7 @@ Esta skill aciona o **Agente de Documentação & Memória** para gerar, atualiza
|
|||
| **3. Wiki do Usuário** | `<base_projeto>/../wiki/<modulo>/` | Usuários / Clientes | Aplicação VitePress com acesso dos usuários (manuais, tutoriais e fluxos). |
|
||||
| **4. Wiki de Desenvolvimento** | `<base_projeto>/../wiki/dev/<modulo>/` | Desenvolvedores / Arquitetos | Aplicação VitePress com acesso interno dev: regras de negócio (`{modulo}.regras-negocio.md`), arquitetura e ADRs (`adrs/`). |
|
||||
| **5. Integração de IA** | Rota Backend `/llm.md` | Agentes de IA / LLMs | Catálogo de schemas Zod, enums e contratos para consumo por LLMs. |
|
||||
| **6. Memória da IA** | `<base_projeto>/memorias-ia/` | Agentes de IA / Auditoria | Registros de sessões, otimizações executadas e decisões históricas. |
|
||||
| **6. Memória da IA** | `<base_projeto>/memorias-ia/` | Agentes de IA / Auditoria | `modulo.yml` (identidade), índice `historico-acoes.md` (`Data \| Memória / Ação \| Arquivo Memoria \| Citações no Código-Fonte`) e sessões individuais `sessao-AAAA-MM-DD-slug.md`. |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -49,16 +57,18 @@ Esta skill aciona o **Agente de Documentação & Memória** para gerar, atualiza
|
|||
# Criar ajuda contextual modalX.ajuda.md para modal/tela
|
||||
/documentacao ajuda <caminho/modalX.vue>
|
||||
|
||||
# Documentar domínio na Wiki do Usuário (VitePress)
|
||||
# Documentar domínio na Wiki do Usuário (VitePress) + commit/push na wiki
|
||||
/documentacao wiki-usuario <modulo>
|
||||
|
||||
# Documentar regras de negócio na Wiki Dev (VitePress)
|
||||
# Documentar regras de negócio na Wiki Dev (VitePress) + commit/push na wiki
|
||||
/documentacao regras <caminho/servico.ts>
|
||||
|
||||
# Criar um ADR na Wiki Dev
|
||||
# Criar um ADR na Wiki Dev + commit/push na wiki
|
||||
/documentacao adr "<Título da Decisão>"
|
||||
```
|
||||
|
||||
*Nota:* Qualquer comando que crie ou modifique arquivos na Wiki (`<base_projeto>/../wiki`) deve finalizar executando `git add`, `git commit` e `git push` dentro de `../wiki`.
|
||||
|
||||
---
|
||||
|
||||
## 🔒 Regras Inegociáveis
|
||||
|
|
@ -67,3 +77,4 @@ Esta skill aciona o **Agente de Documentação & Memória** para gerar, atualiza
|
|||
2. **Linguagem acessível no usuário:** Sem termos técnicos de TI na Wiki do Usuário ou em `.ajuda.md`.
|
||||
3. **JSDoc de Aplicação:** Explicar a utilidade prática no sistema, não apenas repetir tipos.
|
||||
4. **Polimorfismo:** O `.agent` é genérico; personalizações ficam em `./memorias-ia/` e `<base_projeto>/../wiki/`.
|
||||
5. **Fronteira Git e Push Obrigatório na Wiki:** Toda atualização em `<base_projeto>/../wiki` DEVE ser commitada e enviada via `git push` exclusivamente dentro do diretório `../wiki`. Na aplicação principal (`<base_projeto>`), a IA nunca mexe no Git (ver `rules/proibido-commit-ia.md`).
|
||||
|
|
|
|||
|
|
@ -103,3 +103,4 @@ Se o módulo introduziu ou alterou arquitetura ou regras consolidadas do módulo
|
|||
- Atualizar a especificação técnica na **Wiki de Desenvolvimento** em `<base_projeto>/../wiki/dev/<modulo>/`.
|
||||
- Criar ou atualizar ADR em `<base_projeto>/../wiki/dev/<modulo>/adrs/` via skill `documentar-decisao-tecnica`.
|
||||
- Registrar decisões e ações na memória em `<base_projeto>/memorias-ia/`.
|
||||
- **Sincronização Git:** Executar commit e push exclusivamente na Wiki (`git -C <base_projeto>/../wiki add -A && git -C <base_projeto>/../wiki commit -m "docs(<modulo-id>): regras de negócio" && git -C <base_projeto>/../wiki push`). Na aplicação (`<base_projeto>`), nunca mexer no git.
|
||||
|
|
|
|||
|
|
@ -70,6 +70,16 @@ if [ -f "$MODULO_YML" ]; then
|
|||
echo -e " ${VERMELHO}✗${RESET} Chave 'modulo-tipo' ausente."
|
||||
TOTAL_ERROS=$((TOTAL_ERROS + 1))
|
||||
fi
|
||||
|
||||
# Validar memorias-ia/historico-acoes.md (Pilar 6 - Índice de Ações)
|
||||
HISTORICO_MD="$ROOT_DIR/memorias-ia/historico-acoes.md"
|
||||
if [ -f "$HISTORICO_MD" ]; then
|
||||
echo -e " ${VERDE}✓${RESET} Índice memorias-ia/historico-acoes.md encontrado."
|
||||
else
|
||||
echo -e " ${AMARELO}⚠${RESET} Arquivo memorias-ia/historico-acoes.md não encontrado."
|
||||
echo -e " Execute: cp .agent/DOCUMENTACAO/templates/historico-acoes.md.template memorias-ia/historico-acoes.md"
|
||||
TOTAL_AVISOS=$((TOTAL_AVISOS + 1))
|
||||
fi
|
||||
else
|
||||
echo -e " ${VERMELHO}✗ CRÍTICO: Arquivo memorias-ia/modulo.yml NÃO encontrado!${RESET}"
|
||||
echo -e " Execute: cp .agent/DOCUMENTACAO/templates/modulo.yml.template memorias-ia/modulo.yml"
|
||||
|
|
@ -79,7 +89,7 @@ fi
|
|||
# 2. Validar Wiki do Usuário (Pilar 3)
|
||||
echo -e "\n${NEGRITO}[2/6] Wiki do Usuário (Pilar 3)${RESET}"
|
||||
if [ -n "$MODULO_ID" ]; then
|
||||
WIKI_USER_DIR="$ROOT_DIR/<base_projeto>/../wiki/$MODULO_ID"
|
||||
WIKI_USER_DIR="$ROOT_DIR/../wiki/$MODULO_ID"
|
||||
if [ -d "$WIKI_USER_DIR" ]; then
|
||||
echo -e " ${VERDE}✓${RESET} Diretório encontrado em: <base_projeto>/../wiki/$MODULO_ID/"
|
||||
else
|
||||
|
|
@ -93,7 +103,7 @@ fi
|
|||
# 3. Validar Wiki de Desenvolvimento (Pilar 4)
|
||||
echo -e "\n${NEGRITO}[3/6] Wiki de Desenvolvimento (Pilar 4)${RESET}"
|
||||
if [ -n "$MODULO_ID" ]; then
|
||||
WIKI_DEV_DIR="$ROOT_DIR/<base_projeto>/../wiki/dev/$MODULO_ID"
|
||||
WIKI_DEV_DIR="$ROOT_DIR/../wiki/dev/$MODULO_ID"
|
||||
if [ -d "$WIKI_DEV_DIR" ]; then
|
||||
echo -e " ${VERDE}✓${RESET} Diretório encontrado em: <base_projeto>/../wiki/dev/$MODULO_ID/"
|
||||
else
|
||||
|
|
@ -106,7 +116,7 @@ fi
|
|||
|
||||
# 4. Validar Integração de IA (/llm.md - Pilar 5)
|
||||
echo -e "\n${NEGRITO}[4/6] Integração de IA /llm.md (Pilar 5)${RESET}"
|
||||
BACK_DIRS=$(find "$ROOT_DIR" -maxdepth 2 -name "*-back" -type d 2>/dev/null || true)
|
||||
BACK_DIRS=$(find "$ROOT_DIR" -maxdepth 2 -iname "*-back" -type d 2>/dev/null || true)
|
||||
if [ -n "$BACK_DIRS" ]; then
|
||||
if grep -rq "llm\.md" $BACK_DIRS/src 2>/dev/null; then
|
||||
echo -e " ${VERDE}✓${RESET} Rota /llm.md configurada no backend."
|
||||
|
|
|
|||
|
|
@ -17,6 +17,9 @@ RESULTADO=$(
|
|||
-name node_modules -o \
|
||||
-name .git -o \
|
||||
-name dist -o \
|
||||
-name .output -o \
|
||||
-name .nuxt -o \
|
||||
-name .cache -o \
|
||||
-name build \
|
||||
\) -prune \
|
||||
-o \
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue