4.8 KiB
4.8 KiB
| 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 com versionamento automático na Wiki | global | 2026-09-05 |
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:
- Pilar 1 (Código-Fonte): Insere comentários JSDoc de aplicação prática nos arquivos alterados (
rules/jsdoc-padrao.md). - Pilar 2 (Ajuda UI): Gera
{componente}.ajuda.mdpara modais e telas criados/modificados (skills/adicionar-ajuda). - Pilar 3 (Wiki do Usuário): Atualiza tutoriais e manuais em
<base_projeto>/../wiki/<modulo>/(aplicação VitePress com acesso dos usuários). - Pilar 4 (Wiki de Desenvolvimento): Documenta regras de negócio (
{modulo}.regras-negocio.md), modelos e ADRs em<base_projeto>/../wiki/dev/<modulo>/(aplicação VitePress com acesso interno dev). - Pilar 5 (Rota IA): Assegura que novos schemas e rotas estejam refletidos na rota
/llm.md. - Pilar 6 (Memória IA): Registra o relatório completo da sessão em
<base_projeto>/memorias-ia/. - Sincronização Git da Wiki (Obrigatório e Exclusivo):
- Se houver arquivos novos ou alterados em
<base_projeto>/../wiki/:git -C <base_projeto>/../wiki add -A git -C <base_projeto>/../wiki commit -m "docs(<modulo-id>): sincronizar documentação [contexto]" git -C <base_projeto>/../wiki push - Trava de Segurança da Aplicação: Na aplicação (
<base_projeto>), o agente NÃO pode mexer no git (o versionamento do código-fonte da aplicação permanece sob controle humano exclusivo).
- Se houver arquivos novos ou alterados em
🏛️ 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 | <base_projeto>/../wiki/<modulo>/ |
Usuários / Clientes | Aplicação VitePress com acesso dos usuários (manuais, tutoriais e fluxos). |
| 4. Wiki de Desenvolvimento | <base_projeto>/../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) + commit/push na wiki
/documentacao wiki-usuario <modulo>
# Documentar regras de negócio na Wiki Dev (VitePress) + commit/push na wiki
/documentacao regras <caminho/servico.ts>
# Criar um ADR na Wiki Dev + commit/push na wiki
/documentacao adr "<Título da Decisão>"
Nota: Qualquer comando que crie ou modifique arquivos na Wiki (<base_projeto>/../wiki) deve finalizar executando git add, git commit e git push dentro de ../wiki.
🔒 Regras Inegociáveis
- Nunca inventar regras: Documentar estritamente o que foi implementado no código ou declarado na conversa.
- Linguagem acessível no usuário: Sem termos técnicos de TI na Wiki do Usuário ou em
.ajuda.md. - JSDoc de Aplicação: Explicar a utilidade prática no sistema, não apenas repetir tipos.
- Polimorfismo: O
.agenté genérico; personalizações ficam em./memorias-ia/e<base_projeto>/../wiki/. - Fronteira Git e Push Obrigatório na Wiki: Toda atualização em
<base_projeto>/../wikiDEVE ser commitada e enviada viagit pushexclusivamente dentro do diretório../wiki. Na aplicação principal (<base_projeto>), a IA nunca mexe no Git (verrules/proibido-commit-ia.md).