publico/.agent
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

.

Browse source
This commit is contained in:
Luiz Silva 2026-09-28 22:18:39 -03:00
parent f5abcec365
commit e7adba8fd8
84 changed files with 4222 additions and 2182 deletions
Download patch file Download diff file Expand all files Collapse all files

104
agents/documentacao/skills/diagnosticar-lacunas-documentacao/SKILL
View file

@ -1,104 +0,0 @@
---
name: diagnosticar-lacunas-documentacao
description: >
Diagnóstico de lacunas de documentação cobrindo os 6 pilares: comentários de aplicação no código,
ajuda na tela (.ajuda.md), wiki de usuário, wiki dev, rota /llm.md e memórias da IA.
scope: global
updatedAt: "2026-09-01"
---
# Skill: Diagnosticar Lacunas de Documentação e Memória
## Objetivo
Identificar proativamente onde a documentação e memórias estão ausentes, incompletas ou desatualizadas antes de criar ou corrigir código.
---
## Etapas de Diagnóstico nos 6 Pilares
### 1. Pilar 1 — Comentários e JSDoc no Código-Fonte
```sh
# Listar funções exportadas sem JSDoc
rg "^export (const|function|async function)" --include='*.ts' <modulo>-comuns/src/ <modulo>-back/src/ -n | while read line; do
file=$(echo "$line" | cut -d: -f1)
lineno=$(echo "$line" | cut -d: -f2)
prev=$((lineno - 1))
if ! sed -n "${prev}p" "$file" | grep -q "*/"; then
echo "SEM JSDOC DE APLICAÇÃO: $line"
fi
done
```
### 2. Pilar 2 — Ajuda na Tela (UI) em `.ajuda.md`
```sh
# Listar modais/telas Vue que não possuem arquivo .ajuda.md correspondente
find <modulo>-front/src -name "modal*.vue" -o -name "Modal*.vue" | while read vueFile; do
dir=$(dirname "$vueFile")
base=$(basename "$vueFile" .vue)
ajudaFile="$dir/$base.ajuda.md"
if [ ! -f "$ajudaFile" ]; then
echo "MODAL SEM AJUDA: $vueFile → falta $base.ajuda.md"
fi
done
```
### 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 <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 (`<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 <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`)
```sh
# Verificar se o backend possui a rota /llm.md registrada
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/`)
```sh
# 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"
```
---
## Relatório Consolidado de Diagnóstico
```markdown
# Diagnóstico de Documentação e Memória — [Módulo]
## 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 (<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
## Ações Recomendadas
1. ...
```
---
## Referências
- Rule: `rules/ddd-documentacao-primeiro.md`
- Rule: `rules/jsdoc-padrao.md`
- Rule: `rules/regras-negocio-md.md`
- Skill: `skills/adicionar-ajuda/SKILL.md`
- Skill: `skills/documentar-dominio-modulo/SKILL.md`
- Skill: `skills/documentar-decisao-tecnica/SKILL.md`