sdd-toolkit 1.9.0 → 1.9.2
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/README.md +393 -339
- package/README.pt.md +327 -327
- package/definitions/sdd-coder.yaml +71 -71
- package/definitions/sdd-feature.yaml +73 -73
- package/definitions/sdd-log.yaml +61 -61
- package/definitions/sdd-project.yaml +4 -28
- package/definitions/sdd-requirements.yaml +70 -70
- package/definitions/sdd-review.yaml +88 -88
- package/definitions/sdd.yaml +23 -23
- package/package.json +42 -42
- package/src/commands/view.js +18 -18
- package/src/index.js +98 -98
- package/src/lib/dashboard.js +187 -187
- package/src/lib/docs.js +69 -69
- package/src/lib/i18n.js +65 -65
- package/src/lib/messages.js +234 -234
- package/src/lib/profiles.js +186 -186
- package/src/lib/transformers.js +12 -12
- package/templates/guidelines.md +9 -9
- package/templates/project.md +28 -28
- package/templates/requirements.md +15 -15
- package/templates/task.md +11 -11
package/README.pt.md
CHANGED
|
@@ -1,334 +1,334 @@
|
|
|
1
|
-
# sdd-toolkit (CLI de Especificação Universal)
|
|
2
|
-
|
|
3
|
-

|
|
4
|
-

|
|
5
|
-

|
|
6
|
-
|
|
7
|
-
CLI tool para configurar automaticamente o ambiente de desenvolvimento e instalar agentes de IA (Auditor, Coder, etc.) para várias ferramentas modernas de IA.
|
|
8
|
-
|
|
9
|
-
## Visão Geral
|
|
10
|
-
|
|
11
|
-
**sdd-toolkit** é um "Gerenciador de Pacotes de Agentes de IA". Ele define uma equipe padrão de Desenvolvedores de IA e os instala diretamente no contexto de sua assistente de codificação de IA favorita (como Gemini, Roo Code, Kilo Code, OpenCode).
|
|
12
|
-
|
|
13
|
-
A ideia principal é parar de criar prompts do zero e instalar um workflow comprovado e estruturado.
|
|
14
|
-
|
|
15
|
-
## 📑 Índice
|
|
16
|
-
|
|
17
|
-
- [Visão Geral](#visão-geral)
|
|
18
|
-
- [Recursos Principais](#-recursos-principais)
|
|
19
|
-
- [A Equipe](#-a-equipe-funções-dos-agentes)
|
|
20
|
-
- [Instalação e Uso](#instalação-e-uso)
|
|
21
|
-
- [Como Funciona](#como-funciona)
|
|
22
|
-
- [Fluxo de Desenvolvimento](#fluxo-de-desenvolvimento)
|
|
23
|
-
- [Comandos nas Ferramentas de IA](#comandos-nas-ferramentas-de-ia)
|
|
24
|
-
- [Estrutura de Arquivos Gerados](#estrutura-de-arquivos-gerados)
|
|
25
|
-
- [Exemplos de Uso](#exemplos-de-uso)
|
|
26
|
-
- [Solução de Problemas](#solução-de-problemas)
|
|
27
|
-
- [Perguntas Frequentes](#-perguntas-frequentes)
|
|
28
|
-
- [Estrutura do Projeto](#estrutura-do-projeto)
|
|
29
|
-
- [Licença](#licença)
|
|
30
|
-
|
|
31
|
-
## 🚀 Recursos Principais
|
|
32
|
-
|
|
33
|
-
### 1. Workflow Inteligente e Ágil
|
|
34
|
-
- **Fluxo Híbrido:** Suporta planejamento "Waterfall" (para novos projetos) e execução "Agile" (para hotfixes).
|
|
35
|
-
- **Contexto Inteligente:** Os agentes escaneiam automaticamente seu `package.json`, `go.mod`, ou `requirements.txt` para entender sua stack. Não mais explicar "Eu uso React" toda vez.
|
|
36
|
-
- **Memória Unificada:** Todo contexto é armazenado em uma pasta oculta `.sdd-toolkit/`, mantendo sua raiz limpa.
|
|
37
|
-
|
|
38
|
-
### 2. Suporte Multi-Idiomas
|
|
39
|
-
O toolkit suporta Inglês, Português (Brasil) e Espanhol. Os agentes adaptam automaticamente suas respostas ao idioma preferido.
|
|
40
|
-
|
|
41
|
-
### 3. Instalação de Agentes de IA
|
|
42
|
-
Lê definições agnósticas (YAML) e as converte para formatos específicos:
|
|
1
|
+
# sdd-toolkit (CLI de Especificação Universal)
|
|
2
|
+
|
|
3
|
+

|
|
4
|
+

|
|
5
|
+

|
|
6
|
+
|
|
7
|
+
CLI tool para configurar automaticamente o ambiente de desenvolvimento e instalar agentes de IA (Auditor, Coder, etc.) para várias ferramentas modernas de IA.
|
|
8
|
+
|
|
9
|
+
## Visão Geral
|
|
10
|
+
|
|
11
|
+
**sdd-toolkit** é um "Gerenciador de Pacotes de Agentes de IA". Ele define uma equipe padrão de Desenvolvedores de IA e os instala diretamente no contexto de sua assistente de codificação de IA favorita (como Gemini, Roo Code, Kilo Code, OpenCode).
|
|
12
|
+
|
|
13
|
+
A ideia principal é parar de criar prompts do zero e instalar um workflow comprovado e estruturado.
|
|
14
|
+
|
|
15
|
+
## 📑 Índice
|
|
16
|
+
|
|
17
|
+
- [Visão Geral](#visão-geral)
|
|
18
|
+
- [Recursos Principais](#-recursos-principais)
|
|
19
|
+
- [A Equipe](#-a-equipe-funções-dos-agentes)
|
|
20
|
+
- [Instalação e Uso](#instalação-e-uso)
|
|
21
|
+
- [Como Funciona](#como-funciona)
|
|
22
|
+
- [Fluxo de Desenvolvimento](#fluxo-de-desenvolvimento)
|
|
23
|
+
- [Comandos nas Ferramentas de IA](#comandos-nas-ferramentas-de-ia)
|
|
24
|
+
- [Estrutura de Arquivos Gerados](#estrutura-de-arquivos-gerados)
|
|
25
|
+
- [Exemplos de Uso](#exemplos-de-uso)
|
|
26
|
+
- [Solução de Problemas](#solução-de-problemas)
|
|
27
|
+
- [Perguntas Frequentes](#-perguntas-frequentes)
|
|
28
|
+
- [Estrutura do Projeto](#estrutura-do-projeto)
|
|
29
|
+
- [Licença](#licença)
|
|
30
|
+
|
|
31
|
+
## 🚀 Recursos Principais
|
|
32
|
+
|
|
33
|
+
### 1. Workflow Inteligente e Ágil
|
|
34
|
+
- **Fluxo Híbrido:** Suporta planejamento "Waterfall" (para novos projetos) e execução "Agile" (para hotfixes).
|
|
35
|
+
- **Contexto Inteligente:** Os agentes escaneiam automaticamente seu `package.json`, `go.mod`, ou `requirements.txt` para entender sua stack. Não mais explicar "Eu uso React" toda vez.
|
|
36
|
+
- **Memória Unificada:** Todo contexto é armazenado em uma pasta oculta `.sdd-toolkit/`, mantendo sua raiz limpa.
|
|
37
|
+
|
|
38
|
+
### 2. Suporte Multi-Idiomas
|
|
39
|
+
O toolkit suporta Inglês, Português (Brasil) e Espanhol. Os agentes adaptam automaticamente suas respostas ao idioma preferido.
|
|
40
|
+
|
|
41
|
+
### 3. Instalação de Agentes de IA
|
|
42
|
+
Lê definições agnósticas (YAML) e as converte para formatos específicos:
|
|
43
43
|
- **Gemini CLI:** Gera arquivos de configuração `.toml`.
|
|
44
|
-
- **Roo Code:** Gera agentes em `.roo/commands/*.md`.
|
|
45
|
-
- **Cline:** Gera modos customizados (`_custom_modes.json`) e regras de contexto em `.cline/`.
|
|
46
|
-
- **GitHub Copilot:** Gera instruções em `.github/prompts.md` e agentes em `.github/prompts/*.md`.
|
|
47
|
-
- **Cursor:** Gera regras em `.cursor/commands/*.mdc`.
|
|
48
|
-
- **Windsurf:** Gera workflows em `.windsurf/workflows/*.md`.
|
|
49
|
-
- **Trae:** Gera instruções em `.trae/instructions.md`.
|
|
50
|
-
- **OpenCode:** Gera agentes em `.opencode/commands/*.md`.
|
|
51
|
-
- **Kilo Code:** Gera prompts Markdown (`.kilocode/workflows/*.md`).
|
|
44
|
+
- **Roo Code:** Gera agentes em `.roo/commands/*.md`.
|
|
45
|
+
- **Cline:** Gera modos customizados (`_custom_modes.json`) e regras de contexto em `.cline/`.
|
|
46
|
+
- **GitHub Copilot:** Gera instruções em `.github/prompts.md` e agentes em `.github/prompts/*.md`.
|
|
47
|
+
- **Cursor:** Gera regras em `.cursor/commands/*.mdc`.
|
|
48
|
+
- **Windsurf:** Gera workflows em `.windsurf/workflows/*.md`.
|
|
49
|
+
- **Trae:** Gera instruções em `.trae/instructions.md`.
|
|
50
|
+
- **OpenCode:** Gera agentes em `.opencode/commands/*.md`.
|
|
51
|
+
- **Kilo Code:** Gera prompts Markdown (`.kilocode/workflows/*.md`).
|
|
52
52
|
|
|
53
53
|
## 👥 A Equipe (Funções dos Agentes)
|
|
54
54
|
|
|
55
55
|
O sistema instala uma equipe de agentes especializados:
|
|
56
56
|
|
|
57
|
-
### 🏗️ Agentes Estratégicos
|
|
58
|
-
- **@Arquiteto de Projeto:** Define o escopo e princípios.
|
|
59
|
-
- **@Engenheiro de Requisitos:** Define a stack técnica (Auto-detectada).
|
|
60
|
-
|
|
61
|
-
### ⚡ Agentes de Execução
|
|
62
|
-
- **@Gerente de Features:** Gerencia features, marcos e tarefas.
|
|
63
|
-
- **@Codificador:** O desenvolvedor sênior. Implementa código seguindo princípios SOLID.
|
|
64
|
-
|
|
65
|
-
### 🛡️ Agentes de Qualidade
|
|
66
|
-
- **@QA Engineer:** Revisa código contra a especificação.
|
|
67
|
-
- **@Gerente de Releases:** Consolida logs e gerencia o changelog.
|
|
68
|
-
|
|
69
|
-
## Instalação e Uso
|
|
70
|
-
|
|
71
|
-
### Configuração Inicial
|
|
72
|
-
Execute a ferramenta diretamente via `npx` sem instalação prévia:
|
|
73
|
-
|
|
74
|
-
```bash
|
|
75
|
-
npx sdd-toolkit
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
### Ver o Dashboard do Projeto
|
|
79
|
-
Verifique o status atual do seu projeto:
|
|
80
|
-
|
|
81
|
-
```bash
|
|
82
|
-
sdd-toolkit view
|
|
83
|
-
```
|
|
84
|
-
|
|
85
|
-
### Atualizar Instalação Existente
|
|
86
|
-
Atualize os agentes instalados sem reconfiguração:
|
|
87
|
-
|
|
88
|
-
```bash
|
|
89
|
-
sdd-toolkit upgrade
|
|
90
|
-
```
|
|
91
|
-
|
|
92
|
-
### Instalação Global
|
|
93
|
-
Ou instale globalmente:
|
|
94
|
-
|
|
95
|
-
```bash
|
|
96
|
-
npm install -g sdd-toolkit
|
|
97
|
-
sdd-toolkit
|
|
98
|
-
```
|
|
99
|
-
|
|
100
|
-
## Como Funciona
|
|
101
|
-
|
|
102
|
-
1. **Inicialização:** O assistente detecta suas ferramentas e configura a pasta de contexto oculta `.sdd-toolkit/`.
|
|
103
|
-
2. **Construção de Agentes:** Lê as definições dos agentes (YAML) e as compila no formato nativo da sua ferramenta de IA.
|
|
104
|
-
3. **Execução:** Interaja com os agentes usando comandos simplificados (ex.: `/project`, `/coder`, `/feature`).
|
|
105
|
-
|
|
106
|
-
## Fluxo de Desenvolvimento
|
|
107
|
-
|
|
108
|
-
O sdd-toolkit fornece um fluxo de trabalho estruturado com agentes especializados:
|
|
109
|
-
|
|
110
|
-
### 1. Definir Projeto
|
|
111
|
-
- Comando: `/project`
|
|
112
|
-
- Cria `.sdd-toolkit/project.md` com o escopo e princípios do projeto.
|
|
113
|
-
|
|
114
|
-
### 2. Definir Requisitos
|
|
115
|
-
- Comando: `/requirements`
|
|
116
|
-
- Analisa sua stack e cria `.sdd-toolkit/requirements.md`.
|
|
117
|
-
|
|
118
|
-
### 3. Planejar Features
|
|
119
|
-
- Comando: `/feature`
|
|
120
|
-
- Cria `.sdd-toolkit/features/[nome].md` com marcos e tarefas.
|
|
121
|
-
|
|
122
|
-
### 4. Implementar Código
|
|
123
|
-
- Comando: `/coder [task-id]`
|
|
124
|
-
- Implementa tarefas do plano de features e registra o trabalho.
|
|
125
|
-
|
|
126
|
-
### 5. Revisar Código
|
|
127
|
-
- Comando: `/review [task-id]`
|
|
128
|
-
- QA Engineer revisa a implementação contra os requisitos.
|
|
129
|
-
|
|
130
|
-
### 6. Release
|
|
131
|
-
- Comando: `/log` ou `/dev:release`
|
|
132
|
-
- Consolida logs no changelog e arquiva o trabalho concluído.
|
|
133
|
-
|
|
134
|
-
## Comandos nas Ferramentas de IA
|
|
135
|
-
|
|
136
|
-
Uma vez que os agentes estejam instalados, use estes comandos no seu assistente de codificação de IA:
|
|
137
|
-
|
|
138
|
-
### Acessar Agentes
|
|
139
|
-
- **`/sdd`** - Exibe os agentes disponíveis e ajuda
|
|
140
|
-
- **`/sdd.project`** - Ativa o Arquiteto de Projeto
|
|
141
|
-
- **`/sdd.requirements`** - Ativa o Engenheiro de Requisitos
|
|
142
|
-
- **`/sdd.feature`** - Ativa o Gerente de Features
|
|
143
|
-
- **`/sdd.coder`** - Ativa o Codificador
|
|
144
|
-
- **`/sdd.review`** - Ativa o QA Engineer
|
|
145
|
-
- **`/sdd.log`** - Ativa o Gerente de Releases
|
|
146
|
-
|
|
147
|
-
### Comandos Especiais
|
|
148
|
-
- **`/dev:review [Task_ID]`** - Aciona revisão de código para uma tarefa específica
|
|
149
|
-
- **`/dev:release`** - Consolida logs e cria changelog
|
|
150
|
-
|
|
151
|
-
## Estrutura de Arquivos Gerados
|
|
152
|
-
|
|
153
|
-
Após executar `sdd-toolkit`, a seguinte estrutura é criada em seu projeto:
|
|
154
|
-
|
|
155
|
-
```
|
|
156
|
-
.sdd-toolkit/
|
|
157
|
-
├── project.md # Escopo e princípios do projeto
|
|
158
|
-
├── requirements.md # Requisitos técnicos e stack
|
|
159
|
-
├── guidelines.md # Diretrizes de desenvolvimento do projeto
|
|
160
|
-
├── milestones.md # Roadmap de desenvolvimento
|
|
161
|
-
├── task.md # Backlog de execução de tarefas
|
|
162
|
-
├── features/ # Especificações individuais de features
|
|
163
|
-
│ └── [feature-name].md
|
|
164
|
-
├── logs/
|
|
165
|
-
│ ├── executions/ # Logs de execução de tarefas
|
|
166
|
-
│ ├── reviews/ # Relatórios de revisão de código
|
|
167
|
-
│ └── archive/ # Trabalho concluído arquivado
|
|
168
|
-
└── agents/ # Definições personalizadas de agentes (overrides opcionais)
|
|
169
|
-
```
|
|
170
|
-
|
|
171
|
-
## Estrutura do Projeto
|
|
172
|
-
|
|
173
|
-
- `definitions/`: Definições YAML de agentes
|
|
174
|
-
- `templates/`: Modelos de documentação
|
|
175
|
-
- `src/`: Código fonte da CLI
|
|
176
|
-
|
|
177
|
-
## Exemplos de Uso
|
|
178
|
-
|
|
179
|
-
### Fluxo Completo: Nova Feature
|
|
180
|
-
|
|
181
|
-
1. **Definir projeto:**
|
|
182
|
-
```
|
|
183
|
-
/sdd.project
|
|
184
|
-
```
|
|
185
|
-
Cria `.sdd-toolkit/project.md` com escopo e princípios.
|
|
186
|
-
|
|
187
|
-
2. **Definir requisitos técnicos:**
|
|
188
|
-
```
|
|
189
|
-
/sdd.requirements
|
|
190
|
-
```
|
|
191
|
-
Analisa seu `package.json`/`go.mod` e cria `.sdd-toolkit/requirements.md`.
|
|
192
|
-
|
|
193
|
-
3. **Planejar uma nova feature:**
|
|
194
|
-
```
|
|
195
|
-
/sdd.feature
|
|
196
|
-
```
|
|
197
|
-
Especifique sua feature (ex: "Adicionar autenticação de usuário"). Cria `.sdd-toolkit/features/auth.md`.
|
|
198
|
-
|
|
199
|
-
4. **Implementar tarefas:**
|
|
200
|
-
```
|
|
201
|
-
/sdd.coder MT01-task-1
|
|
202
|
-
```
|
|
203
|
-
Codificador implementa a tarefa seguindo princípios SOLID e registra o trabalho.
|
|
204
|
-
|
|
205
|
-
5. **Revisar implementação:**
|
|
206
|
-
```
|
|
207
|
-
/sdd.review MT01-task-1
|
|
208
|
-
```
|
|
209
|
-
QA Engineer valida a implementação contra os requisitos.
|
|
210
|
-
|
|
211
|
-
6. **Release das mudanças:**
|
|
212
|
-
```
|
|
213
|
-
/sdd.log
|
|
214
|
-
```
|
|
215
|
-
Consolida logs no changelog e arquiva o trabalho concluído.
|
|
216
|
-
|
|
217
|
-
### Correção Rápida de Bug
|
|
218
|
-
|
|
219
|
-
1. **Usar Codificador diretamente:**
|
|
220
|
-
```
|
|
221
|
-
/sdd.coder fixar-bug-login
|
|
222
|
-
```
|
|
223
|
-
Codificador analisa, corrige e documenta a mudança.
|
|
224
|
-
|
|
225
|
-
2. **Revisar correção:**
|
|
226
|
-
```
|
|
227
|
-
/sdd.review fixar-bug-login
|
|
228
|
-
```
|
|
229
|
-
Valida que a correção atende os requisitos.
|
|
230
|
-
|
|
231
|
-
## Licença
|
|
232
|
-
|
|
233
|
-
MIT
|
|
234
|
-
|
|
235
|
-
## ❓ Solução de Problemas
|
|
236
|
-
|
|
237
|
-
### Agentes não aparecem na sua ferramenta de IA
|
|
238
|
-
|
|
239
|
-
**Problema:** Depois de executar `sdd-toolkit`, os agentes não aparecem no seu assistente de codificação de IA.
|
|
240
|
-
|
|
241
|
-
**Soluções:**
|
|
242
|
-
- **Roo Code/Cline:** Verifique se você configurou os Modos Personalizados nas configurações. Veja a mensagem de aviso após a instalação.
|
|
243
|
-
- **Cursor:** Reinicie a IDE após a instalação.
|
|
244
|
-
- **OpenCode:** Atualize o painel de comandos.
|
|
245
|
-
- **Gemini CLI:** Verifique se a pasta `.gemini/commands/dev/` existe com arquivos `.toml`.
|
|
246
|
-
|
|
247
|
-
### Erro de permissão ao executar sdd-toolkit
|
|
248
|
-
|
|
249
|
-
**Problema:** Recebendo "Permissão negada" ou erro EACCES ao executar `npx sdd-toolkit`.
|
|
250
|
-
|
|
251
|
-
**Soluções:**
|
|
252
|
-
- **Opção 1:** Execute com permissões elevadas (não recomendado):
|
|
253
|
-
```bash
|
|
254
|
-
sudo npx sdd-toolkit
|
|
255
|
-
```
|
|
256
|
-
- **Opção 2:** Corrija permissões do npm:
|
|
257
|
-
```bash
|
|
258
|
-
npm config set prefix ~/.npm-global
|
|
259
|
-
export PATH=~/.npm-global/bin:$PATH
|
|
260
|
-
```
|
|
261
|
-
- **Opção 3:** Instale globalmente com sudo:
|
|
262
|
-
```bash
|
|
263
|
-
sudo npm install -g sdd-toolkit
|
|
264
|
-
```
|
|
265
|
-
|
|
266
|
-
### Agentes respondendo no idioma errado
|
|
267
|
-
|
|
268
|
-
**Problema:** Os agentes não estão respondendo no seu idioma preferido.
|
|
269
|
-
|
|
270
|
-
**Solução:**
|
|
271
|
-
- Execute `sdd-toolkit` novamente e certifique-se de selecionar o idioma correto durante a configuração (Inglês, Português ou Espanhol).
|
|
272
|
-
- Ou edite manualmente o `LANGUAGE_RULES` nos arquivos dos seus agentes.
|
|
273
|
-
|
|
274
|
-
### Perfil de stack não aplicando regras
|
|
275
|
-
|
|
276
|
-
**Problema:** As regras do perfil de stack selecionado não estão sendo usadas pelos agentes.
|
|
277
|
-
|
|
278
|
-
**Solução:**
|
|
279
|
-
- O perfil de stack é aplicado apenas durante a instalação inicial ou upgrade. Execute:
|
|
280
|
-
```bash
|
|
281
|
-
sdd-toolkit upgrade
|
|
282
|
-
```
|
|
283
|
-
Certifique-se de selecionar o mesmo perfil de stack novamente.
|
|
284
|
-
|
|
285
|
-
### Pasta `.sdd-toolkit/` não criada
|
|
286
|
-
|
|
287
|
-
**Problema:** A estrutura de pastas ocultas não é criada após a instalação.
|
|
288
|
-
|
|
289
|
-
**Soluções:**
|
|
290
|
-
- Verifique se você está executando o comando a partir do diretório raiz do seu projeto (onde está o `package.json`).
|
|
291
|
-
- Verifique as permissões de escrita no diretório.
|
|
292
|
-
- Verifique mensagens de erro durante a instalação.
|
|
293
|
-
|
|
294
|
-
## 🔎 Perguntas Frequentes
|
|
295
|
-
|
|
296
|
-
**P: Posso usar múltiplos assistentes de IA simultaneamente?**
|
|
297
|
-
|
|
298
|
-
R: Sim! Você pode instalar agentes para múltiplas ferramentas de IA no mesmo projeto. Cada ferramenta tem sua própria estrutura de pastas (`.roo/`, `.cline/`, `.cursor/`, etc.) e podem coexistir sem conflitos.
|
|
299
|
-
|
|
300
|
-
**P: Como atualizo os agentes após a configuração inicial?**
|
|
301
|
-
|
|
302
|
-
R: Execute `sdd-toolkit upgrade`. Isso atualizará todos os agentes instalados sem exigir que você reconfigure seu perfil de stack ou regras globais.
|
|
303
|
-
|
|
304
|
-
**P: Posso personalizar as definições dos agentes?**
|
|
305
|
-
|
|
306
|
-
R: Sim! Crie arquivos YAML personalizados na pasta `.sdd-toolkit/agents/`. O toolkit usará suas versões personalizadas em vez das padrão. Você pode copiar e modificar as definições padrão da pasta `definitions/` no toolkit.
|
|
307
|
-
|
|
308
|
-
**P: O que acontece se eu executar `sdd-toolkit` múltiplas vezes?**
|
|
309
|
-
|
|
310
|
-
R: A ferramenta é idempotente - executá-la novamente apenas atualizará ou regerará arquivos ausentes sem duplicar configurações existentes. Seus documentos de projeto existentes em `.sdd-toolkit/` serão preservados.
|
|
311
|
-
|
|
312
|
-
**P: Posso usar isso com projetos que já têm código existente?**
|
|
313
|
-
|
|
314
|
-
R: Sim! O agente "Engenheiro de Requisitos" pode analisar seu `package.json`, `go.mod` ou `requirements.txt` existente para detectar automaticamente sua stack. O "Arquiteto de Projeto" também pode formalizar projetos existentes em modo "híbrido".
|
|
315
|
-
|
|
316
|
-
**P: Preciso commitar a pasta `.sdd-toolkit/` no meu repositório?**
|
|
317
|
-
|
|
318
|
-
R: Sim, é recomendado. A pasta `.sdd-toolkit/` contém a documentação do seu projeto, especificações e configurações dos agentes. Commitá-la garante consistência em toda a equipe e preserva o contexto para sessões futuras.
|
|
319
|
-
|
|
320
|
-
**P: Como removo o sdd-toolkit do meu projeto?**
|
|
321
|
-
|
|
322
|
-
R: Simplesmente delete a pasta `.sdd-toolkit/` e quaisquer pastas específicas de ferramentas (`.roo/`, `.cline/`, `.cursor/`, etc.). Esses são todos arquivos gerados e não afetarão seu código fonte.
|
|
323
|
-
|
|
324
|
-
**P: Minhas mudanças de código são rastreadas pelo sdd-toolkit?**
|
|
325
|
-
|
|
326
|
-
R: Não, o sdd-toolkit apenas gerencia documentação e configurações de agentes de IA. Ele não rastreia mudanças de código, lê seus arquivos fonte, ou interfere com controle de versão.
|
|
327
|
-
|
|
328
|
-
**P: Posso adicionar meus próprios perfis de stack?**
|
|
329
|
-
|
|
330
|
-
R: Atualmente, os perfis de stack são codificados no toolkit. Para adicionar um perfil personalizado, você pode usar o recurso de "Regras Globais" durante a configuração para injetar suas próprias convenções, ou pode fazer um fork do repositório e adicionar seu perfil em `src/lib/profiles.js`.
|
|
331
|
-
|
|
332
|
-
**P: Isso é adequado para projetos empresariais?**
|
|
333
|
-
|
|
57
|
+
### 🏗️ Agentes Estratégicos
|
|
58
|
+
- **@Arquiteto de Projeto:** Define o escopo e princípios.
|
|
59
|
+
- **@Engenheiro de Requisitos:** Define a stack técnica (Auto-detectada).
|
|
60
|
+
|
|
61
|
+
### ⚡ Agentes de Execução
|
|
62
|
+
- **@Gerente de Features:** Gerencia features, marcos e tarefas.
|
|
63
|
+
- **@Codificador:** O desenvolvedor sênior. Implementa código seguindo princípios SOLID.
|
|
64
|
+
|
|
65
|
+
### 🛡️ Agentes de Qualidade
|
|
66
|
+
- **@QA Engineer:** Revisa código contra a especificação.
|
|
67
|
+
- **@Gerente de Releases:** Consolida logs e gerencia o changelog.
|
|
68
|
+
|
|
69
|
+
## Instalação e Uso
|
|
70
|
+
|
|
71
|
+
### Configuração Inicial
|
|
72
|
+
Execute a ferramenta diretamente via `npx` sem instalação prévia:
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
npx sdd-toolkit
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Ver o Dashboard do Projeto
|
|
79
|
+
Verifique o status atual do seu projeto:
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
sdd-toolkit view
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
### Atualizar Instalação Existente
|
|
86
|
+
Atualize os agentes instalados sem reconfiguração:
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
sdd-toolkit upgrade
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### Instalação Global
|
|
93
|
+
Ou instale globalmente:
|
|
94
|
+
|
|
95
|
+
```bash
|
|
96
|
+
npm install -g sdd-toolkit
|
|
97
|
+
sdd-toolkit
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## Como Funciona
|
|
101
|
+
|
|
102
|
+
1. **Inicialização:** O assistente detecta suas ferramentas e configura a pasta de contexto oculta `.sdd-toolkit/`.
|
|
103
|
+
2. **Construção de Agentes:** Lê as definições dos agentes (YAML) e as compila no formato nativo da sua ferramenta de IA.
|
|
104
|
+
3. **Execução:** Interaja com os agentes usando comandos simplificados (ex.: `/project`, `/coder`, `/feature`).
|
|
105
|
+
|
|
106
|
+
## Fluxo de Desenvolvimento
|
|
107
|
+
|
|
108
|
+
O sdd-toolkit fornece um fluxo de trabalho estruturado com agentes especializados:
|
|
109
|
+
|
|
110
|
+
### 1. Definir Projeto
|
|
111
|
+
- Comando: `/project`
|
|
112
|
+
- Cria `.sdd-toolkit/project.md` com o escopo e princípios do projeto.
|
|
113
|
+
|
|
114
|
+
### 2. Definir Requisitos
|
|
115
|
+
- Comando: `/requirements`
|
|
116
|
+
- Analisa sua stack e cria `.sdd-toolkit/requirements.md`.
|
|
117
|
+
|
|
118
|
+
### 3. Planejar Features
|
|
119
|
+
- Comando: `/feature`
|
|
120
|
+
- Cria `.sdd-toolkit/features/[nome].md` com marcos e tarefas.
|
|
121
|
+
|
|
122
|
+
### 4. Implementar Código
|
|
123
|
+
- Comando: `/coder [task-id]`
|
|
124
|
+
- Implementa tarefas do plano de features e registra o trabalho.
|
|
125
|
+
|
|
126
|
+
### 5. Revisar Código
|
|
127
|
+
- Comando: `/review [task-id]`
|
|
128
|
+
- QA Engineer revisa a implementação contra os requisitos.
|
|
129
|
+
|
|
130
|
+
### 6. Release
|
|
131
|
+
- Comando: `/log` ou `/dev:release`
|
|
132
|
+
- Consolida logs no changelog e arquiva o trabalho concluído.
|
|
133
|
+
|
|
134
|
+
## Comandos nas Ferramentas de IA
|
|
135
|
+
|
|
136
|
+
Uma vez que os agentes estejam instalados, use estes comandos no seu assistente de codificação de IA:
|
|
137
|
+
|
|
138
|
+
### Acessar Agentes
|
|
139
|
+
- **`/sdd`** - Exibe os agentes disponíveis e ajuda
|
|
140
|
+
- **`/sdd.project`** - Ativa o Arquiteto de Projeto
|
|
141
|
+
- **`/sdd.requirements`** - Ativa o Engenheiro de Requisitos
|
|
142
|
+
- **`/sdd.feature`** - Ativa o Gerente de Features
|
|
143
|
+
- **`/sdd.coder`** - Ativa o Codificador
|
|
144
|
+
- **`/sdd.review`** - Ativa o QA Engineer
|
|
145
|
+
- **`/sdd.log`** - Ativa o Gerente de Releases
|
|
146
|
+
|
|
147
|
+
### Comandos Especiais
|
|
148
|
+
- **`/dev:review [Task_ID]`** - Aciona revisão de código para uma tarefa específica
|
|
149
|
+
- **`/dev:release`** - Consolida logs e cria changelog
|
|
150
|
+
|
|
151
|
+
## Estrutura de Arquivos Gerados
|
|
152
|
+
|
|
153
|
+
Após executar `sdd-toolkit`, a seguinte estrutura é criada em seu projeto:
|
|
154
|
+
|
|
155
|
+
```
|
|
156
|
+
.sdd-toolkit/
|
|
157
|
+
├── project.md # Escopo e princípios do projeto
|
|
158
|
+
├── requirements.md # Requisitos técnicos e stack
|
|
159
|
+
├── guidelines.md # Diretrizes de desenvolvimento do projeto
|
|
160
|
+
├── milestones.md # Roadmap de desenvolvimento
|
|
161
|
+
├── task.md # Backlog de execução de tarefas
|
|
162
|
+
├── features/ # Especificações individuais de features
|
|
163
|
+
│ └── [feature-name].md
|
|
164
|
+
├── logs/
|
|
165
|
+
│ ├── executions/ # Logs de execução de tarefas
|
|
166
|
+
│ ├── reviews/ # Relatórios de revisão de código
|
|
167
|
+
│ └── archive/ # Trabalho concluído arquivado
|
|
168
|
+
└── agents/ # Definições personalizadas de agentes (overrides opcionais)
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
## Estrutura do Projeto
|
|
172
|
+
|
|
173
|
+
- `definitions/`: Definições YAML de agentes
|
|
174
|
+
- `templates/`: Modelos de documentação
|
|
175
|
+
- `src/`: Código fonte da CLI
|
|
176
|
+
|
|
177
|
+
## Exemplos de Uso
|
|
178
|
+
|
|
179
|
+
### Fluxo Completo: Nova Feature
|
|
180
|
+
|
|
181
|
+
1. **Definir projeto:**
|
|
182
|
+
```
|
|
183
|
+
/sdd.project
|
|
184
|
+
```
|
|
185
|
+
Cria `.sdd-toolkit/project.md` com escopo e princípios.
|
|
186
|
+
|
|
187
|
+
2. **Definir requisitos técnicos:**
|
|
188
|
+
```
|
|
189
|
+
/sdd.requirements
|
|
190
|
+
```
|
|
191
|
+
Analisa seu `package.json`/`go.mod` e cria `.sdd-toolkit/requirements.md`.
|
|
192
|
+
|
|
193
|
+
3. **Planejar uma nova feature:**
|
|
194
|
+
```
|
|
195
|
+
/sdd.feature
|
|
196
|
+
```
|
|
197
|
+
Especifique sua feature (ex: "Adicionar autenticação de usuário"). Cria `.sdd-toolkit/features/auth.md`.
|
|
198
|
+
|
|
199
|
+
4. **Implementar tarefas:**
|
|
200
|
+
```
|
|
201
|
+
/sdd.coder MT01-task-1
|
|
202
|
+
```
|
|
203
|
+
Codificador implementa a tarefa seguindo princípios SOLID e registra o trabalho.
|
|
204
|
+
|
|
205
|
+
5. **Revisar implementação:**
|
|
206
|
+
```
|
|
207
|
+
/sdd.review MT01-task-1
|
|
208
|
+
```
|
|
209
|
+
QA Engineer valida a implementação contra os requisitos.
|
|
210
|
+
|
|
211
|
+
6. **Release das mudanças:**
|
|
212
|
+
```
|
|
213
|
+
/sdd.log
|
|
214
|
+
```
|
|
215
|
+
Consolida logs no changelog e arquiva o trabalho concluído.
|
|
216
|
+
|
|
217
|
+
### Correção Rápida de Bug
|
|
218
|
+
|
|
219
|
+
1. **Usar Codificador diretamente:**
|
|
220
|
+
```
|
|
221
|
+
/sdd.coder fixar-bug-login
|
|
222
|
+
```
|
|
223
|
+
Codificador analisa, corrige e documenta a mudança.
|
|
224
|
+
|
|
225
|
+
2. **Revisar correção:**
|
|
226
|
+
```
|
|
227
|
+
/sdd.review fixar-bug-login
|
|
228
|
+
```
|
|
229
|
+
Valida que a correção atende os requisitos.
|
|
230
|
+
|
|
231
|
+
## Licença
|
|
232
|
+
|
|
233
|
+
MIT
|
|
234
|
+
|
|
235
|
+
## ❓ Solução de Problemas
|
|
236
|
+
|
|
237
|
+
### Agentes não aparecem na sua ferramenta de IA
|
|
238
|
+
|
|
239
|
+
**Problema:** Depois de executar `sdd-toolkit`, os agentes não aparecem no seu assistente de codificação de IA.
|
|
240
|
+
|
|
241
|
+
**Soluções:**
|
|
242
|
+
- **Roo Code/Cline:** Verifique se você configurou os Modos Personalizados nas configurações. Veja a mensagem de aviso após a instalação.
|
|
243
|
+
- **Cursor:** Reinicie a IDE após a instalação.
|
|
244
|
+
- **OpenCode:** Atualize o painel de comandos.
|
|
245
|
+
- **Gemini CLI:** Verifique se a pasta `.gemini/commands/dev/` existe com arquivos `.toml`.
|
|
246
|
+
|
|
247
|
+
### Erro de permissão ao executar sdd-toolkit
|
|
248
|
+
|
|
249
|
+
**Problema:** Recebendo "Permissão negada" ou erro EACCES ao executar `npx sdd-toolkit`.
|
|
250
|
+
|
|
251
|
+
**Soluções:**
|
|
252
|
+
- **Opção 1:** Execute com permissões elevadas (não recomendado):
|
|
253
|
+
```bash
|
|
254
|
+
sudo npx sdd-toolkit
|
|
255
|
+
```
|
|
256
|
+
- **Opção 2:** Corrija permissões do npm:
|
|
257
|
+
```bash
|
|
258
|
+
npm config set prefix ~/.npm-global
|
|
259
|
+
export PATH=~/.npm-global/bin:$PATH
|
|
260
|
+
```
|
|
261
|
+
- **Opção 3:** Instale globalmente com sudo:
|
|
262
|
+
```bash
|
|
263
|
+
sudo npm install -g sdd-toolkit
|
|
264
|
+
```
|
|
265
|
+
|
|
266
|
+
### Agentes respondendo no idioma errado
|
|
267
|
+
|
|
268
|
+
**Problema:** Os agentes não estão respondendo no seu idioma preferido.
|
|
269
|
+
|
|
270
|
+
**Solução:**
|
|
271
|
+
- Execute `sdd-toolkit` novamente e certifique-se de selecionar o idioma correto durante a configuração (Inglês, Português ou Espanhol).
|
|
272
|
+
- Ou edite manualmente o `LANGUAGE_RULES` nos arquivos dos seus agentes.
|
|
273
|
+
|
|
274
|
+
### Perfil de stack não aplicando regras
|
|
275
|
+
|
|
276
|
+
**Problema:** As regras do perfil de stack selecionado não estão sendo usadas pelos agentes.
|
|
277
|
+
|
|
278
|
+
**Solução:**
|
|
279
|
+
- O perfil de stack é aplicado apenas durante a instalação inicial ou upgrade. Execute:
|
|
280
|
+
```bash
|
|
281
|
+
sdd-toolkit upgrade
|
|
282
|
+
```
|
|
283
|
+
Certifique-se de selecionar o mesmo perfil de stack novamente.
|
|
284
|
+
|
|
285
|
+
### Pasta `.sdd-toolkit/` não criada
|
|
286
|
+
|
|
287
|
+
**Problema:** A estrutura de pastas ocultas não é criada após a instalação.
|
|
288
|
+
|
|
289
|
+
**Soluções:**
|
|
290
|
+
- Verifique se você está executando o comando a partir do diretório raiz do seu projeto (onde está o `package.json`).
|
|
291
|
+
- Verifique as permissões de escrita no diretório.
|
|
292
|
+
- Verifique mensagens de erro durante a instalação.
|
|
293
|
+
|
|
294
|
+
## 🔎 Perguntas Frequentes
|
|
295
|
+
|
|
296
|
+
**P: Posso usar múltiplos assistentes de IA simultaneamente?**
|
|
297
|
+
|
|
298
|
+
R: Sim! Você pode instalar agentes para múltiplas ferramentas de IA no mesmo projeto. Cada ferramenta tem sua própria estrutura de pastas (`.roo/`, `.cline/`, `.cursor/`, etc.) e podem coexistir sem conflitos.
|
|
299
|
+
|
|
300
|
+
**P: Como atualizo os agentes após a configuração inicial?**
|
|
301
|
+
|
|
302
|
+
R: Execute `sdd-toolkit upgrade`. Isso atualizará todos os agentes instalados sem exigir que você reconfigure seu perfil de stack ou regras globais.
|
|
303
|
+
|
|
304
|
+
**P: Posso personalizar as definições dos agentes?**
|
|
305
|
+
|
|
306
|
+
R: Sim! Crie arquivos YAML personalizados na pasta `.sdd-toolkit/agents/`. O toolkit usará suas versões personalizadas em vez das padrão. Você pode copiar e modificar as definições padrão da pasta `definitions/` no toolkit.
|
|
307
|
+
|
|
308
|
+
**P: O que acontece se eu executar `sdd-toolkit` múltiplas vezes?**
|
|
309
|
+
|
|
310
|
+
R: A ferramenta é idempotente - executá-la novamente apenas atualizará ou regerará arquivos ausentes sem duplicar configurações existentes. Seus documentos de projeto existentes em `.sdd-toolkit/` serão preservados.
|
|
311
|
+
|
|
312
|
+
**P: Posso usar isso com projetos que já têm código existente?**
|
|
313
|
+
|
|
314
|
+
R: Sim! O agente "Engenheiro de Requisitos" pode analisar seu `package.json`, `go.mod` ou `requirements.txt` existente para detectar automaticamente sua stack. O "Arquiteto de Projeto" também pode formalizar projetos existentes em modo "híbrido".
|
|
315
|
+
|
|
316
|
+
**P: Preciso commitar a pasta `.sdd-toolkit/` no meu repositório?**
|
|
317
|
+
|
|
318
|
+
R: Sim, é recomendado. A pasta `.sdd-toolkit/` contém a documentação do seu projeto, especificações e configurações dos agentes. Commitá-la garante consistência em toda a equipe e preserva o contexto para sessões futuras.
|
|
319
|
+
|
|
320
|
+
**P: Como removo o sdd-toolkit do meu projeto?**
|
|
321
|
+
|
|
322
|
+
R: Simplesmente delete a pasta `.sdd-toolkit/` e quaisquer pastas específicas de ferramentas (`.roo/`, `.cline/`, `.cursor/`, etc.). Esses são todos arquivos gerados e não afetarão seu código fonte.
|
|
323
|
+
|
|
324
|
+
**P: Minhas mudanças de código são rastreadas pelo sdd-toolkit?**
|
|
325
|
+
|
|
326
|
+
R: Não, o sdd-toolkit apenas gerencia documentação e configurações de agentes de IA. Ele não rastreia mudanças de código, lê seus arquivos fonte, ou interfere com controle de versão.
|
|
327
|
+
|
|
328
|
+
**P: Posso adicionar meus próprios perfis de stack?**
|
|
329
|
+
|
|
330
|
+
R: Atualmente, os perfis de stack são codificados no toolkit. Para adicionar um perfil personalizado, você pode usar o recurso de "Regras Globais" durante a configuração para injetar suas próprias convenções, ou pode fazer um fork do repositório e adicionar seu perfil em `src/lib/profiles.js`.
|
|
331
|
+
|
|
332
|
+
**P: Isso é adequado para projetos empresariais?**
|
|
333
|
+
|
|
334
334
|
R: Sim, o sdd-toolkit é desenhado para escalar. A pasta `.sdd-toolkit/` pode ser commitada no seu repositório, garantindo que todos os membros da equipe usem as mesmas configurações de agentes e sigam os mesmos princípios de desenvolvimento definidos em `guidelines.md`.
|