--- name: documentar-dominio-modulo scope: global updatedAt: "2026-06-01" description: > Guia para documentar o domínio científico/técnico de cada módulo SaaS, garantindo que o agente compreenda a terminologia e as regras do domínio ao gerar código, texto e interface. --- # Skill: Documentar Domínio de um Módulo Use esta skill ao iniciar um novo módulo SaaS ou ao perceber que o agente não conhece o vocabulário e as regras do domínio que o módulo aborda. Cada módulo opera em uma disciplina diferente da ciência/gestão ambiental (licenciamento, gases de efeito estufa, resíduos, projetos, etc.). O agente precisa de uma **base factual do domínio** para gerar labels, mensagens, regras de negócio e textos comerciais corretos. --- ## PASSO 1 — Identificar o Domínio do Módulo Determinar qual área da ciência/gestão o módulo aborda: | Exemplo de módulo | Domínio | |---|---| | Licenciamento | Licenciamento ambiental (LP, LI, LO, condicionantes) | | GEE | Gases de Efeito Estufa (inventário, emissões, fatores) | | Resíduos | Gestão de resíduos sólidos (PGRS, MTR, classificação) | | Outorga | Outorga de uso de recursos hídricos | | Flora/Fauna | Monitoramento de biodiversidade | | Projetos | Gestão de projetos ambientais e consultorias | --- ## PASSO 2 — Criar o Arquivo de Domínio Criar em `.agent/memoria/dominio-.md`: ```markdown # Domínio: ## Área de Conhecimento Breve descrição da disciplina (1-3 linhas). ## Glossário do Módulo | Termo | Definição | Sigla | |---|---|---| | Licença Prévia | Autorização para planejamento do empreendimento | LP | | Licença de Instalação | Autorização para início das obras | LI | | ... | ... | ... | ## Entidades Principais Lista das entidades de negócio do módulo com descrição e relações: - **Empreendimento**: unidade física onde ocorre a atividade potencialmente poluidora - **Licença**: autorização ambiental vinculada a um empreendimento - **Condicionante**: obrigação imposta pelo órgão ambiental na licença - ... ## Legislação Aplicável | Norma | Descrição | Relevância | |---|---|---| | Lei 6.938/1981 | Política Nacional do Meio Ambiente | Base legal do licenciamento | | Resolução CONAMA 237/1997 | Regulamenta o licenciamento ambiental | Tipos de licença, prazos | | ... | ... | ... | ## Regras de citação legal - Formato: "Resolução CONAMA nº 237/1997, art. 8º, inciso I" - Toda sigla na primeira ocorrência com nome por extenso - Legislação federal > estadual > municipal (hierarquia) ## Fluxos do Domínio Descrever os processos-chave que o módulo implementa: 1. Solicitação de licença → Análise técnica → Emissão → Monitoramento 2. Cadastro de condicionante → Acompanhamento de prazo → Cumprimento ## Vocabulário de Interface Termos que devem ser usados em labels, botões e mensagens: | Contexto | ❌ Genérico | ✅ Correto para o módulo | |---|---|---| | Campo de nome | "Nome" | "Razão Social do Empreendedor" | | Status | "Ativo/Inativo" | "Vigente/Vencida/Suspensa" | | Ação principal | "Criar novo" | "Solicitar nova licença" | | Lista vazia | "Nenhum registro" | "Nenhuma licença cadastrada" | ``` --- ## PASSO 3 — Validar com o Operador Antes de consolidar: - [ ] Os termos do glossário estão corretos para o contexto do módulo? - [ ] As entidades cobrem os conceitos centrais? - [ ] A legislação listada é a principal (não exaustiva)? - [ ] O vocabulário de interface reflete como o usuário fala no dia a dia? --- ## PASSO 4 — Conectar com as Rules Após documentar o domínio: 1. Verificar se labels e mensagens no código usam o vocabulário definido (rule `mensagens-usuario.md`) 2. Verificar se schemas Zod têm mensagens de erro no idioma do domínio (rule `zod-validacao-padrao.md`) 3. Verificar se os arquivos `.ajuda.md` usam termos do glossário (workflow `adicionar-ajuda.md`) 4. Verificar se textos comerciais citam a legislação corretamente (workflow `comercial.md`) --- ## Checklist Final - [ ] Arquivo `dominio-.md` criado em `.agent/memoria/`? - [ ] Glossário com pelo menos os 10 termos centrais do módulo? - [ ] Entidades principais listadas com descrição? - [ ] Legislação base documentada com formato de citação? - [ ] Vocabulário de interface definido (labels, status, ações, empty states)? - [ ] Operador validou a terminologia? ## Referências - Rule: `global/rules/mensagens-usuario.md` - Rule: `global/rules/regras-negocio-md.md` - Workflow: `agents/ag-comercial/workflows/comercial.md` - Workflow: `agents/ag-front/workflows/adicionar-ajuda.md`