@onion-architect-ai/cli 4.1.0-beta.4 → 4.1.0-beta.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cli.js +1 -1
- package/dist/cli.js.map +1 -1
- package/package.json +1 -1
- package/templates/.cursor/agents/development/c4-architecture-specialist.md +712 -0
- package/templates/.cursor/agents/development/c4-documentation-specialist.md +658 -0
- package/templates/.cursor/agents/development/clickup-specialist.md +397 -0
- package/templates/.cursor/agents/development/cursor-specialist.md +249 -0
- package/templates/.cursor/agents/development/docs-reverse-engineer.md +418 -0
- package/templates/.cursor/agents/development/gamma-api-specialist.md +1169 -0
- package/templates/.cursor/agents/development/gitflow-specialist.md +1207 -0
- package/templates/.cursor/agents/development/linux-security-specialist.md +676 -0
- package/templates/.cursor/agents/development/mermaid-specialist.md +516 -0
- package/templates/.cursor/agents/development/nodejs-specialist.md +673 -0
- package/templates/.cursor/agents/development/nx-migration-specialist.md +867 -0
- package/templates/.cursor/agents/development/nx-monorepo-specialist.md +619 -0
- package/templates/.cursor/agents/development/postgres-specialist.md +1124 -0
- package/templates/.cursor/agents/development/react-developer.md +132 -0
- package/templates/.cursor/agents/development/runflow-specialist.md +278 -0
- package/templates/.cursor/agents/development/system-documentation-orchestrator.md +1388 -0
- package/templates/.cursor/agents/development/task-specialist.md +618 -0
- package/templates/.cursor/agents/development/whisper-specialist.md +373 -0
- package/templates/.cursor/agents/development/zen-engine-specialist.md +421 -0
- package/templates/.cursor/agents/git/branch-code-reviewer.md +200 -0
- package/templates/.cursor/agents/git/branch-documentation-writer.md +162 -0
- package/templates/.cursor/agents/git/branch-metaspec-checker.md +68 -0
- package/templates/.cursor/agents/git/branch-test-planner.md +177 -0
- package/templates/.cursor/agents/product/branding-positioning-specialist.md +1030 -0
- package/templates/.cursor/agents/product/extract-meeting-specialist.md +395 -0
- package/templates/.cursor/agents/product/meeting-consolidator.md +483 -0
- package/templates/.cursor/agents/product/pain-price-specialist.md +509 -0
- package/templates/.cursor/agents/product/presentation-orchestrator.md +1191 -0
- package/templates/.cursor/agents/product/product-agent.md +202 -0
- package/templates/.cursor/agents/product/story-points-framework-specialist.md +539 -0
- package/templates/.cursor/agents/product/storytelling-business-specialist.md +891 -0
- package/templates/.cursor/agents/review/code-reviewer.md +155 -0
- package/templates/.cursor/agents/testing/test-agent.md +425 -0
- package/templates/.cursor/agents/testing/test-engineer.md +295 -0
- package/templates/.cursor/agents/testing/test-planner.md +118 -0
- package/templates/.cursor/commands/docs/build-business-docs.md +276 -0
- package/templates/.cursor/commands/docs/build-index.md +128 -0
- package/templates/.cursor/commands/docs/build-tech-docs.md +204 -0
- package/templates/.cursor/commands/docs/consolidate-documents.md +424 -0
- package/templates/.cursor/commands/docs/docs-health.md +142 -0
- package/templates/.cursor/commands/docs/help.md +306 -0
- package/templates/.cursor/commands/docs/refine-vision.md +27 -0
- package/templates/.cursor/commands/docs/reverse-consolidate.md +160 -0
- package/templates/.cursor/commands/docs/sync-sessions.md +320 -0
- package/templates/.cursor/commands/docs/validate-docs.md +159 -0
- package/templates/.cursor/commands/engineer/bump.md +43 -0
- package/templates/.cursor/commands/engineer/docs.md +39 -0
- package/templates/.cursor/commands/engineer/help.md +329 -0
- package/templates/.cursor/commands/engineer/hotfix.md +186 -0
- package/templates/.cursor/commands/engineer/plan.md +111 -0
- package/templates/.cursor/commands/engineer/pr-update.md +198 -0
- package/templates/.cursor/commands/engineer/pr.md +136 -0
- package/templates/.cursor/commands/engineer/pre-pr.md +91 -0
- package/templates/.cursor/commands/engineer/start.md +266 -0
- package/templates/.cursor/commands/engineer/validate-phase-sync.md +118 -0
- package/templates/.cursor/commands/engineer/warm-up.md +173 -0
- package/templates/.cursor/commands/engineer/work.md +169 -0
- package/templates/.cursor/commands/git/code-review.md +215 -0
- package/templates/.cursor/commands/git/fast-commit.md +45 -0
- package/templates/.cursor/commands/git/feature/finish.md +90 -0
- package/templates/.cursor/commands/git/feature/publish.md +91 -0
- package/templates/.cursor/commands/git/feature/start.md +158 -0
- package/templates/.cursor/commands/git/help.md +306 -0
- package/templates/.cursor/commands/git/hotfix/finish.md +98 -0
- package/templates/.cursor/commands/git/hotfix/start.md +94 -0
- package/templates/.cursor/commands/git/init.md +139 -0
- package/templates/.cursor/commands/git/release/finish.md +98 -0
- package/templates/.cursor/commands/git/release/start.md +95 -0
- package/templates/.cursor/commands/git/sync.md +228 -0
- package/templates/.cursor/commands/global/help.md +388 -0
- package/templates/.cursor/commands/product/analyze-pain-price.md +709 -0
- package/templates/.cursor/commands/product/branding.md +460 -0
- package/templates/.cursor/commands/product/check.md +48 -0
- package/templates/.cursor/commands/product/checklist-sync.md +241 -0
- package/templates/.cursor/commands/product/collect.md +96 -0
- package/templates/.cursor/commands/product/consolidate-meetings.md +306 -0
- package/templates/.cursor/commands/product/convert-to-tasks.md +220 -0
- package/templates/.cursor/commands/product/estimate.md +519 -0
- package/templates/.cursor/commands/product/extract-meeting.md +241 -0
- package/templates/.cursor/commands/product/feature.md +431 -0
- package/templates/.cursor/commands/product/help.md +212 -0
- package/templates/.cursor/commands/product/light-arch.md +97 -0
- package/templates/.cursor/commands/product/presentation.md +189 -0
- package/templates/.cursor/commands/product/refine.md +186 -0
- package/templates/.cursor/commands/product/spec.md +107 -0
- package/templates/.cursor/commands/product/task-check.md +340 -0
- package/templates/.cursor/commands/product/task.md +585 -0
- package/templates/.cursor/commands/product/transform-consolidated.md +592 -0
- package/templates/.cursor/commands/product/validate-task.md +294 -0
- package/templates/.cursor/commands/product/warm-up.md +187 -0
- package/templates/.cursor/commands/product/whisper.md +325 -0
- package/templates/.cursor/commands/test/e2e.md +392 -0
- package/templates/.cursor/commands/test/integration.md +523 -0
- package/templates/.cursor/commands/test/unit.md +378 -0
|
@@ -0,0 +1,320 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: sync-sessions
|
|
3
|
+
description: Sincronizar e organizar sessões de trabalho do Sistema Onion.
|
|
4
|
+
model: sonnet
|
|
5
|
+
category: docs
|
|
6
|
+
tags: [sessions, sync, organization]
|
|
7
|
+
version: "4.0.0"
|
|
8
|
+
updated: "2025-12-20"
|
|
9
|
+
level: intermediate
|
|
10
|
+
context: technical
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# 🔄 Sync Sessions - Sincronização de Sessões Onion
|
|
14
|
+
|
|
15
|
+
Sincroniza e organiza todas as sessões de trabalho do Sistema Onion, garantindo que o contexto de desenvolvimento esteja preservado e acessível para referência futura.
|
|
16
|
+
|
|
17
|
+
## 🎯 Objetivo
|
|
18
|
+
|
|
19
|
+
Este comando analisa o trabalho realizado na sessão atual, organiza a documentação gerada e sincroniza com a estrutura `.cursor/sessions/`, mantendo um histórico organizado de todas as atividades de desenvolvimento.
|
|
20
|
+
|
|
21
|
+
## 🎯 Funcionalidades
|
|
22
|
+
|
|
23
|
+
### Organização de Sessões
|
|
24
|
+
- Detecta o trabalho realizado na sessão atual
|
|
25
|
+
- Cria estrutura organizada por data e tópico
|
|
26
|
+
- Preserva contexto e decisões tomadas
|
|
27
|
+
- Gera índice navegável de sessões
|
|
28
|
+
|
|
29
|
+
### Sincronização Automática
|
|
30
|
+
- Identifica arquivos criados/modificados
|
|
31
|
+
- Captura comandos Onion executados
|
|
32
|
+
- Preserva interações e decisões
|
|
33
|
+
- Mantém histórico de mudanças
|
|
34
|
+
|
|
35
|
+
### Validação e Integridade
|
|
36
|
+
- Verifica completude da documentação da sessão
|
|
37
|
+
- Valida estrutura de diretórios
|
|
38
|
+
- Identifica sessões incompletas
|
|
39
|
+
- Sugere melhorias na organização
|
|
40
|
+
|
|
41
|
+
## 🚀 Como Usar
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
# Sincronizar sessão atual
|
|
45
|
+
/docs/sync-sessions
|
|
46
|
+
|
|
47
|
+
# Sincronizar com nome customizado
|
|
48
|
+
/docs/sync-sessions "implementacao-feature-x"
|
|
49
|
+
|
|
50
|
+
# Sincronizar e arquivar sessão
|
|
51
|
+
/docs/sync-sessions --archive
|
|
52
|
+
|
|
53
|
+
# Apenas validar sem sincronizar
|
|
54
|
+
/docs/sync-sessions --validate-only
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## 📋 Processo Executado
|
|
58
|
+
|
|
59
|
+
### 1. **Análise da Sessão Atual**
|
|
60
|
+
- Identifica data/hora de início
|
|
61
|
+
- Lista arquivos criados/modificados
|
|
62
|
+
- Captura comandos executados
|
|
63
|
+
- Extrai decisões e contexto
|
|
64
|
+
|
|
65
|
+
### 2. **Estruturação**
|
|
66
|
+
```
|
|
67
|
+
.cursor/sessions/
|
|
68
|
+
└── YYYY-MM-DD_HHMM_topic-name/
|
|
69
|
+
├── README.md # Resumo da sessão
|
|
70
|
+
├── context.md # Contexto inicial
|
|
71
|
+
├── decisions.md # Decisões tomadas
|
|
72
|
+
├── changes.md # Mudanças realizadas
|
|
73
|
+
├── notes.md # Notas e observações
|
|
74
|
+
├── files-changed.txt # Lista de arquivos
|
|
75
|
+
└── commands-executed.txt # Comandos usados
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### 3. **Geração de Documentação**
|
|
79
|
+
- **README.md**: Resumo executivo da sessão
|
|
80
|
+
- **context.md**: Contexto e motivação
|
|
81
|
+
- **decisions.md**: Decisões arquiteturais e técnicas
|
|
82
|
+
- **changes.md**: Log detalhado de mudanças
|
|
83
|
+
- **notes.md**: Anotações e insights
|
|
84
|
+
|
|
85
|
+
### 4. **Sincronização**
|
|
86
|
+
- Move/copia arquivos para estrutura correta
|
|
87
|
+
- Atualiza índice de sessões
|
|
88
|
+
- Gera links de navegação
|
|
89
|
+
- Valida integridade
|
|
90
|
+
|
|
91
|
+
## 📁 Estrutura de Sessão
|
|
92
|
+
|
|
93
|
+
### README.md
|
|
94
|
+
```markdown
|
|
95
|
+
# [Topic Name] - [Date]
|
|
96
|
+
|
|
97
|
+
## 🎯 Objetivo
|
|
98
|
+
[Descrição do objetivo da sessão]
|
|
99
|
+
|
|
100
|
+
## 📊 Resultados
|
|
101
|
+
- [Lista de entregas]
|
|
102
|
+
- [Arquivos criados/modificados]
|
|
103
|
+
|
|
104
|
+
## 🔗 Links Relacionados
|
|
105
|
+
- [Documentação relacionada]
|
|
106
|
+
- [Issues/PRs relacionados]
|
|
107
|
+
|
|
108
|
+
## ⏱️ Tempo Investido
|
|
109
|
+
[Duração aproximada]
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
### context.md
|
|
113
|
+
```markdown
|
|
114
|
+
# Contexto - [Topic]
|
|
115
|
+
|
|
116
|
+
## Situação Inicial
|
|
117
|
+
[Estado do projeto antes da sessão]
|
|
118
|
+
|
|
119
|
+
## Motivação
|
|
120
|
+
[Por que este trabalho foi necessário]
|
|
121
|
+
|
|
122
|
+
## Restrições
|
|
123
|
+
[Limitações técnicas, tempo, recursos]
|
|
124
|
+
|
|
125
|
+
## Referências
|
|
126
|
+
[Links, documentos, discussões relevantes]
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
### decisions.md
|
|
130
|
+
```markdown
|
|
131
|
+
# Decisões Tomadas - [Topic]
|
|
132
|
+
|
|
133
|
+
## Decisão 1: [Título]
|
|
134
|
+
- **Contexto**: [Por que esta decisão foi necessária]
|
|
135
|
+
- **Opções Consideradas**:
|
|
136
|
+
- Opção A: [Prós/Contras]
|
|
137
|
+
- Opção B: [Prós/Contras]
|
|
138
|
+
- **Decisão**: [Opção escolhida]
|
|
139
|
+
- **Justificativa**: [Razões]
|
|
140
|
+
- **Impacto**: [Consequências]
|
|
141
|
+
|
|
142
|
+
## Decisão 2: [Título]
|
|
143
|
+
[...]
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
### changes.md
|
|
147
|
+
```markdown
|
|
148
|
+
# Mudanças Realizadas - [Topic]
|
|
149
|
+
|
|
150
|
+
## Arquivos Criados
|
|
151
|
+
- `path/to/file1.ts` - [Descrição]
|
|
152
|
+
- `path/to/file2.md` - [Descrição]
|
|
153
|
+
|
|
154
|
+
## Arquivos Modificados
|
|
155
|
+
- `path/to/existing.ts`
|
|
156
|
+
- [Descrição da mudança]
|
|
157
|
+
- [Linhas afetadas]
|
|
158
|
+
|
|
159
|
+
## Comandos Executados
|
|
160
|
+
1. `/docs/build-tech-docs` - [Resultado]
|
|
161
|
+
2. `/git/create-branch` - [Branch criada]
|
|
162
|
+
|
|
163
|
+
## Testes Adicionados
|
|
164
|
+
- [Lista de testes criados]
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
## 🤖 Integração com Agentes
|
|
168
|
+
|
|
169
|
+
Este comando convoca automaticamente:
|
|
170
|
+
- **@branch-documentation-writer**: Gera documentação estruturada
|
|
171
|
+
- **@metaspec-gate-keeper**: Valida conformidade com padrões
|
|
172
|
+
- **@gitflow-specialist**: Auxilia em questões Git se necessário
|
|
173
|
+
|
|
174
|
+
## ⚙️ Opções Avançadas
|
|
175
|
+
|
|
176
|
+
### Flags Disponíveis
|
|
177
|
+
```bash
|
|
178
|
+
--archive # Move sessão para archived/
|
|
179
|
+
--validate-only # Apenas valida sem sincronizar
|
|
180
|
+
--force # Força sincronização mesmo com erros
|
|
181
|
+
--skip-git # Não inclui informações Git
|
|
182
|
+
--detailed # Gera relatório detalhado
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
### Exemplos Avançados
|
|
186
|
+
```bash
|
|
187
|
+
# Sincronizar e arquivar sessão antiga
|
|
188
|
+
/docs/sync-sessions "refactoring-api" --archive
|
|
189
|
+
|
|
190
|
+
# Validar integridade sem modificar
|
|
191
|
+
/docs/sync-sessions --validate-only
|
|
192
|
+
|
|
193
|
+
# Sincronização forçada com relatório detalhado
|
|
194
|
+
/docs/sync-sessions --force --detailed
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
## 📊 Métricas Capturadas
|
|
198
|
+
|
|
199
|
+
O comando captura automaticamente:
|
|
200
|
+
- **Arquivos**: Criados, modificados, deletados
|
|
201
|
+
- **Linhas de Código**: Adicionadas, removidas
|
|
202
|
+
- **Comandos**: Onion executados
|
|
203
|
+
- **Tempo**: Duração aproximada da sessão
|
|
204
|
+
- **Agentes**: AI agents convocados
|
|
205
|
+
- **Commits**: Git commits relacionados (se aplicável)
|
|
206
|
+
|
|
207
|
+
## ⚠️ Resolução de Problemas
|
|
208
|
+
|
|
209
|
+
### **Problema 1: Sessão já existe**
|
|
210
|
+
- **Sintoma**: Erro "Session directory already exists"
|
|
211
|
+
- **Solução**: Use flag `--force` ou renomeie a sessão
|
|
212
|
+
|
|
213
|
+
### **Problema 2: Arquivos não detectados**
|
|
214
|
+
- **Sintoma**: Lista de arquivos incompleta
|
|
215
|
+
- **Causa**: Arquivos fora do workspace ou gitignored
|
|
216
|
+
- **Fix**: Verifique `.gitignore` e workspace boundaries
|
|
217
|
+
|
|
218
|
+
### **Problema 3: Contexto insuficiente**
|
|
219
|
+
- **Sintoma**: README.md com pouca informação
|
|
220
|
+
- **Solução**: Execute comandos Onion com mais contexto antes de sincronizar
|
|
221
|
+
|
|
222
|
+
## 🔍 Validações Realizadas
|
|
223
|
+
|
|
224
|
+
O comando valida:
|
|
225
|
+
- ✅ Estrutura de diretórios correta
|
|
226
|
+
- ✅ Todos os arquivos markdown obrigatórios presentes
|
|
227
|
+
- ✅ README.md com seções mínimas
|
|
228
|
+
- ✅ Links internos funcionando
|
|
229
|
+
- ✅ Sem duplicação de sessões
|
|
230
|
+
- ✅ Índice de sessões atualizado
|
|
231
|
+
|
|
232
|
+
## 📈 Output Esperado
|
|
233
|
+
|
|
234
|
+
```bash
|
|
235
|
+
🔄 Sincronizando Sessão Onion...
|
|
236
|
+
|
|
237
|
+
📊 Análise da Sessão:
|
|
238
|
+
• Tópico: implementação-dashboard-operacoes
|
|
239
|
+
• Data: 2025-10-03 10:30
|
|
240
|
+
• Arquivos Criados: 15
|
|
241
|
+
• Arquivos Modificados: 8
|
|
242
|
+
• Comandos Executados: 5
|
|
243
|
+
• Agentes Convocados: 3
|
|
244
|
+
|
|
245
|
+
📁 Estrutura Criada:
|
|
246
|
+
✅ .cursor/sessions/2025-10-03_1030_dashboard-operacoes/
|
|
247
|
+
✅ README.md
|
|
248
|
+
✅ context.md
|
|
249
|
+
✅ decisions.md
|
|
250
|
+
✅ changes.md
|
|
251
|
+
✅ notes.md
|
|
252
|
+
✅ files-changed.txt
|
|
253
|
+
✅ commands-executed.txt
|
|
254
|
+
|
|
255
|
+
🔗 Índice Atualizado:
|
|
256
|
+
✅ .cursor/sessions/INDEX.md
|
|
257
|
+
|
|
258
|
+
✅ Sessão sincronizada com sucesso!
|
|
259
|
+
|
|
260
|
+
📚 Para revisar:
|
|
261
|
+
cat .cursor/sessions/2025-10-03_1030_dashboard-operacoes/README.md
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
## 🎯 Casos de Uso
|
|
265
|
+
|
|
266
|
+
### Caso 1: Fim de Sessão de Desenvolvimento
|
|
267
|
+
```bash
|
|
268
|
+
# Ao terminar trabalho do dia
|
|
269
|
+
/docs/sync-sessions "refactoring-contracts-module"
|
|
270
|
+
```
|
|
271
|
+
|
|
272
|
+
### Caso 2: Antes de Trocar de Branch
|
|
273
|
+
```bash
|
|
274
|
+
# Preservar contexto antes de mudar de tarefa
|
|
275
|
+
/docs/sync-sessions --detailed
|
|
276
|
+
git checkout other-branch
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
### Caso 3: Auditoria de Trabalho Realizado
|
|
280
|
+
```bash
|
|
281
|
+
# Gerar relatório completo da sessão
|
|
282
|
+
/docs/sync-sessions --validate-only --detailed
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
### Caso 4: Arquivar Trabalho Concluído
|
|
286
|
+
```bash
|
|
287
|
+
# Mover sessão para archived após merge
|
|
288
|
+
/docs/sync-sessions "feature-x-completed" --archive
|
|
289
|
+
```
|
|
290
|
+
|
|
291
|
+
## 🔗 Comandos Relacionados
|
|
292
|
+
|
|
293
|
+
- `/docs/build-index` - Reconstrói índice de documentação
|
|
294
|
+
- `/docs/docs-health` - Verifica saúde da documentação
|
|
295
|
+
- `/docs/validate-docs` - Valida completude
|
|
296
|
+
- `/git/help` - Ajuda com Git workflows
|
|
297
|
+
|
|
298
|
+
## 📝 Notas Importantes
|
|
299
|
+
|
|
300
|
+
1. **Frequência**: Execute ao final de cada sessão significativa de trabalho
|
|
301
|
+
2. **Contexto**: Quanto mais contexto fornecer, melhor a documentação gerada
|
|
302
|
+
3. **Consistência**: Manter padrão de nomenclatura ajuda na navegação
|
|
303
|
+
4. **Limpeza**: Arquive sessões antigas periodicamente para manter organização
|
|
304
|
+
|
|
305
|
+
## 🎓 Best Practices
|
|
306
|
+
|
|
307
|
+
1. **Nomeie Sessions Descritivamente**: Use nomes que descrevam claramente o trabalho
|
|
308
|
+
2. **Documente Decisões**: Capture o "porquê" das decisões, não apenas o "o quê"
|
|
309
|
+
3. **Preserve Contexto**: Inclua links para issues, PRs, discussões relevantes
|
|
310
|
+
4. **Seja Consistente**: Use padrões consistentes de nomenclatura
|
|
311
|
+
5. **Arquive Regularmente**: Mova sessões antigas para `archived/` periodicamente
|
|
312
|
+
|
|
313
|
+
---
|
|
314
|
+
|
|
315
|
+
**Agente Responsável**: @branch-documentation-writer
|
|
316
|
+
**Validador**: @metaspec-gate-keeper
|
|
317
|
+
**Categoria**: Documentação / Organização
|
|
318
|
+
**Prioridade**: Média
|
|
319
|
+
**Última Atualização**: Outubro 2025
|
|
320
|
+
|
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: validate-docs
|
|
3
|
+
description: |
|
|
4
|
+
Validação de completude e consistência da documentação.
|
|
5
|
+
Use para verificar estrutura, links e padrões.
|
|
6
|
+
model: sonnet
|
|
7
|
+
|
|
8
|
+
parameters:
|
|
9
|
+
- name: path
|
|
10
|
+
description: Caminho para validar (default: docs/)
|
|
11
|
+
required: false
|
|
12
|
+
default: docs/
|
|
13
|
+
- name: fix
|
|
14
|
+
description: Corrigir problemas automaticamente
|
|
15
|
+
required: false
|
|
16
|
+
default: "false"
|
|
17
|
+
|
|
18
|
+
category: docs
|
|
19
|
+
tags:
|
|
20
|
+
- validation
|
|
21
|
+
- documentation
|
|
22
|
+
- quality
|
|
23
|
+
|
|
24
|
+
version: "4.0.0"
|
|
25
|
+
updated: "2025-12-20"
|
|
26
|
+
|
|
27
|
+
related_commands:
|
|
28
|
+
- /docs/docs-health
|
|
29
|
+
- /docs/build-tech-docs
|
|
30
|
+
|
|
31
|
+
related_agents:
|
|
32
|
+
- system-documentation-orchestrator
|
|
33
|
+
level: intermediate
|
|
34
|
+
context: technical
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
# ✅ Validar Documentação
|
|
38
|
+
|
|
39
|
+
Validação abrangente de estrutura e qualidade de docs.
|
|
40
|
+
|
|
41
|
+
## 🎯 Objetivo
|
|
42
|
+
|
|
43
|
+
Verificar completude, consistência e padrões da documentação.
|
|
44
|
+
|
|
45
|
+
## ⚡ Fluxo de Execução
|
|
46
|
+
|
|
47
|
+
### Passo 1: Validar Estrutura
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
# Arquivos obrigatórios
|
|
51
|
+
REQUIRED=(README.md CHANGELOG.md)
|
|
52
|
+
for f in "${REQUIRED[@]}"; do
|
|
53
|
+
test -f "$f" && echo "✅ $f" || echo "❌ $f ausente"
|
|
54
|
+
done
|
|
55
|
+
|
|
56
|
+
# Hierarquia de diretórios
|
|
57
|
+
ls -la {{path}}/
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
#### Checklist de Estrutura
|
|
61
|
+
|
|
62
|
+
- [ ] `README.md` na raiz
|
|
63
|
+
- [ ] `docs/` com índice
|
|
64
|
+
- [ ] Naming em kebab-case
|
|
65
|
+
- [ ] Extensão `.md`
|
|
66
|
+
|
|
67
|
+
### Passo 2: Validar Conteúdo
|
|
68
|
+
|
|
69
|
+
#### Verificações por Arquivo
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
for f in $(find {{path}} -name "*.md"); do
|
|
73
|
+
# Header presente
|
|
74
|
+
head -1 "$f" | grep -q "^#" || echo "⚠️ $f: sem header"
|
|
75
|
+
|
|
76
|
+
# Linhas mínimas
|
|
77
|
+
[ $(wc -l < "$f") -lt 10 ] && echo "⚠️ $f: muito curto"
|
|
78
|
+
done
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
#### Seções Obrigatórias
|
|
82
|
+
|
|
83
|
+
| Tipo de Doc | Seções Requeridas |
|
|
84
|
+
|-------------|-------------------|
|
|
85
|
+
| README | Objetivo, Uso, Instalação |
|
|
86
|
+
| API | Endpoints, Exemplos |
|
|
87
|
+
| Guide | Pré-requisitos, Steps |
|
|
88
|
+
| Spec | Objetivo, Requisitos |
|
|
89
|
+
|
|
90
|
+
### Passo 3: Validar Links
|
|
91
|
+
|
|
92
|
+
```bash
|
|
93
|
+
# Links internos
|
|
94
|
+
grep -roh '\[.*\](.*\.md)' {{path}}/ | \
|
|
95
|
+
sed 's/.*(\(.*\))/\1/' | \
|
|
96
|
+
while read link; do
|
|
97
|
+
test -f "$link" || echo "❌ Link quebrado: $link"
|
|
98
|
+
done
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### Passo 4: Gerar Relatório
|
|
102
|
+
|
|
103
|
+
## 📤 Output Esperado
|
|
104
|
+
|
|
105
|
+
### Sem Erros
|
|
106
|
+
|
|
107
|
+
```
|
|
108
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
109
|
+
✅ VALIDAÇÃO CONCLUÍDA
|
|
110
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
111
|
+
|
|
112
|
+
📊 Resumo:
|
|
113
|
+
∟ Arquivos: 45
|
|
114
|
+
∟ Erros: 0
|
|
115
|
+
∟ Avisos: 3
|
|
116
|
+
|
|
117
|
+
✅ Estrutura: OK
|
|
118
|
+
✅ Conteúdo: OK
|
|
119
|
+
✅ Links: OK
|
|
120
|
+
|
|
121
|
+
⚠️ Avisos:
|
|
122
|
+
∟ 3 arquivos sem update >30d
|
|
123
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
### Com Erros
|
|
127
|
+
|
|
128
|
+
```
|
|
129
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
130
|
+
❌ ERROS ENCONTRADOS
|
|
131
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
132
|
+
|
|
133
|
+
📊 Resumo:
|
|
134
|
+
∟ Arquivos: 45
|
|
135
|
+
∟ Erros: 5
|
|
136
|
+
∟ Avisos: 8
|
|
137
|
+
|
|
138
|
+
❌ Erros:
|
|
139
|
+
∟ docs/api.md: link quebrado (line 45)
|
|
140
|
+
∟ docs/guide.md: sem header
|
|
141
|
+
∟ README.md: seção "Uso" ausente
|
|
142
|
+
|
|
143
|
+
⚠️ Avisos:
|
|
144
|
+
∟ 8 arquivos muito curtos (<50 linhas)
|
|
145
|
+
|
|
146
|
+
💡 Para corrigir: /docs/validate-docs fix="true"
|
|
147
|
+
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
## 🔗 Referências
|
|
151
|
+
|
|
152
|
+
- Health check: /docs/docs-health
|
|
153
|
+
- Agente: @system-documentation-orchestrator
|
|
154
|
+
|
|
155
|
+
## ⚠️ Notas
|
|
156
|
+
|
|
157
|
+
- Executar antes de releases
|
|
158
|
+
- `fix="true"` corrige apenas formatação
|
|
159
|
+
- Links quebrados requerem correção manual
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: bump
|
|
3
|
+
description: Bump de versão seguindo semver. Incrementa major, minor ou patch.
|
|
4
|
+
model: sonnet
|
|
5
|
+
category: engineer
|
|
6
|
+
tags: [version, release, semver]
|
|
7
|
+
version: "4.0.0"
|
|
8
|
+
updated: "2025-12-20"
|
|
9
|
+
level: advanced
|
|
10
|
+
context: technical
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
Vamos preparar isso para um release aumentando o número da versão.
|
|
14
|
+
|
|
15
|
+
Siga estas regras para versionamento x.y.z:
|
|
16
|
+
|
|
17
|
+
- x (Versão major): Incremente quando você fizer mudanças incompatíveis na API ou funcionalidade. Exemplos incluem:
|
|
18
|
+
Mudanças que quebram APIs públicas (ex.: remover ou renomear métodos).
|
|
19
|
+
Reescritas majors ou refatoração que alteram comportamento.
|
|
20
|
+
Mudanças que requerem que usuários atualizem seu código ou dependências para manter compatibilidade.
|
|
21
|
+
- y (Versão minor): Incremente quando você adicionar novas funcionalidades ou melhorias de forma retrocompatível. Exemplos incluem:
|
|
22
|
+
Adicionando novos métodos, endpoints, ou funcionalidades.
|
|
23
|
+
Depreciar funcionalidades (mas não removê-las ainda).
|
|
24
|
+
Melhorias que não quebram funcionalidades existentes.
|
|
25
|
+
- z (Versão patch): Incremente quando você fizer correções de bugs retrocompatíveis ou pequenas atualizações. Exemplos incluem:
|
|
26
|
+
Corrigir bugs sem alterar funcionalidade pretendida.
|
|
27
|
+
Pequenas melhorias de performance.
|
|
28
|
+
Atualizações de documentação ou mudanças de metadata.
|
|
29
|
+
|
|
30
|
+
Altere a versão no pyproject.toml.
|
|
31
|
+
Então, execute `uv sync --all-extras` para regenerar o lock file.
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
## 📚 Pré-requisitos
|
|
36
|
+
|
|
37
|
+
Domine comandos starter antes de usar este comando intermediate/advanced.
|
|
38
|
+
|
|
39
|
+
Consulte os comandos help para ver hierarquia completa e comandos relacionados:
|
|
40
|
+
- /business/help --level=starter
|
|
41
|
+
- /technical/help --level=starter
|
|
42
|
+
|
|
43
|
+
💡 Comandos intermediate/advanced assumem familiaridade com workflows básicos do contexto.
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: docs
|
|
3
|
+
description: Invocar agente de documentação para branch atual.
|
|
4
|
+
model: sonnet
|
|
5
|
+
category: engineer
|
|
6
|
+
tags: [documentation, branch]
|
|
7
|
+
version: "4.0.0"
|
|
8
|
+
updated: "2025-12-20"
|
|
9
|
+
level: starter
|
|
10
|
+
context: technical
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
Por favor, invoque o agente branch-documentation-writer
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## 🚀 Próximos Passos
|
|
18
|
+
|
|
19
|
+
Após gerar/atualizar documentação:
|
|
20
|
+
|
|
21
|
+
1. **Validar consistência**:
|
|
22
|
+
```bash
|
|
23
|
+
/technical/validate-docs
|
|
24
|
+
```
|
|
25
|
+
Verifica links quebrados, seções faltando, etc.
|
|
26
|
+
|
|
27
|
+
2. **Construir índice completo**:
|
|
28
|
+
```bash
|
|
29
|
+
/technical/build-index
|
|
30
|
+
```
|
|
31
|
+
Gera índice navegável de toda documentação técnica.
|
|
32
|
+
|
|
33
|
+
3. **Verificar saúde da docs**:
|
|
34
|
+
```bash
|
|
35
|
+
/technical/docs-health
|
|
36
|
+
```
|
|
37
|
+
Analisa cobertura, atualização e qualidade geral.
|
|
38
|
+
|
|
39
|
+
💡 **Dica**: Documente enquanto implementa, não depois! Contexto fresco = docs melhores.
|