refactor: remover extensões .md de todos os artefatos — v3.0.0
- 55 arquivos .md renomeados para sem extensão - Convenção: artefatos de conhecimento sem extensão, scripts (.sh) e dados (.json) mantêm extensão - Scripts atualizados: gerar-manifesto.sh, atualizar-agente.sh, atualizar-agente.global.sh, gerar-agent-json.sh, verificar-linhas.sh - Documentação reescrita: AGENTS, README, EXTEND para refletir uso como submodule .agent direto - manifesto.json regenerado v3.0.0 - Todas as referências internas entre artefatos atualizadas BREAKING CHANGE: arquivos não possuem mais extensão .md
This commit is contained in:
parent
22023df81e
commit
bf9be375e2
58 changed files with 506 additions and 514 deletions
|
|
@ -124,7 +124,7 @@ processor.on('failed', (job, erro) => {
|
|||
|
||||
## Referências
|
||||
|
||||
- Rule: `global/rules/mensagens-usuario.md` (vocabulário para mensagens ao usuário)
|
||||
- Persona: `agents/ag-front/persona.md` (estados de UI)
|
||||
- Persona: `agents/ag-back/persona.md` (tratamento de erros)
|
||||
- Persona: `agents/ag-ux/persona.md` (feedback imediato como princípio)
|
||||
- Rule: `global/rules/mensagens-usuario` (vocabulário para mensagens ao usuário)
|
||||
- Persona: `agents/ag-front/persona` (estados de UI)
|
||||
- Persona: `agents/ag-back/persona` (tratamento de erros)
|
||||
- Persona: `agents/ag-ux/persona` (feedback imediato como princípio)
|
||||
|
|
@ -116,5 +116,5 @@ Sem esta regra:
|
|||
|
||||
## Referências
|
||||
|
||||
- Rule: `global/rules/zod-validacao-padrao.md` (schemas no `*-comuns`)
|
||||
- Skill: `global/skills/mapear-codigo-fonte/SKILL.md`
|
||||
- Rule: `global/rules/zod-validacao-padrao` (schemas no `*-comuns`)
|
||||
- Skill: `global/skills/mapear-codigo-fonte/SKILL`
|
||||
|
|
@ -56,4 +56,4 @@ Sem este padrão, funções compartilhadas ficam sem documentação, casts apare
|
|||
|
||||
## Referências
|
||||
|
||||
- Rule: `global/rules/typescript-sem-any.md`
|
||||
- Rule: `global/rules/typescript-sem-any`
|
||||
|
|
@ -63,4 +63,4 @@ Sem esta regra, arquivos crescem silenciosamente até se tornarem intocáveis
|
|||
## Referências
|
||||
|
||||
- Script: `verificar-linhas.sh`
|
||||
- Workflow: `global/workflows/otimizar-codigos.md`
|
||||
- Workflow: `global/workflows/otimizar-codigos`
|
||||
|
|
@ -119,5 +119,5 @@ Sem esta regra, o agente gera mensagens técnicas que confundem gestores ambient
|
|||
|
||||
## Referências
|
||||
|
||||
- Rule: `global/rules/zod-validacao-padrao.md` (schemas com mensagens customizadas)
|
||||
- Workflow: `global/workflows/ux.md` (design de interface)
|
||||
- Rule: `global/rules/zod-validacao-padrao` (schemas com mensagens customizadas)
|
||||
- Workflow: `global/workflows/ux` (design de interface)
|
||||
|
|
@ -116,5 +116,5 @@ Sem este padrão:
|
|||
|
||||
## Referências
|
||||
|
||||
- Skill: `global/skills/documentar-regras-negocio/SKILL.md`
|
||||
- Workflow: `global/workflows/documentar-regras-negocio.md`
|
||||
- Skill: `global/skills/documentar-regras-negocio/SKILL`
|
||||
- Workflow: `global/workflows/documentar-regras-negocio`
|
||||
|
|
@ -72,6 +72,6 @@ Se encontrar uma string que represente um valor de domínio do sistema, o agente
|
|||
|
||||
## Referências
|
||||
|
||||
- Skill: `global/skills/diagnosticar-erros-build/SKILL.md` (quando erros de tipagem causam falhas de build em cascata)
|
||||
- Workflow: `global/workflows/otimizar-codigos.md` (padrão de documentação para casts temporários)
|
||||
- Skill: `global/skills/diagnosticar-erros-build/SKILL` (quando erros de tipagem causam falhas de build em cascata)
|
||||
- Workflow: `global/workflows/otimizar-codigos` (padrão de documentação para casts temporários)
|
||||
|
||||
|
|
@ -13,8 +13,8 @@ globs:
|
|||
alwaysApply: true
|
||||
updatedAt: "2026-06-01"
|
||||
references:
|
||||
- global/rules/typescript-sem-any.md
|
||||
- global/skills/criar-schema-zod/SKILL.md
|
||||
- global/rules/typescript-sem-any
|
||||
- global/skills/criar-schema-zod/SKILL
|
||||
---
|
||||
|
||||
# Regra: Zod como Validador Padrão
|
||||
|
|
@ -311,5 +311,5 @@ Com esta regra:
|
|||
|
||||
## Referências
|
||||
|
||||
- Rule: `global/rules/typescript-sem-any.md` (narrowing com Zod mencionado como alternativa)
|
||||
- Skill: `global/skills/criar-schema-zod/SKILL.md` (guia prático para criar schemas)
|
||||
- Rule: `global/rules/typescript-sem-any` (narrowing com Zod mencionado como alternativa)
|
||||
- Skill: `global/skills/criar-schema-zod/SKILL` (guia prático para criar schemas)
|
||||
|
|
@ -180,5 +180,5 @@ Zero erros = concluído.
|
|||
|
||||
## Referências
|
||||
|
||||
- Rule: `global/rules/zod-validacao-padrao.md`
|
||||
- Rule: `global/rules/typescript-sem-any.md`
|
||||
- Rule: `global/rules/zod-validacao-padrao`
|
||||
- Rule: `global/rules/typescript-sem-any`
|
||||
|
|
@ -181,6 +181,6 @@ pnpm install && pnpm build
|
|||
|
||||
## Referências
|
||||
|
||||
- Rules: `global/rules/typescript-sem-any.md`
|
||||
- Workflow: `global/workflows/otimizar-codigos.md`
|
||||
- Skill: `global/skills/mapear-codigo-fonte/SKILL.md`
|
||||
- Rules: `global/rules/typescript-sem-any`
|
||||
- Workflow: `global/workflows/otimizar-codigos`
|
||||
- Skill: `global/skills/mapear-codigo-fonte/SKILL`
|
||||
|
|
@ -157,5 +157,5 @@ Antes de considerar completo:
|
|||
|
||||
## Referências
|
||||
|
||||
- Workflow: `global/workflows/aprimorar-IA.md` (seção de classificação de artefatos)
|
||||
- Workflow: `global/workflows/otimizar-codigos.md`
|
||||
- Workflow: `global/workflows/aprimorar-IA` (seção de classificação de artefatos)
|
||||
- Workflow: `global/workflows/otimizar-codigos`
|
||||
|
|
@ -107,10 +107,10 @@ Antes de consolidar:
|
|||
|
||||
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`)
|
||||
1. Verificar se labels e mensagens no código usam o vocabulário definido (rule `mensagens-usuario`)
|
||||
2. Verificar se schemas Zod têm mensagens de erro no idioma do domínio (rule `zod-validacao-padrao`)
|
||||
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`)
|
||||
4. Verificar se textos comerciais citam a legislação corretamente (workflow `comercial`)
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -125,7 +125,7 @@ Após documentar o domínio:
|
|||
|
||||
## 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`
|
||||
- Rule: `global/rules/mensagens-usuario`
|
||||
- Rule: `global/rules/regras-negocio-md`
|
||||
- Workflow: `agents/ag-comercial/workflows/comercial`
|
||||
- Workflow: `agents/ag-front/workflows/adicionar-ajuda`
|
||||
|
|
@ -208,5 +208,5 @@ Percorrer cada regra listada no `.md` e verificar que há código correspondente
|
|||
|
||||
## Referências
|
||||
|
||||
- Rule: `global/rules/regras-negocio-md.md`
|
||||
- Workflow: `global/workflows/documentar-regras-negocio.md`
|
||||
- Rule: `global/rules/regras-negocio-md`
|
||||
- Workflow: `global/workflows/documentar-regras-negocio`
|
||||
|
|
@ -156,5 +156,5 @@ Descrever como os dados fluem entre pacotes.
|
|||
|
||||
## Referências
|
||||
|
||||
- Rules: `global/rules/typescript-sem-any.md`
|
||||
- Workflow: `global/workflows/otimizar-codigos.md`
|
||||
- Rules: `global/rules/typescript-sem-any`
|
||||
- Workflow: `global/workflows/otimizar-codigos`
|
||||
|
|
@ -172,6 +172,6 @@ Quando dois agentes têm visões diferentes:
|
|||
|
||||
## Referências
|
||||
|
||||
- Rule: `global/rules/autonomia-agente.md`
|
||||
- Rule: `global/rules/fronteiras-monorepo.md`
|
||||
- Personas: `agents/*/persona.md`
|
||||
- Rule: `global/rules/autonomia-agente`
|
||||
- Rule: `global/rules/fronteiras-monorepo`
|
||||
- Personas: `agents/*/persona`
|
||||
|
|
@ -129,7 +129,7 @@ Sempre que houver processo repetível identificado:
|
|||
|
||||
Sempre que um padrão operacional complexo for definido, refinado ou corrigido:
|
||||
|
||||
* Criar ou atualizar skill em `.agent/local/skills/<nome-da-skill>/SKILL.md`.
|
||||
* Criar ou atualizar skill em `.agent/local/skills/<nome-da-skill>/SKILL`.
|
||||
|
||||
### Quando atualizar uma skill:
|
||||
|
||||
|
|
@ -158,13 +158,13 @@ Instruções com código, regras e padrões.
|
|||
- [ ] Item de verificação
|
||||
|
||||
## Referências
|
||||
- Regras: `.agent/local/rules/xxx.md`
|
||||
- Workflow: `.agent/local/workflows/xxx.md`
|
||||
- Regras: `.agent/local/rules/xxx`
|
||||
- Workflow: `.agent/local/workflows/xxx`
|
||||
```
|
||||
|
||||
### Regras de organização:
|
||||
|
||||
- Uma skill por diretório: `.agent/local/skills/<nome>/SKILL.md`
|
||||
- Uma skill por diretório: `.agent/local/skills/<nome>/SKILL`
|
||||
- Skills globais são identificadas pelo campo `scope: global` no frontmatter
|
||||
- Nome do diretório em `kebab-case`
|
||||
- A skill **não deve duplicar** conteúdo de rules — referencia-as via seção `Referências`
|
||||
|
|
@ -181,7 +181,7 @@ Instruções com código, regras e padrões.
|
|||
|
||||
### Skills de projeto (criadas localmente em cada monorepo):
|
||||
|
||||
Cada projeto pode criar skills adicionais específicas em `.agent/local/skills/<nome>/SKILL.md`.
|
||||
Cada projeto pode criar skills adicionais específicas em `.agent/local/skills/<nome>/SKILL`.
|
||||
Essas skills focam nos padrões e domínios exclusivos daquele projeto.
|
||||
|
||||
Exemplos de skills de projeto:
|
||||
|
|
@ -200,7 +200,7 @@ Exemplos de skills de projeto:
|
|||
Sempre que decisões críticas sobre a arquitetura da aplicação ou o contexto do domínio precisarem ser arquivadas temporária ou permanentemente de maneira descritiva (e não diretamente injetável em código ou regra de lint):
|
||||
|
||||
* Registre o novo documento no formato adequado mantendo a pasta limpa em `.agent/memoria/`.
|
||||
* Exemplo: Manter diário de pendências (`diario-pendencias-modulo-x.md`) ou ADR (`adr-001-migracao-nuxt-4.md`).
|
||||
* Exemplo: Manter diário de pendências (`diario-pendencias-modulo-x`) ou ADR (`adr-001-migracao-nuxt-4`).
|
||||
* Atenção! Tudo que puder ser abstraído para formato técnico estrito deve virar **Skill** ou **Rule**. Use a Memória apenas como extensão de base factual.
|
||||
|
||||
---
|
||||
|
|
@ -9,7 +9,7 @@ updatedAt: "2026-06-01"
|
|||
# Workflow: Documentar Regras de Negócio de um Módulo
|
||||
|
||||
Use este workflow com `/documentar-regras-negocio.global` para criar ou atualizar o arquivo
|
||||
`{modulo}.regras-negocio.md` de qualquer módulo TypeScript com lógica de negócio não-trivial.
|
||||
`{modulo}.regras-negocio` de qualquer módulo TypeScript com lógica de negócio não-trivial.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -27,7 +27,7 @@ Identificar e anotar:
|
|||
|
||||
---
|
||||
|
||||
[2] Verificar se já existe um `.regras-negocio.md`
|
||||
[2] Verificar se já existe um `.regras-negocio`
|
||||
|
||||
```bash
|
||||
ls $(dirname <arquivo>)/*.regras-negocio.md 2>/dev/null
|
||||
|
|
@ -38,9 +38,9 @@ ls $(dirname <arquivo>)/*.regras-negocio.md 2>/dev/null
|
|||
|
||||
---
|
||||
|
||||
[3] Criar o arquivo `.regras-negocio.md`
|
||||
[3] Criar o arquivo `.regras-negocio`
|
||||
|
||||
Nomenclatura: `{nome-sem-_inicial}.regras-negocio.md` na mesma pasta do módulo.
|
||||
Nomenclatura: `{nome-sem-_inicial}.regras-negocio` na mesma pasta do módulo.
|
||||
|
||||
Preencher com o template da skill `documentar-regras-negocio.global`:
|
||||
- Contexto
|
||||
|
|
@ -68,19 +68,19 @@ Se já existia e está correto → sem mudança necessária.
|
|||
|
||||
Percorrer cada função do módulo:
|
||||
|
||||
- JSDoc com lista de regras de negócio → substituir por referência ao `.md`
|
||||
- JSDoc com lista de regras de negócio → substituir por referência ao ``
|
||||
- Manter apenas `@param` e `@returns` com informação técnica precisa
|
||||
- Comentários inline (`//`) explicando lógica pontual são aceitos → manter
|
||||
|
||||
---
|
||||
|
||||
[6] Verificar consistência — código ↔ `.md`
|
||||
[6] Verificar consistência — código ↔ ``
|
||||
|
||||
Para cada regra listada no `.md`:
|
||||
Para cada regra listada no ``:
|
||||
|
||||
- [ ] Existe `if` correspondente no código
|
||||
- [ ] A ordem de avaliação bate entre `.md` e código
|
||||
- [ ] Campos com separador de concatenação batem entre `.md` e código
|
||||
- [ ] A ordem de avaliação bate entre `` e código
|
||||
- [ ] Campos com separador de concatenação batem entre `` e código
|
||||
- [ ] `null` como neutro está implementado corretamente (`!= null`)
|
||||
- [ ] Queries têm `orderBy` quando a posição dos resultados importa
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue