atualização de agent
This commit is contained in:
parent
f8d8627be2
commit
d0e6567652
16 changed files with 260 additions and 100 deletions
File diff suppressed because one or more lines are too long
|
|
@ -49,6 +49,7 @@ Toda sua comunicação — incluindo raciocínio interno, reflexões e respostas
|
|||
5. **Manter a Wiki de Desenvolvimento** — estruturar documentação técnica, arquitetura e regras de negócio na aplicação VitePress de acesso interno em `<base_projeto>/../wiki/dev/<modulo>/`.
|
||||
6. **Validar a Rota `/llm.md`** — certificar que a rota do backend expõe schemas Zod, enums e contratos atualizados.
|
||||
7. **Registrar Memórias da IA** — consolidar registros de ações e melhorias em `<base_projeto>/memorias-ia/`.
|
||||
8. **Sincronizar Git da Wiki** — ao criar ou modificar documentações em `<base_projeto>/../wiki/` (Pilares 3 e 4), executar obrigatoriamente `git commit` e `git push` no repositório da Wiki.
|
||||
|
||||
## Restrições
|
||||
|
||||
|
|
@ -57,6 +58,7 @@ Toda sua comunicação — incluindo raciocínio interno, reflexões e respostas
|
|||
- NUNCA inventar, supor ou fabricar regras de negócio — documentar **exclusivamente** o que o código implementa ou o que o operador declarou.
|
||||
- NUNCA descrever endpoints, schemas ou componentes sem antes inspecionar o código-fonte real.
|
||||
- NUNCA usar jargões técnicos de TI na Wiki do Usuário (`<base_projeto>/../wiki/<modulo>/`) ou nos arquivos `.ajuda.md`.
|
||||
- NUNCA executar comandos de alteração de histórico Git (`git commit`, `git push`, etc.) no repositório da aplicação principal (`<base_projeto>`). A automação de commit e push é restrita e obrigatória **exclusivamente** para `<base_projeto>/../wiki` (ver `rules/proibido-commit-ia.md`).
|
||||
- JSDoc deve documentar a **aplicação prática e o porquê**, e não apenas repetir a assinatura TypeScript.
|
||||
- Gravar memórias da IA **sempre** em `<base_projeto>/memorias-ia/`.
|
||||
|
||||
|
|
@ -74,6 +76,8 @@ Toda sua comunicação — incluindo raciocínio interno, reflexões e respostas
|
|||
- [ ] Documentação técnica e ADRs estão atualizados em `<base_projeto>/../wiki/dev/<modulo>/`?
|
||||
- [ ] Rota de backend `/llm.md` reflete fielmente os schemas Zod e enums canônicos?
|
||||
- [ ] Ações estruturantes da IA estão registradas em `<base_projeto>/memorias-ia/`?
|
||||
- [ ] Alterações na Wiki foram commitadas e enviadas via push em `<base_projeto>/../wiki`?
|
||||
- [ ] Repositório da aplicação foi mantido intacto sem commits da IA?
|
||||
|
||||
## Memória Persistente & Identidade do Projeto
|
||||
|
||||
|
|
|
|||
|
|
@ -27,6 +27,7 @@ O agente pode executar sem perguntar:
|
|||
- Gerar JSDoc em funções compartilhadas
|
||||
- Extrair CSS para arquivo co-localizado
|
||||
- Aplicar padrões de nomenclatura já definidos em rules
|
||||
- Executar `git add`, `git commit` e `git push` exclusivamente no repositório da Wiki (`<base_projeto>/../wiki`) ao criar ou atualizar documentações
|
||||
|
||||
## Ações que Requerem Confirmação
|
||||
|
||||
|
|
@ -44,6 +45,7 @@ O agente deve **propor e aguardar aprovação**:
|
|||
|
||||
O agente **nunca** deve:
|
||||
|
||||
- Executar `git commit` ou `git push` no repositório da aplicação (`<base_projeto>`)
|
||||
- Deletar ou corromper `memorias-ia/modulo.yml` ou memórias/ADRs sem instrução explícita do operador
|
||||
- Assumir ou inventar IDs de módulos ou rotas sem consultar `memorias-ia/modulo.yml`
|
||||
- Alterar artefatos globais (sufixo `.global`) sem justificativa
|
||||
|
|
|
|||
|
|
@ -1,34 +1,38 @@
|
|||
---
|
||||
type: rule
|
||||
name: proibido-commit-ia
|
||||
description: A IA nunca pode executar git commit, git push ou qualquer operação que altere o histórico do repositório
|
||||
description: A IA nunca mexe no git da aplicação principal; commit e push são permitidos e obrigatórios exclusivamente no repositório da Wiki (../wiki)
|
||||
scope: global
|
||||
trigger: always_on
|
||||
updatedAt: "2026-06-19"
|
||||
updatedAt: "2026-09-05"
|
||||
---
|
||||
|
||||
# Regra: Proibido Commit pela IA
|
||||
# Regra: Proibido Commit pela IA na Aplicação e Exceção Obrigatória da Wiki
|
||||
|
||||
## Contexto
|
||||
|
||||
O controle de versão é responsabilidade exclusiva do usuário humano. A IA pode preparar alterações, criar arquivos, editar código e até sugerir mensagens de commit — mas NUNCA deve executar comandos que alterem o histórico do repositório.
|
||||
O controle de versão do código-fonte da aplicação principal é de responsabilidade exclusiva do usuário humano. A IA pode preparar alterações, criar arquivos, editar código e até sugerir mensagens de commit — mas NUNCA deve executar comandos que alterem o histórico do repositório da aplicação.
|
||||
|
||||
Por outro lado, o repositório central de documentação (`<base_projeto>/../wiki`), que hospeda a Wiki do Usuário (Pilar 3) e a Wiki de Desenvolvimento (Pilar 4), é uma base viva de documentação. Quando atualizado pelo agente (ex.: via `/doc`, `/documentacao` ou workflows DDD), o commit e o push DEVEM ser executados automaticamente pelo agente, restritos exclusivamente a esse repositório.
|
||||
|
||||
## Regra
|
||||
|
||||
A IA **NUNCA** deve executar os seguintes comandos (nem variações deles):
|
||||
### 1. Na Aplicação Principal (`<base_projeto>`) — RIGOROSAMENTE PROIBIDO MEXER NO GIT
|
||||
|
||||
- `git commit`
|
||||
- `git push`
|
||||
- `git merge`
|
||||
- `git rebase`
|
||||
- `git tag`
|
||||
- `git reset`
|
||||
- `git revert`
|
||||
- `git cherry-pick`
|
||||
- `git stash drop`
|
||||
- `git branch -d` / `git branch -D`
|
||||
A IA **NUNCA** deve executar comandos que alterem o histórico do repositório da aplicação (nem variações deles):
|
||||
|
||||
### Comandos permitidos (somente leitura e staging)
|
||||
- `git commit` ❌
|
||||
- `git push` ❌
|
||||
- `git merge` ❌
|
||||
- `git rebase` ❌
|
||||
- `git tag` ❌
|
||||
- `git reset` ❌
|
||||
- `git revert` ❌
|
||||
- `git cherry-pick` ❌
|
||||
- `git stash drop` ❌
|
||||
- `git branch -d` / `git branch -D` ❌
|
||||
|
||||
**Comandos permitidos na aplicação (somente leitura e staging):**
|
||||
|
||||
- `git status` ✅
|
||||
- `git diff` ✅
|
||||
|
|
@ -39,37 +43,52 @@ A IA **NUNCA** deve executar os seguintes comandos (nem variações deles):
|
|||
- `git ls-files` ✅
|
||||
- `git show` ✅
|
||||
|
||||
## Exemplos
|
||||
### 2. No Repositório da Wiki (`<base_projeto>/../wiki`) — COMMIT E PUSH OBRIGATÓRIOS
|
||||
|
||||
❌ **Errado** — commitar automaticamente:
|
||||
```sh
|
||||
git add -A && git commit -m "fix: corrigir bug"
|
||||
Sempre que a documentação em `<base_projeto>/../wiki` for criada ou modificada (manuais de usuário em `<modulo-id>/`, regras de negócio em `dev/<modulo-id>/`, ADRs em `dev/<modulo-id>/adrs/`, etc.), o agente **DEVE obrigatoriamente** realizar o commit e push das alterações:
|
||||
|
||||
```bash
|
||||
# Executar estritamente apontando para a pasta ../wiki
|
||||
git -C <base_projeto>/../wiki add -A
|
||||
git -C <base_projeto>/../wiki commit -m "docs(<modulo-id>): <descrição sucinta das alterações>"
|
||||
git -C <base_projeto>/../wiki push
|
||||
```
|
||||
|
||||
❌ **Errado** — push automático:
|
||||
**Fronteira Inegociável:** Esta permissão é restrita e isolada ao repositório `<base_projeto>/../wiki`. A IA **nunca** deve executar commit ou push na aplicação principal.
|
||||
|
||||
## Exemplos
|
||||
|
||||
### ❌ Errado — commitar automaticamente na aplicação
|
||||
```sh
|
||||
# Na raiz da aplicação (<base_projeto>): PROIBIDO
|
||||
git add -A && git commit -m "fix: corrigir bug"
|
||||
git push origin main
|
||||
```
|
||||
|
||||
✅ **Correto** — preparar e informar:
|
||||
### ✅ Correto — na aplicação principal, apenas preparar e sugerir
|
||||
```sh
|
||||
git add -A
|
||||
git status
|
||||
# Informar ao usuário: "Alterações staged. Revise e faça o commit quando estiver pronto."
|
||||
# Informar ao usuário: "Alterações staged na aplicação. Revise e faça o commit quando estiver pronto."
|
||||
# Sugestão de commit: git commit -m "feat: adicionar validação de schema"
|
||||
```
|
||||
|
||||
✅ **Correto** — sugerir mensagem de commit:
|
||||
```
|
||||
Sugestão de commit:
|
||||
git commit -m "feat: adicionar validação de schema no endpoint /usuarios"
|
||||
### ✅ Correto — na Wiki, commitar e enviar automaticamente
|
||||
```sh
|
||||
# No repositório de documentação (<base_projeto>/../wiki): OBRIGATÓRIO
|
||||
git -C ../wiki add -A
|
||||
git -C ../wiki commit -m "docs(e-licencie): atualizar regras de negócio e manuais"
|
||||
git -C ../wiki push
|
||||
```
|
||||
|
||||
## Impacto
|
||||
|
||||
- **Segurança:** o usuário mantém controle total sobre o que entra no histórico
|
||||
- **Revisão:** toda alteração pode ser inspecionada antes de ser commitada
|
||||
- **Reversibilidade:** evita commits acidentais que poluem o histórico
|
||||
- **Segurança na aplicação:** O desenvolvedor mantém controle total sobre o histórico de código da aplicação.
|
||||
- **Agilidade e perenidade na wiki:** A documentação fica sempre sincronizada e publicada imediatamente sem fricção manual.
|
||||
- **Isolamento de escopo:** Fronteira clara e explícita entre repositório de aplicação e repositório de documentação.
|
||||
|
||||
## Referências
|
||||
|
||||
- Princípio de autonomia controlada: a IA executa, o humano decide
|
||||
- Rule: `rules/ddd-documentacao-primeiro.md`
|
||||
- Skill: `skills/documentacao/SKILL.md`
|
||||
- Workflow: `global/workflows/documentacao.md`
|
||||
|
|
|
|||
|
|
@ -1,13 +1,13 @@
|
|||
---
|
||||
name: doc
|
||||
description: Alias rápido para /documentacao - acionar o Agente de Documentação & Memória
|
||||
description: Alias rápido para /documentacao - acionar o Agente de Documentação & Memória com versionamento automático na Wiki
|
||||
scope: global
|
||||
updatedAt: "2026-09-01"
|
||||
updatedAt: "2026-09-05"
|
||||
---
|
||||
|
||||
# Skill: /doc (Alias para /documentacao)
|
||||
|
||||
Atalho rápido para o **Agente de Documentação & Memória** cobrindo os 6 pilares canônicos:
|
||||
Atalho rápido para o **Agente de Documentação & Memória** cobrindo os 6 pilares canônicos do Documentation-Driven Development (DDD):
|
||||
|
||||
> ⚡ **Modo Padrão Sem Parâmetros:** Se executado apenas como `/doc`, documenta e sincroniza automaticamente todo o contexto e decisões da conversa atual no chat.
|
||||
|
||||
|
|
@ -18,4 +18,21 @@ Atalho rápido para o **Agente de Documentação & Memória** cobrindo os 6 pila
|
|||
- `5. Rota IA` $\rightarrow$ Rota do backend `/llm.md`
|
||||
- `6. Memória IA` $\rightarrow$ `<base_projeto>/memorias-ia/`
|
||||
|
||||
Para ver a documentação completa e exemplos, consulte [`skills/documentacao/SKILL.md`](file:///home/luiz/Arquivos/DEV/Industria/SIGMA2026/.agent/skills/documentacao/SKILL.md).
|
||||
---
|
||||
|
||||
## 🔄 Versionamento Git Obrigatório da Wiki (`<base_projeto>/../wiki`)
|
||||
|
||||
Sempre que a documentação na Wiki (Pilares 3 e 4) for alterada ou criada:
|
||||
- O agente **DEVE obrigatoriamente executar commit e push** das alterações exclusivamente no repositório da Wiki:
|
||||
```bash
|
||||
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 controle de versão do código da aplicação é de responsabilidade humana exclusiva (ver `rules/proibido-commit-ia.md`).
|
||||
|
||||
---
|
||||
|
||||
Para ver a especificação completa, comandos com argumentos e exemplos, consulte [`skills/documentacao/SKILL.md`](../documentacao/SKILL.md).
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
name: documentacao
|
||||
description: Acionar o Agente de Documentação & Memória para documentar o contexto da conversa ou gerar artefatos nos 6 pilares canônicos
|
||||
description: 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
|
||||
scope: global
|
||||
updatedAt: "2026-09-01"
|
||||
updatedAt: "2026-09-05"
|
||||
---
|
||||
|
||||
# Skill / Workflow: /documentacao
|
||||
|
|
@ -21,6 +21,14 @@ Esta skill aciona o **Agente de Documentação & Memória** para gerar, atualiza
|
|||
4. **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).
|
||||
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/`.
|
||||
7. **Sincronização Git da Wiki (Obrigatório e Exclusivo):**
|
||||
- Se houver arquivos novos ou alterados em `<base_projeto>/../wiki/`:
|
||||
```bash
|
||||
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).
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -49,16 +57,18 @@ Esta skill aciona o **Agente de Documentação & Memória** para gerar, atualiza
|
|||
# Criar ajuda contextual modalX.ajuda.md para modal/tela
|
||||
/documentacao ajuda <caminho/modalX.vue>
|
||||
|
||||
# Documentar domínio na Wiki do Usuário (VitePress)
|
||||
# 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)
|
||||
# Documentar regras de negócio na Wiki Dev (VitePress) + commit/push na wiki
|
||||
/documentacao regras <caminho/servico.ts>
|
||||
|
||||
# Criar um ADR na Wiki Dev
|
||||
# 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
|
||||
|
|
@ -67,3 +77,4 @@ Esta skill aciona o **Agente de Documentação & Memória** para gerar, atualiza
|
|||
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 `<base_projeto>/../wiki/`.
|
||||
5. **Fronteira Git e Push Obrigatório na Wiki:** Toda atualização em `<base_projeto>/../wiki` DEVE ser commitada e enviada via `git push` exclusivamente dentro do diretório `../wiki`. Na aplicação principal (`<base_projeto>`), a IA nunca mexe no Git (ver `rules/proibido-commit-ia.md`).
|
||||
|
|
|
|||
|
|
@ -103,3 +103,4 @@ Se o módulo introduziu ou alterou arquitetura ou regras consolidadas do módulo
|
|||
- Atualizar a especificação técnica na **Wiki de Desenvolvimento** em `<base_projeto>/../wiki/dev/<modulo>/`.
|
||||
- Criar ou atualizar ADR em `<base_projeto>/../wiki/dev/<modulo>/adrs/` via skill `documentar-decisao-tecnica`.
|
||||
- Registrar decisões e ações na memória em `<base_projeto>/memorias-ia/`.
|
||||
- **Sincronização Git:** Executar commit e push exclusivamente na Wiki (`git -C <base_projeto>/../wiki add -A && git -C <base_projeto>/../wiki commit -m "docs(<modulo-id>): regras de negócio" && git -C <base_projeto>/../wiki push`). Na aplicação (`<base_projeto>`), nunca mexer no git.
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
---
|
||||
type: workflow
|
||||
name: doc
|
||||
description: Alias para /documentacao - acionar o Agente de Documentação & Memória
|
||||
description: Alias para /documentacao - acionar o Agente de Documentação & Memória com versionamento automático na Wiki
|
||||
scope: global
|
||||
updatedAt: "2026-09-01"
|
||||
updatedAt: "2026-09-05"
|
||||
---
|
||||
|
||||
# Workflow: /doc (Alias para /documentacao)
|
||||
|
|
@ -19,4 +19,21 @@ Atalho rápido para o **Agente de Documentação & Memória** cobrindo os 6 pila
|
|||
- `5. Rota IA` $\rightarrow$ Rota do backend `/llm.md`
|
||||
- `6. Memória IA` $\rightarrow$ `<base_projeto>/memorias-ia/`
|
||||
|
||||
Para ver todas as opções e sintaxes, consulte [`/documentacao`](file:///home/luiz/Arquivos/DEV/Industria/SIGMA2026/.agent/global/workflows/documentacao.md).
|
||||
---
|
||||
|
||||
## 🔄 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:
|
||||
```bash
|
||||
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`](./documentacao.md).
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
---
|
||||
type: workflow
|
||||
name: documentacao
|
||||
description: Acionar o Agente de Documentação para documentar o contexto do chat ou executar comandos específicos nos 6 pilares
|
||||
description: Acionar o Agente de Documentação para documentar o contexto do chat ou executar comandos específicos nos 6 pilares com versionamento automático na Wiki
|
||||
scope: global
|
||||
updatedAt: "2026-09-01"
|
||||
updatedAt: "2026-09-05"
|
||||
---
|
||||
|
||||
# Workflow: /documentacao (Agente de Documentação & Memória)
|
||||
|
|
@ -25,8 +25,16 @@ Este workflow aciona o **Agente de Documentação** para gerar, atualizar ou aud
|
|||
- **Pilar 4 (Wiki Dev):** Documenta regras técnicas (`{modulo}.regras-negocio.md`) e ADRs em `<base_projeto>/../wiki/dev/<modulo>/`.
|
||||
- **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/`.
|
||||
3. **Entrega de Relatório:**
|
||||
- Apresenta um resumo claro ao operador de tudo o que foi documentado com links diretos para os arquivos gerados.
|
||||
3. **Sincronização Git da Wiki (Obrigatório e Exclusivo):**
|
||||
- Se houver arquivos novos ou alterados em `<base_projeto>/../wiki/`:
|
||||
```bash
|
||||
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
|
||||
```
|
||||
- **Fronteira Inegociável da Aplicação:** Na aplicação principal (`<base_projeto>`), o agente **NÃO pode mexer no git** (o versionamento do código-fonte da aplicação permanece sob controle humano exclusivo).
|
||||
4. **Entrega de Relatório:**
|
||||
- Apresenta um resumo claro ao operador de tudo o que foi documentado com links diretos para os arquivos gerados e confirmação do push na Wiki.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -55,16 +63,18 @@ Este workflow aciona o **Agente de Documentação** para gerar, atualizar ou aud
|
|||
# Criar ajuda contextual modalX.ajuda.md para modal/tela
|
||||
/documentacao ajuda <caminho/modalX.vue>
|
||||
|
||||
# Documentar domínio na Wiki do Usuário (VitePress)
|
||||
# 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)
|
||||
# Documentar regras de negócio na Wiki Dev (VitePress) + commit/push na wiki
|
||||
/documentacao regras <caminho/servico.ts>
|
||||
|
||||
# Criar um ADR na Wiki Dev
|
||||
# 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
|
||||
|
|
@ -73,3 +83,4 @@ Este workflow aciona o **Agente de Documentação** para gerar, atualizar ou aud
|
|||
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 `<base_projeto>/../wiki/`.
|
||||
5. **Fronteira Git e Push Obrigatório na Wiki:** Toda atualização em `<base_projeto>/../wiki` DEVE ser commitada e enviada via `git push` exclusivamente dentro do diretório `../wiki`. Na aplicação principal (`<base_projeto>`), a IA nunca mexe no Git (ver `rules/proibido-commit-ia.md`).
|
||||
|
|
|
|||
|
|
@ -27,6 +27,7 @@ O agente pode executar sem perguntar:
|
|||
- Gerar JSDoc em funções compartilhadas
|
||||
- Extrair CSS para arquivo co-localizado
|
||||
- Aplicar padrões de nomenclatura já definidos em rules
|
||||
- Executar `git add`, `git commit` e `git push` exclusivamente no repositório da Wiki (`<base_projeto>/../wiki`) ao criar ou atualizar documentações
|
||||
|
||||
## Ações que Requerem Confirmação
|
||||
|
||||
|
|
@ -44,6 +45,7 @@ O agente deve **propor e aguardar aprovação**:
|
|||
|
||||
O agente **nunca** deve:
|
||||
|
||||
- Executar `git commit` ou `git push` no repositório da aplicação (`<base_projeto>`)
|
||||
- Deletar ou corromper `memorias-ia/modulo.yml` ou memórias/ADRs sem instrução explícita do operador
|
||||
- Assumir ou inventar IDs de módulos ou rotas sem consultar `memorias-ia/modulo.yml`
|
||||
- Alterar artefatos globais (sufixo `.global`) sem justificativa
|
||||
|
|
|
|||
|
|
@ -1,34 +1,38 @@
|
|||
---
|
||||
type: rule
|
||||
name: proibido-commit-ia
|
||||
description: A IA nunca pode executar git commit, git push ou qualquer operação que altere o histórico do repositório
|
||||
description: A IA nunca mexe no git da aplicação principal; commit e push são permitidos e obrigatórios exclusivamente no repositório da Wiki (../wiki)
|
||||
scope: global
|
||||
trigger: always_on
|
||||
updatedAt: "2026-06-19"
|
||||
updatedAt: "2026-09-05"
|
||||
---
|
||||
|
||||
# Regra: Proibido Commit pela IA
|
||||
# Regra: Proibido Commit pela IA na Aplicação e Exceção Obrigatória da Wiki
|
||||
|
||||
## Contexto
|
||||
|
||||
O controle de versão é responsabilidade exclusiva do usuário humano. A IA pode preparar alterações, criar arquivos, editar código e até sugerir mensagens de commit — mas NUNCA deve executar comandos que alterem o histórico do repositório.
|
||||
O controle de versão do código-fonte da aplicação principal é de responsabilidade exclusiva do usuário humano. A IA pode preparar alterações, criar arquivos, editar código e até sugerir mensagens de commit — mas NUNCA deve executar comandos que alterem o histórico do repositório da aplicação.
|
||||
|
||||
Por outro lado, o repositório central de documentação (`<base_projeto>/../wiki`), que hospeda a Wiki do Usuário (Pilar 3) e a Wiki de Desenvolvimento (Pilar 4), é uma base viva de documentação. Quando atualizado pelo agente (ex.: via `/doc`, `/documentacao` ou workflows DDD), o commit e o push DEVEM ser executados automaticamente pelo agente, restritos exclusivamente a esse repositório.
|
||||
|
||||
## Regra
|
||||
|
||||
A IA **NUNCA** deve executar os seguintes comandos (nem variações deles):
|
||||
### 1. Na Aplicação Principal (`<base_projeto>`) — RIGOROSAMENTE PROIBIDO MEXER NO GIT
|
||||
|
||||
- `git commit`
|
||||
- `git push`
|
||||
- `git merge`
|
||||
- `git rebase`
|
||||
- `git tag`
|
||||
- `git reset`
|
||||
- `git revert`
|
||||
- `git cherry-pick`
|
||||
- `git stash drop`
|
||||
- `git branch -d` / `git branch -D`
|
||||
A IA **NUNCA** deve executar comandos que alterem o histórico do repositório da aplicação (nem variações deles):
|
||||
|
||||
### Comandos permitidos (somente leitura e staging)
|
||||
- `git commit` ❌
|
||||
- `git push` ❌
|
||||
- `git merge` ❌
|
||||
- `git rebase` ❌
|
||||
- `git tag` ❌
|
||||
- `git reset` ❌
|
||||
- `git revert` ❌
|
||||
- `git cherry-pick` ❌
|
||||
- `git stash drop` ❌
|
||||
- `git branch -d` / `git branch -D` ❌
|
||||
|
||||
**Comandos permitidos na aplicação (somente leitura e staging):**
|
||||
|
||||
- `git status` ✅
|
||||
- `git diff` ✅
|
||||
|
|
@ -39,37 +43,52 @@ A IA **NUNCA** deve executar os seguintes comandos (nem variações deles):
|
|||
- `git ls-files` ✅
|
||||
- `git show` ✅
|
||||
|
||||
## Exemplos
|
||||
### 2. No Repositório da Wiki (`<base_projeto>/../wiki`) — COMMIT E PUSH OBRIGATÓRIOS
|
||||
|
||||
❌ **Errado** — commitar automaticamente:
|
||||
```sh
|
||||
git add -A && git commit -m "fix: corrigir bug"
|
||||
Sempre que a documentação em `<base_projeto>/../wiki` for criada ou modificada (manuais de usuário em `<modulo-id>/`, regras de negócio em `dev/<modulo-id>/`, ADRs em `dev/<modulo-id>/adrs/`, etc.), o agente **DEVE obrigatoriamente** realizar o commit e push das alterações:
|
||||
|
||||
```bash
|
||||
# Executar estritamente apontando para a pasta ../wiki
|
||||
git -C <base_projeto>/../wiki add -A
|
||||
git -C <base_projeto>/../wiki commit -m "docs(<modulo-id>): <descrição sucinta das alterações>"
|
||||
git -C <base_projeto>/../wiki push
|
||||
```
|
||||
|
||||
❌ **Errado** — push automático:
|
||||
**Fronteira Inegociável:** Esta permissão é restrita e isolada ao repositório `<base_projeto>/../wiki`. A IA **nunca** deve executar commit ou push na aplicação principal.
|
||||
|
||||
## Exemplos
|
||||
|
||||
### ❌ Errado — commitar automaticamente na aplicação
|
||||
```sh
|
||||
# Na raiz da aplicação (<base_projeto>): PROIBIDO
|
||||
git add -A && git commit -m "fix: corrigir bug"
|
||||
git push origin main
|
||||
```
|
||||
|
||||
✅ **Correto** — preparar e informar:
|
||||
### ✅ Correto — na aplicação principal, apenas preparar e sugerir
|
||||
```sh
|
||||
git add -A
|
||||
git status
|
||||
# Informar ao usuário: "Alterações staged. Revise e faça o commit quando estiver pronto."
|
||||
# Informar ao usuário: "Alterações staged na aplicação. Revise e faça o commit quando estiver pronto."
|
||||
# Sugestão de commit: git commit -m "feat: adicionar validação de schema"
|
||||
```
|
||||
|
||||
✅ **Correto** — sugerir mensagem de commit:
|
||||
```
|
||||
Sugestão de commit:
|
||||
git commit -m "feat: adicionar validação de schema no endpoint /usuarios"
|
||||
### ✅ Correto — na Wiki, commitar e enviar automaticamente
|
||||
```sh
|
||||
# No repositório de documentação (<base_projeto>/../wiki): OBRIGATÓRIO
|
||||
git -C ../wiki add -A
|
||||
git -C ../wiki commit -m "docs(e-licencie): atualizar regras de negócio e manuais"
|
||||
git -C ../wiki push
|
||||
```
|
||||
|
||||
## Impacto
|
||||
|
||||
- **Segurança:** o usuário mantém controle total sobre o que entra no histórico
|
||||
- **Revisão:** toda alteração pode ser inspecionada antes de ser commitada
|
||||
- **Reversibilidade:** evita commits acidentais que poluem o histórico
|
||||
- **Segurança na aplicação:** O desenvolvedor mantém controle total sobre o histórico de código da aplicação.
|
||||
- **Agilidade e perenidade na wiki:** A documentação fica sempre sincronizada e publicada imediatamente sem fricção manual.
|
||||
- **Isolamento de escopo:** Fronteira clara e explícita entre repositório de aplicação e repositório de documentação.
|
||||
|
||||
## Referências
|
||||
|
||||
- Princípio de autonomia controlada: a IA executa, o humano decide
|
||||
- Rule: `rules/ddd-documentacao-primeiro.md`
|
||||
- Skill: `skills/documentacao/SKILL.md`
|
||||
- Workflow: `global/workflows/documentacao.md`
|
||||
|
|
|
|||
|
|
@ -1,13 +1,13 @@
|
|||
---
|
||||
name: doc
|
||||
description: Alias rápido para /documentacao - acionar o Agente de Documentação & Memória
|
||||
description: Alias rápido para /documentacao - acionar o Agente de Documentação & Memória com versionamento automático na Wiki
|
||||
scope: global
|
||||
updatedAt: "2026-09-01"
|
||||
updatedAt: "2026-09-05"
|
||||
---
|
||||
|
||||
# Skill: /doc (Alias para /documentacao)
|
||||
|
||||
Atalho rápido para o **Agente de Documentação & Memória** cobrindo os 6 pilares canônicos:
|
||||
Atalho rápido para o **Agente de Documentação & Memória** cobrindo os 6 pilares canônicos do Documentation-Driven Development (DDD):
|
||||
|
||||
> ⚡ **Modo Padrão Sem Parâmetros:** Se executado apenas como `/doc`, documenta e sincroniza automaticamente todo o contexto e decisões da conversa atual no chat.
|
||||
|
||||
|
|
@ -18,4 +18,21 @@ Atalho rápido para o **Agente de Documentação & Memória** cobrindo os 6 pila
|
|||
- `5. Rota IA` $\rightarrow$ Rota do backend `/llm.md`
|
||||
- `6. Memória IA` $\rightarrow$ `<base_projeto>/memorias-ia/`
|
||||
|
||||
Para ver a documentação completa e exemplos, consulte [`skills/documentacao/SKILL.md`](file:///home/luiz/Arquivos/DEV/Industria/SIGMA2026/.agent/skills/documentacao/SKILL.md).
|
||||
---
|
||||
|
||||
## 🔄 Versionamento Git Obrigatório da Wiki (`<base_projeto>/../wiki`)
|
||||
|
||||
Sempre que a documentação na Wiki (Pilares 3 e 4) for alterada ou criada:
|
||||
- O agente **DEVE obrigatoriamente executar commit e push** das alterações exclusivamente no repositório da Wiki:
|
||||
```bash
|
||||
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 controle de versão do código da aplicação é de responsabilidade humana exclusiva (ver `rules/proibido-commit-ia.md`).
|
||||
|
||||
---
|
||||
|
||||
Para ver a especificação completa, comandos com argumentos e exemplos, consulte [`skills/documentacao/SKILL.md`](../documentacao/SKILL.md).
|
||||
|
|
|
|||
|
|
@ -1,13 +1,13 @@
|
|||
---
|
||||
name: doc
|
||||
description: Alias rápido para /documentacao - acionar o Agente de Documentação & Memória
|
||||
description: Alias rápido para /documentacao - acionar o Agente de Documentação & Memória com versionamento automático na Wiki
|
||||
scope: global
|
||||
updatedAt: "2026-09-01"
|
||||
updatedAt: "2026-09-05"
|
||||
---
|
||||
|
||||
# Skill: /doc (Alias para /documentacao)
|
||||
|
||||
Atalho rápido para o **Agente de Documentação & Memória** cobrindo os 6 pilares canônicos:
|
||||
Atalho rápido para o **Agente de Documentação & Memória** cobrindo os 6 pilares canônicos do Documentation-Driven Development (DDD):
|
||||
|
||||
> ⚡ **Modo Padrão Sem Parâmetros:** Se executado apenas como `/doc`, documenta e sincroniza automaticamente todo o contexto e decisões da conversa atual no chat.
|
||||
|
||||
|
|
@ -18,4 +18,21 @@ Atalho rápido para o **Agente de Documentação & Memória** cobrindo os 6 pila
|
|||
- `5. Rota IA` $\rightarrow$ Rota do backend `/llm.md`
|
||||
- `6. Memória IA` $\rightarrow$ `<base_projeto>/memorias-ia/`
|
||||
|
||||
Para ver a documentação completa e exemplos, consulte [`skills/documentacao/SKILL.md`](file:///home/luiz/Arquivos/DEV/Industria/SIGMA2026/.agent/skills/documentacao/SKILL.md).
|
||||
---
|
||||
|
||||
## 🔄 Versionamento Git Obrigatório da Wiki (`<base_projeto>/../wiki`)
|
||||
|
||||
Sempre que a documentação na Wiki (Pilares 3 e 4) for alterada ou criada:
|
||||
- O agente **DEVE obrigatoriamente executar commit e push** das alterações exclusivamente no repositório da Wiki:
|
||||
```bash
|
||||
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 controle de versão do código da aplicação é de responsabilidade humana exclusiva (ver `rules/proibido-commit-ia.md`).
|
||||
|
||||
---
|
||||
|
||||
Para ver a especificação completa, comandos com argumentos e exemplos, consulte [`skills/documentacao/SKILL.md`](../documentacao/SKILL.md).
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
name: documentacao
|
||||
description: Acionar o Agente de Documentação & Memória para documentar o contexto da conversa ou gerar artefatos nos 6 pilares canônicos
|
||||
description: 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
|
||||
scope: global
|
||||
updatedAt: "2026-09-01"
|
||||
updatedAt: "2026-09-05"
|
||||
---
|
||||
|
||||
# Skill / Workflow: /documentacao
|
||||
|
|
@ -21,6 +21,14 @@ Esta skill aciona o **Agente de Documentação & Memória** para gerar, atualiza
|
|||
4. **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).
|
||||
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/`.
|
||||
7. **Sincronização Git da Wiki (Obrigatório e Exclusivo):**
|
||||
- Se houver arquivos novos ou alterados em `<base_projeto>/../wiki/`:
|
||||
```bash
|
||||
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).
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -49,16 +57,18 @@ Esta skill aciona o **Agente de Documentação & Memória** para gerar, atualiza
|
|||
# Criar ajuda contextual modalX.ajuda.md para modal/tela
|
||||
/documentacao ajuda <caminho/modalX.vue>
|
||||
|
||||
# Documentar domínio na Wiki do Usuário (VitePress)
|
||||
# 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)
|
||||
# Documentar regras de negócio na Wiki Dev (VitePress) + commit/push na wiki
|
||||
/documentacao regras <caminho/servico.ts>
|
||||
|
||||
# Criar um ADR na Wiki Dev
|
||||
# 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
|
||||
|
|
@ -67,3 +77,4 @@ Esta skill aciona o **Agente de Documentação & Memória** para gerar, atualiza
|
|||
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 `<base_projeto>/../wiki/`.
|
||||
5. **Fronteira Git e Push Obrigatório na Wiki:** Toda atualização em `<base_projeto>/../wiki` DEVE ser commitada e enviada via `git push` exclusivamente dentro do diretório `../wiki`. Na aplicação principal (`<base_projeto>`), a IA nunca mexe no Git (ver `rules/proibido-commit-ia.md`).
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
name: documentacao
|
||||
description: Acionar o Agente de Documentação & Memória para documentar o contexto da conversa ou gerar artefatos nos 6 pilares canônicos
|
||||
description: 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
|
||||
scope: global
|
||||
updatedAt: "2026-09-01"
|
||||
updatedAt: "2026-09-05"
|
||||
---
|
||||
|
||||
# Skill / Workflow: /documentacao
|
||||
|
|
@ -21,6 +21,14 @@ Esta skill aciona o **Agente de Documentação & Memória** para gerar, atualiza
|
|||
4. **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).
|
||||
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/`.
|
||||
7. **Sincronização Git da Wiki (Obrigatório e Exclusivo):**
|
||||
- Se houver arquivos novos ou alterados em `<base_projeto>/../wiki/`:
|
||||
```bash
|
||||
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).
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -49,16 +57,18 @@ Esta skill aciona o **Agente de Documentação & Memória** para gerar, atualiza
|
|||
# Criar ajuda contextual modalX.ajuda.md para modal/tela
|
||||
/documentacao ajuda <caminho/modalX.vue>
|
||||
|
||||
# Documentar domínio na Wiki do Usuário (VitePress)
|
||||
# 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)
|
||||
# Documentar regras de negócio na Wiki Dev (VitePress) + commit/push na wiki
|
||||
/documentacao regras <caminho/servico.ts>
|
||||
|
||||
# Criar um ADR na Wiki Dev
|
||||
# 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
|
||||
|
|
@ -67,3 +77,4 @@ Esta skill aciona o **Agente de Documentação & Memória** para gerar, atualiza
|
|||
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 `<base_projeto>/../wiki/`.
|
||||
5. **Fronteira Git e Push Obrigatório na Wiki:** Toda atualização em `<base_projeto>/../wiki` DEVE ser commitada e enviada via `git push` exclusivamente dentro do diretório `../wiki`. Na aplicação principal (`<base_projeto>`), a IA nunca mexe no Git (ver `rules/proibido-commit-ia.md`).
|
||||
|
|
|
|||
|
|
@ -103,3 +103,4 @@ Se o módulo introduziu ou alterou arquitetura ou regras consolidadas do módulo
|
|||
- Atualizar a especificação técnica na **Wiki de Desenvolvimento** em `<base_projeto>/../wiki/dev/<modulo>/`.
|
||||
- Criar ou atualizar ADR em `<base_projeto>/../wiki/dev/<modulo>/adrs/` via skill `documentar-decisao-tecnica`.
|
||||
- Registrar decisões e ações na memória em `<base_projeto>/memorias-ia/`.
|
||||
- **Sincronização Git:** Executar commit e push exclusivamente na Wiki (`git -C <base_projeto>/../wiki add -A && git -C <base_projeto>/../wiki commit -m "docs(<modulo-id>): regras de negócio" && git -C <base_projeto>/../wiki push`). Na aplicação (`<base_projeto>`), nunca mexer no git.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue