.agent/global/workflows/doc.md

1.8 KiB

type name description scope updatedAt
workflow doc Alias para /documentacao - acionar o Agente de Documentação & Memória com versionamento automático na Wiki global 2026-09-05

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/

🔄 Versionamento Git Obrigatório da Wiki (<base_projeto>/../wiki)

Sempre que a documentação na Wiki (Pilares 3 e 4) for criada ou atualizada:

  • O agente DEVE obrigatoriamente executar commit e push das alterações exclusivamente no diretório da Wiki:
    git -C <base_projeto>/../wiki add -A
    git -C <base_projeto>/../wiki commit -m "docs(<modulo-id>): sincronizar documentação"
    git -C <base_projeto>/../wiki push
    

🔒 Fronteira Inegociável de Git: Na aplicação principal (<base_projeto>), o agente NUNCA pode mexer no git (proibido git commit, git push, git merge, etc.). O versionamento do código da aplicação é mantido exclusivamente pelo usuário (ver rules/proibido-commit-ia.md).


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