50 lines
2.8 KiB
Text
50 lines
2.8 KiB
Text
---
|
|
name: doc
|
|
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-05"
|
|
---
|
|
|
|
# Skill: /doc (Alias para /documentacao)
|
|
|
|
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.
|
|
|
|
- `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 arquivo central `historico-acoes.md`)
|
|
|
|
---
|
|
|
|
## 🧠 Pilar 6: Memória da IA e Histórico de Ações (`memorias-ia/`)
|
|
|
|
Ao documentar a sessão (seja via `/doc` ou `/documentacao`):
|
|
1. **Arquivo da Sessão:** O agente gera o registro detalhado em `<base_projeto>/memorias-ia/sessao-AAAA-MM-DD-slug.md` descrevendo contexto, causa raiz, solução técnica, citações no código-fonte e validações.
|
|
2. **Índice de Ações (`historico-acoes.md`):** O agente registra/atualiza a linha correspondente na tabela de `<base_projeto>/memorias-ia/historico-acoes.md`:
|
|
```markdown
|
|
| Data | Memória / Ação | Arquivo Memoria | Citações no Código-Fonte |
|
|
| :--- | :--- | :--- | :--- |
|
|
| **AAAA-MM-DD** | [Descrição da Ação] | [`sessao-AAAA-MM-DD-slug.md`](./sessao-AAAA-MM-DD-slug.md) | `caminho/arquivo.ts`<br>`outro/arquivo.vue` |
|
|
```
|
|
|
|
|
|
## 🔄 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).
|