.agent/global/workflows/doc.md

2.1 KiB

type name description scope updatedAt
workflow doc Alias para /documentacao - acionar o Agente de Documentação & Memória nos 6 pilares com sugestão de mensagem de commit para o operador humano global 2026-10-14

Workflow: /doc (Alias para /documentacao)

Atalho rápido para o Agente de Documentação & Memória cobrindo os 6 pilares canônicos:

⚡ Sem Parâmetros: Se executado apenas como /doc, documenta automaticamente todo o contexto e decisões da conversa atual no chat.

  • 1. Código-Fonte \rightarrow JSDoc de aplicação prática (rules/jsdoc-padrao.md)
  • 2. Ajuda UI \rightarrow modalX.ajuda.md co-localizado com modalX.vue
  • 3. Wiki Usuário \rightarrow <base_projeto>/../wiki/<modulo>/ (VitePress com acesso dos usuários)
  • 4. Wiki Dev \rightarrow <base_projeto>/../wiki/dev/<modulo>/ (VitePress com acesso interno dev e regras {modulo}.regras-negocio.md)
  • 5. Rota IA \rightarrow Rota do backend /llm.md
  • 6. Memória IA \rightarrow <base_projeto>/memorias-ia/ (gera sessao-AAAA-MM-DD-slug.md e indexa no índice historico-acoes.md com a tabela Data | Memória / Ação | Arquivo Memoria | Citações no Código-Fonte)

💬 Sugestão de Mensagem de Commit (Commit Exclusivo por Humano)

Sempre que a documentação na aplicação (<base_projeto>) ou na Wiki (<modulo-wiki>, padrão ../wiki) for criada ou atualizada:

  • O agente NUNCA executa git commit ou git push — o commit deve ser feito exclusivamente pelo operador humano (ver rules/proibido-commit-ia.md).
  • O agente apresenta ao operador humano a sugestão de mensagem de commit pronta para uso:
    💬 **Sugestão de Commit (Wiki / Aplicação):**
    `docs(<modulo-id>): <descrição sucinta das alterações>`
    

🔒 Fronteira Git: Apenas o submódulo .agent pode receber commit/push de forma automática pela IA. Tanto na aplicação principal (<base_projeto>) quanto na Wiki (<modulo-wiki>), a IA apenas sugere o texto do commit ao operador humano.


Para ver todas as opções, comandos e sintaxes completas, consulte /documentacao.