.agent/global/rules/identidade-modulo.md

3.6 KiB

type name description scope trigger priority updatedAt
rule identidade-modulo Identificação obrigatória do projeto/módulo via memorias-ia/modulo.yml (modulo-id, modulo-caminho, modulo-descricao, modulo-tipo). global always_on critica 2026-09-02

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.


Regra de Existência Obrigatória

Todo projeto que utiliza o .agent DEVE conter obrigatoriamente na raiz do projeto pai o arquivo:

<base_projeto>/memorias-ia/modulo.yml

Caso o arquivo não exista ou esteja incompleto ao iniciar uma interação em um novo projeto, a prioridade máxima do agente é diagnosticá-lo e criá-lo/solicitá-lo com base no template antes de executar qualquer implementação.


Estrutura Canônica de memorias-ia/modulo.yml

O arquivo deve conter estritamente as 4 chaves abaixo:

modulo-id: <identificador-do-modulo>
modulo-caminho: <rota-na-url>
modulo-descricao: <texto-descritivo>
modulo-tipo: <texto-tipo-arquitetura>

Definição dos Campos

Campo Tipo Descrição Exemplo
modulo-id string Identificador único do módulo no ecossistema. Utilizado para compor nomes de pacotes, pastas de wiki e referências de regras de negócio. e-licencie.sigma
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

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;
  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;

👉 O agente DEVE obrigatoriamente ler e extrair as informações de memorias-ia/modulo.yml.


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 deletar ou corromper o arquivo memorias-ia/modulo.yml.

Referências

  • Rule: global/rules/ddd-documentacao-primeiro.md
  • Rule: global/rules/regras-negocio-md.md
  • Template: .agent/DOCUMENTACAO/templates/modulo.yml.template
  • Hub: .agent/DOCUMENTACAO/README