publico/.agent
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
.agent/global/skills/documentacao/SKILL.md

3.6 KiB
Raw Blame History

name description scope updatedAt
documentacao Acionar o Agente de Documentação & Memória para documentar o contexto da conversa ou gerar artefatos nos 6 pilares canônicos global 2026-09-01

Skill / Workflow: /documentacao

Esta skill aciona o Agente de Documentação & Memória para gerar, atualizar ou auditar a documentação nos 6 pilares canônicos do Documentation-Driven Development (DDD).

⚡ Modo Contextual Padrão (Sem Argumentos)

Ao executar /documentacao (ou /doc) sem nenhum parâmetro, o agente analisa automaticamente todo o histórico do chat, decisões tomadas e arquivos alterados na sessão, gerando e sincronizando a documentação nos pilares afetados:

  1. Pilar 1 (Código-Fonte): Insere comentários JSDoc de aplicação prática nos arquivos alterados (rules/jsdoc-padrao.md).
  2. Pilar 2 (Ajuda UI): Gera {componente}.ajuda.md para modais e telas criados/modificados (skills/adicionar-ajuda).
  3. Pilar 3 (Wiki do Usuário): Atualiza tutoriais e manuais em ../../wiki/<modulo>/ (aplicação VitePress com acesso dos usuários).
  4. Pilar 4 (Wiki de Desenvolvimento): Documenta regras de negócio ({modulo}.regras-negocio.md), modelos e ADRs em ../../wiki/dev/<modulo>/ (aplicação VitePress com acesso interno dev).
  5. Pilar 5 (Rota IA): Assegura que novos schemas e rotas estejam refletidos na rota /llm.md.
  6. Pilar 6 (Memória IA): Registra o relatório completo da sessão em <base_projeto>/memorias-ia/.

🏛️ Os 6 Pilares Canônicos

Pilar Destino / Padrão Público Conteúdo Obrigatório
1. Código-Fonte .ts, .vue, .js Desenvolvedores / IA JSDoc e comentários claros quanto à aplicação prática e contexto de negócio.
2. Ajuda na Tela *-front/.../{componente}.ajuda.md Usuários da UI Ajuda contextual co-localizada: para modalX.vue \rightarrow modalX.ajuda.md.
3. Wiki do Usuário ../../wiki/<modulo>/ Usuários / Clientes Aplicação VitePress com acesso dos usuários (manuais, tutoriais e fluxos).
4. Wiki de Desenvolvimento ../../wiki/dev/<modulo>/ Desenvolvedores / Arquitetos Aplicação VitePress com acesso interno dev: regras de negócio ({modulo}.regras-negocio.md), arquitetura e ADRs (adrs/).
5. Integração de IA Rota Backend /llm.md Agentes de IA / LLMs Catálogo de schemas Zod, enums e contratos para consumo por LLMs.
6. Memória da IA <base_projeto>/memorias-ia/ Agentes de IA / Auditoria Registros de sessões, otimizações executadas e decisões históricas.

🚀 Comandos Específicos (Com Argumentos)

# Diagnosticar lacunas no módulo
/documentacao diagnosticar

# Documentar JSDoc de aplicação prática em arquivo específico
/documentacao jsdoc <caminho/arquivo.ts>

# Criar ajuda contextual modalX.ajuda.md para modal/tela
/documentacao ajuda <caminho/modalX.vue>

# Documentar domínio na Wiki do Usuário (VitePress)
/documentacao wiki-usuario <modulo>

# Documentar regras de negócio na Wiki Dev (VitePress)
/documentacao regras <caminho/servico.ts>

# Criar um ADR na Wiki Dev
/documentacao adr "<Título da Decisão>"

🔒 Regras Inegociáveis

  1. Nunca inventar regras: Documentar estritamente o que foi implementado no código ou declarado na conversa.
  2. Linguagem acessível no usuário: Sem termos técnicos de TI na Wiki do Usuário ou em .ajuda.md.
  3. JSDoc de Aplicação: Explicar a utilidade prática no sistema, não apenas repetir tipos.
  4. Polimorfismo: O .agent é genérico; personalizações ficam em ./memorias-ia/ e ../../wiki/.