aplimoramento de agent
This commit is contained in:
parent
b361f25955
commit
f597436be3
83 changed files with 1312 additions and 574 deletions
File diff suppressed because one or more lines are too long
|
|
@ -33,8 +33,8 @@ Toda sua comunicação — incluindo raciocínio interno, reflexões e respostas
|
|||
|
||||
1. **Código-Fonte**: JSDoc e comentários claros e coerentes quanto à aplicação prática nos arquivos `.ts`, `.vue` e `.js`.
|
||||
2. **Ajuda na Tela (UI)**: Arquivos `{componente}.ajuda.md` co-localizados no frontend (para `modalX.vue`, o arquivo **DEVE** ser `modalX.ajuda.md`).
|
||||
3. **Wiki do Usuário**: Aplicação VitePress com acesso dos usuários em `../../wiki/<modulo>/` (manuais e guias de operação).
|
||||
4. **Wiki de Desenvolvimento**: Aplicação VitePress com acesso interno da equipe de desenvolvimento em `../../wiki/dev/<modulo>/` (documentação técnica, arquitetura, modelos de banco, regras de negócio `{modulo}.regras-negocio.md`, filas e ADRs).
|
||||
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/`.
|
||||
7. **Hub DDD (`DOCUMENTACAO/`)**: Templates e manifesto do Documentation-Driven Development.
|
||||
|
|
@ -45,8 +45,8 @@ Toda sua comunicação — incluindo raciocínio interno, reflexões e respostas
|
|||
1. **Diagnosticar lacunas** — executar a skill `diagnosticar-lacunas-documentacao` antes de escrever documentação (ver `rules/diagnostico-antes-correcao.md`).
|
||||
2. **Auditar comentários de código** — garantir que funções, serviços, composables e rotas possuam comentários claros e coerentes quanto à sua aplicação prática (ver `rules/jsdoc-padrao.md`).
|
||||
3. **Garantir ajuda contextual em telas** — assegurar que qualquer modal/tela com suporte a ajuda tenha seu respectivo `modalX.ajuda.md` co-localizado no frontend.
|
||||
4. **Manter a Wiki do Usuário** — redigir e manter manuais na aplicação VitePress em `../../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 `../../wiki/dev/<modulo>/`.
|
||||
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/`.
|
||||
|
||||
|
|
@ -56,7 +56,7 @@ Toda sua comunicação — incluindo raciocínio interno, reflexões e respostas
|
|||
- NUNCA documentar sem antes diagnosticar lacunas e ler o código-fonte integral (ver `rules/diagnostico-antes-correcao.md`).
|
||||
- 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 (`../../wiki/<modulo>/`) ou nos arquivos `.ajuda.md`.
|
||||
- NUNCA usar jargões técnicos de TI na Wiki do Usuário (`<base_projeto>/../wiki/<modulo>/`) ou nos arquivos `.ajuda.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/`.
|
||||
|
||||
|
|
@ -70,14 +70,16 @@ Toda sua comunicação — incluindo raciocínio interno, reflexões e respostas
|
|||
|
||||
- [ ] Funções, serviços e rotas possuem comentários claros e coerentes quanto à sua aplicação prática?
|
||||
- [ ] Telas e modais Vue possuem arquivo co-localizado `{componente}.ajuda.md` (ex: `modalX.ajuda.md`)?
|
||||
- [ ] Documentação de usuário está atualizada em `../../wiki/<modulo>/`?
|
||||
- [ ] Documentação técnica e ADRs estão atualizados em `../../wiki/dev/<modulo>/`?
|
||||
- [ ] 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/`?
|
||||
|
||||
## Memória Persistente
|
||||
## Memória Persistente & Identidade do Projeto
|
||||
|
||||
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.
|
||||
O arquivo `<base_projeto>/memorias-ia/modulo.yml` é de **existência obrigatória em todos os projetos** e define a identidade do módulo (`modulo-id`, `modulo-caminho`, `modulo-descricao`, `modulo-tipo`).
|
||||
- Toda vez que precisar do ID do módulo (`modulo-id`), da rota/prefixo de URL (`modulo-caminho`), ou de informações de tipo/descrição (`modulo-tipo` / `modulo-descricao`), consulte obrigatoriamente `memorias-ia/modulo.yml`.
|
||||
- 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/`.
|
||||
|
|
|
|||
|
|
@ -45,18 +45,18 @@ find <modulo>-front/src -name "modal*.vue" -o -name "Modal*.vue" | while read vu
|
|||
done
|
||||
```
|
||||
|
||||
### 3. Pilar 3 — Wiki do Usuário (`../../wiki/<modulo>/`)
|
||||
### 3. Pilar 3 — Wiki do Usuário (`<base_projeto>/../wiki/<modulo>/`)
|
||||
|
||||
```sh
|
||||
# Verificar se existe documentação de usuário do módulo
|
||||
ls -la ../../wiki/<modulo>/*.md 2>/dev/null || echo "WIKI DE USUÁRIO AUSENTE EM ../../wiki/<modulo>/"
|
||||
ls -la <base_projeto>/../wiki/<modulo>/*.md 2>/dev/null || echo "WIKI DE USUÁRIO AUSENTE EM <base_projeto>/../wiki/<modulo>/"
|
||||
```
|
||||
|
||||
### 4. Pilar 4 — Wiki de Desenvolvimento (`../../wiki/dev/<modulo>/`)
|
||||
### 4. Pilar 4 — Wiki de Desenvolvimento (`<base_projeto>/../wiki/dev/<modulo>/`)
|
||||
|
||||
```sh
|
||||
# Verificar se existe documentação de desenvolvimento, regras de negócio ({modulo}.regras-negocio.md) e ADRs
|
||||
ls -la ../../wiki/dev/<modulo>/*.md 2>/dev/null || echo "WIKI DEV AUSENTE EM ../../wiki/dev/<modulo>/"
|
||||
ls -la <base_projeto>/../wiki/dev/<modulo>/*.md 2>/dev/null || echo "WIKI DEV AUSENTE EM <base_projeto>/../wiki/dev/<modulo>/"
|
||||
```
|
||||
|
||||
### 5. Pilar 5 — Rota de Integração de IA (`/llm.md`)
|
||||
|
|
@ -83,8 +83,8 @@ ls -la memorias-ia/ 2>/dev/null || echo "DIRETÓRIO memorias-ia/ NÃO ENCONTRADO
|
|||
## Resumo dos 6 Pilares
|
||||
- **Código-fonte sem JSDoc de aplicação:** N
|
||||
- **Modais/Telas sem .ajuda.md co-localizado:** N
|
||||
- **Wiki de Usuário (../../wiki/<modulo>/):** Presente / Ausente
|
||||
- **Wiki de Desenvolvimento (../../wiki/dev/<modulo>/):** Presente / Ausente
|
||||
- **Wiki de Usuário (<base_projeto>/../wiki/<modulo>/):** Presente / Ausente
|
||||
- **Wiki de Desenvolvimento (<base_projeto>/../wiki/dev/<modulo>/):** Presente / Ausente
|
||||
- **Rota /llm.md no backend:** Configurada / Ausente
|
||||
- **Registros em memorias-ia/:** N registros
|
||||
|
||||
|
|
|
|||
|
|
@ -45,18 +45,18 @@ find <modulo>-front/src -name "modal*.vue" -o -name "Modal*.vue" | while read vu
|
|||
done
|
||||
```
|
||||
|
||||
### 3. Pilar 3 — Wiki do Usuário (`../../wiki/<modulo>/`)
|
||||
### 3. Pilar 3 — Wiki do Usuário (`<base_projeto>/../wiki/<modulo-id>/`)
|
||||
|
||||
```sh
|
||||
# Verificar se existe documentação de usuário do módulo
|
||||
ls -la ../../wiki/<modulo>/*.md 2>/dev/null || echo "WIKI DE USUÁRIO AUSENTE EM ../../wiki/<modulo>/"
|
||||
ls -la <base_projeto>/../wiki/<modulo-id>/*.md 2>/dev/null || echo "WIKI DE USUÁRIO AUSENTE EM <base_projeto>/../wiki/<modulo-id>/"
|
||||
```
|
||||
|
||||
### 4. Pilar 4 — Wiki de Desenvolvimento (`../../wiki/dev/<modulo>/`)
|
||||
### 4. Pilar 4 — Wiki de Desenvolvimento (`<base_projeto>/../wiki/dev/<modulo-id>/`)
|
||||
|
||||
```sh
|
||||
# Verificar se existe documentação de desenvolvimento, regras de negócio ({modulo}.regras-negocio.md) e ADRs
|
||||
ls -la ../../wiki/dev/<modulo>/*.md 2>/dev/null || echo "WIKI DEV AUSENTE EM ../../wiki/dev/<modulo>/"
|
||||
ls -la <base_projeto>/../wiki/dev/<modulo-id>/*.md 2>/dev/null || echo "WIKI DEV AUSENTE EM <base_projeto>/../wiki/dev/<modulo-id>/"
|
||||
```
|
||||
|
||||
### 5. Pilar 5 — Rota de Integração de IA (`/llm.md`)
|
||||
|
|
@ -66,10 +66,19 @@ ls -la ../../wiki/dev/<modulo>/*.md 2>/dev/null || echo "WIKI DEV AUSENTE EM ../
|
|||
rg "llm\.md" --include='*.ts' <modulo>-back/src/ -n || echo "ROTA /llm.md NÃO ENCONTRADA NO BACKEND"
|
||||
```
|
||||
|
||||
### 6. Pilar 6 — Memória das Ações da IA (`<base_projeto>/memorias-ia/`)
|
||||
### 6. Pilar 6 — Memória das Ações da IA e Identidade (`<base_projeto>/memorias-ia/`)
|
||||
|
||||
```sh
|
||||
# Verificar memórias registradas para o projeto
|
||||
# 1. Verificar arquivo obrigatório modulo.yml e chaves
|
||||
if [ -f "memorias-ia/modulo.yml" ]; then
|
||||
for chave in modulo-id modulo-caminho modulo-descricao modulo-tipo; do
|
||||
grep -q "^$chave:" memorias-ia/modulo.yml || echo "CHAVE AUSENTE EM modulo.yml: $chave"
|
||||
done
|
||||
else
|
||||
echo "CRÍTICO: memorias-ia/modulo.yml AUSENTE"
|
||||
fi
|
||||
|
||||
# 2. Verificar memórias registradas para o projeto
|
||||
ls -la memorias-ia/ 2>/dev/null || echo "DIRETÓRIO memorias-ia/ NÃO ENCONTRADO NA RAIZ DO PROJETO"
|
||||
```
|
||||
|
||||
|
|
@ -83,9 +92,10 @@ ls -la memorias-ia/ 2>/dev/null || echo "DIRETÓRIO memorias-ia/ NÃO ENCONTRADO
|
|||
## Resumo dos 6 Pilares
|
||||
- **Código-fonte sem JSDoc de aplicação:** N
|
||||
- **Modais/Telas sem .ajuda.md co-localizado:** N
|
||||
- **Wiki de Usuário (../../wiki/<modulo>/):** Presente / Ausente
|
||||
- **Wiki de Desenvolvimento (../../wiki/dev/<modulo>/):** Presente / Ausente
|
||||
- **Wiki de Usuário (<base_projeto>/../wiki/<modulo-id>/):** Presente / Ausente
|
||||
- **Wiki de Desenvolvimento (<base_projeto>/../wiki/dev/<modulo-id>/):** Presente / Ausente
|
||||
- **Rota /llm.md no backend:** Configurada / Ausente
|
||||
- **Identidade em memorias-ia/modulo.yml:** Conforme / Ausente
|
||||
- **Registros em memorias-ia/:** N registros
|
||||
|
||||
## Ações Recomendadas
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue