feat(identidade): padronizar modulo-acesso e modulo-wiki no framework e validar-setup
This commit is contained in:
parent
d43631be13
commit
19df29ea45
18 changed files with 193 additions and 104 deletions
|
|
@ -1,18 +1,18 @@
|
|||
---
|
||||
type: rule
|
||||
name: identidade-modulo
|
||||
description: Identificação obrigatória do projeto/módulo via memorias-ia/modulo.yml (modulo-id, modulo-caminho, modulo-descricao, modulo-tipo).
|
||||
description: Identificação obrigatória do projeto/módulo via memorias-ia/modulo.yml (modulo-id, modulo-caminho, modulo-descricao, modulo-tipo, modulo-acesso, modulo-wiki).
|
||||
scope: global
|
||||
trigger: always_on
|
||||
priority: critica
|
||||
updatedAt: "2026-09-02"
|
||||
updatedAt: "2026-10-06"
|
||||
---
|
||||
|
||||
# Regra: Identidade do Projeto via `memorias-ia/modulo.yml`
|
||||
|
||||
## Contexto
|
||||
|
||||
O framework `.agent` é polimórfico e genérico, sendo compartilhado como submódulo Git entre múltiplos projetos do ecossistema. Para que qualquer agente saiba com precisão e sem ambiguidades qual é o projeto hospedeiro, seu identificador canônico, suas rotas de URL, sua descrição e sua stack técnica, a identidade do módulo é centralizada em um arquivo padronizado.
|
||||
O framework `.agent` é polimórfico e genérico, sendo compartilhado como submódulo Git entre múltiplos projetos do ecossistema. Para que qualquer agente saiba com precisão e sem ambiguidades qual é o projeto hospedeiro, seu identificador canônico, suas rotas de URL, sua descrição, sua stack técnica, suas credenciais de teste e o caminho da sua Wiki, a identidade do módulo é centralizada em um arquivo padronizado.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -30,13 +30,21 @@ Caso o arquivo não exista ou esteja incompleto ao iniciar uma interação em um
|
|||
|
||||
## Estrutura Canônica de `memorias-ia/modulo.yml`
|
||||
|
||||
O arquivo deve conter estritamente as 4 chaves abaixo:
|
||||
O arquivo contém os seguintes campos estruturados:
|
||||
|
||||
```yaml
|
||||
modulo-id: <identificador-do-modulo>
|
||||
modulo-caminho: <rota-na-url>
|
||||
modulo-descricao: <texto-descritivo>
|
||||
modulo-tipo: <texto-tipo-arquitetura>
|
||||
|
||||
# Credenciais padrão para autenticação em testes (agent-browser, E2E, QA)
|
||||
modulo-acesso:
|
||||
usuario: <login-ou-email>
|
||||
senha: <senha-de-teste>
|
||||
|
||||
# Caminho para o repositório da Wiki do projeto (quando omitido ou vazio, o padrão é ../wiki/)
|
||||
modulo-wiki: <caminho-da-wiki>
|
||||
```
|
||||
|
||||
### Definição dos Campos
|
||||
|
|
@ -47,15 +55,19 @@ modulo-tipo: <texto-tipo-arquitetura>
|
|||
| **`modulo-caminho`** | `string` | Rota / prefixo utilizado na URL e navegação do módulo (base route para front, proxy e endpoints). | `/sigma/` |
|
||||
| **`modulo-descricao`** | `string` | Descrição textual do propósito funcional e escopo de negócio do módulo. | `Módulo para gestão de monitoramentos ambientais` |
|
||||
| **`modulo-tipo`** | `string` | Descrição textual da arquitetura e tecnologias empregadas no módulo. | `aplicação web com back e front nas tecnologias bun e vue 3 com banco postgres` |
|
||||
| **`modulo-acesso`** | `object` | Credenciais padrão (`usuario` e `senha`) para autenticação determinística por agentes de teste (`@testes`, QA, `agent-browser`). | `{ usuario: "admin@gov.br", senha: "123" }` |
|
||||
| **`modulo-wiki`** | `string` | Caminho relativo ou absoluto da Wiki do projeto (VitePress). **Fallback obrigatório:** se omitido ou vazio, assume-se `../wiki/`. | `./QUIPO-WIKI` ou `../wiki` |
|
||||
|
||||
---
|
||||
|
||||
## Regra Universal de Consulta
|
||||
|
||||
Sempre que qualquer agente, persona, workflow ou skill necessitar de:
|
||||
1. **Nome ou ID do módulo (`modulo-id`)**: para criar ou referenciar documentação na Wiki do Usuário (`<base_projeto>/../wiki/<modulo-id>/`), Wiki de Desenvolvimento (`<base_projeto>/../wiki/dev/<modulo-id>/`), regras de negócio (`{modulo}.regras-negocio.md`), ADRs (`<base_projeto>/../wiki/dev/<modulo-id>/adrs/`) ou relatórios;
|
||||
1. **Nome ou ID do módulo (`modulo-id`)**: para criar ou referenciar documentação na Wiki do Usuário (`<modulo-wiki>/<modulo-id>/`), Wiki de Desenvolvimento (`<modulo-wiki>/dev/<modulo-id>/`), regras de negócio (`{modulo}.regras-negocio.md`), ADRs (`<modulo-wiki>/dev/<modulo-id>/adrs/`) ou relatórios;
|
||||
2. **Rota ou URL base (`modulo-caminho`)**: para configurar rotas frontend, rotas backend, endpoints de documentação de IA (`/llm.md` e `<modulo-caminho>llm.md`), links de navegação ou proxies;
|
||||
3. **Propósito ou Stack (`modulo-descricao` e `modulo-tipo`)**: para contextualizar novos agentes, gerar propostas comerciais, marketing, reels, análises de arquitetura ou testes;
|
||||
4. **Credenciais de Testes (`modulo-acesso`)**: O agente de testes (`@testes`, rotinas com `agent-browser`, QA) DEVE extrair `usuario` e `senha` de `modulo-acesso` em `memorias-ia/modulo.yml` para autenticação determinística em rotinas de teste e validação de interface;
|
||||
5. **Caminho da Wiki (`modulo-wiki`)**: Qualquer operação de documentação, leitura de regras ou commit na Wiki deve resolver o caminho a partir de `modulo-wiki`, adotando compulsoriamente `../wiki/` caso a chave não esteja presente ou esteja vazia.
|
||||
|
||||
👉 **O agente DEVE obrigatoriamente ler e extrair as informações de `memorias-ia/modulo.yml`.**
|
||||
|
||||
|
|
@ -63,8 +75,8 @@ Sempre que qualquer agente, persona, workflow ou skill necessitar de:
|
|||
|
||||
## Proibições
|
||||
|
||||
- **NUNCA** assumir, deduzir ou "chutar" o ID ou a rota do módulo via heurísticas incertas quando o arquivo existir.
|
||||
- **NUNCA** codificar IDs ou rotas de módulos hardcoded em regras e artefatos globais do `.agent`.
|
||||
- **NUNCA** assumir, deduzir ou "chutar" o ID, a rota, credenciais de teste ou caminho de wiki via heurísticas incertas quando o arquivo existir.
|
||||
- **NUNCA** codificar IDs, rotas ou credenciais hardcoded em regras e artefatos globais do `.agent`.
|
||||
- **NUNCA** deletar ou corromper o arquivo `memorias-ia/modulo.yml`.
|
||||
|
||||
---
|
||||
|
|
@ -73,5 +85,6 @@ Sempre que qualquer agente, persona, workflow ou skill necessitar de:
|
|||
|
||||
- Rule: `global/rules/ddd-documentacao-primeiro.md`
|
||||
- Rule: `global/rules/regras-negocio-md.md`
|
||||
- Rule: `global/rules/testes-interface-agent-browser.md`
|
||||
- Template: `.agent/DOCUMENTACAO/templates/modulo.yml.template`
|
||||
- Hub: `.agent/DOCUMENTACAO/README`
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue